WordPress.org

Make WordPress Core

Changeset 36025


Ignore:
Timestamp:
12/19/2015 08:53:55 AM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Add missing parameter notations and descriptions in the DocBlock for get_link().

See #32246.

File:
1 edited

Legend:

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

    r36024 r36025  
    19731973
    19741974/**
    1975  * Retrieve bookmark data based on ID.
     1975 * Retrieves bookmark data based on ID.
    19761976 *
    19771977 * @since 2.0.0
     
    19791979 * @see get_bookmark()
    19801980 *
    1981  * @param int $bookmark_id ID of link
    1982  * @param string $output OBJECT, ARRAY_N, or ARRAY_A
    1983  * @return object|array
    1984  */
    1985 function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
     1981 * @param int    $bookmark_id ID of link
     1982 * @param string $output      Optional. Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A.
     1983 *                            Default OBJECT.
     1984 * @param string $filter      Optional. How to filter the link for output. Accepts 'raw', 'edit',
     1985 *                            'attribute', 'js', 'db', or 'display'. Default 'raw'.
     1986 * @return object|array Bookmark object or array, depending on the type specified by `$output`.
     1987 */
     1988function get_link( $bookmark_id, $output = OBJECT, $filter = 'raw' ) {
    19861989    _deprecated_function( __FUNCTION__, '2.1', 'get_bookmark()' );
    19871990    return get_bookmark($bookmark_id, $output, $filter);
Note: See TracChangeset for help on using the changeset viewer.