WordPress 3.3.2
[autoinstalls/wordpress.git] / wp-includes / author-template.php
index c62b4bc0270671164ac21a1c5c90cdbede9de209..4b21e446e34502f5afc3d3eb4d36706ed9fcb3f2 100644 (file)
  */
 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);
 }
 
 /**
@@ -34,208 +38,112 @@ function get_the_author($deprecated = '') {
  * 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.
+ * 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
  *
  * @param string $deprecated Deprecated.
- * @param string $deprecated_echo Echo the string or return it.
+ * @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();
 }
 
 /**
- * Retrieve the description of the author of the current post.
- *
- * @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;
-}
-
-/**
- * Display the description of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_description
- * @since 1.0.0
- * @see get_the_author_description()
- */
-function the_author_description() {
-       echo get_the_author_description();
-}
-
-/**
- * Retrieve the login name of the author of the current post.
- *
- * @since 1.5
- * @uses $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;
-}
-
-/**
- * Display the login name of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_login
- * @since 0.71
- * @see get_the_author_login()
- */
-function the_author_login() {
-       echo get_the_author_login();
-}
-
-/**
- * Retrieve the first name of the author of the current post.
+ * Retrieve the author who last edited the current post.
  *
- * @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;
-}
-
-/**
- * Display the first name of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_firstname
- * @since 0.71
- * @uses get_the_author_firstname()
- */
-function the_author_firstname() {
-       echo get_the_author_firstname();
-}
-
-/**
- * Retrieve the last name of the author of the current post.
- *
- * @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;
-}
-
-/**
- * Display the last name of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_lastname
- * @since 0.71
- * @uses get_the_author_lastname()
+ * @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_lastname() {
-       echo get_the_author_lastname();
+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);
+       }
 }
 
 /**
- * Retrieve the nickname of the author of the current post.
+ * Display the name of the author who last edited the current post.
  *
- * @since 1.5
- * @uses $authordata The current author's DB object.
- * @return string The author's nickname.
+ * @since 2.8
+ * @see get_the_author()
+ * @return string The author's display name, from get_the_modified_author().
  */
