WordPress.org

Make WordPress Core

Changeset 32042


Ignore:
Timestamp:
04/05/2015 04:03:12 PM (5 years ago)
Author:
DrewAPicture
Message:

Various inline documentation syntax fixes in wp-includes/link-template.php.

See #31888.

File:
1 edited

Legend:

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

    r31800 r32042  
    33913391 * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
    33923392 *                           user email, WP_User object, WP_Post object, or comment object.
    3393  * @param array $args        {
     3393 * @param array $args {
    33943394 *     Optional. Arguments to return instead of the default arguments.
    33953395 *
     
    34043404 *     @type string $rating         What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
    34053405 *                                  judged in that order. Default is the value of the 'avatar_rating' option.
    3406  *     @type string $scheme         URL scheme to use. See {@see set_url_scheme()} for accepted values.
     3406 *     @type string $scheme         URL scheme to use. See set_url_scheme() for accepted values.
    34073407 *                                  Default null.
    34083408 *     @type array  $processed_args When the function returns, the value will be the processed/sanitized $args
    34093409 *                                  plus a "found_avatar" guess. Pass as a reference. Default null.
    34103410 * }
    3411  *
    34123411 * @return false|string The URL of the avatar we found, or false if we couldn't find an avatar.
    34133412 */
     
    34243423 * @param mixed $id_or_email The Gravatar to check the data against. Accepts a user_id, gravatar md5 hash,
    34253424 *                           user email, WP_User object, WP_Post object, or comment object.
    3426  * @param array $args        {
     3425 * @param array $args {
    34273426 *     Optional. Arguments to return instead of the default arguments.
    34283427 *
     
    34393438 *     @type string $rating         What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
    34403439 *                                  judged in that order. Default is the value of the 'avatar_rating' option.
    3441  *     @type string $scheme         URL scheme to use. See {@see set_url_scheme()} for accepted values.
     3440 *     @type string $scheme         URL scheme to use. See set_url_scheme() for accepted values.
    34423441 *                                  Default null.
    34433442 *     @type array  $processed_args When the function returns, the value will be the processed/sanitized $args
     
    34453444 *     @type string $extra_attr     HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
    34463445 * }
    3447  *
    34483446 * @return array $processed_args {
    3449  *     Along with the arguments passed in $args, this will contain a couple of extra arguments.
     3447 *     Along with the arguments passed in `$args`, this will contain a couple of extra arguments.
    34503448 *
    34513449 *     @type bool   $found_avatar True if we were able to find an avatar for this user,
     
    35193517     *
    35203518     * Passing a non-null value in the 'url' member of the return array will
    3521      * effectively short circuit {@see get_avatar_data()}, passing the value
    3522      * through the 'get_avatar_data' filter and returning early.
     3519     * effectively short circuit get_avatar_data(), passing the value through
     3520     * the {@see 'get_avatar_data'} filter and returning early.
    35233521     *
    35243522     * @since 4.2.0
     
    36153613     * @since 4.2.0
    36163614     *
    3617      * @param string            $url           The URL of the avatar.
    3618      * @param int|object|string $id_or_email   A user ID, email address, or comment object.
    3619      * @param array             $args          Arguments passed to get_avatar_data(), after processing.
     3615     * @param string            $url         The URL of the avatar.
     3616     * @param int|object|string $id_or_email A user ID, email address, or comment object.
     3617     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
    36203618     */
    36213619    $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
     
    36263624     * @since 4.2.0
    36273625     *
    3628      * @param array             $args          Arguments passed to get_avatar_data(), after processing.
    3629      * @param int|object|string $id_or_email   A user ID, email address, or comment object.
     3626     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
     3627     * @param int|object|string $id_or_email A user ID, email address, or comment object.
    36303628     */
    36313629    return apply_filters( 'get_avatar_data', $args, $id_or_email );
Note: See TracChangeset for help on using the changeset viewer.