enmi-conf.org: comparison wp/wp-includes/author-template.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 /**
 * Retrieve the author of the current post.
 *
 * @since 1.5.0
 *
-* @global object $authordata The current author's DB object.
+* @global WP_User $authordata The current author's data.
 *
 * @param string $deprecated Deprecated.
 * @return string|null The author's display name.
 */
 function get_the_author( $deprecated = '' ) {
 	/**
 	 * Filters the display name of the current post's author.
 	 *
 	 * @since 2.9.0
 	 *
-	 * @param string $authordata->display_name The author's display name.
+	 * @param string|null $display_name The author's display name.
 	 */
 	return apply_filters( 'the_author', is_object( $authordata ) ? $authordata->display_name : null );
 }
 /**
 *
 * The normal, expected behavior of this function is to echo the author and not
 * return it. However, backward compatibility has to be maintained.
 *
 * @since 0.71
+*
 * @see get_the_author()
-* @link https://codex.wordpress.org/Template_Tags/the_author
+* @link https://developer.wordpress.org/reference/functions/the_author/
 *
 * @param string $deprecated      Deprecated.
 * @param bool   $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().
 */
 	if ( true !== $deprecated_echo ) {
 		_deprecated_argument(
 			__FUNCTION__,
 			'1.5.0',
-			/* translators: %s: get_the_author() */
 			sprintf(
+				/* translators: %s: get_the_author() */
 				__( 'Use %s instead if you do not want the value echoed.' ),
 				'<code>get_the_author()</code>'
 			)
 		);
 	}
 		/**
 		 * Filters 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.
+		 * @param string $display_name The author's display name.
 		 */
 		return apply_filters( 'the_modified_author', $last_user->display_name );
 	}
 }
 * - user_url
 * - yim
 *
 * @since 2.8.0
 *
-* @global object $authordata The current author's DB object.
+* @global WP_User $authordata The current author's data.
 *
 * @param string    $field   Optional. The user field to retrieve. Default empty.
 * @param int|false $user_id Optional. User ID.
 * @return string The author's field from the current author's DB object, otherwise an empty string.
 */
 		$user_id = isset( $authordata->ID ) ? $authordata->ID : 0;
 	} else {
 		$authordata = get_userdata( $user_id );
 	}
-	if ( in_array( $field, array( 'login', 'pass', 'nicename', 'email', 'url', 'registered', 'activation_key', 'status' ) ) ) {
+	if ( in_array( $field, array( 'login', 'pass', 'nicename', 'email', 'url', 'registered', 'activation_key', 'status' ), true ) ) {
 		$field = 'user_' . $field;
 	}
 	$value = isset( $authordata->$field ) ? $authordata->$field : '';
 function get_the_author_link() {
 	if ( get_the_author_meta( 'url' ) ) {
 		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 */
+			/* translators: %s: Author's display name. */
 			esc_attr( sprintf( __( 'Visit %s&#8217;s website' ), get_the_author() ) ),
 			get_the_author()
 		);
 	} else {
 		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
+* @link https://developer.wordpress.org/reference/functions/the_author_link/
 *
 * @since 2.1.0
 */
 function the_author_link() {
 	echo get_the_author_link();
 }
 /**
 * Display the number of posts by the author of the current post.
 *
-* @link https://codex.wordpress.org/Template_Tags/the_author_posts
+* @link https://developer.wordpress.org/reference/functions/the_author_posts/
 * @since 0.71
 */
 function the_author_posts() {
 	echo get_the_author_posts();
 }
 *
 * Returns an HTML-formatted link using get_author_posts_url().
 *
 * @since 4.4.0
 *
-* @global object $authordata The current author's DB object.
+* @global WP_User $authordata The current author's data.
 *
 * @return string An HTML link to the author page, or an empty string if $authordata isn't defined.
 */
 function get_the_author_posts_link() {
 	global $authordata;
 	}
 	$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 */
+		/* translators: %s: Author's display name. */
 		esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ),
 		get_the_author()
 	);
 	/**
 /**
 * Retrieve the URL to the author page for the user with the ID provided.
 *
 * @since 2.1.0
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @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.
 */
 	if ( empty( $link ) ) {
 		$file = home_url( '/' );
 		$link = $file . '?author=' . $auth_ID;
 	} else {
-		if ( '' == $author_nicename ) {
+		if ( '' === $author_nicename ) {
 			$user = get_userdata( $author_id );
 			if ( ! empty( $user->user_nicename ) ) {
 				$author_nicename = $user->user_nicename;
 			}
 		}
 	 * Filters 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 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;
 }
 /**
 * List all the authors of the site, with several options available.
 *
-* @link https://codex.wordpress.org/Template_Tags/wp_list_authors
+* @link https://developer.wordpress.org/reference/functions/wp_list_authors/
 *
 * @since 1.2.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 *     @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 string       $feed_type     The feed type to link to. Possible values include 'rss2', 'atom'.
+*                                       Default is the value of get_default_feed().
 *     @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 string|void The output, if echo is set to false.
+* @return void|string Void if 'echo' argument is true, list of authors if 'echo' is false.
 */
 function wp_list_authors( $args = '' ) {
 	global $wpdb;
 	$defaults = array(
 			$return .= $name . ', ';
 			continue; // No need to go further to process HTML.
 		}
-		if ( 'list' == $args['style'] ) {
+		if ( 'list' === $args['style'] ) {
 			$return .= '<li>';
 		}
 		$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 */
+			/* translators: %s: Author's display name. */
 			esc_attr( sprintf( __( 'Posts by %s' ), $author->display_name ) ),
 			$name
 		);
 		if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
 		if ( $args['optioncount'] ) {
 			$link .= ' (' . $posts . ')';
 		}
 		$return .= $link;
-		$return .= ( 'list' == $args['style'] ) ? '</li>' : ', ';
+		$return .= ( 'list' === $args['style'] ) ? '</li>' : ', ';
 	}
 	$return = rtrim( $return, ', ' );
-	if ( ! $args['echo'] ) {
+	if ( $args['echo'] ) {
+		echo $return;
+	} else {
 		return $return;
 	}
-	echo $return;
 }
 /**
 * Determines whether this site has more than one author.
 *
 * @return bool Whether or not we have more than one author
 */
 function is_multi_author() {
 	global $wpdb;
-	if ( false === ( $is_multi_author = get_transient( 'is_multi_author' ) ) ) {
+	$is_multi_author = get_transient( 'is_multi_author' );
+	if ( false === $is_multi_author ) {
 		$rows            = (array) $wpdb->get_col( "SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 2" );
 		$is_multi_author = 1 < count( $rows ) ? 1 : 0;
 		set_transient( 'is_multi_author', $is_multi_author );
 	}
 * Helper function to clear the cache for number of authors.
 *
 * @since 3.2.0
 * @access private
 */
-function __clear_multi_author_cache() {
+function __clear_multi_author_cache() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
 	delete_transient( 'is_multi_author' );
 }

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a