[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Author Template functions for use in themes.
   4   *
   5   * These functions must be used within the WordPress Loop.
   6   *
   7   * @link http://codex.wordpress.org/Author_Templates
   8   *
   9   * @package WordPress
  10   * @subpackage Template
  11   */
  12  
  13  /**
  14   * Retrieve the author of the current post.
  15   *
  16   * @since 1.5
  17   * @uses $authordata The current author's DB object.
  18   * @uses apply_filters() Calls 'the_author' hook on the author display name.
  19   *
  20   * @param string $deprecated Deprecated.
  21   * @return string The author's display name.
  22   */
  23  function get_the_author($deprecated = '') {
  24      global $authordata;
  25  
  26      if ( !empty( $deprecated ) )
  27          _deprecated_argument( __FUNCTION__, '2.1' );
  28  
  29      return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null);
  30  }
  31  
  32  /**
  33   * Display the name of the author of the current post.
  34   *
  35   * The behavior of this function is based off of old functionality predating
  36   * get_the_author(). This function is not deprecated, but is designed to echo
  37   * the value from get_the_author() and as an result of any old theme that might
  38   * still use the old behavior will also pass the value from get_the_author().
  39   *
  40   * The normal, expected behavior of this function is to echo the author and not
  41   * return it. However, backwards compatiability has to be maintained.
  42   *
  43   * @since 0.71
  44   * @see get_the_author()
  45   * @link http://codex.wordpress.org/Template_Tags/the_author
  46   *
  47   * @param string $deprecated Deprecated.
  48   * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.
  49   * @return string The author's display name, from get_the_author().
  50   */
  51  function the_author( $deprecated = '', $deprecated_echo = true ) {
  52      if ( !empty( $deprecated ) )
  53          _deprecated_argument( __FUNCTION__, '2.1' );
  54      if ( $deprecated_echo !== true )
  55          _deprecated_argument( __FUNCTION__, '1.5', __('Use <code>get_the_author()</code> instead if you do not want the value echoed.') );
  56      if ( $deprecated_echo )
  57          echo get_the_author();
  58      return get_the_author();
  59  }
  60  
  61  /**
  62   * Retrieve the author who last edited the current post.
  63   *
  64   * @since 2.8
  65   * @uses $post The current post's DB object.
  66   * @uses get_post_meta() Retrieves the ID of the author who last edited the current post.
  67   * @uses get_userdata() Retrieves the author's DB object.
  68   * @uses apply_filters() Calls 'the_modified_author' hook on the author display name.
  69   * @return string The author's display name.
  70   */
  71  function get_the_modified_author() {
  72      global $post;
  73      if ( $last_id = get_post_meta($post->ID, '_edit_last', true) ) {
  74          $last_user = get_userdata($last_id);
  75          return apply_filters('the_modified_author', $last_user->display_name);
  76      }
  77  }
  78  
  79  /**
  80   * Display the name of the author who last edited the current post.
  81   *
  82   * @since 2.8
  83   * @see get_the_author()
  84   * @return string The author's display name, from get_the_modified_author().
  85   */
  86  function the_modified_author() {
  87      echo get_the_modified_author();
  88  }
  89  
  90  /**
  91   * Retrieve the requested data of the author of the current post.
  92   * @link http://codex.wordpress.org/Template_Tags/the_author_meta
  93   * @since 2.8.0
  94   * @uses $authordata The current author's DB object (if $user_id not specified).
  95   * @param string $field selects the field of the users record.
  96   * @param int $user_id Optional. User ID.
  97   * @return string The author's field from the current author's DB object.
  98   */
  99  function get_the_author_meta($field = '', $user_id = false) {
 100      if ( ! $user_id )
 101          global $authordata;
 102      else
 103          $authordata = get_userdata( $user_id );
 104  
 105      // Keys used as object vars cannot have dashes.
 106      $field = str_replace('-', '', $field);
 107      $field = strtolower($field);
 108      $user_field = "user_$field";
 109  
 110      if ( 'id' == $field )
 111          $value = isset($authordata->ID) ? (int)$authordata->ID : 0;
 112      elseif ( isset($authordata->$user_field) )
 113          $value = $authordata->$user_field;
 114      else
 115          $value = isset($authordata->$field) ? $authordata->$field : '';
 116  
 117      return apply_filters('get_the_author_' . $field, $value, $user_id);
 118  }
 119  
 120  /**
 121   * Retrieve the requested data of the author of the current post.
 122   * @link http://codex.wordpress.org/Template_Tags/the_author_meta
 123   * @since 2.8.0
 124   * @param string $field selects the field of the users record.
 125   * @param int $user_id Optional. User ID.
 126   * @echo string The author's field from the current author's DB object.
 127   */
 128  function the_author_meta($field = '', $user_id = false) {
 129      echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id);
 130  }
 131  
 132  /**
 133   * Retrieve either author's link or author's name.
 134   *
 135   * If the author has a home page set, return an HTML link, otherwise just return the
 136   * author's name.
 137   *
 138   * @uses get_the_author_meta()
 139   * @uses get_the_author()
 140   */
 141  function get_the_author_link() {
 142      if ( get_the_author_meta('url') ) {
 143          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>';
 144      } else {
 145          return get_the_author();
 146      }
 147  }
 148  
 149  /**
 150   * Display either author's link or author's name.
 151   *
 152   * If the author has a home page set, echo an HTML link, otherwise just echo the
 153   * author's name.
 154   *
 155   * @link http://codex.wordpress.org/Template_Tags/the_author_link
 156   * @since 2.1
 157   * @uses get_the_author_link()
 158   */
 159  function the_author_link() {
 160      echo get_the_author_link();
 161  }
 162  
 163  /**
 164   * Retrieve the number of posts by the author of the current post.
 165   *
 166   * @since 1.5
 167   * @uses $post The current post in the Loop's DB object.
 168   * @uses count_user_posts()
 169   * @return int The number of posts by the author.
 170   */
 171  function get_the_author_posts() {
 172      global $post;
 173      return count_user_posts($post->post_author);
 174  }
 175  
 176  /**
 177   * Display the number of posts by the author of the current post.
 178   *
 179   * @link http://codex.wordpress.org/Template_Tags/the_author_posts
 180   * @since 0.71
 181   * @uses get_the_author_posts() Echoes returned value from function.
 182   */
 183  function the_author_posts() {
 184      echo get_the_author_posts();
 185  }
 186  
 187  /**
 188   * Display an HTML link to the author page of the author of the current post.
 189   *
 190   * Does just echo get_author_posts_url() function, like the others do. The
 191   * reason for this, is that another function is used to help in printing the
 192   * link to the author's posts.
 193   *
 194   * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
 195   * @since 1.2.0
 196   * @uses $authordata The current author's DB object.
 197   * @uses get_author_posts_url()
 198   * @uses get_the_author()
 199   * @param string $deprecated Deprecated.
 200   */
 201  function the_author_posts_link($deprecated = '') {
 202      if ( !empty( $deprecated ) )
 203          _deprecated_argument( __FUNCTION__, '2.1' );
 204  
 205      global $authordata;
 206      if ( !is_object( $authordata ) )
 207          return false;
 208      $link = sprintf(
 209          '<a href="%1$s" title="%2$s">%3$s</a>',
 210          get_author_posts_url( $authordata->ID, $authordata->user_nicename ),
 211          esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ),
 212          get_the_author()
 213      );
 214      echo apply_filters( 'the_author_posts_link', $link );
 215  }
 216  
 217  /**
 218   * Retrieve the URL to the author page for the user with the ID provided.
 219   *
 220   * @since 2.1.0
 221   * @uses $wp_rewrite WP_Rewrite
 222   * @return string The URL to the author's page.
 223   */
 224  function get_author_posts_url($author_id, $author_nicename = '') {
 225      global $wp_rewrite;
 226      $auth_ID = (int) $author_id;
 227      $link = $wp_rewrite->get_author_permastruct();
 228  
 229      if ( empty($link) ) {
 230          $file = home_url( '/' );
 231          $link = $file . '?author=' . $auth_ID;
 232      } else {
 233          if ( '' == $author_nicename ) {
 234              $user = get_userdata($author_id);
 235              if ( !empty($user->user_nicename) )
 236                  $author_nicename = $user->user_nicename;
 237          }
 238          $link = str_replace('%author%', $author_nicename, $link);
 239          $link = home_url( user_trailingslashit( $link ) );
 240      }
 241  
 242      $link = apply_filters('author_link', $link, $author_id, $author_nicename);
 243  
 244      return $link;
 245  }
 246  
 247  /**
 248   * List all the authors of the blog, with several options available.
 249   *
 250   * <ul>
 251   * <li>optioncount (boolean) (false): Show the count in parenthesis next to the
 252   * author's name.</li>
 253   * <li>exclude_admin (boolean) (true): Exclude the 'admin' user that is
 254   * installed bydefault.</li>
 255   * <li>show_fullname (boolean) (false): Show their full names.</li>
 256   * <li>hide_empty (boolean) (true): Don't show authors without any posts.</li>
 257   * <li>feed (string) (''): If isn't empty, show links to author's feeds.</li>
 258   * <li>feed_image (string) (''): If isn't empty, use this image to link to
 259   * feeds.</li>
 260   * <li>echo (boolean) (true): Set to false to return the output, instead of
 261   * echoing.</li>
 262   * <li>style (string) ('list'): Whether to display list of authors in list form
 263   * or as a string.</li>
 264   * <li>html (bool) (true): Whether to list the items in html form or plaintext.
 265   * </li>
 266   * </ul>
 267   *
 268   * @link http://codex.wordpress.org/Template_Tags/wp_list_authors
 269   * @since 1.2.0
 270   * @param array $args The argument array.
 271   * @return null|string The output, if echo is set to false.
 272   */
 273  function wp_list_authors($args = '') {
 274      global $wpdb;
 275  
 276      $defaults = array(
 277          'orderby' => 'name', 'order' => 'ASC', 'number' => '',
 278          'optioncount' => false, 'exclude_admin' => true,
 279          'show_fullname' => false, 'hide_empty' => true,
 280          'feed' => '', 'feed_image' => '', 'feed_type' => '', 'echo' => true,
 281          'style' => 'list', 'html' => true
 282      );
 283  
 284      $args = wp_parse_args( $args, $defaults );
 285      extract( $args, EXTR_SKIP );
 286  
 287      $return = '';
 288  
 289      $query_args = wp_array_slice_assoc( $args, array( 'orderby', 'order', 'number' ) );
 290      $query_args['fields'] = 'ids';
 291      $authors = get_users( $query_args );
 292  
 293      $author_count = array();
 294      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 )
 295          $author_count[$row->post_author] = $row->count;
 296  
 297      foreach ( $authors as $author_id ) {
 298          $author = get_userdata( $author_id );
 299  
 300          if ( $exclude_admin && 'admin' == $author->display_name )
 301              continue;
 302  
 303          $posts = isset( $author_count[$author->ID] ) ? $author_count[$author->ID] : 0;
 304  
 305          if ( !$posts && $hide_empty )
 306              continue;
 307  
 308          $link = '';
 309  
 310          if ( $show_fullname && $author->first_name && $author->last_name )
 311              $name = "$author->first_name $author->last_name";
 312          else
 313              $name = $author->display_name;
 314  
 315          if ( !$html ) {
 316              $return .= $name . ', ';
 317  
 318              continue; // No need to go further to process HTML.
 319          }
 320  
 321          if ( 'list' == $style ) {
 322              $return .= '<li>';
 323          }
 324  
 325          $link = '<a href="' . get_author_posts_url( $author->ID, $author->user_nicename ) . '" title="' . esc_attr( sprintf(__("Posts by %s"), $author->display_name) ) . '">' . $name . '</a>';
 326  
 327          if ( !empty( $feed_image ) || !empty( $feed ) ) {
 328              $link .= ' ';
 329              if ( empty( $feed_image ) ) {
 330                  $link .= '(';
 331              }
 332  
 333              $link .= '<a href="' . get_author_feed_link( $author->ID ) . '"';
 334  
 335              $alt = $title = '';
 336              if ( !empty( $feed ) ) {
 337                  $title = ' title="' . esc_attr( $feed ) . '"';
 338                  $alt = ' alt="' . esc_attr( $feed ) . '"';
 339                  $name = $feed;
 340                  $link .= $title;
 341              }
 342  
 343              $link .= '>';
 344  
 345              if ( !empty( $feed_image ) )
 346                  $link .= '<img src="' . esc_url( $feed_image ) . '" style="border: none;"' . $alt . $title . ' />';
 347              else
 348                  $link .= $name;
 349  
 350              $link .= '</a>';
 351  
 352              if ( empty( $feed_image ) )
 353                  $link .= ')';
 354          }
 355  
 356          if ( $optioncount )
 357              $link .= ' ('. $posts . ')';
 358  
 359          $return .= $link;
 360          $return .= ( 'list' == $style ) ? '</li>' : ', ';
 361      }
 362  
 363      $return = rtrim($return, ', ');
 364  
 365      if ( !$echo )
 366          return $return;
 367  
 368      echo $return;
 369  }
 370  
 371  /**
 372   * Does this site have more than one author
 373   * 
 374   * Checks to see if more than one author has published posts.
 375   *
 376   * @since 3.2 
 377   * @return bool Whether or not we have more than one author
 378   */
 379  function is_multi_author() {
 380      global $wpdb;
 381      
 382      if ( false === ( $is_multi_author = wp_cache_get('is_multi_author', 'posts') ) ) {
 383          $rows = (array) $wpdb->get_col("SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 2");
 384          $is_multi_author = 1 < count( $rows ) ? 1 : 0;
 385          wp_cache_set('is_multi_author', $is_multi_author, 'posts');
 386      }
 387  
 388      return (bool) $is_multi_author;
 389  }
 390  
 391  /** 
 392   * Helper function to clear the cache for number of authors.
 393   * 
 394   * @private
 395   */
 396  function __clear_multi_author_cache() {
 397      wp_cache_delete('is_multi_author', 'posts');
 398  }
 399  add_action('transition_post_status', '__clear_multi_author_cache');
 400  
 401  ?>