X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..refs/tags/wordpress-3.1-scripts:/wp-includes/author-template.php

diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php
index 10495544..641b69d4 100644
--- a/wp-includes/author-template.php
+++ b/wp-includes/author-template.php
@@ -1,327 +1,231 @@
 <?php
+/**
+ * Author Template functions for use in themes.
+ *
+ * These functions must be used within the WordPress Loop.
+ *
+ * @link http://codex.wordpress.org/Author_Templates
+ *
+ * @package WordPress
+ * @subpackage Template
+ */
 
 /**
- * Get the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
+ * 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.
+ *
  * @param string $deprecated Deprecated.
  * @return string 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' );
+
+	return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null);
 }
 
 /**
- * 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 normal, expected behavior of this function is to echo the author and not
+ * return it. However, backwards compatiability has to be maintained.
+ *
+ * @since 0.71
  * @see get_the_author()
+ * @link http://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().
+ * @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().
  */
-function the_author($deprecated = '', $deprecated_echo = true) {
+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 <code>get_the_author()</code> instead if you do not want the value echoed.') );
 	if ( $deprecated_echo )
 		echo get_the_author();
 	return get_the_author();
 }
 
 /**
- * Get the description of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The author's description.
- */
-function get_the_author_description() {
-	global $authordata;
-	return $authordata->description;
-}
-
-/**
- * Echo the description of the author of the current post in the Loop.
- * @see get_the_author_description()
- * @return null
- */
-function the_author_description() {
-	echo get_the_author_description();
-}
-
-/**
- * Get the login name of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The author's login name (username).
- */
-function get_the_author_login() {
-	global $authordata;
-	return $authordata->user_login;
-}
-
-/**
- * Echo the login name of the author of the current post in the Loop.
- * @see get_the_author_login()
- * @return null
- */
-function the_author_login() {
-	echo get_the_author_login();
-}
-
-/**
- * Get the first name of the author of the current post in the Loop.
- * @global object $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;
-}
-
-/**
- * Echo the first name of the author of the current post in the Loop.
- * @see get_the_author_firstname()
- * @return null
- */
-function the_author_firstname() {
-	echo get_the_author_firstname();
-}
-
-/**
- * Get the last name of the author of the current post in the Loop.
- * @global object $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;
-}
-
-/**
- * Echo the last name of the author of the current post in the Loop.
- * @see get_the_author_lastname()
- * @return null
- */
-function the_author_lastname() {
-	echo get_the_author_lastname();
-}
-
-/**
- * Get the nickname of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The author's nickname.
- */
-function get_the_author_nickname() {
-	global $authordata;
-	return $authordata->nickname;
-}
-
-/**
- * Echo the nickname of the author of the current post in the Loop.
- * @see get_the_author_nickname()
- * @return null
- */
-function the_author_nickname() {
-	echo get_the_author_nickname();
-}
-
-/**
- * Get the ID of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return int The author's ID.
- */
-function get_the_author_ID() {
-	global $authordata;
-	return (int) $authordata->ID;
-}
-
-/**
- * Echo the ID of the author of the current post in the Loop.
- * @see get_the_author_ID()
- * @return null
+ * 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.
  */
