Changeset 25429

Timestamp:

09/13/2013 07:24:26 PM (11 years ago)

Author:

SergeyBiryukov

Message:

Inline documentation for hooks in wp-includes/author-template.php.

props Frank Klein.
see #25229.

File:

• trunk/src/wp-includes/author-template.php (modified) (7 diffs)

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

@@ -27 +27 @@
         _deprecated_argument( __FUNCTION__, '2.1' );
 
+    /**
+     * Filter the display name of the current post's author.
+     *
+     * @since 2.9.0
+     *
+     * @param string $authordata->display_name The author's display name.
+     */
     return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null);
 }
@@ -72 +79 @@
     if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) {
         $last_user = get_userdata($last_id);
+
+        /**
+         * Filter the display name of the author who last edited the current post.
+         *
+         * @since 2.8.0
+         *
+         * @param string $last_user->display_name The author's display name.
+         */
         return apply_filters('the_modified_author', $last_user->display_name);
     }
@@ -109 +124 @@
     $value = isset( $authordata->$field ) ? $authordata->$field : '';
 
+    /**
+     * Filter the value of the requested user metadata.
+     *
+     * The filter name is dynamic and depends on the $field parameter of the function.
+     *
+     * @since 2.8.0
+     *
+     * @param string $value   The value of the metadata.
+     * @param int    $user_id The user ID.
+     */
     return apply_filters( 'get_the_author_' . $field, $value, $user_id );
 }
@@ -120 +145 @@
  * @echo string The author's field from the current author's DB object.
  */
-function the_author_meta($field = '', $user_id = false) {
-    echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id);
+function the_author_meta( $field = '', $user_id = false ) {
+    $author_meta = get_the_author_meta( $field, $user_id );
+
+    /**
+     * The value of the requested user metadata.
+     *
+     * The filter name is dynamic and depends on the $field parameter of the function.
+     *
+     * @since 2.8.0
+     *
+     * @param string $author_meta The value of the metadata.
+     * @param int    $user_id     The user ID.
+     */
+    echo apply_filters( 'the_author_' . $field, $author_meta, $user_id );
 }
 
@@ -205 +242 @@
         get_the_author()
     );
+
+    /**
+     * Filter the link to the author page of the author of the current post.
+     *
+     * @since 2.9.0
+     *
+     * @param string $link HTML link.
+     */
     echo apply_filters( 'the_author_posts_link', $link );
 }
@@ -233 +278 @@
     }
 
-    $link = apply_filters('author_link', $link, $author_id, $author_nicename);
+    /**
+     * Filter the URL to the author's page.
+     *
+     * @since 2.1.0
+     *
+     * @param string $link            The URL to the author's page.
+     * @param int    $author_id       The author's id.
+     * @param string $author_nicename The author's nice name.
+     */
+    $link = apply_filters( 'author_link', $link, $author_id, $author_nicename );
 
     return $link;
@@ -379 +433 @@
     }
 
+    /**
+     * Filter whether the site has more than one author with published posts.
+     *
+     * @since 3.2.0
+     *
+     * @param bool $is_multi_author Whether $is_multi_author should evaluate as true.
+     */
     return apply_filters( 'is_multi_author', (bool) $is_multi_author );
 }