X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/11be15bd505d66a91e2c80062190b13e315a04a9..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-includes/author-template.php diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php index 2a894989..2280487d 100644 --- a/wp-includes/author-template.php +++ b/wp-includes/author-template.php @@ -13,9 +13,9 @@ /** * Retrieve the author of the current post. * - * @since 1.5 + * @since 1.5.0 + * * @uses $authordata The current author's DB object. - * @uses apply_filters() Calls 'the_author' hook on the author display name. * * @param string $deprecated Deprecated. * @return string The author's display name. @@ -26,6 +26,13 @@ function get_the_author($deprecated = '') { if ( !empty( $deprecated ) ) _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); } @@ -61,16 +68,21 @@ function the_author( $deprecated = '', $deprecated_echo = true ) { /** * Retrieve the author who last edited the current post. * - * @since 2.8 - * @uses $post The current post's DB object. - * @uses get_post_meta() Retrieves the ID of the author who last edited the current post. - * @uses get_userdata() Retrieves the author's DB object. - * @uses apply_filters() Calls 'the_modified_author' hook on the author display name. + * @since 2.8.0 + * * @return string The author's display name. */ function get_the_modified_author() { 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); } } @@ -78,7 +90,8 @@ function get_the_modified_author() { /** * Display the name of the author who last edited the current post. * - * @since 2.8 + * @since 2.8.0 + * * @see get_the_author() * @return string The author's display name, from get_the_modified_author(). */ @@ -90,7 +103,6 @@ function the_modified_author() { * Retrieve the requested data of the author of the current post. * @link http://codex.wordpress.org/Template_Tags/the_author_meta * @since 2.8.0 - * @uses $authordata The current author's DB object (if $user_id not specified). * @param string $field selects the field of the users record. * @param int $user_id Optional. User ID. * @return string The author's field from the current author's DB object. @@ -108,6 +120,16 @@ function get_the_author_meta( $field = '', $user_id = false ) { $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 ); } @@ -119,8 +141,20 @@ function get_the_author_meta( $field = '', $user_id = false ) { * @param int $user_id Optional. User ID. * @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 ); } /** @@ -128,9 +162,6 @@ function the_author_meta($field = '', $user_id = false) { * * If the author has a home page set, return an HTML link, otherwise just return the * author's name. - * - * @uses get_the_author_meta() - * @uses get_the_author() */ function get_the_author_link() { if ( get_the_author_meta('url') ) { @@ -147,8 +178,8 @@ function get_the_author_link() { * author's name. * * @link http://codex.wordpress.org/Template_Tags/the_author_link - * @since 2.1 - * @uses get_the_author_link() + * + * @since 2.1.0 */ function the_author_link() { echo get_the_author_link(); @@ -157,13 +188,16 @@ function the_author_link() { /** * Retrieve the number of posts by the author of the current post. * - * @since 1.5 - * @uses $post The current post in the Loop's DB object. - * @uses count_user_posts() + * @since 1.5.0 + * * @return int The number of posts by the author. */ function get_the_author_posts() { - return count_user_posts( get_post()->post_author ); + $post = get_post(); + if ( ! $post ) { + return 0; + } + return count_user_posts( $post->post_author ); } /** @@ -171,7 +205,6 @@ function get_the_author_posts() { * * @link http://codex.wordpress.org/Template_Tags/the_author_posts * @since 0.71 - * @uses get_the_author_posts() Echoes returned value from function. */ function the_author_posts() { echo get_the_author_posts(); @@ -186,9 +219,6 @@ function the_author_posts() { * * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link * @since 1.2.0 - * @uses $authordata The current author's DB object. - * @uses get_author_posts_url() - * @uses get_the_author() * @param string $deprecated Deprecated. */ function the_author_posts_link($deprecated = '') { @@ -204,6 +234,14 @@ function the_author_posts_link($deprecated = '') { esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ), 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 ); } @@ -232,7 +270,16 @@ function get_author_posts_url($author_id, $author_nicename = '') { $link = home_url( user_trailingslashit( $link ) ); } - $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; } @@ -240,30 +287,37 @@ function get_author_posts_url($author_id, $author_nicename = '') { /** * List all the authors of the blog, with several options available. * - *