Ticket #25229: author-template.3.patch

wp-includes/author-template.php

@@ -26 +26 @@
         if ( !empty( $deprecated ) )
                 _deprecated_argument( __FUNCTION__, '2.1' );
 
+        /**
+         * 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);
 }
 
@@ -71 +78 @@
 function get_the_modified_author() {
         if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) {
                 $last_user = get_userdata($last_id);
+
+                /**
+                 * The display name of 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);
         }
 }
@@ -108 +123 @@
 
         $value = isset( $authordata->$field ) ? $authordata->$field : '';
 
+        /**
+         * 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 The value of the metadata.
+         * @param int    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) {
+        /**
+         * 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 The value of the metadata.
+         * @param int    The user ID.
+         */
         echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id);
 }
 
@@ -204 +239 @@
                 esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ),
                 get_the_author()
         );
+
+        /**
+         * The link to the author page of the author of the current post.
+         *
+         * @since 2.9.0
+         *
+         * @param string HTML link.
+         */
         echo apply_filters( 'the_author_posts_link', $link );
 }
 
@@ -232 +275 @@
                 $link = home_url( user_trailingslashit( $link ) );
         }
 
+        /**
+         * 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 ID of an author.
+         * @param string $author_nicename Optional. The author's nice name.
+         */
         $link = apply_filters('author_link', $link, $author_id, $author_nicename);
 
         return $link;
@@ -378 +430 @@
                 set_transient( 'is_multi_author', $is_multi_author );
         }
 
+        /**
+         * 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 );
 }