vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 22:30:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Convert various uses of (optional) in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.

Browse Source 
The style for marking parameters optional in inline PHP docs is: `@param type $var Optional. Description. Accepts. Default.`, where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.


git-svn-id: https://develop.svn.wordpress.org/trunk@30753 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2014-12-06 21:23:52 +00:00
parent 71bb091cc3
commit 7187da0b32
9 changed files with 85 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/wp-admin/includes/post.php
View File

@@ -1116,14 +1116,14 @@ function postbox_classes( $id, $page ) {
}
/**
* {@internal Missing Short Description}}
* Get a sample permalink based off of the post name.
*
* @since 2.5.0
*
* @param integer $id Post ID or post object.
* @param string $title (optional) Title
* @param string $name (optional) Name
* @return array With two entries of type string
* @param int $id Post ID or post object.
* @param string $title Optional. Title. Default null.
* @param string $name Optional. Name. Default null.
* @return array Arra yith two entries of type string.
*/
function get_sample_permalink($id, $title = null, $name = null) {
$post = get_post( $id );
@@ -1185,9 +1185,9 @@ function get_sample_permalink($id, $title = null, $name = null) {
*
* @since 2.5.0
*
* @param integer $id Post ID or post object.
* @param string $new_title Optional. New title.
* @param string $new_slug Optional. New slug.
* @param int $id Post ID or post object.
* @param string $new_title Optional. New title. Default null.
* @param string $new_slug Optional. New slug. Default null.
* @return string The HTML of the sample permalink slug editor.
*/
function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) {