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

Timestamp:

09/21/2019 05:40:58 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Docblock corrections and improvements, mostly related to various pre_* filters.

See #47110

File:

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

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

@@ -3998 +3998 @@
  * @since 4.2.0
  *
- * @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 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.
@@ -4021 +4021 @@
  *     @type string $extra_attr     HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
  * }
- * @return array $processed_args {
+ * @return array {
  *     Along with the arguments passed in `$args`, this will contain a couple of extra arguments.
  *
@@ -4102 +4102 @@
      * @since 4.2.0
      *
-     * @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.
+     * @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 );
@@ -4194 +4194 @@
      *
      * @param string $url         The URL of the avatar.
-     * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+     * @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.
@@ -4205 +4205 @@
      * @since 4.2.0
      *
-     * @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.
+     * @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 );