X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/author-template.php diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php index 9b4ed39e..36d08bc8 100644 --- a/wp-includes/author-template.php +++ b/wp-includes/author-template.php @@ -2,382 +2,273 @@ /** * Author Template functions for use in themes. * + * These functions must be used within the WordPress Loop. + * + * @link https://codex.wordpress.org/Author_Templates + * * @package WordPress * @subpackage Template */ /** - * get_the_author() - Get the author of the current post in the Loop. + * Retrieve the author of the current post. + * + * @since 1.5.0 * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @uses apply_filters() Calls 'the_author' hook on the author display name. + * @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; - return apply_filters('the_author', $authordata->display_name); + + 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); } /** - * the_author() - Echo the name of the author of the current post in the Loop. + * Display the name of the author of the current post. * - * The behavior of this function is based off of old functionality predating get_the_author(). - * This function is not deprecated, but is designed to echo the value from get_the_author() - * and as an result of any old theme that might still use the old behavior will also - * pass the value from get_the_author(). + * The behavior of this function is based off of old functionality predating + * get_the_author(). This function is not deprecated, but is designed to echo + * the value from get_the_author() and as an result of any old theme that might + * still use the old behavior will also pass the value from get_the_author(). * - * The normal, expected behavior of this function is to echo the author and not return it. - * However, backwards compatiability has to be maintained. + * The normal, expected behavior of this function is to echo the author and not + * return it. However, backwards compatibility has to be maintained. * * @since 0.71 * @see get_the_author() + * @link https://codex.wordpress.org/Template_Tags/the_author * * @param string $deprecated Deprecated. - * @param string $deprecated_echo Echo the string or return it. Deprecated, use get_the_author(). - * @return string The author's display name, from get_the_author(). - */ -function the_author($deprecated = '', $deprecated_echo = true) { + * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it. + * @return string|null The author's display name, from get_the_author(). + */ +function the_author( $deprecated = '', $deprecated_echo = true ) { + if ( !empty( $deprecated ) ) + _deprecated_argument( __FUNCTION__, '2.1' ); + if ( $deprecated_echo !== true ) + _deprecated_argument( __FUNCTION__, '1.5', __('Use get_the_author() instead if you do not want the value echoed.') ); if ( $deprecated_echo ) echo get_the_author(); return get_the_author(); } /** - * get_the_author_description() - Get the description of the author of the current post in the Loop. - * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's description. - */ -function get_the_author_description() { - global $authordata; - return $authordata->description; -} - -/** - * the_author_description() - Echo the description of the author of the current post in the Loop. + * Retrieve the author who last edited the current post. * - * @since 1.0.0 - * @see get_the_author_description() - */ -function the_author_description() { - echo get_the_author_description(); -} - -/** - * get_the_author_login() - Get the login name of the author of the current post in the Loop. + * @since 2.8.0 * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's login name (username). + * @return string|void The author's display name. */ -function get_the_author_login() { - global $authordata; - return $authordata->user_login; -} +function get_the_modified_author() { + if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) { + $last_user = get_userdata($last_id); -/** - * the_author_login() - Echo the login name of the author of the current post in the Loop. - * - * @since 0.71 - * @see get_the_author_login() - */ -function the_author_login() { - echo get_the_author_login(); + /** + * 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); + } } /** - * get_the_author_firstname() - Get the first name of the author of the current post in the Loop. + * Display the name of the author who last edited the current post, + * if the author's ID is available. * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's first name. - */ -function get_the_author_firstname() { - global $authordata; - return $authordata->first_name; -} - -/** - * the_author_firstname() - Echo the first name of the author of the current post in the Loop. + * @since 2.8.0 * - * @since 0.71 - * @uses get_the_author_firstname() + * @see get_the_author() */ -function the_author_firstname() { - echo get_the_author_firstname(); +function the_modified_author() { + echo get_the_modified_author(); } /** - * get_the_author_lastname() - Get the last name of the author of the current post in the Loop. + * Retrieve the requested data of the author of the current post. + * @link https://codex.wordpress.org/Template_Tags/the_author_meta + * @since 2.8.0 * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's last name. - */ -function get_the_author_lastname() { - global $authordata; - return $authordata->last_name; -} - -/** - * the_author_lastname() - Echo the last name of the author of the current post in the Loop. + * @global object $authordata The current author's DB object. * - * @since 0.71 - * @uses get_the_author_lastname() + * @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 the_author_lastname() { - echo get_the_author_lastname(); -} +function get_the_author_meta( $field = '', $user_id = false ) { + $original_user_id = $user_id; -/** - * get_the_author_nickname() - Get the nickname of the author of the current post in the Loop. - * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's nickname. - */ -function get_the_author_nickname() { - global $authordata; - return $authordata->nickname; -} + if ( ! $user_id ) { + global $authordata; + $user_id = isset( $authordata->ID ) ? $authordata->ID : 0; + } else { + $authordata = get_userdata( $user_id ); + } -/** - * the_author_nickname() - Echo the nickname of the author of the current post in the Loop. - * - * @since 0.71 - * @uses get_the_author_nickname() - */ -function the_author_nickname() { - echo get_the_author_nickname(); -} + if ( in_array( $field, array( 'login', 'pass', 'nicename', 'email', 'url', 'registered', 'activation_key', 'status' ) ) ) + $field = 'user_' . $field; -/** - * get_the_author_ID() - Get the ID of the author of the current post in the Loop. - * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return int The author's ID. - */ -function get_the_author_ID() { - global $authordata; - return (int) $authordata->ID; -} + $value = isset( $authordata->$field ) ? $authordata->$field : ''; -/** - * the_author_ID() - Echo the ID of the author of the current post in the Loop. - * - * @since 0.71 - * @uses get_the_author_ID() - */ -function the_author_ID() { - echo get_the_author_id(); + /** + * 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 + * @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 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, $original_user_id ); } /** - * get_the_author_email() - Get the email of the author of the current post in the Loop. + * Outputs the field from the user's DB object. Defaults to current post's author. * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's username. - */ -function get_the_author_email() { - global $authordata; - return $authordata->user_email; -} - -/** - * the_author_email() - Echo the email of the author of the current post in the Loop. + * @link https://codex.wordpress.org/Template_Tags/the_author_meta * - * @since 0.71 - * @uses get_the_author_email() - */ -function the_author_email() { - echo apply_filters('the_author_email', get_the_author_email() ); -} - -/** - * get_the_author_url() - Get the URL to the home page of the author of the current post in the Loop. + * @since 2.8.0 * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The URL to the author's page. + * @param string $field selects the field of the users record. + * @param int $user_id Optional. User ID. */ -function get_the_author_url() { - global $authordata; +function the_author_meta( $field = '', $user_id = false ) { + $author_meta = get_the_author_meta( $field, $user_id ); - if ( 'http://' == $authordata->user_url ) - return ''; - - return $authordata->user_url; + /** + * 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 ); } /** - * the_author_url() - Echo the URL to the home page of the author of the current post in the Loop. + * Retrieve either author's link or author's name. * - * @since 0.71 - * @uses get_the_author_url() - */ -function the_author_url() { - echo get_the_author_url(); -} - -/** - * the_author_link() - If the author has a home page set, echo an HTML link, otherwise just echo the author's name. + * If the author has a home page set, return an HTML link, otherwise just return the + * author's name. * - * @since 2.1 - * @uses get_the_author_url() - * @uses 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 the_author_link() { - if (get_the_author_url()) { - echo '' . get_the_author() . ''; +function get_the_author_link() { + if ( get_the_author_meta('url') ) { + return '' . get_the_author() . ''; } else { - the_author(); + return get_the_author(); } } /** - * get_the_author_icq() - Get the ICQ number of the author of the current post in the Loop. - * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's ICQ number. - */ -function get_the_author_icq() { - global $authordata; - return $authordata->icq; -} - -/** - * the_author_icq() - Echo the ICQ number of the author of the current post in the Loop. - * - * @since 0.71 - * @see get_the_author_icq() - */ -function the_author_icq() { - echo get_the_author_icq(); -} - -/** - * get_the_author_aim() - Get the AIM name of the author of the current post in the Loop. + * Display either author's link or author's name. * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's AIM name. - */ -function get_the_author_aim() { - global $authordata; - return str_replace(' ', '+', $authordata->aim); -} - -/** - * the_author_aim() - Echo the AIM name of the author of the current post in the Loop. - * - * @since 0.71 - * @see get_the_author_aim() - */ -function the_author_aim() { - echo get_the_author_aim(); -} - -/** - * get_the_author_yim() - Get the Yahoo! IM name of the author of the current post in the Loop. + * If the author has a home page set, echo an HTML link, otherwise just echo the + * author's name. * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's Yahoo! IM name. - */ -function get_the_author_yim() { - global $authordata; - return $authordata->yim; -} - -/** - * the_author_yim() - Echo the Yahoo! IM name of the author of the current post in the Loop. + * @link https://codex.wordpress.org/Template_Tags/the_author_link * - * @since 0.71 - * @see get_the_author_yim() + * @since 2.1.0 */ -function the_author_yim() { - echo get_the_author_yim(); -} - -/** - * get_the_author_msn() - Get the MSN address of the author of the current post in the Loop. - * - * @since 1.5 - * @uses $authordata The current author's DB object. - * @return string The author's MSN address. - */ -function get_the_author_msn() { - global $authordata; - return $authordata->msn; +function the_author_link() { + echo get_the_author_link(); } /** - * the_author_msn() - Echo the MSN address of the author of the current post in the Loop. + * Retrieve the number of posts by the author of the current post. * - * @since 0.71 - * @see get_the_author_msn() - */ -function the_author_msn() { - echo get_the_author_msn(); -} - -/** - * get_the_author_posts() - Get the number of posts by the author of the current post in the Loop. + * @since 1.5.0 * - * @since 1.5 - * @uses $post The current post in the Loop's DB object. - * @uses get_usernumposts() * @return int The number of posts by the author. */ function get_the_author_posts() { - global $post; - return get_usernumposts($post->post_author); + $post = get_post(); + if ( ! $post ) { + return 0; + } + return count_user_posts( $post->post_author, $post->post_type ); } /** - * the_author_posts() - Echo the number of posts by the author of the current post in the Loop. + * Display the number of posts by the author of the current post. * + * @link https://codex.wordpress.org/Template_Tags/the_author_posts * @since 0.71 - * @uses get_the_author_posts() Echos returned value from function. */ function the_author_posts() { echo get_the_author_posts(); } /** - * the_author_posts_link() - Echo an HTML link to the author page of the author of the current post in the Loop. + * Display an HTML link to the author page of the author of the current post. + * + * Does just echo get_author_posts_url() function, like the others do. The + * reason for this, is that another function is used to help in printing the + * link to the author's posts. + * + * @link https://codex.wordpress.org/Template_Tags/the_author_posts_link + * @since 1.2.0 * - * Does just echo get_author_posts_url() function, like the others do. The reason for this, - * is that another function is used to help in printing the link to the author's posts. + * @global object $authordata The current author's DB object. * - * @since 1.2 - * @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 = '') { + if ( !empty( $deprecated ) ) + _deprecated_argument( __FUNCTION__, '2.1' ); + global $authordata; - printf( - '%3$s', - get_author_posts_url( $authordata->ID, $authordata->user_nicename ), - sprintf( __( 'Posts by %s' ), attribute_escape( get_the_author() ) ), + if ( ! is_object( $authordata ) ) { + return; + } + + $link = sprintf( + '', + esc_url( get_author_posts_url( $authordata->ID, $authordata->user_nicename ) ), + 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 ); } /** - * get_author_posts_url() - Get the URL to the author page of the author of the current post in the Loop. + * Retrieve the URL to the author page for the user with the ID provided. + * + * @since 2.1.0 + * + * @global WP_Rewrite $wp_rewrite * - * @since 2.1 - * @uses $wp_rewrite WP_Rewrite * @return string The URL to the author's page. */ function get_author_posts_url($author_id, $author_nicename = '') { @@ -386,7 +277,7 @@ function get_author_posts_url($author_id, $author_nicename = '') { $link = $wp_rewrite->get_author_permastruct(); if ( empty($link) ) { - $file = get_option('home') . '/'; + $file = home_url( '/' ); $link = $file . '?author=' . $auth_ID; } else { if ( '' == $author_nicename ) { @@ -395,116 +286,192 @@ function get_author_posts_url($author_id, $author_nicename = '') { $author_nicename = $user->user_nicename; } $link = str_replace('%author%', $author_nicename, $link); - $link = get_option('home') . trailingslashit($link); + $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; } /** - * get_author_name() - Get the specified author's preferred display name. + * List all the authors of the blog, with several options available. * - * @since 1.0.0 - * @param int $auth_id The ID of the author. - * @return string The author's display name. - */ -function get_author_name( $auth_id ) { - $authordata = get_userdata( $auth_id ); - return $authordata->display_name; -} - -/** - * wp_list_authors() - List all the authors of the blog, with several options available. - * - * optioncount (boolean) (false): Show the count in parenthesis next to the author's name. - * exclude_admin (boolean) (true): Exclude the 'admin' user that is installed by default. - * show_fullname (boolean) (false): Show their full names. - * hide_empty (boolean) (true): Don't show authors without any posts. - * feed (string) (''): If isn't empty, show links to author's feeds. - * feed_image (string) (''): If isn't empty, use this image to link to feeds. - * echo (boolean) (true): Set to false to return the output, instead of echoing. - * - * @since 1.2 - * @param array $args The argument array. - * @return null|string The output, if echo is set to false. + * @link https://codex.wordpress.org/Template_Tags/wp_list_authors + * + * @since 1.2.0 + * + * @global wpdb $wpdb + * + * @param string|array $args { + * Optional. Array or string of default arguments. + * + * @type string $orderby How to sort the authors. Accepts 'nicename', 'email', 'url', 'registered', + * 'user_nicename', 'user_email', 'user_url', 'user_registered', 'name', + * 'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'. + * @type string $order Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'. + * @type int $number Maximum authors to return or display. Default empty (all authors). + * @type bool $optioncount Show the count in parenthesis next to the author's name. Default false. + * @type bool $exclude_admin Whether to exclude the 'admin' account, if it exists. Default false. + * @type bool $show_fullname Whether to show the author's full name. Default false. + * @type bool $hide_empty Whether to hide any authors with no posts. Default true. + * @type string $feed If not empty, show a link to the author's feed and use this text as the alt + * parameter of the link. Default empty. + * @type string $feed_image If not empty, show a link to the author's feed and use this image URL as + * clickable anchor. Default empty. + * @type string $feed_type The feed type to link to, such as 'rss2'. Defaults to default feed type. + * @type bool $echo Whether to output the result or instead return it. Default true. + * @type string $style If 'list', each author is wrapped in an `
  • ` element, otherwise the authors + * will be separated by commas. + * @type bool $html Whether to list the items in HTML form or plaintext. Default true. + * @type string $exclude An array, comma-, or space-separated list of author IDs to exclude. Default empty. + * @type string $exclude An array, comma-, or space-separated list of author IDs to include. Default empty. + * } + * @return string|void The output, if echo is set to false. */ -function wp_list_authors($args = '') { +function wp_list_authors( $args = '' ) { global $wpdb; $defaults = array( + 'orderby' => 'name', 'order' => 'ASC', 'number' => '', 'optioncount' => false, 'exclude_admin' => true, 'show_fullname' => false, 'hide_empty' => true, - 'feed' => '', 'feed_image' => '', 'feed_type' => '', 'echo' => true + 'feed' => '', 'feed_image' => '', 'feed_type' => '', 'echo' => true, + 'style' => 'list', 'html' => true, 'exclude' => '', 'include' => '' ); - $r = wp_parse_args( $args, $defaults ); - extract($r, EXTR_SKIP); + $args = wp_parse_args( $args, $defaults ); $return = ''; - /** @todo Move select to get_authors(). */ - $authors = $wpdb->get_results("SELECT ID, user_nicename from $wpdb->users " . ($exclude_admin ? "WHERE user_login <> 'admin' " : '') . "ORDER BY display_name"); + $query_args = wp_array_slice_assoc( $args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) ); + $query_args['fields'] = 'ids'; + $authors = get_users( $query_args ); $author_count = array(); - foreach ((array) $wpdb->get_results("SELECT DISTINCT post_author, COUNT(ID) AS count FROM $wpdb->posts WHERE post_type = 'post' AND " . get_private_posts_cap_sql( 'post' ) . " GROUP BY post_author") as $row) { + foreach ( (array) $wpdb->get_results( "SELECT DISTINCT post_author, COUNT(ID) AS count FROM $wpdb->posts WHERE " . get_private_posts_cap_sql( 'post' ) . " GROUP BY post_author" ) as $row ) { $author_count[$row->post_author] = $row->count; } + foreach ( $authors as $author_id ) { + $author = get_userdata( $author_id ); + + if ( $args['exclude_admin'] && 'admin' == $author->display_name ) { + continue; + } - foreach ( (array) $authors as $author ) { - $author = get_userdata( $author->ID ); - $posts = (isset($author_count[$author->ID])) ? $author_count[$author->ID] : 0; - $name = $author->display_name; + $posts = isset( $author_count[$author->ID] ) ? $author_count[$author->ID] : 0; + + if ( ! $posts && $args['hide_empty'] ) { + continue; + } - if ( $show_fullname && ($author->first_name != '' && $author->last_name != '') ) + if ( $args['show_fullname'] && $author->first_name && $author->last_name ) { $name = "$author->first_name $author->last_name"; + } else { + $name = $author->display_name; + } + + if ( ! $args['html'] ) { + $return .= $name . ', '; + + continue; // No need to go further to process HTML. + } - if ( !($posts == 0 && $hide_empty) ) + if ( 'list' == $args['style'] ) { $return .= '
  • '; - if ( $posts == 0 ) { - if ( !$hide_empty ) - $link = $name; - } else { - $link = 'display_name)) . '">' . $name . ''; + } - if ( (! empty($feed_image)) || (! empty($feed)) ) { - $link .= ' '; - if (empty($feed_image)) - $link .= '('; - $link .= 'ID, $author->user_nicename ) . '" title="' . esc_attr( sprintf(__("Posts by %s"), $author->display_name) ) . '">' . $name . ''; - if ( !empty($feed) ) { - $title = ' title="' . $feed . '"'; - $alt = ' alt="' . $feed . '"'; - $name = $feed; - $link .= $title; - } + if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) { + $link .= ' '; + if ( empty( $args['feed_image'] ) ) { + $link .= '('; + } - $link .= '>'; + $link .= ''; - else - $link .= $name; + $alt = ''; + if ( ! empty( $args['feed'] ) ) { + $alt = ' alt="' . esc_attr( $args['feed'] ) . '"'; + $name = $args['feed']; + } - $link .= ''; + $link .= '>'; - if ( empty($feed_image) ) - $link .= ')'; + if ( ! empty( $args['feed_image'] ) ) { + $link .= ''; + } else { + $link .= $name; } - if ( $optioncount ) - $link .= ' ('. $posts . ')'; + $link .= ''; + + if ( empty( $args['feed_image'] ) ) { + $link .= ')'; + } + } + if ( $args['optioncount'] ) { + $link .= ' ('. $posts . ')'; } - if ( !($posts == 0 && $hide_empty) ) - $return .= $link . '
    • '; + $return .= $link; + $return .= ( 'list' == $args['style'] ) ? '' : ', '; } - if ( !$echo ) + + $return = rtrim( $return, ', ' ); + + if ( ! $args['echo'] ) { return $return; + } echo $return; } -?> \ No newline at end of file +/** + * Does this site have more than one author + * + * Checks to see if more than one author has published posts. + * + * @since 3.2.0 + * + * @global wpdb $wpdb + * + * @return bool Whether or not we have more than one author + */ +function is_multi_author() { + global $wpdb; + + if ( false === ( $is_multi_author = get_transient( 'is_multi_author' ) ) ) { + $rows = (array) $wpdb->get_col("SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 2"); + $is_multi_author = 1 < count( $rows ) ? 1 : 0; + set_transient( 'is_multi_author', $is_multi_author ); + } + + /** + * 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 ); +} + +/** + * Helper function to clear the cache for number of authors. + * + * @private + */ +function __clear_multi_author_cache() { + delete_transient( 'is_multi_author' ); +}