X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/449d082fcc4873c1f7d363a0d9f7409be7f6e77d..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-includes/author-template.php
diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php
index 7cc6291c..2280487d 100644
--- a/wp-includes/author-template.php
+++ b/wp-includes/author-template.php
@@ -13,16 +13,27 @@
/**
* Retrieve the author of the current post.
*
- * @since 1.5
+ * @since 1.5.0
+ *
* @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.
*/
function get_the_author($deprecated = '') {
global $authordata;
- return apply_filters('the_author', $authordata->display_name);
+
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '2.1' );
+
+ /**
+ * Filter the display name of the current post's author.
+ *
+ * @since 2.9.0
+ *
+ * @param string $authordata->display_name The author's display name.
+ */
+ return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null);
}
/**
@@ -34,208 +45,130 @@ function get_the_author($deprecated = '') {
* 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.
+ * return it. However, backwards compatibility 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.
+ * @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().
*/
-function the_author($deprecated = '', $deprecated_echo = true) {
+function the_author( $deprecated = '', $deprecated_echo = true ) {
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '2.1' );
+ if ( $deprecated_echo !== true )
+ _deprecated_argument( __FUNCTION__, '1.5', __('Use get_the_author()
instead if you do not want the value echoed.') );
if ( $deprecated_echo )
echo get_the_author();
return get_the_author();
}
/**
- * 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() {
- global $authordata;
- return $authordata->description;
-}
-
-/**
- * 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()
- */
-function the_author_description() {
- echo get_the_author_description();
-}
-
-/**
- * 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() {
- global $authordata;
- return $authordata->user_login;
-}
-
-/**
- * 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()
- */
-function the_author_login() {
- echo get_the_author_login();
-}
-
-/**
- * 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() {
- global $authordata;
- return $authordata->first_name;
-}
-
-/**
- * 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();
-}
-
-/**
- * Retrieve the last name of the author of the current post.
+ * Retrieve the author who last edited 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() {
- global $authordata;
- return $authordata->last_name;
-}
-
-/**
- * Display the last name of the author of the current post.
+ * @since 2.8.0
*
- * @link http://codex.wordpress.org/Template_Tags/the_author_lastname
- * @since 0.71
- * @uses get_the_author_lastname()
+ * @return string The author's display name.
*/
-function the_author_lastname() {
- echo get_the_author_lastname();
+function get_the_modified_author() {
+ if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) {
+ $last_user = get_userdata($last_id);
+
+ /**
+ * Filter the display name of the author who last edited the current post.
+ *
+ * @since 2.8.0
+ *
+ * @param string $last_user->display_name The author's display name.
+ */
+ return apply_filters('the_modified_author', $last_user->display_name);
+ }
}
/**
- * Retrieve the nickname of the author of the current post.
+ * Display the name of the author who last edited 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() {
- global $authordata;
- return $authordata->nickname;
-}
-
-/**
- * Display the nickname of the author of the current post.
+ * @since 2.8.0
*
- * @link http://codex.wordpress.org/Template_Tags/the_author_nickname
- * @since 0.71
- * @uses get_the_author_nickname()
+ * @see get_the_author()
+ * @return string The author's display name, from get_the_modified_author().
*/
-function the_author_nickname() {
- echo get_the_author_nickname();
+function the_modified_author() {
+ echo get_the_modified_author();
}
/**
- * 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.
+ * Retrieve the requested data of the author of the current post.
+ * @link http://codex.wordpress.org/Template_Tags/the_author_meta
+ * @since 2.8.0
+ * @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.
*/
-function get_the_author_ID() {
- global $authordata;
- return (int) $authordata->ID;
-}
+function get_the_author_meta( $field = '', $user_id = false ) {
+ if ( ! $user_id ) {
+ global $authordata;
+ $user_id = isset( $authordata->ID ) ? $authordata->ID : 0;
+ } else {
+ $authordata = get_userdata( $user_id );
+ }
-/**
- * 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();
-}
+ if ( in_array( $field, array( 'login', 'pass', 'nicename', 'email', 'url', 'registered', 'activation_key', 'status' ) ) )
+ $field = 'user_' . $field;
-/**
- * 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() {
- global $authordata;
- return $authordata->user_email;
-}
+ $value = isset( $authordata->$field ) ? $authordata->$field : '';
-/**
- * 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() );
+ /**
+ * Filter the value of the requested user metadata.
+ *
+ * The filter name is dynamic and depends on the $field parameter of the function.
+ *
+ * @since 2.8.0
+ *
+ * @param string $value The value of the metadata.
+ * @param int $user_id The user ID.
+ */
+ return apply_filters( 'get_the_author_' . $field, $value, $user_id );
}
/**
- * 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.
+ * Retrieve the requested data of the author of the current post.
+ * @link http://codex.wordpress.org/Template_Tags/the_author_meta
+ * @since 2.8.0
+ * @param string $field selects the field of the users record.
+ * @param int $user_id Optional. User ID.
+ * @echo string The author's field from the current author's DB object.
*/
-function get_the_author_url() {
- global $authordata;
-
- if ( 'http://' == $authordata->user_url )
- return '';
+function the_author_meta( $field = '', $user_id = false ) {
+ $author_meta = get_the_author_meta( $field, $user_id );
- return $authordata->user_url;
+ /**
+ * The value of the requested user metadata.
+ *
+ * The filter name is dynamic and depends on the $field parameter of the function.
+ *
+ * @since 2.8.0
+ *
+ * @param string $author_meta The value of the metadata.
+ * @param int $user_id The user ID.
+ */
+ echo apply_filters( 'the_author_' . $field, $author_meta, $user_id );
}
/**
- * Display the URL to the home page of the author of the current post.
+ * Retrieve either author's link or author's name.
*
- * @link http://codex.wordpress.org/Template_Tags/the_author_url
- * @since 0.71
- * @uses get_the_author_url()
+ * If the author has a home page set, return an HTML link, otherwise just return the
+ * author's name.
*/
-function the_author_url() {
- echo get_the_author_url();
+function get_the_author_link() {
+ if ( get_the_author_meta('url') ) {
+ return '' . get_the_author() . '';
+ } else {
+ return get_the_author();
+ }
}
/**
@@ -245,121 +178,26 @@ function the_author_url() {
* 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()) {
- echo '' . get_the_author() . '';
- } else {
- the_author();
- }
-}
-
-/**
- * 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() {
- global $authordata;
- return $authordata->icq;
-}
-
-/**
- * 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()
- */
-function the_author_icq() {
- echo get_the_author_icq();
-}
-
-/**
- * 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() {
- global $authordata;
- return str_replace(' ', '+', $authordata->aim);
-}
-
-/**
- * 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()
- */
-function the_author_aim() {
- echo get_the_author_aim();
-}
-
-/**
- * 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() {
- global $authordata;
- return $authordata->yim;
-}
-
-/**
- * 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()
- */
-function the_author_yim() {
- echo get_the_author_yim();
-}
-
-/**
- * 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() {
- global $authordata;
- return $authordata->msn;
-}
-
-/**
- * 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()
+ * @since 2.1.0
*/
-function the_author_msn() {
- echo get_the_author_msn();
+function the_author_link() {
+ echo get_the_author_link();
}
/**
* 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()
+ * @since 1.5.0
+ *
* @return int The number of posts by the author.
*/
function get_the_author_posts() {
- global $post;
- return get_usernumposts($post->post_author);
+ $post = get_post();
+ if ( ! $post ) {
+ return 0;
+ }
+ return count_user_posts( $post->post_author );
}
/**
@@ -367,7 +205,6 @@ function get_the_author_posts() {
*
* @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();
@@ -382,23 +219,34 @@ function the_author_posts() {
*
* @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
* @since 1.2.0
- * @uses $authordata The current author's DB object.
- * @uses get_author_posts_url()
- * @uses get_the_author()
* @param string $deprecated Deprecated.
*/
function the_author_posts_link($deprecated = '') {
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '2.1' );
+
global $authordata;
- printf(
- '%3$s',
- get_author_posts_url( $authordata->ID, $authordata->user_nicename ),
- sprintf( __( 'Posts by %s' ), attribute_escape( get_the_author() ) ),
+ if ( !is_object( $authordata ) )
+ return false;
+ $link = sprintf(
+ '%3$s',
+ esc_url( get_author_posts_url( $authordata->ID, $authordata->user_nicename ) ),
+ esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ),
get_the_author()
);
+
+ /**
+ * Filter the link to the author page of the author of the current post.
+ *
+ * @since 2.9.0
+ *
+ * @param string $link HTML link.
+ */
+ echo apply_filters( 'the_author_posts_link', $link );
}
/**
- * Retrieve the URL to the author page of the author of the current post.
+ * Retrieve the URL to the author page for the user with the ID provided.
*
* @since 2.1.0
* @uses $wp_rewrite WP_Rewrite
@@ -410,7 +258,7 @@ function get_author_posts_url($author_id, $author_nicename = '') {
$link = $wp_rewrite->get_author_permastruct();
if ( empty($link) ) {
- $file = get_option('home') . '/';
+ $file = home_url( '/' );
$link = $file . '?author=' . $auth_ID;
} else {
if ( '' == $author_nicename ) {
@@ -419,119 +267,188 @@ function get_author_posts_url($author_id, $author_nicename = '') {
$author_nicename = $user->user_nicename;
}
$link = str_replace('%author%', $author_nicename, $link);
- $link = get_option('home') . trailingslashit($link);
+ $link = home_url( user_trailingslashit( $link ) );
}
- $link = apply_filters('author_link', $link, $author_id, $author_nicename);
+ /**
+ * Filter the URL to the author's page.
+ *
+ * @since 2.1.0
+ *
+ * @param string $link The URL to the author's page.
+ * @param int $author_id The author's id.
+ * @param string $author_nicename The author's nice name.
+ */
+ $link = apply_filters( 'author_link', $link, $author_id, $author_nicename );
return $link;
}
-/**
- * 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.
- */
-function get_author_name( $auth_id ) {
- $authordata = get_userdata( $auth_id );
- return $authordata->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.
- * 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.0
- * @param array $args The argument array.
- * @return null|string The output, if echo is set to false.
- */
-function wp_list_authors($args = '') {
+ *
+ * @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 `