WordPress.org

Make WordPress Core


Ignore:
Timestamp:
03/16/2020 06:38:03 PM (19 months ago)
Author:
johnbillion
Message:

Docs: Various docblock corrections and improvements.

See #49572

File:
1 edited

Legend:

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

    r47398 r47461  
    26442644
    26452645        /**
    2646          * Filters whether to retrieve the avatar URL early.
     2646         * Allows the HTML for a user's avatar to be returned early.
    26472647         *
    26482648         * Passing a non-null value will effectively short-circuit get_avatar(), passing
     
    26522652         *
    26532653         * @param string|null $avatar      HTML for the user's avatar. Default null.
    2654          * @param mixed       $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
     2654         * @param mixed       $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
    26552655         *                                 user email, WP_User object, WP_Post object, or WP_Comment object.
    26562656         * @param array       $args        Arguments passed to get_avatar_url(), after processing.
     
    27032703
    27042704        /**
    2705          * Filters the avatar to retrieve.
     2705         * Filters the HTML for a user's avatar.
    27062706         *
    27072707         * @since 2.5.0
    27082708         * @since 4.2.0 The `$args` parameter was added.
    27092709         *
    2710          * @param string $avatar      <img> tag for the user's avatar.
    2711          * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
     2710         * @param string $avatar      HTML for the user's avatar.
     2711         * @param mixed  $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
    27122712         *                            user email, WP_User object, WP_Post object, or WP_Comment object.
    27132713         * @param int    $size        Square avatar width and height in pixels to retrieve.
    27142714         * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
    2715          *                            'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'.
     2715         *                            'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
    27162716         *                            Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
    27172717         * @param string $alt         Alternative text to use in the avatar image tag. Default empty.
Note: See TracChangeset for help on using the changeset viewer.