Changeset 33891 for trunk/src/wp-includes/pluggable.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/pluggable.php (modified) (3 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2191 +2191 @@
  *
  * @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 comment object.
+ *                           user email, WP_User object, WP_Post object, or WP_Comment object.
  * @param int    $size       Optional. Height and width of the avatar image file in pixels. Default 96.
  * @param string $default    Optional. URL for the default image or a default type. Accepts '404'
@@ -2259 +2259 @@
      * @since 4.2.0
      *
-     * @param string            $avatar      HTML for the user's avatar. Default null.
-     * @param int|object|string $id_or_email A user ID, email address, or comment object.
-     * @param array             $args        Arguments passed to get_avatar_url(), after processing.
+     * @param string $avatar      HTML for the user's avatar. Default null.
+     * @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_url(), after processing.
      */
     $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
@@ -2315 +2316 @@
      * @since 4.2.0 The `$args` parameter was added.
      *
-     * @param string            $avatar      <img> tag for the user's avatar.
-     * @param int|object|string $id_or_email A user ID, email address, or comment object.
-     * @param int               $size        Square avatar width and height in pixels to retrieve.
-     * @param string            $alt         Alternative text to use in the avatar image tag.
+     * @param string $avatar      <img> tag for the user's 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 int    $size        Square avatar width and height in pixels to retrieve.
+     * @param string $alt         Alternative text to use in the avatar image tag.
      *                                       Default empty.
-     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
+     * @param array  $args        Arguments passed to get_avatar_data(), after processing.
      */
     return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );