diff options
author | donncha <donncha@7be80a69-a1ef-0310-a953-fb0f7c49ff36> | 2008-04-04 16:44:15 +0000 |
---|---|---|
committer | donncha <donncha@7be80a69-a1ef-0310-a953-fb0f7c49ff36> | 2008-04-04 16:44:15 +0000 |
commit | 7740e89de3e1bc0cc636120e3ca8ab9e97e4d3cc (patch) | |
tree | c6fd23b598f3994eddb18cb1c0f2e8d95ff054fa /wp-includes/author-template.php | |
parent | f650f48c048bfbbb2ae702b6425d87e39358d748 (diff) | |
download | wordpress-mu-7740e89de3e1bc0cc636120e3ca8ab9e97e4d3cc.tar.gz wordpress-mu-7740e89de3e1bc0cc636120e3ca8ab9e97e4d3cc.tar.xz wordpress-mu-7740e89de3e1bc0cc636120e3ca8ab9e97e4d3cc.zip |
Merged with WordPress 2.5, unstable, only for testing
git-svn-id: http://svn.automattic.com/wordpress-mu/trunk@1218 7be80a69-a1ef-0310-a953-fb0f7c49ff36
Diffstat (limited to 'wp-includes/author-template.php')
-rw-r--r-- | wp-includes/author-template.php | 236 |
1 files changed, 153 insertions, 83 deletions
diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php index 57bc3a9..795258d 100644 --- a/wp-includes/author-template.php +++ b/wp-includes/author-template.php @@ -1,8 +1,18 @@ <?php +/** + * Author Template functions for use in themes. + * + * @package WordPress + * @subpackage Template + */ /** - * Get the author of the current post in the Loop. - * @global object $authordata The current author's DB object. + * get_the_author() - Get the author of the current post in the Loop. + * + * @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. */ @@ -12,8 +22,19 @@ function get_the_author($deprecated = '') { } /** - * Echo the name of the author of the current post in the Loop. + * the_author() - Echo the name of the author of the current post in the Loop. + * + * 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() + * * @param string $deprecated Deprecated. * @param string $deprecated_echo Echo the string or return it. Deprecated, use get_the_author(). * @return string The author's display name, from get_the_author(). @@ -25,8 +46,10 @@ function the_author($deprecated = '', $deprecated_echo = true) { } /** - * Get the description of the author of the current post in the Loop. - * @global object $authordata The current author's DB object. + * get_the_author_description() - Get the description of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's description. */ function get_the_author_description() { @@ -35,17 +58,20 @@ function get_the_author_description() { } /** - * Echo the description of the author of the current post in the Loop. + * the_author_description() - Echo the description of the author of the current post in the Loop. + * + * @since 1.0.0 * @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. + * get_the_author_login() - Get the login name of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's login name (username). */ function get_the_author_login() { @@ -54,17 +80,20 @@ function get_the_author_login() { } /** - * Echo the login name of the author of the current post in the Loop. + * the_author_login() - Echo the login name of the author of the current post in the Loop. + * + * @since 0.71 * @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. + * get_the_author_firstname() - Get the first name of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's first name. */ function get_the_author_firstname() { @@ -73,17 +102,20 @@ function get_the_author_firstname() { } /** - * Echo the first name of the author of the current post in the Loop. - * @see get_the_author_firstname() - * @return null + * the_author_firstname() - Echo the first name of the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_firstname() */ 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. + * get_the_author_lastname() - Get the last name of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's last name. */ function get_the_author_lastname() { @@ -92,17 +124,20 @@ function get_the_author_lastname() { } /** - * Echo the last name of the author of the current post in the Loop. - * @see get_the_author_lastname() - * @return null + * the_author_lastname() - Echo the last name of the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_lastname() */ 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. + * get_the_author_nickname() - Get the nickname of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's nickname. */ function get_the_author_nickname() { @@ -111,17 +146,20 @@ function get_the_author_nickname() { } /** - * Echo the nickname of the author of the current post in the Loop. - * @see get_the_author_nickname() - * @return null + * the_author_nickname() - Echo the nickname of the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_nickname() */ 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. + * get_the_author_ID() - Get the ID of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return int The author's ID. */ function get_the_author_ID() { @@ -130,17 +168,20 @@ function get_the_author_ID() { } /** - * Echo the ID of the author of the current post in the Loop. - * @see get_the_author_ID() - * @return null + * the_author_ID() - Echo the ID of the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_ID() */ function the_author_ID() { echo get_the_author_id(); } /** - * Get the email of the author of the current post in the Loop. - * @global object $authordata The current author's DB object. + * get_the_author_email() - Get the email of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's username. */ function get_the_author_email() { @@ -149,17 +190,20 @@ function get_the_author_email() { } /** - * Echo the email of the author of the current post in the Loop. - * @see get_the_author_email() - * @return null + * the_author_email() - Echo the email of the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_email() */ function the_author_email() { echo apply_filters('the_author_email', get_the_author_email() ); } /** - * 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. + * get_the_author_url() - Get the URL to the home page of the author of the current post in the Loop. + * + * @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() { @@ -172,19 +216,21 @@ function get_the_author_url() { } /** - * Echo the URL to the home page of the author of the current post in the Loop. - * @see get_the_author_url() - * @return null + * the_author_url() - Echo the URL to the home page of the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_url() */ function the_author_url() { echo get_the_author_url(); } /** - * 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 + * the_author_link() - If the author has a home page set, echo an HTML link, otherwise just echo the author's name. + * + * @since 2.1 + * @uses get_the_author_url() + * @uses the_author() */ function the_author_link() { if (get_the_author_url()) { @@ -195,8 +241,10 @@ function the_author_link() { } /** - * Get the ICQ number of the author of the current post in the Loop. - * @global object $authordata The current author's DB object. + * get_the_author_icq() - Get the ICQ number of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's ICQ number. */ function get_the_author_icq() { @@ -205,17 +253,20 @@ function get_the_author_icq() { } /** - * Echo the ICQ number of the author of the current post in the Loop. + * the_author_icq() - Echo the ICQ number of the author of the current post in the Loop. + * + * @since 0.71 * @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. + * get_the_author_aim() - Get the AIM name of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's AIM name. */ function get_the_author_aim() { @@ -224,17 +275,20 @@ function get_the_author_aim() { } /** - * Echo the AIM name of the author of the current post in the Loop. + * the_author_aim() - Echo the AIM name of the author of the current post in the Loop. + * + * @since 0.71 * @see get_the_author_aim() - * @return null */ 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. + * get_the_author_yim() - Get the Yahoo! IM name of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's Yahoo! IM name. */ function get_the_author_yim() { @@ -243,17 +297,20 @@ function get_the_author_yim() { } /** - * Echo the Yahoo! IM name of the author of the current post in the Loop. + * the_author_yim() - Echo the Yahoo! IM name of the author of the current post in the Loop. + * + * @since 0.71 * @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. + * get_the_author_msn() - Get the MSN address of the author of the current post in the Loop. + * + * @since 1.5 + * @uses $authordata The current author's DB object. * @return string The author's MSN address. */ function get_the_author_msn() { @@ -262,18 +319,21 @@ function get_the_author_msn() { } /** - * Echo the MSN address of the author of the current post in the Loop. + * the_author_msn() - Echo the MSN address of the author of the current post in the Loop. + * + * @since 0.71 * @see get_the_author_msn() - * @return null */ function the_author_msn() { echo get_the_author_msn(); } /** - * 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() + * get_the_author_posts() - Get the number of posts by the author of the current post in the Loop. + * + * @since 1.5 + * @uses $post The current post in the Loop's DB object. + * @uses get_usernumposts() * @return int The number of posts by the author. */ function get_the_author_posts() { @@ -282,22 +342,27 @@ function get_the_author_posts() { } /** - * Echo the number of posts by the author of the current post in the Loop. - * @see get_the_author_posts() - * @return null + * the_author_posts() - Echo the number of posts by the author of the current post in the Loop. + * + * @since 0.71 + * @uses get_the_author_posts() Echos 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 + * the_author_posts_link() - Echo an HTML link to the author page of the author of the current post in the Loop. + * + * 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. + * + * @since 1.2 + * @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 = '') { global $authordata; printf( @@ -309,14 +374,14 @@ function the_author_posts_link($deprecated = '') { } /** - * 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. + * get_author_posts_url() - Get the URL to the author page of the author of the current post in the Loop. + * + * @since 2.1 + * @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(); @@ -339,7 +404,9 @@ function get_author_posts_url($author_id, $author_nicename = '') { } /** - * Get the specified author's preferred display name. + * get_author_name() - Get 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. */ @@ -349,7 +416,8 @@ function get_author_name( $auth_id ) { } /** - * List all the authors of the blog, with several options available. + * wp_list_authors() - 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. @@ -357,6 +425,8 @@ function get_author_name( $auth_id ) { * 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. + * + * @since 1.2 * @param array $args The argument array. * @return null|string The output, if echo is set to false. */ @@ -366,7 +436,7 @@ function wp_list_authors($args = '') { $defaults = array( 'optioncount' => false, 'exclude_admin' => true, 'show_fullname' => false, 'hide_empty' => true, - 'feed' => '', 'feed_image' => '', 'echo' => true + 'feed' => '', 'feed_image' => '', 'feed_type' => '', 'echo' => true ); $r = wp_parse_args( $args, $defaults ); @@ -374,7 +444,7 @@ function wp_list_authors($args = '') { $return = ''; - // TODO: Move select to get_authors(). + /** @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"); $author_count = array(); @@ -414,7 +484,7 @@ function wp_list_authors($args = '') { $link .= '>'; if ( !empty($feed_image) ) - $link .= "<img src=\"$feed_image\" border=\"0\"$alt$title" . ' />'; + $link .= "<img src=\"$feed_image\" style=\"border: none;\"$alt$title" . ' />'; else $link .= $name; |