Changeset 46660 for trunk/src/wp-includes/rest-api.php

Timestamp:

11/05/2019 09:21:46 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-includes/rest-api.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api.php

@@ -1166 +1166 @@
  * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
  *                           user email, WP_User object, WP_Post object, or WP_Comment object.
- * @return array Gravatar url for each size.
+ * @return array Avatar URLs keyed by size. Each value can be a URL string or boolean false.
  */
 function rest_get_avatar_urls( $id_or_email ) {
@@ -1184 +1184 @@
  * @since 4.7.0
  *
- * @return array List of pixel sizes for avatars. Default `[ 24, 48, 96 ]`.
+ * @return int[] List of pixel sizes for avatars. Default `[ 24, 48, 96 ]`.
  */
 function rest_get_avatar_sizes() {
@@ -1195 +1195 @@
      * @since 4.4.0
      *
-     * @param array $sizes An array of int values that are the pixel sizes for avatars.
+     * @param int[] $sizes An array of int values that are the pixel sizes for avatars.
      *                     Default `[ 24, 48, 96 ]`.
      */