Changeset 33891 for trunk/src/wp-includes/link-template.php

Timestamp:

09/03/2015 06:16:35 PM (10 years ago)

Author:

wonderboymusic

Message:

Introduce WP_Comment class to model/strongly-type rows from the comments database table. Inclusion of this class is a pre-req for some more general comment cleanup and sanity.

• Takes inspiration from WP_Post and adds sanity to comment caching.
• Clarifies when the current global value for $comment is returned. The current implementation in get_comment() introduces side effects and an occasion stale global value for $comment when comment caches are cleaned.
• Strongly-types @param docs
• This class is marked final for now

Props wonderboymusic, nacin.

See #32619.

File:

• trunk/src/wp-includes/link-template.php (modified) (6 diffs)

trunk/src/wp-includes/link-template.php

@@ -3455 +3455 @@
  *
  * @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 comment object.
+ *                           user email, WP_User object, WP_Post object, or WP_Comment object.
  * @param array $args {
  *     Optional. Arguments to return instead of the default arguments.
@@ -3486 +3486 @@
  * @since 4.2.0
  *
- * @param mixed $id_or_email The Gravatar to check the data against. Accepts a user_id, gravatar md5 hash,
- *                           user email, WP_User object, WP_Post object, or comment object.
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ *                            user email, WP_User object, WP_Post object, or WP_Comment object.
  * @param array $args {
  *     Optional. Arguments to return instead of the default arguments.
@@ -3587 +3587 @@
      * @since 4.2.0
      *
-     * @param array             $args          Arguments passed to get_avatar_data(), after processing.
-     * @param int|object|string $id_or_email   A user ID, email address, or comment object.
+     * @param array  $args        Arguments passed to get_avatar_data(), after processing.
+     * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+     *                            user email, WP_User object, WP_Post object, or WP_Comment object.
      */
     $args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
@@ -3617 +3618 @@
         // Post Object
         $user = get_user_by( 'id', (int) $id_or_email->post_author );
-    } elseif ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
-        // Comment Object
-
+    } elseif ( $id_or_email instanceof WP_Comment ) {
         /**
          * Filter the list of allowed comment types for retrieving avatars.
@@ -3682 +3681 @@
      * @since 4.2.0
      *
-     * @param string            $url         The URL of the avatar.
-     * @param int|object|string $id_or_email A user ID, email address, or comment object.
-     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
+     * @param string $url         The URL of the avatar.
+     * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+     *                            user email, WP_User object, WP_Post object, or WP_Comment object.
+     * @param array  $args        Arguments passed to get_avatar_data(), after processing.
      */
     $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
@@ -3693 +3693 @@
      * @since 4.2.0
      *
-     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
-     * @param int|object|string $id_or_email A user ID, email address, or comment object.
+     * @param array  $args        Arguments passed to get_avatar_data(), after processing.
+     * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+     *                            user email, WP_User object, WP_Post object, or WP_Comment object.
      */
     return apply_filters( 'get_avatar_data', $args, $id_or_email );