From bd3a1d74d929b6e88e653a6b8ea61aa89fd59789 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 28 Feb 2016 19:32:25 +0000 Subject: [PATCH] Docs: Improve a variety of DocBlocks in wp-includes/deprecated.php. See #32246. Built from https://develop.svn.wordpress.org/trunk@36763 git-svn-id: http://core.svn.wordpress.org/trunk@36730 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/deprecated.php | 24 ++++++++++++------------ wp-includes/version.php | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index 69a6bfb2b3..5d871be806 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -13,14 +13,14 @@ */ /** - * Entire Post data. + * Retrieves all post data for a given post. * * @since 0.71 * @deprecated 1.5.1 Use get_post() * @see get_post() * - * @param int $postid - * @return array + * @param int $postid Post ID. + * @return array Post data. */ function get_postdata($postid) { _deprecated_function( __FUNCTION__, '1.5.1', 'get_post()' ); @@ -70,14 +70,14 @@ function start_wp() { } /** - * Return or Print Category ID. + * Returns or prints a category ID. * * @since 0.71 * @deprecated 0.71 Use get_the_category() * @see get_the_category() * - * @param bool $echo - * @return null|int + * @param bool $echo Optional. Whether to echo the output. Default true. + * @return int Category ID. */ function the_category_ID($echo = true) { _deprecated_function( __FUNCTION__, '0.71', 'get_the_category()' ); @@ -93,16 +93,16 @@ function the_category_ID($echo = true) { } /** - * Print category with optional text before and after. + * Prints a category with optional text before and after. * * @since 0.71 * @deprecated 0.71 Use get_the_category_by_ID() * @see get_the_category_by_ID() * - * @param string $before - * @param string $after + * @param string $before Optional. Text to display before the category. Default empty. + * @param string $after Optional. Text to display after the category. Default empty. */ -function the_category_head($before='', $after='') { +function the_category_head( $before = '', $after = '' ) { global $currentcat, $previouscat; _deprecated_function( __FUNCTION__, '0.71', 'get_the_category_by_ID()' ); @@ -119,7 +119,7 @@ function the_category_head($before='', $after='') { } /** - * Prints link to the previous post. + * Prints a link to the previous post. * * @since 1.5.0 * @deprecated 2.0.0 Use previous_post_link() @@ -129,7 +129,7 @@ function the_category_head($before='', $after='') { * @param string $previous * @param string $title * @param string $in_same_cat - * @param int $limitprev + * @param int $limitprev * @param string $excluded_categories */ function previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') { diff --git a/wp-includes/version.php b/wp-includes/version.php index cada0a0a2f..98e6b01b42 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.5-beta1-36762'; +$wp_version = '4.5-beta1-36763'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.