From d4dd02b4aeca44da3cc12930ff6bc4bf8fff8b00 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 3 Jul 2014 19:28:14 +0000 Subject: [PATCH] Remove backticks on `$post` variables in some short parameter descriptions. See [28653], [28654]. See #28388. Built from https://develop.svn.wordpress.org/trunk@28976 git-svn-id: http://core.svn.wordpress.org/trunk@28765 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/class-wp-list-table.php | 4 ++-- wp-admin/includes/template.php | 2 +- wp-includes/comment-template.php | 4 ++-- wp-includes/link-template.php | 2 +- wp-includes/media.php | 8 ++++---- wp-includes/post-template.php | 6 +++--- wp-includes/post.php | 24 +++++++++++------------ wp-includes/revision.php | 2 +- wp-includes/taxonomy.php | 4 ++-- 9 files changed, 28 insertions(+), 28 deletions(-) diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php index b2e14c45f8..dcaeb23ce5 100644 --- a/wp-admin/includes/class-wp-list-table.php +++ b/wp-admin/includes/class-wp-list-table.php @@ -519,8 +519,8 @@ class WP_List_Table { * @since 3.1.0 * @access protected * - * @param int $post_id - * @param int $pending_comments + * @param int $post_id The post ID. + * @param int $pending_comments Number of pending comments. */ protected function comments_bubble( $post_id, $pending_comments ) { $pending_phrase = sprintf( __( '%s pending' ), number_format( $pending_comments ) ); diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index b2a15d0d2c..e1ecad35db 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -1472,7 +1472,7 @@ function the_post_password() { * * @since 2.7.0 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return string The post title if set. */ function _draft_or_post_title( $post = 0 ) { diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php index bb7c3afadd..774fc68f9b 100644 --- a/wp-includes/comment-template.php +++ b/wp-includes/comment-template.php @@ -641,7 +641,7 @@ function get_comment_link( $comment = null, $args = array() ) { * * @since 1.5.0 * - * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @return string The link to the comments. */ function get_comments_link( $post_id = 0 ) { @@ -678,7 +678,7 @@ function comments_link( $deprecated = '', $deprecated_2 = '' ) { * * @since 1.5.0 * - * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @return int The number of comments a post has. */ function get_comments_number( $post_id = 0 ) { diff --git a/wp-includes/link-template.php b/wp-includes/link-template.php index 57856b5bce..557e753877 100644 --- a/wp-includes/link-template.php +++ b/wp-includes/link-template.php @@ -290,7 +290,7 @@ function get_post_permalink( $id = 0, $leavename = false, $sample = false ) { * * @since 1.0.0 * - * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @param mixed $deprecated Not used. * @return string */ diff --git a/wp-includes/media.php b/wp-includes/media.php index 1efa375ca3..ce573f322b 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -3022,7 +3022,7 @@ function wp_enqueue_media( $args = array() ) { * @since 3.6.0 * * @param string $type Mime type. - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return array Found attachments. */ function get_attached_media( $type, $post = 0 ) { @@ -3147,7 +3147,7 @@ function get_post_galleries( $post, $html = true ) { * * @since 3.6.0 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @param bool $html Whether to return HTML or data. * @return string|array Gallery data and srcs parsed from the expanded shortcode. */ @@ -3172,7 +3172,7 @@ function get_post_gallery( $post = 0, $html = true ) { * * @since 3.6.0 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return array A list of lists, each containing image srcs parsed. * from an expanded shortcode */ @@ -3186,7 +3186,7 @@ function get_post_galleries_images( $post = 0 ) { * * @since 3.6.0 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return array A list of a gallery's image srcs in order. */ function get_post_gallery_images( $post = 0 ) { diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index 7af1d96612..f3a65dfa82 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -105,7 +105,7 @@ function the_title_attribute( $args = '' ) { * * @since 0.71 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return string */ function get_the_title( $post = 0 ) { @@ -1565,7 +1565,7 @@ function prepend_attachment($content) { * * @since 1.0.0 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return string HTML content for password form for password protected post. */ function get_the_password_form( $post = 0 ) { @@ -1738,7 +1738,7 @@ function wp_post_revision_title_expanded( $revision, $link = true ) { * @uses get_edit_post_link() * @uses get_the_author_meta() * - * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @param string $type 'all' (default), 'revision' or 'autosave' * @return null */ diff --git a/wp-includes/post.php b/wp-includes/post.php index 1d93bcc211..84fcb7916a 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -1868,7 +1868,7 @@ function delete_post_meta_by_key($post_meta_key) { * @since 1.2.0 * @link http://codex.wordpress.org/Function_Reference/get_post_custom * - * @param int $post_id Optional. Post ID. Default is ID of the global `$post`. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. * @return array Post meta for the given post. */ function get_post_custom( $post_id = 0 ) { @@ -1887,7 +1887,7 @@ function get_post_custom( $post_id = 0 ) { * @since 1.2.0 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys * - * @param int $post_id Optional. Post ID. Default is ID of the global `$post`. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. * @return array|null Either array of the keys, or null if keys could not be retrieved. */ function get_post_custom_keys( $post_id = 0 ) { @@ -1910,7 +1910,7 @@ function get_post_custom_keys( $post_id = 0 ) { * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values * * @param string $key Meta field key. - * @param int $post_id Optional. Post ID. Default is ID of the global `$post`. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. * @return array Meta field values. */ function get_post_custom_values( $key = '', $post_id = 0 ) { @@ -1930,7 +1930,7 @@ function get_post_custom_values( $key = '', $post_id = 0 ) { * * @since 2.7.0 * - * @param int $post_id Optional. Post ID. Default is ID of the global `$post`. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. * @return bool Whether post is sticky. */ function is_sticky( $post_id = 0 ) { @@ -2624,7 +2624,7 @@ function wp_trash_post($post_id = 0) { * * @since 2.9.0 * - * @param int $post_id Optional. Post ID. Default is ID of the global `$post`. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. * @return mixed False on failure */ function wp_untrash_post( $post_id = 0 ) { @@ -2788,7 +2788,7 @@ function wp_untrash_post_comments($post = null) { * * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here. * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. * @param array $args Optional. Overwrite the defaults. * @return array */ @@ -2813,7 +2813,7 @@ function wp_get_post_categories( $post_id = 0, $args = array() ) { * * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. * @param array $args Optional. Overwrite the defaults * @return array List of post tags. */ @@ -2832,7 +2832,7 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) { * * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. * @param string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag. * @param array $args Optional. {@link wp_get_object_terms()} arguments. * @return array List of post tags. @@ -3646,7 +3646,7 @@ function _truncate_post_slug( $slug, $length = 200 ) { * * @since 2.3.0 * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. * @param string $tags The tags to set for the post, separated by commas. * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise */ @@ -3660,7 +3660,7 @@ function wp_add_post_tags( $post_id = 0, $tags = '' ) { * @since 2.3.0 * @uses wp_set_object_terms() Sets the tags for the post. * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. * @param string $tags The tags to set for the post, separated by commas. * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. * @return mixed Array of affected term IDs. WP_Error or false on failure. @@ -3675,7 +3675,7 @@ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { * @since 2.8.0 * @uses wp_set_object_terms() Sets the tags for the post. * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. * @param string $tags The tags to set for the post, separated by commas. * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'. * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. @@ -3714,7 +3714,7 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a * * @since 2.1.0 * - * @param int $post_ID Optional. The Post ID. Does not default to the ID of the global `$post`. + * @param int $post_ID Optional. The Post ID. Does not default to the ID of the global $post. * @param array|int $post_categories Optional. List of categories or ID of category. * @param bool $append If true, don't delete existing categories, just add on. If false, replace the categories with the new categories. * @return bool|mixed diff --git a/wp-includes/revision.php b/wp-includes/revision.php index 6aa7f6aaaa..45e436f567 100644 --- a/wp-includes/revision.php +++ b/wp-includes/revision.php @@ -409,7 +409,7 @@ function wp_delete_post_revision( $revision_id ) { * * @uses get_children() * - * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @return array An array of revisions, or an empty array if none. */ function wp_get_post_revisions( $post_id = 0, $args = null ) { diff --git a/wp-includes/taxonomy.php b/wp-includes/taxonomy.php index 20e1b494b6..31810c1a98 100644 --- a/wp-includes/taxonomy.php +++ b/wp-includes/taxonomy.php @@ -3778,7 +3778,7 @@ function the_taxonomies( $args = array() ) { * * @since 2.5.0 * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @param array $args Override the defaults. * @return array List of taxonomies. */ @@ -3831,7 +3831,7 @@ function get_the_taxonomies( $post = 0, $args = array() ) { * * @uses get_object_taxonomies() * - * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return array */ function get_post_taxonomies( $post = 0 ) {