Changeset 45632

Timestamp:

07/14/2019 02:34:02 PM (5 years ago)

Author:

SergeyBiryukov

Message:

REST API: Allow rest_get_avatar_urls() to accept full user, post, or comment objects, rather than just an email address, to provide better flexibility for alternative avatar data.

Since the function uses get_avatar_url() internally, which already supports it, this should not have any backward compatibility concerns.

Props donmhico, dshanske, pputzer, joehoyle, TimothyBlynJacobs.
Fixes #40030.

Location:

trunk/src/wp-includes

Files:

• rest-api.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-users-controller.php (modified) (1 diff)

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

@@ -1086 +1086 @@
 
 /**
- * Retrieves the avatar urls in various sizes based on a given email address.
+ * Retrieves the avatar urls in various sizes.
  *
  * @since 4.7.0
@@ -1092 +1092 @@
  * @see get_avatar_url()
  *
- * @param string $email Email address.
+ * @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 $urls Gravatar url for each size.
  */
-function rest_get_avatar_urls( $email ) {
+function rest_get_avatar_urls( $id_or_email ) {
     $avatar_sizes = rest_get_avatar_sizes();
 
     $urls = array();
     foreach ( $avatar_sizes as $size ) {
-        $urls[ $size ] = get_avatar_url( $email, array( 'size' => $size ) );
+        $urls[ $size ] = get_avatar_url( $id_or_email, array( 'size' => $size ) );
     }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -950 +950 @@
 
         if ( in_array( 'author_avatar_urls', $fields, true ) ) {
-            $data['author_avatar_urls'] = rest_get_avatar_urls( $comment->comment_author_email );
+            $data['author_avatar_urls'] = rest_get_avatar_urls( $comment );
         }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -939 +939 @@
 
         if ( in_array( 'avatar_urls', $fields, true ) ) {
-            $data['avatar_urls'] = rest_get_avatar_urls( $user->user_email );
+            $data['avatar_urls'] = rest_get_avatar_urls( $user );
         }