X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/author-template.php diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php index 557a1ab8..36d08bc8 100644 --- a/wp-includes/author-template.php +++ b/wp-includes/author-template.php @@ -4,7 +4,7 @@ * * These functions must be used within the WordPress Loop. * - * @link http://codex.wordpress.org/Author_Templates + * @link https://codex.wordpress.org/Author_Templates * * @package WordPress * @subpackage Template @@ -13,12 +13,12 @@ /** * Retrieve the author of the current post. * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @uses apply_filters() Calls 'the_author' hook on the author display name. + * @since 1.5.0 + * + * @global object $authordata The current author's DB object. * * @param string $deprecated Deprecated. - * @return string The author's display name. + * @return string|null The author's display name. */ function get_the_author($deprecated = '') { global $authordata; @@ -49,11 +49,11 @@ function get_the_author($deprecated = '') { * * @since 0.71 * @see get_the_author() - * @link http://codex.wordpress.org/Template_Tags/the_author + * @link https://codex.wordpress.org/Template_Tags/the_author * * @param string $deprecated Deprecated. * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it. - * @return string The author's display name, from get_the_author(). + * @return string|null The author's display name, from get_the_author(). */ function the_author( $deprecated = '', $deprecated_echo = true ) { if ( !empty( $deprecated ) ) @@ -68,12 +68,9 @@ 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. - * @return string The author's display name. + * @since 2.8.0 + * + * @return string|void The author's display name. */ function get_the_modified_author() { if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) { @@ -91,11 +88,12 @@ function get_the_modified_author() { } /** - * Display the name of the author who last edited the current post. + * Display the name of the author who last edited the current post, + * if the author's ID is available. + * + * @since 2.8.0 * - * @since 2.8 * @see get_the_author() - * @return string The author's display name, from get_the_modified_author(). */ function the_modified_author() { echo get_the_modified_author(); @@ -103,14 +101,18 @@ 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 + * @link https://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). + * + * @global object $authordata The current author's DB object. + * * @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. */ function get_the_author_meta( $field = '', $user_id = false ) { + $original_user_id = $user_id; + if ( ! $user_id ) { global $authordata; $user_id = isset( $authordata->ID ) ? $authordata->ID : 0; @@ -129,20 +131,24 @@ function get_the_author_meta( $field = '', $user_id = false ) { * The filter name is dynamic and depends on the $field parameter of the function. * * @since 2.8.0 + * @since 4.3.0 The `$original_user_id` parameter was added. * - * @param string $value The value of the metadata. - * @param int $user_id The user ID. + * @param string $value The value of the metadata. + * @param int $user_id The user ID for the value. + * @param int|bool $original_user_id The original user ID, as passed to the function. */ - return apply_filters( 'get_the_author_' . $field, $value, $user_id ); + return apply_filters( 'get_the_author_' . $field, $value, $user_id, $original_user_id ); } /** - * Retrieve the requested data of the author of the current post. - * @link http://codex.wordpress.org/Template_Tags/the_author_meta + * Outputs the field from the user's DB object. Defaults to current post's author. + * + * @link https://codex.wordpress.org/Template_Tags/the_author_meta + * * @since 2.8.0 + * * @param string $field selects the field of the users record. * @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 ) { $author_meta = get_the_author_meta( $field, $user_id ); @@ -166,8 +172,8 @@ 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() + * @return string|null An HTML link if the author's url exist in user meta, + * else the result of get_the_author(). */ function get_the_author_link() { if ( get_the_author_meta('url') ) { @@ -183,9 +189,9 @@ function get_the_author_link() { * If the author has a home page set, echo an HTML link, otherwise just echo the * author's name. * - * @link http://codex.wordpress.org/Template_Tags/the_author_link - * @since 2.1 - * @uses get_the_author_link() + * @link https://codex.wordpress.org/Template_Tags/the_author_link + * + * @since 2.1.0 */ function the_author_link() { echo get_the_author_link(); @@ -194,21 +200,23 @@ 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, $post->post_type ); } /** * Display the number of posts by the author of the current post. * - * @link http://codex.wordpress.org/Template_Tags/the_author_posts + * @link https://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(); @@ -221,11 +229,11 @@ function the_author_posts() { * reason for this, is that another function is used to help in printing the * link to the author's posts. * - * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link + * @link https://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() + * + * @global object $authordata The current author's DB object. + * * @param string $deprecated Deprecated. */ function the_author_posts_link($deprecated = '') { @@ -233,8 +241,10 @@ function the_author_posts_link($deprecated = '') { _deprecated_argument( __FUNCTION__, '2.1' ); global $authordata; - if ( !is_object( $authordata ) ) - return false; + if ( ! is_object( $authordata ) ) { + return; + } + $link = sprintf( '%3$s', esc_url( get_author_posts_url( $authordata->ID, $authordata->user_nicename ) ), @@ -256,7 +266,9 @@ function the_author_posts_link($deprecated = '') { * Retrieve the URL to the author page for the user with the ID provided. * * @since 2.1.0 - * @uses $wp_rewrite WP_Rewrite + * + * @global WP_Rewrite $wp_rewrite + * * @return string The URL to the author's page. */ function get_author_posts_url($author_id, $author_nicename = '') { @@ -294,30 +306,39 @@ function get_author_posts_url($author_id, $author_nicename = '') { /** * List all the authors of the blog, with several options available. * - *