Changeset 34677

Timestamp:

09/29/2015 01:48:47 AM (9 years ago)

Author:

DrewAPicture

Message:

Introduce get_the_author_posts_link(), which returns the HTML link to the author page for the current post's author.

the_author_posts_link() has in-turn been converted into a wrapper, with most of its logic moved to the new function.

Adds tests for the new function.

Props chipbennett, zrothauser, wonderboymusic, DrewAPicture.
Fixes #30355.

Location:

trunk

Files:

• src/wp-includes/author-template.php (modified) (2 diffs)
• tests/phpunit/tests/template/author.php (added)

trunk/src/wp-includes/author-template.php

@@ -224 +224 @@
 
 /**
- * Display an HTML link to the author page of the author of the current post.
- *
- * 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.
- *
- * @link https://codex.wordpress.org/Template_Tags/the_author_posts_link
- * @since 1.2.0
+ * Retrieves an HTML link to the author page of the current post's author.
+ *
+ * Returns an HTML-formatted link using get_author_posts_url().
+ *
+ * @since 4.4.0
  *
  * @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' );
-
+ * @return string An HTML link to the author page.
+ */
+function get_the_author_posts_link() {
     global $authordata;
     if ( ! is_object( $authordata ) ) {
@@ -260 +254 @@
      * @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' );
+    }
+    echo get_the_author_posts_link();
 }