<?php
+/**
+ * Author Template functions for use in themes.
+ *
+ * These functions must be used within the WordPress Loop.
+ *
+ * @link http://codex.wordpress.org/Author_Templates
+ *
+ * @package WordPress
+ * @subpackage Template
+ */
/**
- * Get the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
+ * Retrieve the author of the current post.
+ *
+ * @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.
*/
}
/**
- * Echo the name of the author of the current post in the Loop.
+ * 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 compatiability 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. Deprecated, use get_the_author().
+ * @param string $deprecated_echo Echo the string or return it.
* @return string The author's display name, from get_the_author().
*/
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.
+ * 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() {
}
/**
- * Echo the description of the author of the current post in the Loop.
+ * 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()
- * @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.
+ * 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() {
}
/**
- * Echo the login name of the author of the current post in the Loop.
+ * 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()
- * @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.
+ * Retrieve the first name of the author of 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() {
}
/**
- * Echo the first name of the author of the current post in the Loop.
- * @see get_the_author_firstname()
- * @return null
+ * 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();
}
/**
- * Get the last name of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
+ * 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() {
}
/**
- * Echo the last name of the author of the current post in the Loop.
- * @see get_the_author_lastname()
- * @return null
+ * 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()
*/
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.
+ * Retrieve the nickname of the author of the current post.
+ *
+ * @since 1.5
+ * @uses $authordata The current author's DB object.
* @return string The author's nickname.
*/
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
+ * 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()
*/
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.
+ * 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() {
}
/**
- * Echo the ID of the author of the current post in the Loop.
- * @see get_the_author_ID()
- * @return null
+ * 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();
}
/**
- * Get the email of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
+ * 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() {
}
/**
- * Echo the email of the author of the current post in the Loop.
- * @see get_the_author_email()
- * @return null
+ * 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()
*/
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.
+ * Retrieve the URL to the home page of the author of the current post.
+ *
+ * @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() {
}
/**
- * Echo the URL to the home page of the author of the current post in the Loop.
- * @see get_the_author_url()
- * @return null
+ * Display the URL to the home page of the author of the current post.
+ *
+ * @link http://codex.wordpress.org/Template_Tags/the_author_url
+ * @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
+ * 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.
+ *
+ * @link http://codex.wordpress.org/Template_Tags/the_author_link
+ * @since 2.1
+ * @uses get_the_author_url()
+ * @uses the_author()
*/
function the_author_link() {
if (get_the_author_url()) {
}
/**
- * Get the ICQ number of the author of the current post in the Loop.
- * @global object $authordata The current author's DB object.
+ * 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() {
}
/**
- * Echo the ICQ number of the author of the current post in the Loop.
+ * 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()
- * @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.
+ * 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() {
}
/**
- * Echo the AIM name of the author of the current post in the Loop.
+ * 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()
- * @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.
+ * 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() {
}
/**
- * Echo the Yahoo! IM name of the author of the current post in the Loop.
+ * 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()
- * @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.
+ * 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() {
}
/**
- * Echo the MSN address of the author of the current post in the Loop.
+ * 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()
- * @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()
+ * Retrieve the number of posts by the author of the current post.
+ *
+ * @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() {
}
/**
- * Echo the number of posts by the author of the current post in the Loop.
- * @see get_the_author_posts()
- * @return null
+ * Display the number of posts by the author of the current post.
+ *
+ * @link http://codex.wordpress.org/Template_Tags/the_author_posts
+ * @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
+ * 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.
+ *
+ * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
+ * @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(
}
/**
- * 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.
+ * Retrieve the URL to the author page of the author of the current post.
+ *
+ * @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();
}
/**
- * Get the specified author's preferred display name.
+ * 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.
*/
/**
* 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.
+ *
+ * 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.
+ *
+ * @link http://codex.wordpress.org/Template_Tags/wp_list_authors
+ * @since 1.2
* @param array $args The argument array.
* @return null|string The output, if echo is set to false.
*/
$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 );
$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();
$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;
echo $return;
}
-?>
\ No newline at end of file
+?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff