From 62e657a2f037e492d7ff47986f54cdd22fc7e4bc Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sat, 19 Dec 2015 08:23:00 +0000 Subject: [PATCH] Docs: Add a missing summary, parameter, and return descriptiosn to the DocBlock for the deprecated function, `get_linkrating()`. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@36023 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/deprecated.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/deprecated.php b/src/wp-includes/deprecated.php index 4013825574..2b8e98fb9c 100644 --- a/src/wp-includes/deprecated.php +++ b/src/wp-includes/deprecated.php @@ -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'); }