-function get_the_author_nickname() {
-       global $authordata;
-       return $authordata->nickname;
+function the_modified_author() {
+       echo get_the_modified_author();
 }
 
 /**
- * Display the nickname of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_nickname
- * @since 0.71
- * @uses get_the_author_nickname()
+ * 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_nickname() {
-       echo get_the_author_nickname();
-}
+function get_the_author_meta($field = '', $user_id = false) {
+       if ( ! $user_id )
+               global $authordata;
+       else
+               $authordata = get_userdata( $user_id );
 
-/**
- * Retrieve the ID of the author of the current post.
- *
- * @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;
-}
+       // Keys used as object vars cannot have dashes.
+       $field = str_replace('-', '', $field);
+       $field = strtolower($field);
+       $user_field = "user_$field";
 
-/**
- * Display the ID of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_ID
- * @since 0.71
- * @uses get_the_author_ID()
- */
-function the_author_ID() {
-       echo get_the_author_id();
-}
+       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 : '';
 
-/**
- * Retrieve the email of the author of the current post.
- *
- * @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;
+       return apply_filters('get_the_author_' . $field, $value, $user_id);
 }
 
 /**
- * Display the email of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_email
- * @since 0.71
- * @uses get_the_author_email()
+ * 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_email() {
-       echo apply_filters('the_author_email', get_the_author_email() );
+function the_author_meta($field = '', $user_id = false) {
+       echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id);
 }
 
 /**
- * Retrieve the URL to the home page of the author of the current post.
+ * Retrieve either author's link or author's name.
  *
- * @since 1.5
- * @uses $authordata The current author's DB object.
- * @return string The URL to the author's page.
- */
-function get_the_author_url() {
-       global $authordata;
-
-       if ( 'http://' == $authordata->user_url )
-               return '';
-
-       return $authordata->user_url;
-}
-
-/**
- * Display the URL to the home page of the author of the current post.
+ * If the author has a home page set, return an HTML link, otherwise just return the
+ * author's name.
  *
- * @link http://codex.wordpress.org/Template_Tags/the_author_url
- * @since 0.71
- * @uses get_the_author_url()
+ * @uses get_the_author_meta()
+ * @uses get_the_author()
  */
-function the_author_url() {
-       echo get_the_author_url();
+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 {
+               return get_the_author();
+       }
 }
 
 /**
@@ -246,107 +154,10 @@ function the_author_url() {
  *
  * @link http://codex.wordpress.org/Template_Tags/the_author_link
  * @since 2.1
- * @uses get_the_author_url()
- * @uses the_author()
+ * @uses get_the_author_link()
  */
 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>';
-       } else {
-               the_author();
-       }
-}
-
-/**
- * Retrieve the ICQ number of the author of the current post.
- *
- * @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;
-}
-
-/**
- * Display the ICQ number of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_icq
- * @since 0.71
- * @see get_the_author_icq()
- */
-function the_author_icq() {
-       echo get_the_author_icq();
-}
-
-/**
- * Retrieve the AIM name of the author of the current post.
- *
- * @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);
-}
-
-/**
- * Display the AIM name of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_aim
- * @since 0.71
- * @see get_the_author_aim()
- */
-function the_author_aim() {
-       echo get_the_author_aim();
-}
-
-/**
- * Retrieve the Yahoo! IM name of the author of the current post.
- *
- * @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;
-}
-
-/**
- * Display the Yahoo! IM name of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_yim
- * @since 0.71
- * @see get_the_author_yim()
- */
-function the_author_yim() {
-       echo get_the_author_yim();
-}
-
-/**
- * Retrieve the MSN address of the author of the current post.
- *
- * @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;
-}
-
-/**
- * Display the MSN address of the author of the current post.
- *
- * @link http://codex.wordpress.org/Template_Tags/the_author_msn
- * @since 0.71
- * @see get_the_author_msn()
- */
-function the_author_msn() {
-       echo get_the_author_msn();
+       echo get_the_author_link();
 }
 
 /**
@@ -354,12 +165,12 @@ function the_author_msn() {
  *
  * @since 1.5
  * @uses $post The current post in the Loop's DB object.
- * @uses get_usernumposts()
+ * @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);
 }
 
 /**
@@ -367,7 +178,7 @@ function get_the_author_posts() {
  *
  * @link http://codex.wordpress.org/Template_Tags/the_author_posts
  * @since 0.71
- * @uses get_the_author_posts() Echos returned value from function.
+ * @uses get_the_author_posts() Echoes returned value from function.
  */
 function the_author_posts() {
        echo get_the_author_posts();
@@ -381,26 +192,32 @@ function the_author_posts() {
  * link to the author's posts.
  *
  * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
- * @since 1.2
+ * @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' );
+
        global $authordata;
-       printf(
-               '<a href="%1$s" title="%2$s">%3$s</a>',
+       if ( !is_object( $authordata ) )
+               return false;
+       $link = sprintf(
+               '<a href="%1$s" title="%2$s" rel="author">%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 );
 }
 
 /**
- * Retrieve the URL to the author page of the author of the current post.
+ * Retrieve the URL to the author page for the user with the ID provided.
  *
- * @since 2.1
+ * @since 2.1.0
  * @uses $wp_rewrite WP_Rewrite
  * @return string The URL to the author's page.
  */
@@ -410,7 +227,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 ) {
@@ -419,7 +236,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);
@@ -427,33 +244,29 @@ function get_author_posts_url($author_id, $author_nicename = '') {
        return $link;
 }
 
-/**
- * Retrieve the specified author's preferred display name.
- *
- * @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;
-}
-
 /**
  * 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
+ * @since 1.2.0
  * @param array $args The argument array.
  * @return null|string The output, if echo is set to false.
  */
@@ -461,77 +274,128 @@ 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
        );
 
-       $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\" style=\"border: none;\"$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;
 }
 
+/**
+ * Does this site have more than one author
+ *
+ * Checks to see if more than one author has published posts.
+ *
+ * @since 3.2.0
+ * @return bool Whether or not we have more than one author
+ */
+function is_multi_author() {
+       global $wpdb;
+
+       if ( false === ( $is_multi_author = wp_cache_get('is_multi_author', 'posts') ) ) {
+               $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;
+               wp_cache_set('is_multi_author', $is_multi_author, 'posts');
+       }
+
+       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() {
+       wp_cache_delete('is_multi_author', 'posts');
+}
+add_action('transition_post_status', '__clear_multi_author_cache');
+
 ?>