Changeset 48590 for trunk/src/wp-includes/pluggable.php

Timestamp:

07/23/2020 09:09:04 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Another pass at some inline docs fixes mostly made by PHPCBF.

See #49572, #50744

File:

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

trunk/src/wp-includes/pluggable.php

@@ -1490 +1490 @@
      * @since 1.0.0
      *
-     * @param int|WP_Comment  $comment_id Comment ID or WP_Comment object.
-     * @param string          $deprecated Not used
+     * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
+     * @param string         $deprecated Not used
      * @return bool True on completion. False if no email addresses were specified.
      */
@@ -2583 +2583 @@
      * @since 4.2.0 Optional `$args` parameter added.
      *
-     * @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       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'
-     *                           (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
-     *                           (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
-     *                           'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
-     *                           or 'gravatar_default' (the Gravatar logo). Default is the value of the
-     *                           'avatar_default' option, with a fallback of 'mystery'.
-     * @param string $alt        Optional. Alternative text to use in <img> tag. Default empty.
-     * @param array  $args       {
+     * @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        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'
+     *                            (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
+     *                            (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
+     *                            'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
+     *                            or 'gravatar_default' (the Gravatar logo). Default is the value of the
+     *                            'avatar_default' option, with a fallback of 'mystery'.
+     * @param string $alt         Optional. Alternative text to use in img tag. Default empty.
+     * @param array  $args {
      *     Optional. Extra arguments to retrieve the avatar.
      *
@@ -2603 +2603 @@
      *     @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.
+     *     @type array|string $class         Array or string of additional classes to add to the img element.
      *                                       Default null.
      *     @type bool         $force_display Whether to always show the avatar - ignores the show_avatars option.