WordPress.org

Make WordPress Core

Changeset 36023


Ignore:
Timestamp:
12/19/2015 08:23:00 AM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/deprecated.php

    r35885 r36023  
    10651065
    10661066/**
     1067 * Legacy function that retrieved the value of a link's link_rating field.
     1068 *
    10671069 * @since 1.0.1
    10681070 * @deprecated 2.1.0 Use sanitize_bookmark_field()
    10691071 * @see sanitize_bookmark_field()
    10701072 *
    1071  * @param object $link
    1072  * @return mixed
    1073  */
    1074 function get_linkrating($link) {
     1073 * @param object $link Link object.
     1074 * @return mixed Value of the 'link_rating' field, false otherwise.
     1075 */
     1076function get_linkrating( $link ) {
    10751077    _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' );
    10761078    return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display');
Note: See TracChangeset for help on using the changeset viewer.