]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/author-template.php
WordPress 4.7.1-scripts
[autoinstalls/wordpress.git] / wp-includes / author-template.php
index 36d08bc81e9efafcda5825eba6ee4a7d25184a21..b2b6ea3159e791fc1d666589b83fe3fa9667828f 100644 (file)
@@ -24,10 +24,10 @@ 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 @@ 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 compatibility has to be maintained.
+ * return it. However, backward compatibility has to be maintained.
  *
  * @since 0.71
  * @see get_the_author()
@@ -56,12 +56,23 @@ function get_the_author($deprecated = '') {
  * @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();
 }
 
@@ -77,7 +88,7 @@ function get_the_modified_author() {
                $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
                 *
@@ -126,7 +137,7 @@ function get_the_author_meta( $field = '', $user_id = false ) {
        $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.
         *
@@ -177,7 +188,12 @@ function the_author_meta( $field = '', $user_id = false ) {
  */
 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&#8217;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&#8217;s website' ), get_the_author() ) ),
+                       get_the_author()
+               );
        } else {
                return get_the_author();
        }
@@ -223,43 +239,52 @@ function the_author_posts() {
 }
 
 /**
- * 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.
  *
- * 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.
+ * Returns an HTML-formatted link using get_author_posts_url().
  *
- * @link https://codex.wordpress.org/Template_Tags/the_author_posts_link
- * @since 1.2.0
+ * @since 4.4.0
  *
  * @global object $authordata The current author's DB object.
  *
- * @param string $deprecated Deprecated.
+ * @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;
        }
 
-       $link = sprintf(
-               '<a href="%1$s" title="%2$s" rel="author">%3$s</a>',
+       $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();
 }
 
 /**
@@ -269,9 +294,11 @@ function the_author_posts_link($deprecated = '') {
  *
  * @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();
@@ -290,7 +317,7 @@ function get_author_posts_url($author_id, $author_nicename = '') {
        }
 
        /**
-        * Filter the URL to the author's page.
+        * Filters the URL to the author's page.
         *
         * @since 2.1.0
         *
@@ -304,37 +331,37 @@ function get_author_posts_url($author_id, $author_nicename = '') {
 }
 
 /**
- * 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
+ * @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 string|void The output, if echo is set to false.
  */
@@ -390,7 +417,12 @@ function wp_list_authors( $args = '' ) {
                        $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 .= ' ';
@@ -444,7 +476,7 @@ function wp_list_authors( $args = '' ) {
  *
  * @since 3.2.0
  *
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return bool Whether or not we have more than one author
  */
@@ -458,7 +490,7 @@ function is_multi_author() {
        }
 
        /**
-        * 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
         *