-function the_author_ID() {
-	echo get_the_author_id();
+function get_the_modified_author() {
+	global $post;
+	if ( $last_id = get_post_meta($post->ID, '_edit_last', true) ) {
+		$last_user = get_userdata($last_id);
+		return apply_filters('the_modified_author', $last_user->display_name);
+	}
 }
 
 /**
- * Get the email of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The author's username.
+ * Display the name of the author who last edited the current post.
+ *
+ * @since 2.8
+ * @see get_the_author()
+ * @return string The author's display name, from get_the_modified_author().
  */
-function get_the_author_email() {
-	global $authordata;
-	return $authordata->user_email;
+function the_modified_author() {
+	echo get_the_modified_author();
 }
 
 /**
- * Echo the email of the author of the current post in the Loop.
- * @see get_the_author_email()
- * @return null
+ * 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.
  */
-function the_author_email() {
-	echo apply_filters('the_author_email', get_the_author_email() );
-}
+function get_the_author_meta($field = '', $user_id = false) {
+	if ( ! $user_id )
+		global $authordata;
+	else
+		$authordata = get_userdata( $user_id );
 
-/**
- * Get the URL to the home page of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The URL to the author's page.
- */
-function get_the_author_url() {
-	global $authordata;
+	// Keys used as object vars cannot have dashes.
+	$field = str_replace('-', '', $field);
+	$field = strtolower($field);
+	$user_field = "user_$field";
 
-	if ( 'http://' == $authordata->user_url )
-		return '';
+	if ( 'id' == $field )
+		$value = isset($authordata->ID) ? (int)$authordata->ID : 0;
+	elseif ( isset($authordata->$user_field) )
+		$value = $authordata->$user_field;
+	else
+		$value = isset($authordata->$field) ? $authordata->$field : '';
 
-	return $authordata->user_url;
+	return apply_filters('get_the_author_' . $field, $value, $user_id);
 }
 
 /**
- * Echo the URL to the home page of the author of the current post in the Loop.
- * @see get_the_author_url()
- * @return null
+ * 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
+ * @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_url() {
-	echo get_the_author_url();
+function the_author_meta($field = '', $user_id = false) {
+	echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id);
 }
 
 /**
- * If the author has a home page set, echo an HTML link, otherwise just echo the author's name.
- * @see get_the_author_url()
- * @see the_author()
- * @return null
+ * 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 the_author_link() {
-	if (get_the_author_url()) {
-		echo '<a href="' . get_the_author_url() . '" title="' . sprintf(__("Visit %s's website"), get_the_author()) . '" rel="external">' . get_the_author() . '</a>';
+function get_the_author_link() {
+	if ( get_the_author_meta('url') ) {
+		return '<a href="' . get_the_author_meta('url') . '" title="' . esc_attr( sprintf(__("Visit %s&#8217;s website"), get_the_author()) ) . '" rel="external">' . get_the_author() . '</a>';
 	} else {
-		the_author();
+		return get_the_author();
 	}
 }
 
 /**
- * Get the ICQ number of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The author's ICQ number.
- */
-function get_the_author_icq() {
-	global $authordata;
-	return $authordata->icq;
-}
-
-/**
- * Echo the ICQ number of the author of the current post in the Loop.
- * @see get_the_author_icq()
- * @return null
- */
-function the_author_icq() {
-	echo get_the_author_icq();
-}
-
-/**
- * Get the AIM name of the author of the current post in the Loop.
- * @global object $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);
-}
-
-/**
- * Echo the AIM name of the author of the current post in the Loop.
- * @see get_the_author_aim()
- * @return null
+ * 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
+ * @since 2.1
+ * @uses get_the_author_link()
  */
-function the_author_aim() {
-	echo get_the_author_aim();
-}
-
-/**
- * Get the Yahoo! IM name of the author of the current post in the Loop.
- * @global object $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;
-}
-
-/**
- * Echo the Yahoo! IM name of the author of the current post in the Loop.
- * @see get_the_author_yim()
- * @return null
- */
-function the_author_yim() {
-	echo get_the_author_yim();
-}
-
-/**
- * Get the MSN address of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @return string The author's MSN address.
- */
-function get_the_author_msn() {
-	global $authordata;
-	return $authordata->msn;
-}
-
-/**
- * Echo the MSN address of the author of the current post in the Loop.
- * @see get_the_author_msn()
- * @return null
- */
-function the_author_msn() {
-	echo get_the_author_msn();
+function the_author_link() {
+	echo get_the_author_link();
 }
 
 /**
- * Get the number of posts by the author of the current post in the Loop.
- * @global object $post The current post in the Loop's DB object.
- * @see get_usernumposts()
+ * 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()
  * @return int The number of posts by the author.
  */
 function get_the_author_posts() {
 	global $post;
-	return get_usernumposts($post->post_author);
+	return count_user_posts($post->post_author);
 }
 
 /**
- * Echo the number of posts by the author of the current post in the Loop.
- * @see get_the_author_posts()
- * @return null
+ * Display the number of posts by the author of the current post.
+ *
+ * @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();
 }
 
 /**
- * Echo an HTML link to the author page of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
- * @see get_author_posts_url()
- * @see get_the_author()
- * @return null
+ * 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 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.
  */
-/* the_author_posts_link() requires no get_, use get_author_posts_url() */
 function the_author_posts_link($deprecated = '') {
+	if ( !empty( $deprecated ) )
+		_deprecated_argument( __FUNCTION__, '2.1' );
+
 	global $authordata;
-	printf(
+	$link = sprintf(
 		'<a href="%1$s" title="%2$s">%3$s</a>',
 		get_author_posts_url( $authordata->ID, $authordata->user_nicename ),
-		sprintf( __( 'Posts by %s' ), attribute_escape( get_the_author() ) ),
+		esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ),
 		get_the_author()
 	);
+	echo apply_filters( 'the_author_posts_link', $link );
 }
 
 /**
- * Get the URL to the author page of the author of the current post in the Loop.
- * @global object $wpdb WordPress database layer.
- * @global object $wp_rewrite WP_Rewrite
- * @global object $post The current post in the Loop's DB object.
+ * Retrieve the URL to the author page for the user with the ID provided.
+ *
+ * @since 2.1.0
+ * @uses $wp_rewrite WP_Rewrite
  * @return string The URL to the author's page.
  */
 function get_author_posts_url($author_id, $author_nicename = '') {
-	global $wpdb, $wp_rewrite, $post;
+	global $wp_rewrite;
 	$auth_ID = (int) $author_id;
 	$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 ) {
@@ -330,7 +234,7 @@ 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);
@@ -338,25 +242,29 @@ function get_author_posts_url($author_id, $author_nicename = '') {
 	return $link;
 }
 
-/**
- * Get the specified author's preferred display name.
- * @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;
-}
-
 /**
  * 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.
+ *
+ * <ul>
+ * <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 bydefault.</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.
  */
@@ -364,77 +272,98 @@ 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' => '', 'echo' => true
+		'feed' => '', 'feed_image' => '', 'feed_type' => '', 'echo' => true,
+		'style' => 'list', 'html' => true
 	);
 
-	$r = wp_parse_args( $args, $defaults );
-	extract($r, EXTR_SKIP);
+	$args = wp_parse_args( $args, $defaults );
+	extract( $args, EXTR_SKIP );
 
 	$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' ) );
+	$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 post_type = 'post' AND " . get_private_posts_cap_sql( 'post' ) . " GROUP BY post_author") as $row )
 		$author_count[$row->post_author] = $row->count;
-	}
 
-	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;
+	foreach ( $authors as $author_id ) {
+		$author = get_userdata( $author_id );
+
+		if ( $exclude_admin && 'admin' == $author->display_name )
+			continue;
+
+		$posts = isset( $author_count[$author->ID] ) ? $author_count[$author->ID] : 0;
+
+		if ( !$posts && $hide_empty )
+			continue;
+
+		$link = '';
 
-		if ( $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
+			$name = $author->display_name;
 
-		if ( !($posts == 0 && $hide_empty) )
+		if ( !$html ) {
+			$return .= $name . ', ';
+
+			continue; // No need to go further to process HTML.
+		}
+
+		if ( 'list' == $style ) {
 			$return .= '<li>';
-		if ( $posts == 0 ) {
-			if ( !$hide_empty )
-				$link = $name;
-		} else {
-			$link = '<a href="' . get_author_posts_url($author->ID, $author->user_nicename) . '" title="' . sprintf(__("Posts by %s"), attribute_escape($author->display_name)) . '">' . $name . '</a>';
-
-			if ( (! empty($feed_image)) || (! empty($feed)) ) {
-				$link .= ' ';
-				if (empty($feed_image))
-					$link .= '(';
-				$link .= '<a href="' . get_author_rss_link(0, $author->ID, $author->user_nicename) . '"';
-
-				if ( !empty($feed) ) {
-					$title = ' title="' . $feed . '"';
-					$alt = ' alt="' . $feed . '"';
-					$name = $feed;
-					$link .= $title;
-				}
-
-				$link .= '>';
-
-				if ( !empty($feed_image) )
-					$link .= "<img src=\"$feed_image\" border=\"0\"$alt$title" . ' />';
-				else
-					$link .= $name;
-
-				$link .= '</a>';
-
-				if ( empty($feed_image) )
-					$link .= ')';
+		}
+
+		$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 ) ) {
+			$link .= ' ';
+			if ( empty( $feed_image ) ) {
+				$link .= '(';
 			}
 
-			if ( $optioncount )
-				$link .= ' ('. $posts . ')';
+			$link .= '<a href="' . get_author_feed_link( $author->ID ) . '"';
+
+			$alt = $title = '';
+			if ( !empty( $feed ) ) {
+				$title = ' title="' . esc_attr( $feed ) . '"';
+				$alt = ' alt="' . esc_attr( $feed ) . '"';
+				$name = $feed;
+				$link .= $title;
+			}
 
+			$link .= '>';
+
+			if ( !empty( $feed_image ) )
+				$link .= '<img src="' . esc_url( $feed_image ) . '" style="border: none;"' . $alt . $title . ' />';
+			else
+				$link .= $name;
+
+			$link .= '</a>';
+
+			if ( empty( $feed_image ) )
+				$link .= ')';
 		}
 
-		if ( !($posts == 0 && $hide_empty) )
-			$return .= $link . '</li>';
+		if ( $optioncount )
+			$link .= ' ('. $posts . ')';
+
+		$return .= $link;
+		$return .= ( 'list' == $style ) ? '</li>' : ', ';
 	}
+
+	$return = rtrim($return, ', ');
+
 	if ( !$echo )
 		return $return;
+
 	echo $return;
 }
 
-?>
\ No newline at end of file
+?>