WordPress 4.0
[autoinstalls/wordpress.git] / wp-includes / author-template.php
index dd225c0b6d821d7e23587ee3008c585389d6f82c..1ec236abee1cd2c29811e64bbd46c872534120ab 100644 (file)
@@ -206,7 +206,11 @@ function the_author_link() {
  * @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 );
 }
 
 /**
@@ -300,32 +304,37 @@ function get_author_posts_url($author_id, $author_nicename = '') {
 /**
  * List all the authors of the blog, with several options available.
  *
- * <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 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>
- * <li>exclude (array): Array of user IDs to explicitly exclude.</li>
- * <li>include (array): Array of user IDs to explicitly include.</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.
+ *
+ *     @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 = '') {
+function wp_list_authors( $args = '' ) {
        global $wpdb;
 
        $defaults = array(
@@ -337,7 +346,6 @@ function wp_list_authors($args = '') {
        );
 
        $args = wp_parse_args( $args, $defaults );
-       extract( $args, EXTR_SKIP );
 
        $return = '';
 
@@ -346,78 +354,82 @@ function wp_list_authors($args = '') {
        $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 ( $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 ( $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
+               } 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, $feed_type ) . '"';
+                       $link .= '<a href="' . get_author_feed_link( $author->ID, $args['feed_type'] ) . '"';
 
                        $alt = '';
-                       if ( !empty( $feed ) ) {
-                               $alt = ' alt="' . esc_attr( $feed ) . '"';
-                               $name = $feed;
+                       if ( ! empty( $args['feed'] ) ) {
+                               $alt = ' alt="' . esc_attr( $args['feed'] ) . '"';
+                               $name = $args['feed'];
                        }
 
                        $link .= '>';
 
-                       if ( !empty( $feed_image ) )
-                               $link .= '<img src="' . esc_url( $feed_image ) . '" style="border: none;"' . $alt . ' />';
-                       else
+                       if ( ! empty( $args['feed_image'] ) ) {
+                               $link .= '<img src="' . esc_url( $args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
+                       } 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;
 }