--- a/wp/wp-includes/author-template.php Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-includes/author-template.php Mon Oct 14 17:39:30 2019 +0200
@@ -15,19 +15,19 @@
*
* @since 1.5.0
*
- * @uses $authordata The current author's DB object.
+ * @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;
if ( !empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '2.1' );
+ _deprecated_argument( __FUNCTION__, '2.1.0' );
/**
- * Filter the display name of the current post's author.
+ * Filters the display name of the current post's author.
*
* @since 2.9.0
*
@@ -45,7 +45,7 @@
* 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.
+ * return it. However, backward compatibility has to be maintained.
*
* @since 0.71
* @see get_the_author()
@@ -53,15 +53,26 @@
*
* @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().
+ * @return string|null The author's display name, from get_the_author().
*/
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 <code>get_the_author()</code> instead if you do not want the value echoed.') );
- if ( $deprecated_echo )
+ if ( ! empty( $deprecated ) ) {
+ _deprecated_argument( __FUNCTION__, '2.1.0' );
+ }
+
+ if ( true !== $deprecated_echo ) {
+ _deprecated_argument( __FUNCTION__, '1.5.0',
+ /* translators: %s: get_the_author() */
+ sprintf( __( 'Use %s instead if you do not want the value echoed.' ),
+ '<code>get_the_author()</code>'
+ )
+ );
+ }
+
+ if ( $deprecated_echo ) {
echo get_the_author();
+ }
+
return get_the_author();
}
@@ -70,14 +81,14 @@
*
* @since 2.8.0
*
- * @return string The author's display name.
+ * @return string|void The author's display name.
*/
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.
+ * Filters the display name of the author who last edited the current post.
*
* @since 2.8.0
*
@@ -88,26 +99,61 @@
}
/**
- * 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
*
* @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();
}
/**
- * Retrieve the requested data of the author of the current post.
- * @link https://codex.wordpress.org/Template_Tags/the_author_meta
+ * Retrieves the requested data of the author of the current post.
+ *
+ * Valid values for the `$field` parameter include:
+ *
+ * - admin_color
+ * - aim
+ * - comment_shortcuts
+ * - description
+ * - display_name
+ * - first_name
+ * - ID
+ * - jabber
+ * - last_name
+ * - nickname
+ * - plugins_last_view
+ * - plugins_per_page
+ * - rich_editing
+ * - syntax_highlighting
+ * - user_activation_key
+ * - user_description
+ * - user_email
+ * - user_firstname
+ * - user_lastname
+ * - user_level
+ * - user_login
+ * - user_nicename
+ * - user_pass
+ * - user_registered
+ * - user_status
+ * - user_url
+ * - yim
+ *
* @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.
+ *
+ * @global object $authordata The current author's DB object.
+ *
+ * @param string $field Optional. The user field to retrieve. Default empty.
+ * @param int $user_id Optional. User ID.
+ * @return string The author's field from the current author's DB object, otherwise an empty string.
*/
function get_the_author_meta( $field = '', $user_id = false ) {
+ $original_user_id = $user_id;
+
if ( ! $user_id ) {
global $authordata;
$user_id = isset( $authordata->ID ) ? $authordata->ID : 0;
@@ -121,25 +167,30 @@
$value = isset( $authordata->$field ) ? $authordata->$field : '';
/**
- * Filter the value of the requested user metadata.
+ * Filters 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.
+ * @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 );
+ 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 https://codex.wordpress.org/Template_Tags/the_author_meta
+ * Outputs the field from the user's DB object. Defaults to current post's author.
+ *
* @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.
+ *
+ * @param string $field Selects the field of the users record. See get_the_author_meta()
+ * for the list of possible fields.
+ * @param int $user_id Optional. User ID.
+ *
+ * @see get_the_author_meta()
*/
function the_author_meta( $field = '', $user_id = false ) {
$author_meta = get_the_author_meta( $field, $user_id );
@@ -154,7 +205,7 @@
* @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 );
+ echo apply_filters( "the_author_{$field}", $author_meta, $user_id );
}
/**
@@ -162,10 +213,20 @@
*
* If the author has a home page set, return an HTML link, otherwise just return the
* author's name.
+ *
+ * @since 3.0.0
+ *
+ * @return string|null An HTML link if the author's url exist in user meta,
+ * else the result of get_the_author().
*/
function get_the_author_link() {
if ( get_the_author_meta('url') ) {
- return '<a href="' . esc_url( get_the_author_meta('url') ) . '" title="' . esc_attr( sprintf(__("Visit %s’s website"), get_the_author()) ) . '" rel="author external">' . get_the_author() . '</a>';
+ return sprintf( '<a href="%1$s" title="%2$s" rel="author external">%3$s</a>',
+ esc_url( get_the_author_meta('url') ),
+ /* translators: %s: author's display name */
+ esc_attr( sprintf( __( 'Visit %s’s website' ), get_the_author() ) ),
+ get_the_author()
+ );
} else {
return get_the_author();
}
@@ -211,48 +272,66 @@
}
/**
- * Display an HTML link to the author page of the author of the current post.
+ * Retrieves an HTML link to the author page of the current post's author.
+ *
+ * Returns an HTML-formatted link using get_author_posts_url().
*
- * 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 4.4.0
*
- * @link https://codex.wordpress.org/Template_Tags/the_author_posts_link
- * @since 1.2.0
- * @param string $deprecated Deprecated.
+ * @global object $authordata The current author's DB object.
+ *
+ * @return string An HTML link to the author page.
*/
-function the_author_posts_link($deprecated = '') {
- if ( !empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '2.1' );
-
+function get_the_author_posts_link() {
global $authordata;
- if ( !is_object( $authordata ) )
- return false;
- $link = sprintf(
- '<a href="%1$s" title="%2$s" rel="author">%3$s</a>',
+ if ( ! is_object( $authordata ) ) {
+ return;
+ }
+
+ $link = sprintf( '<a href="%1$s" title="%2$s" rel="author">%3$s</a>',
esc_url( get_author_posts_url( $authordata->ID, $authordata->user_nicename ) ),
+ /* translators: %s: author's display name */
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.
+ * Filters 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 );
+ return apply_filters( 'the_author_posts_link', $link );
+}
+
+/**
+ * Displays an HTML link to the author page of the current post's author.
+ *
+ * @since 1.2.0
+ * @since 4.4.0 Converted into a wrapper for get_the_author_posts_link()
+ *
+ * @param string $deprecated Unused.
+ */
+function the_author_posts_link( $deprecated = '' ) {
+ if ( ! empty( $deprecated ) ) {
+ _deprecated_argument( __FUNCTION__, '2.1.0' );
+ }
+ echo get_the_author_posts_link();
}
/**
* 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
+ *
+ * @param int $author_id Author ID.
+ * @param string $author_nicename Optional. The author's nicename (slug). Default empty.
* @return string The URL to the author's page.
*/
-function get_author_posts_url($author_id, $author_nicename = '') {
+function get_author_posts_url( $author_id, $author_nicename = '' ) {
global $wp_rewrite;
$auth_ID = (int) $author_id;
$link = $wp_rewrite->get_author_permastruct();
@@ -271,7 +350,7 @@
}
/**
- * Filter the URL to the author's page.
+ * Filters the URL to the author's page.
*
* @since 2.1.0
*
@@ -285,37 +364,39 @@
}
/**
- * List all the authors of the blog, with several options available.
+ * List all the authors of the site, with several options available.
*
* @link https://codex.wordpress.org/Template_Tags/wp_list_authors
*
* @since 1.2.0
*
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @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 `<li>` element, otherwise the authors
- * will be separated by commas.
- * @type bool $html Whether to list the items in HTML form or plaintext. Default true.
- * @type string $exclude An array, comma-, or space-separated list of author IDs to exclude. Default empty.
- * @type string $exclude An array, comma-, or space-separated list of author IDs to include. Default empty.
+ * @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 `<li>` element, otherwise the authors
+ * will be separated by commas.
+ * @type bool $html Whether to list the items in HTML form or plaintext. Default true.
+ * @type array|string $exclude Array or comma/space-separated list of author IDs to exclude. Default empty.
+ * @type array|string $include Array or comma/space-separated list of author IDs to include. Default empty.
* }
- * @return null|string The output, if echo is set to false. Otherwise null.
+ * @return string|void The output, if echo is set to false.
*/
function wp_list_authors( $args = '' ) {
global $wpdb;
@@ -369,7 +450,12 @@
$return .= '<li>';
}
- $link = '<a href="' . get_author_posts_url( $author->ID, $author->user_nicename ) . '" title="' . esc_attr( sprintf(__("Posts by %s"), $author->display_name) ) . '">' . $name . '</a>';
+ $link = sprintf( '<a href="%1$s" title="%2$s">%3$s</a>',
+ get_author_posts_url( $author->ID, $author->user_nicename ),
+ /* translators: %s: author's display name */
+ esc_attr( sprintf( __( 'Posts by %s' ), $author->display_name ) ),
+ $name
+ );
if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
$link .= ' ';
@@ -422,6 +508,9 @@
* Checks to see if more than one author has published posts.
*
* @since 3.2.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @return bool Whether or not we have more than one author
*/
function is_multi_author() {
@@ -434,7 +523,7 @@
}
/**
- * Filter whether the site has more than one author with published posts.
+ * Filters whether the site has more than one author with published posts.
*
* @since 3.2.0
*
@@ -446,7 +535,8 @@
/**
* Helper function to clear the cache for number of authors.
*
- * @private
+ * @since 3.2.0
+ * @access private
*/
function __clear_multi_author_cache() {
delete_transient( 'is_multi_author' );