enmi-conf.org: comparison wp/wp-includes/author-template.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 /**
 * Author Template functions for use in themes.
 *
 * 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
 */
 /**
 * 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.
 */
 function get_the_author($deprecated = '') {
 * 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 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().
 */
 }
 /**
 * Retrieve the author who last edited the current post.
 *
-* @since 2.8
+* @since 2.8.0
-* @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.
 */
 function get_the_modified_author() {
 	if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) {
 		$last_user = get_userdata($last_id);
 }
 /**
 * 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().
 */
 function the_modified_author() {
 	echo get_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).
 * @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 ) {
 	return apply_filters( 'get_the_author_' . $field, $value, $user_id );
 }
 /**
 * 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
 * @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.
 */
 /**
 * Retrieve either author's link or author's name.
 *
 * 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') ) {
 		return '<a href="' . esc_url( get_the_author_meta('url') ) . '" title="' . esc_attr( sprintf(__("Visit %s&#8217;s website"), get_the_author()) ) . '" rel="author external">' . get_the_author() . '</a>';
 	} else {
 * Display either author's link or author's name.
 *
 * 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
+* @link https://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();
 }
 /**
 * Retrieve the number of posts by the author of the current post.
 *
-* @since 1.5
+* @since 1.5.0
-* @uses $post The current post in the Loop's DB object.
+*
-* @uses count_user_posts()
 * @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();
 }
 *
 * 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 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()
 * @param string $deprecated Deprecated.
 */
 function the_author_posts_link($deprecated = '') {
 	if ( !empty( $deprecated ) )
 		_deprecated_argument( __FUNCTION__, '2.1' );
 }
 /**
 * List all the authors of the blog, with several options available.
 *
-* <ul>
+* @link https://codex.wordpress.org/Template_Tags/wp_list_authors
-* <li>optioncount (boolean) (false): Show the count in parenthesis next to the
+*
-* author's name.</li>
-* <li>exclude_admin (boolean) (true): Exclude the 'admin' user that is
-* installed by default.</li>
-* <li>show_fullname (boolean) (false): Show their full names.</li>
-* <li>hide_empty (boolean) (true): Don't show authors without any posts.</li>
-* <li>feed (string) (''): If isn't empty, show links to author's feeds.</li>
-* <li>feed_image (string) (''): If isn't empty, use this image to link to
-* feeds.</li>
-* <li>echo (boolean) (true): Set to false to return the output, instead of
-* echoing.</li>
-* <li>style (string) ('list'): Whether to display list of authors in list form
-* or as a string.</li>
-* <li>html (bool) (true): Whether to list the items in html form or plaintext.
-* </li>
-* </ul>
-*
-* @link http://codex.wordpress.org/Template_Tags/wp_list_authors
 * @since 1.2.0
-* @param array $args The argument array.
+*
-* @return null|string The output, if echo is set to false.
+* @param string|array $args {
-*/
+*     Optional. Array or string of default arguments.
-function wp_list_authors($args = '') {
+*
+*     @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 `<li>` 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 null|string The output, if echo is set to false. Otherwise null.
+*/
+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,
-		'style' => 'list', 'html' => true
+		'style' => 'list', 'html' => true, 'exclude' => '', 'include' => ''
 	);
 	$args = wp_parse_args( $args, $defaults );
-	extract( $args, EXTR_SKIP );
 	$return = '';
-	$query_args = wp_array_slice_assoc( $args, array( 'orderby', 'order', 'number' ) );
+	$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 ( $exclude_admin && 'admin' == $author->display_name )
+		if ( $args['exclude_admin'] && 'admin' == $author->display_name ) {
 			continue;
+		}
 		$posts = isset( $author_count[$author->ID] ) ? $author_count[$author->ID] : 0;
-		if ( !$posts && $hide_empty )
+		if ( ! $posts && $args['hide_empty'] ) {
 			continue;
+		}
-		$link = '';
+		if ( $args['show_fullname'] && $author->first_name && $author->last_name ) {
-		if ( $show_fullname && $author->first_name && $author->last_name )
 			$name = "$author->first_name $author->last_name";
-		else
+		} else {
 			$name = $author->display_name;
+		}
-		if ( !$html ) {
+		if ( ! $args['html'] ) {
 			$return .= $name . ', ';
 			continue; // No need to go further to process HTML.
 		}
-		if ( 'list' == $style ) {
+		if ( 'list' == $args['style'] ) {
 			$return .= '<li>';
 		}
 		$link = '<a href="' . get_author_posts_url( $author->ID, $author->user_nicename ) . '" title="' . esc_attr( sprintf(__("Posts by %s"), $author->display_name) ) . '">' . $name . '</a>';
-		if ( !empty( $feed_image ) || !empty( $feed ) ) {
+		if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
 			$link .= ' ';
-			if ( empty( $feed_image ) ) {
+			if ( empty( $args['feed_image'] ) ) {
 				$link .= '(';
 			}
-			$link .= '<a href="' . get_author_feed_link( $author->ID ) . '"';
+			$link .= '<a href="' . get_author_feed_link( $author->ID, $args['feed_type'] ) . '"';
-			$alt = $title = '';
+			$alt = '';
-			if ( !empty( $feed ) ) {
+			if ( ! empty( $args['feed'] ) ) {
-				$title = ' title="' . esc_attr( $feed ) . '"';
+				$alt = ' alt="' . esc_attr( $args['feed'] ) . '"';
-				$alt = ' alt="' . esc_attr( $feed ) . '"';
+				$name = $args['feed'];
-				$name = $feed;
-				$link .= $title;
 			}
 			$link .= '>';
-			if ( !empty( $feed_image ) )
+			if ( ! empty( $args['feed_image'] ) ) {
-				$link .= '<img src="' . esc_url( $feed_image ) . '" style="border: none;"' . $alt . $title . ' />';
+				$link .= '<img src="' . esc_url( $args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
-			else
+			} else {
 				$link .= $name;
+			}
 			$link .= '</a>';
-			if ( empty( $feed_image ) )
+			if ( empty( $args['feed_image'] ) ) {
 				$link .= ')';
-		}
+			}
+		}
-		if ( $optioncount )
+		if ( $args['optioncount'] ) {
 			$link .= ' ('. $posts . ')';
+		}
 		$return .= $link;
-		$return .= ( 'list' == $style ) ? '</li>' : ', ';
+		$return .= ( 'list' == $args['style'] ) ? '</li>' : ', ';
 	}
-	$return = rtrim($return, ', ');
+	$return = rtrim( $return, ', ' );
-	if ( !$echo )
+	if ( ! $args['echo'] ) {
 		return $return;
+	}
 	echo $return;
 }
 /**
 * Does this site have more than one author
 * @private
 */
 function __clear_multi_author_cache() {
 	delete_transient( 'is_multi_author' );
 }
-add_action('transition_post_status', '__clear_multi_author_cache');

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001