[ Index ]

WordPress Cross Reference

title

Body

[close]

/wp-includes/ -> author-template.php (summary)

Author Template functions for use in themes. These functions must be used within the WordPress Loop.

File Size: 453 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 15 functions

  get_the_author()
  the_author()
  get_the_modified_author()
  the_modified_author()
  get_the_author_meta()
  the_author_meta()
  get_the_author_link()
  the_author_link()
  get_the_author_posts()
  the_author_posts()
  the_author_posts_link()
  get_author_posts_url()
  wp_list_authors()
  is_multi_author()
  __clear_multi_author_cache()

Functions
Functions that are not part of a class:

get_the_author($deprecated = '')   X-Ref
Retrieve the author of the current post.

param: string $deprecated Deprecated.
return: string The author's display name.

the_author( $deprecated = '', $deprecated_echo = true )   X-Ref
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 compatibility has to be maintained.

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().

get_the_modified_author()   X-Ref
Retrieve the author who last edited the current post.

return: string The author's display name.

the_modified_author()   X-Ref
Display the name of the author who last edited the current post.

return: string The author's display name, from get_the_modified_author().

get_the_author_meta( $field = '', $user_id = false )   X-Ref
Retrieve the requested data of the author of the current post.

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.

the_author_meta( $field = '', $user_id = false )   X-Ref
Retrieve the requested data of the author of the current post.

param: string $field selects the field of the users record.
param: int $user_id Optional. User ID.

get_the_author_link()   X-Ref
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.


the_author_link()   X-Ref
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.


get_the_author_posts()   X-Ref
Retrieve the number of posts by the author of the current post.

return: int The number of posts by the author.

the_author_posts()   X-Ref
Display the number of posts by the author of the current post.


the_author_posts_link($deprecated = '')   X-Ref
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.

param: string $deprecated Deprecated.

get_author_posts_url($author_id, $author_nicename = '')   X-Ref
Retrieve the URL to the author page for the user with the ID provided.

return: string The URL to the author's page.

wp_list_authors($args = '')   X-Ref
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>
</ul>

param: array $args The argument array.
return: null|string The output, if echo is set to false.

is_multi_author()   X-Ref
Does this site have more than one author

Checks to see if more than one author has published posts.

return: bool Whether or not we have more than one author

__clear_multi_author_cache()   X-Ref
Helper function to clear the cache for number of authors.




Generated: Tue Mar 25 01:41:18 2014 WordPress honlapkészítés: online1.hu