Changeset 59564

Timestamp:

12/28/2024 10:08:19 PM (12 months ago)

Author:

SergeyBiryukov

Message:

Options, Meta APIs: Ensure after_section is printed for sections without any fields.

This brings consistency with the before_section HTML content, which did get printed in do_settings_sections() regardless of whether the settings section has any fields attached.

Follow-up to [8855], [21742], [54247].

Props alpipego, SergeyBiryukov.
Fixes #62746.

Location:

trunk

Files:

• src/wp-admin/includes/template.php (modified) (1 diff)
• tests/phpunit/tests/admin/includesTemplate.php (modified) (1 diff)

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

@@ -1785 +1785 @@
         }
 
-        if ( ! isset( $wp_settings_fields ) || ! isset( $wp_settings_fields[ $page ] ) || ! isset( $wp_settings_fields[ $page ][ $section['id'] ] ) ) {
-            continue;
-        }
-        echo '<table class="form-table" role="presentation">';
-        do_settings_fields( $page, $section['id'] );
-        echo '</table>';
+        if ( isset( $wp_settings_fields[ $page ][ $section['id'] ] ) ) {
+            echo '<table class="form-table" role="presentation">';
+            do_settings_fields( $page, $section['id'] );
+            echo '</table>';
+        }
 
         if ( '' !== $section['after_section'] ) {

trunk/tests/phpunit/tests/admin/includesTemplate.php

@@ -242 +242 @@
 
     /**
+     * @ticket 62746
+     *
+     * @param array  $extra_args                   Extra arguments to pass to function `add_settings_section()`.
+     * @param array  $expected_section_data        Expected set of section data.
+     * @param string $expected_before_section_html Expected HTML markup to be rendered before the settings section.
+     * @param string $expected_after_section_html  Expected HTML markup to be rendered after the settings section.
+     *
+     * @covers ::add_settings_section
+     * @covers ::do_settings_sections
+     *
+     * @dataProvider data_extra_args_for_add_settings_section
+     */
+    public function test_add_settings_section_without_any_fields( $extra_args, $expected_section_data, $expected_before_section_html, $expected_after_section_html ) {
+        add_settings_section( 'test-section', 'Section title', '__return_false', 'test-page', $extra_args );
+
+        ob_start();
+        do_settings_sections( 'test-page' );
+        $output = ob_get_clean();
+
+        $this->assertStringContainsString( $expected_before_section_html, $output, 'Test page output does not contain the custom markup to be placed before the section.' );
+        $this->assertStringContainsString( $expected_after_section_html, $output, 'Test page output does not contain the custom markup to be placed after the section.' );
+    }
+
+    /**
      * Data provider for `test_add_settings_section_with_extra_args()`.
      *