Changeset 36023

Timestamp:

12/19/2015 08:23:00 AM (9 years ago)

Author:

DrewAPicture

Message:

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

See #32246.

File:

• trunk/src/wp-includes/deprecated.php (modified) (1 diff)

trunk/src/wp-includes/deprecated.php

@@ -1065 +1065 @@
 
 /**
+ * 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
- */
-function get_linkrating($link) {
+ * @param object $link Link object.
+ * @return mixed Value of the 'link_rating' field, false otherwise.
+ */
+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');