WordPress.org

Make WordPress Core

Changeset 32045


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

Various inline documentation syntactical fixes in wp-includes/pluggable.php for 4.2 changes.

See #31888.

File:
1 edited

Legend:

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

    r31770 r32045  
    21242124 *
    21252125 * @since 2.5.0
    2126  * @since 4.2.0 Optional $args parameter added.
     2126 * @since 4.2.0 Optional `$args` parameter added.
    21272127 *
    21282128 * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
     
    21442144 *     @type string       $rating        What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
    21452145 *                                       judged in that order. Default is the value of the 'avatar_rating' option.
    2146  *     @type string       $scheme        URL scheme to use. See {@see set_url_scheme()} for accepted values.
     2146 *     @type string       $scheme        URL scheme to use. See set_url_scheme() for accepted values.
    21472147 *                                       Default null.
    21482148 *     @type array|string $class         Array or string of additional classes to add to the <img> element.
     
    21522152 *     @type string       $extra_attr    HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
    21532153 * }
    2154  *
    21552154 * @return false|string `<img>` tag for the user's avatar. False on failure.
    21562155 */
     
    21912190     * Filter whether to retrieve the avatar URL early.
    21922191     *
    2193      * Passing a non-null value will effectively short-circuit {@see get_avatar()},
    2194      * passing the value through the 'pre_get_avatar' filter and returning early.
     2192     * Passing a non-null value will effectively short-circuit get_avatar(), passing
     2193     * the value through the {@see 'pre_get_avatar'} filter and returning early.
    21952194     *
    21962195     * @since 4.2.0
    21972196     *
    2198      * @param string            $avatar        HTML for the user's avatar. Default null.
    2199      * @param int|object|string $id_or_email   A user ID, email address, or comment object.
    2200      * @param array             $args          Arguments passed to get_avatar_url(), after processing.
     2197     * @param string            $avatar      HTML for the user's avatar. Default null.
     2198     * @param int|object|string $id_or_email A user ID, email address, or comment object.
     2199     * @param array             $args        Arguments passed to get_avatar_url(), after processing.
    22012200     */
    22022201    $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
     2202
    22032203    if ( ! is_null( $avatar ) ) {
    22042204        /** This filter is documented in wp-includes/pluggable.php */
     
    22492249     *
    22502250     * @since 2.5.0
    2251      * @since 4.2.0 $args parameter added
    2252      *
    2253      * @param string            $avatar         &lt;img&gt; tag for the user's avatar.
    2254      * @param int|object|string $id_or_email    A user ID, email address, or comment object.
    2255      * @param int               $size           Square avatar width and height in pixels to retrieve.
    2256      * @param string            $alt            Alternative text to use in the avatar image tag.
    2257      *                                          Default empty.
    2258      * @param array             $args           Arguments passed to get_avatar_data(), after processing.
     2251     * @since 4.2.0 The `$args` parameter was added.
     2252     *
     2253     * @param string            $avatar      &lt;img&gt; tag for the user's avatar.
     2254     * @param int|object|string $id_or_email A user ID, email address, or comment object.
     2255     * @param int               $size        Square avatar width and height in pixels to retrieve.
     2256     * @param string            $alt         Alternative text to use in the avatar image tag.
     2257     *                                       Default empty.
     2258     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
    22592259     */
    22602260    return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
Note: See TracChangeset for help on using the changeset viewer.