Changeset 53147

Timestamp:

04/11/2022 11:36:56 PM (3 years ago)

Author:

davidbaumwald

Message:

Formatting: Make get_the_author_link pluggable.

Adds a new filter to alter the output of get_the_author_link. This change also adds unit tests for the new filter.

Props dshanske, donmhico, audrasjb, peterwilsoncc, SergeyBiryukov.
Fixes #51859.

Location:

trunk

Files:

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

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

@@ -225 +225 @@
  * @since 3.0.0
  *
+ * @global WP_User $authordata The current author's data.
+ *
  * @return string|null An HTML link if the author's url exist in user meta,
  *                     else the result of get_the_author().
@@ -230 +232 @@
 function get_the_author_link() {
     if ( get_the_author_meta( 'url' ) ) {
-        return sprintf(
+        global $authordata;
+
+        $author_url          = get_the_author_meta( 'url' );
+        $author_display_name = get_the_author();
+
+        $link = sprintf(
             '<a href="%1$s" title="%2$s" rel="author external">%3$s</a>',
-            esc_url( get_the_author_meta( 'url' ) ),
+            esc_url( $author_url ),
             /* translators: %s: Author's display name. */
-            esc_attr( sprintf( __( 'Visit %s&#8217;s website' ), get_the_author() ) ),
-            get_the_author()
+            esc_attr( sprintf( __( 'Visit %s&#8217;s website' ), $author_display_name ) ),
+            $author_display_name
         );
+
+        /**
+         * Filters the author URL link HTML.
+         *
+         * @since 6.0.0
+         *
+         * @param string  $link       The default rendered author HTML link.
+         * @param string  $author_url Author's URL.
+         * @param WP_User $authordata Author user data.
+         */
+        return apply_filters( 'the_author_link', $link, $author_url, $authordata );
     } else {
         return get_the_author();

trunk/tests/phpunit/tests/user/author.php

@@ -20 +20 @@
                 'display_name' => 'Test Author',
                 'description'  => 'test_author',
+                'user_url'     => 'http://example.com',
             )
         );
@@ -145 +146 @@
     }
 
+    /**
+     * @ticket 51859
+     *
+     * @covers ::get_the_author_link
+     */
+    public function test_get_the_author_link() {
+        $author_url          = get_the_author_meta( 'url' );
+        $author_display_name = get_the_author();
+
+        $link = get_the_author_link();
+
+        $this->assertStringContainsString( $author_url, $link, 'The link does not contain the author URL' );
+        $this->assertStringContainsString( $author_display_name, $link, 'The link does not contain the author display name' );
+    }
+
+    /**
+     * @ticket 51859
+     *
+     * @covers ::get_the_author_link
+     */
+    public function test_filtered_get_the_author_link() {
+        $filter = new MockAction();
+
+        add_filter( 'the_author_link', array( &$filter, 'filter' ) );
+
+        get_the_author_link();
+
+        $this->assertSame( 1, $filter->get_call_count() );
+        $this->assertSame( array( 'the_author_link' ), $filter->get_tags() );
+    }
 }