Changeset 32045

Timestamp:

04/05/2015 04:45:34 PM (9 years ago)

Author:

DrewAPicture

Message:

Various inline documentation syntactical fixes in wp-includes/pluggable.php for 4.2 changes.

See #31888.

File:

• trunk/src/wp-includes/pluggable.php (modified) (5 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2124 +2124 @@
  *
  * @since 2.5.0
- * @since 4.2.0 Optional $args parameter added.
+ * @since 4.2.0 Optional `$args` parameter added.
  *
  * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
@@ -2144 +2144 @@
  *     @type string       $rating        What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
  *                                       judged in that order. Default is the value of the 'avatar_rating' option.
- *     @type string       $scheme        URL scheme to use. See {@see set_url_scheme()} for accepted values.
+ *     @type string       $scheme        URL scheme to use. See set_url_scheme() for accepted values.
  *                                       Default null.
  *     @type array|string $class         Array or string of additional classes to add to the <img> element.
@@ -2152 +2152 @@
  *     @type string       $extra_attr    HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
  * }
- *
  * @return false|string `<img>` tag for the user's avatar. False on failure.
  */
@@ -2191 +2190 @@
      * Filter whether to retrieve the avatar URL early.
      *
-     * Passing a non-null value will effectively short-circuit {@see get_avatar()},
-     * passing the value through the 'pre_get_avatar' filter and returning early.
+     * Passing a non-null value will effectively short-circuit get_avatar(), passing
+     * the value through the {@see 'pre_get_avatar'} filter and returning early.
      *
      * @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 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.
      */
     $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
+
     if ( ! is_null( $avatar ) ) {
         /** This filter is documented in wp-includes/pluggable.php */
@@ -2249 +2249 @@
      *
      * @since 2.5.0
-     * @since 4.2.0 $args parameter added
-     *
-     * @param string            $avatar         &lt;img&gt; 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.
-     *                                          Default empty.
-     * @param array             $args           Arguments passed to get_avatar_data(), after processing.
+     * @since 4.2.0 The `$args` parameter was added.
+     *
+     * @param string            $avatar      &lt;img&gt; 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.
+     *                                       Default empty.
+     * @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 );