Docs: Add a missing summary, parameter, and return descriptiosn to the DocBlock for the deprecated function, `get_linkrating()`.

See #32246.

Built from https://develop.svn.wordpress.org/trunk@36023


git-svn-id: http://core.svn.wordpress.org/trunk@35988 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-12-19 08:23:26 +00:00
parent df0c1aa0ed
commit 7b1ac33dee
2 changed files with 6 additions and 4 deletions

View File

@ -1064,14 +1064,16 @@ function links_popup_script($text = 'Links', $width=400, $height=400, $file='lin
}
/**
* Legacy function that retrieved the value of a link's link_rating field.
*
* @since 1.0.1
* @deprecated 2.1.0 Use sanitize_bookmark_field()
* @see sanitize_bookmark_field()
*
* @param object $link
* @return mixed
* @param object $link Link object.
* @return mixed Value of the 'link_rating' field, false otherwise.
*/
function get_linkrating($link) {
function get_linkrating( $link ) {
_deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' );
return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display');
}

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.5-alpha-36022';
$wp_version = '4.5-alpha-36023';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.