Changeset 55755

Timestamp:

05/14/2023 05:56:26 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Correct fallback return value in get_the_author().

If the $authordata global is not set, get_the_author() returned null, causing a PHP 8.1 "null to non-nullable" deprecation notice in ent2ncr() hooked via the_author filter:

str_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated

This commit updates get_the_author() to return an empty string if called before $authordata is set, bringing consistency with a few other similar functions which also return an empty string in this case:

• get_the_author_meta()
• get_the_author_posts_link()
• get_the_modified_author()

Follow-up to [695/tests], [2858], [11138], [12284], [20575], [34677], [44616], [53187].

Props Soean, jrf, sabernhardt, salvoaranzulla, antpb, ebai4, sajjad67, tijmensmit, SergeyBiryukov.
Fixes #58157.

Location:

trunk

Files:

• src/wp-includes/author-template.php (modified) (6 diffs)
• tests/phpunit/tests/user/getTheAuthor.php (modified) (1 diff)
• tests/phpunit/tests/user/getTheAuthorMeta.php (modified) (1 diff)
• tests/phpunit/tests/user/getTheAuthorPostsLink.php (modified) (1 diff)
• tests/phpunit/tests/user/getTheModifiedAuthor.php (added)

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

@@ -15 +15 @@
  *
  * @since 1.5.0
+ * @since 6.3.0 Returns an empty string if the author's display name is unknown.
  *
  * @global WP_User $authordata The current author's data.
  *
  * @param string $deprecated Deprecated.
- * @return string|null The author's display name.
+ * @return string The author's display name, empty string if unknown.
  */
 function get_the_author( $deprecated = '' ) {
@@ -33 +34 @@
          * @since 2.9.0
          *
-         * @param string|null $display_name The author's display name.
-         */
-        return apply_filters( 'the_author', is_object( $authordata ) ? $authordata->display_name : null );
+         * @param string $display_name The author's display name.
+         */
+        return apply_filters( 'the_author', is_object( $authordata ) ? $authordata->display_name : '' );
 }
 
@@ -56 +57 @@
  * @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().
+ * @return string The author's display name, from get_the_author().
  */
 function the_author( $deprecated = '', $deprecated_echo = true ) {
@@ -220 +221 @@
  * Retrieves either author's link or author's name.
  *
- * If the author has a home page set, return an HTML link, otherwise just return the
- * author's name.
+ * If the author has a home page set, return an HTML link, otherwise just return
+ * the author's name.
  *
  * @since 3.0.0
@@ -227 +228 @@
  * @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().
+ * @return string An HTML link if the author's URL exists in user meta,
+ *                otherwise the result of get_the_author().
  */
 function get_the_author_link() {
@@ -308 +309 @@
  * @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.
+ * @return string An HTML link to the author page, or an empty string if $authordata is not set.
  */
 function get_the_author_posts_link() {
         global $authordata;
+
         if ( ! is_object( $authordata ) ) {
                 return '';

trunk/tests/phpunit/tests/user/getTheAuthor.php

@@ -46 +46 @@
                 $this->assertSame( 'Test Author', $author_name );
         }
+
+        /**
+         * @ticket 58157
+         */
+        public function test_get_the_author_should_return_empty_string_if_authordata_is_not_set() {
+                unset( $GLOBALS['authordata'] );
+
+                $this->assertSame( '', get_the_author() );
+        }
 }

trunk/tests/phpunit/tests/user/getTheAuthorMeta.php

@@ -62 +62 @@
         }
 
-        public function test_get_the_author_meta_no_authordata() {
+        /**
+         * @ticket 20529
+         * @ticket 58157
+         */
+        public function test_get_the_author_meta_should_return_empty_string_if_authordata_is_not_set() {
                 unset( $GLOBALS['authordata'] );
 

trunk/tests/phpunit/tests/user/getTheAuthorPostsLink.php

@@ -80 +80 @@
                 unset( $GLOBALS['authordata'] );
         }
+
+        /**
+         * @ticket 58157
+         */
+        public function test_get_the_author_posts_link_should_return_empty_string_if_authordata_is_not_set() {
+                unset( $GLOBALS['authordata'] );
+
+                $this->assertSame( '', get_the_author_posts_link() );
+        }
 }