Make WordPress Core


Ignore:
Timestamp:
10/03/2023 04:13:43 PM (9 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for get_avatar() and related functions.

Includes:

  • Expanding and synchronizing documentation for the default and rating arguments.
  • Adding @since entries for the loading, fetchpriority, and decoding arguments.
  • Wrapping long lines as per the documentation standards.
  • Fixing a typo in the identicon value.
  • Minor formatting edits for consistency.

Follow-up to [31107], [45632], [47554], [53480], [56037].

See #58833.

File:
1 edited

Legend:

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

    r56192 r56767  
    12161216
    12171217/**
    1218  * Retrieves the avatar urls in various sizes.
     1218 * Retrieves the avatar URLs in various sizes.
    12191219 *
    12201220 * @since 4.7.0
     
    12221222 * @see get_avatar_url()
    12231223 *
    1224  * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
     1224 * @param mixed $id_or_email The avatar to retrieve a URL for. Accepts a user ID, Gravatar MD5 hash,
    12251225 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
    12261226 * @return (string|false)[] Avatar URLs keyed by size. Each value can be a URL string or boolean false.
Note: See TracChangeset for help on using the changeset viewer.