Changeset 52828

Timestamp:

03/07/2022 02:42:49 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Themes: Correct the logic for displaying a _doing_it_wrong() notice for add_theme_support( 'html5' ).

• Calling add_theme_support( 'html5' ) without passing an array of supported types should throw a _doing_it_wrong() notice: "You need to pass an array of types".
• If the second parameter is not specified, it should fall back to an array of comment-list, comment-form, and search-form for backward compatibility.
• If the second parameter is not an array, the function should return false.

The latter two points are covered by existing unit tests. The first one is now addressed by @expectedIncorrectUsage.

Follow-up to [25193], [25235], [25785].

Props audrasjb, peterwilsoncc, SergeyBiryukov.
Fixes #51657.

Location:

trunk

Files:

• src/wp-includes/theme.php (modified) (2 diffs)
• tests/phpunit/tests/theme/support.php (modified) (3 diffs)

trunk/src/wp-includes/theme.php

@@ -2608 +2608 @@
         case 'html5':
             // You can't just pass 'html5', you need to pass an array of types.
-            if ( empty( $args[0] ) ) {
-                // Build an array of types for back-compat.
-                $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
-            } elseif ( ! isset( $args[0] ) || ! is_array( $args[0] ) ) {
+            if ( empty( $args[0] ) || ! is_array( $args[0] ) ) {
                 _doing_it_wrong(
                     "add_theme_support( 'html5' )",
@@ -2617 +2614 @@
                     '3.6.1'
                 );
-                return false;
+
+                if ( ! empty( $args[0] ) && ! is_array( $args[0] ) ) {
+                    return false;
+                }
+
+                // Build an array of types for back-compat.
+                $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
             }
 

trunk/tests/phpunit/tests/theme/support.php

@@ -77 +77 @@
     /**
      * @ticket 24932
+     *
+     * @expectedIncorrectUsage add_theme_support( 'html5' )
      */
     public function test_supports_html5() {
@@ -82 +84 @@
         $this->assertFalse( current_theme_supports( 'html5' ) );
         $this->assertFalse( current_theme_supports( 'html5', 'comment-form' ) );
+
+        /*
+         * If the second parameter is not specified, it should throw a _doing_it_wrong() notice
+         * and fall back to `array( 'comment-list', 'comment-form', 'search-form' )` for back-compat.
+         */
         $this->assertNotFalse( add_theme_support( 'html5' ) );
         $this->assertTrue( current_theme_supports( 'html5' ) );
@@ -99 +106 @@
         $this->assertFalse( current_theme_supports( 'html5' ) );
         $this->assertFalse( current_theme_supports( 'html5', 'comment-form' ) );
+
+        // The second parameter should be an array.
         $this->assertFalse( add_theme_support( 'html5', 'comment-form' ) );
         $this->assertNotFalse( add_theme_support( 'html5', array( 'comment-form' ) ) );