X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/67f24b02807a1ff7e9d1a97453ed84c404c0af0f..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/author-template.php
diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php
index 908e2335..36d08bc8 100644
--- a/wp-includes/author-template.php
+++ b/wp-includes/author-template.php
@@ -4,7 +4,7 @@
*
* These functions must be used within the WordPress Loop.
*
- * @link http://codex.wordpress.org/Author_Templates
+ * @link https://codex.wordpress.org/Author_Templates
*
* @package WordPress
* @subpackage Template
@@ -13,16 +13,27 @@
/**
* 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.
+ * @since 1.5.0
+ *
+ * @global object $authordata The current author's DB object.
*
* @param string $deprecated Deprecated.
- * @return string The author's display name.
+ * @return string|null 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,17 +45,21 @@ 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
+ * @link https://codex.wordpress.org/Template_Tags/the_author
*
* @param string $deprecated Deprecated.
- * @param string $deprecated_echo Echo the string or return it.
- * @return string The author's display name, from get_the_author().
+ * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.
+ * @return string|null 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();
@@ -53,27 +68,32 @@ function the_author($deprecated = '', $deprecated_echo = true) {
/**
* Retrieve the author who last edited the current post.
*
- * @since 2.8
- * @uses $post The current post's DB object.
- * @uses get_post_meta() Retrieves the ID of the author who last edited the current post.
- * @uses get_userdata() Retrieves the author's DB object.
- * @uses apply_filters() Calls 'the_modified_author' hook on the author display name.
- * @return string The author's display name.
+ * @since 2.8.0
+ *
+ * @return string|void The author's display name.
*/
function get_the_modified_author() {
- global $post;
- if ( $last_id = get_post_meta($post->ID, '_edit_last', true) ) {
+ 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);
}
}
/**
- * Display the name of the author who last edited the current post.
+ * Display the name of the author who last edited the current post,
+ * if the author's ID is available.
+ *
+ * @since 2.8.0
*
- * @since 2.8
* @see get_the_author()
- * @return string The author's display name, from get_the_modified_author().
*/
function the_modified_author() {
echo get_the_modified_author();
@@ -81,82 +101,122 @@ function the_modified_author() {
/**
* Retrieve the requested data of the author of the current post.
- * @link http://codex.wordpress.org/Template_Tags/the_author_meta
+ * @link https://codex.wordpress.org/Template_Tags/the_author_meta
* @since 2.8.0
- * @uses $authordata The current author's DB object (if $user_id not specified).
+ *
+ * @global object $authordata The current author's DB object.
+ *
* @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_meta($field = '', $user_id = false) {
- if ( ! $user_id )
+function get_the_author_meta( $field = '', $user_id = false ) {
+ $original_user_id = $user_id;
+
+ if ( ! $user_id ) {
global $authordata;
- else
+ $user_id = isset( $authordata->ID ) ? $authordata->ID : 0;
+ } else {
$authordata = get_userdata( $user_id );
+ }
- $field = strtolower($field);
- $user_field = "user_$field";
-
- if ( 'id' == $field )
- $value = isset($authordata->ID) ? (int)$authordata->ID : 0;
- elseif ( isset($authordata->$user_field) )
- $value = $authordata->$user_field;
- else
- $value = isset($authordata->$field) ? $authordata->$field : '';
-
- return apply_filters('get_the_author_' . $field, $value);
+ if ( in_array( $field, array( 'login', 'pass', 'nicename', 'email', 'url', 'registered', 'activation_key', 'status' ) ) )
+ $field = 'user_' . $field;
+
+ $value = isset( $authordata->$field ) ? $authordata->$field : '';
+
+ /**
+ * 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
+ * @since 4.3.0 The `$original_user_id` parameter was added.
+ *
+ * @param string $value The value of the metadata.
+ * @param int $user_id The user ID for the value.
+ * @param int|bool $original_user_id The original user ID, as passed to the function.
+ */
+ return apply_filters( 'get_the_author_' . $field, $value, $user_id, $original_user_id );
}
/**
- * Retrieve the requested data of the author of the current post.
- * @link http://codex.wordpress.org/Template_Tags/the_author_meta
+ * Outputs the field from the user's DB object. Defaults to current post's author.
+ *
+ * @link https://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 the_author_meta($field = '', $user_id = false) {
- echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id));
+function the_author_meta( $field = '', $user_id = false ) {
+ $author_meta = get_the_author_meta( $field, $user_id );
+
+ /**
+ * 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 either author's link or author's name.
+ * Retrieve either author's link or author's name.
*
- * If the author has a home page set, echo an HTML link, otherwise just echo the
+ * If the author has a home page set, return an HTML link, otherwise just return the
* author's name.
*
- * @link http://codex.wordpress.org/Template_Tags/the_author_link
- * @since 2.1
- * @uses get_the_author_meta()
- * @uses the_author()
+ * @return string|null An HTML link if the author's url exist in user meta,
+ * else the result of get_the_author().
*/
-function the_author_link() {
+function get_the_author_link() {
if ( get_the_author_meta('url') ) {
- echo '' . get_the_author() . '';
+ return '' . get_the_author() . '';
} else {
- the_author();
+ return get_the_author();
}
}
+/**
+ * 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 https://codex.wordpress.org/Template_Tags/the_author_link
+ *
+ * @since 2.1.0
+ */
+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, $post->post_type );
}
/**
* Display the number of posts by the author of the current post.
*
- * @link http://codex.wordpress.org/Template_Tags/the_author_posts
+ * @link https://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();
@@ -169,28 +229,46 @@ function the_author_posts() {
* 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
+ * @link https://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()
+ *
+ * @global object $authordata The current author's DB object.
+ *
* @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 ),
+ if ( ! is_object( $authordata ) ) {
+ return;
+ }
+
+ $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
+ *
+ * @global WP_Rewrite $wp_rewrite
+ *
* @return string The URL to the author's page.
*/
function get_author_posts_url($author_id, $author_nicename = '') {
@@ -199,7 +277,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 ) {
@@ -208,10 +286,19 @@ 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;
}
@@ -219,123 +306,172 @@ function get_author_posts_url($author_id, $author_nicename = '') {
/**
* List all the authors of the blog, with several options available.
*
- *