Changeset 54247 for trunk/tests/phpunit/tests/template.php

Timestamp:

09/20/2022 09:57:43 AM (2 years ago)

Author:

audrasjb

Message:

Administration: Allow to wrap Settings sections with custom HTML content.

This changeset improves the add_settings_section() function to allow developers to pass extra HTML mark-up to be rendered before and after the settings section. Extra argument $args can now be passed to the function, and is an array that can contain the following items:

• before_section: HTML content to prepend to the section's HTML output. Receives the section's class name provided with the section_class argument via an optional %s placeholder. Default empty.
• after_section: HTML content to append to the section's HTML output. Default empty.
• section_class: The class name to use for the section. Used by before_section if a %s placeholder is present. Default empty.

The HTML passed using these extra arguments is escaped using wp_kses_post() just before rendering. This changeset also provides a set of unit tests for this new feature.

Props griffinjt, nacin, scribu, ross_ritchey, ryan, chriscct7, palmiak, rehanali, costdev, martinkrcho, chaion07, audrasjb, hellofromtonya.
Fixes #17851.

File:

• trunk/tests/phpunit/tests/template.php (modified) (1 diff)

trunk/tests/phpunit/tests/template.php

@@ -457 +457 @@
     }
 
+    /**
+     * @ticket 17851
+     * @covers ::add_settings_section
+     */
+    public function test_add_settings_section() {
+        add_settings_section( 'test-section', 'Section title', '__return_false', 'test-page' );
+
+        global $wp_settings_sections;
+        $this->assertIsArray( $wp_settings_sections, 'List of sections is not initialized.' );
+        $this->assertArrayHasKey( 'test-page', $wp_settings_sections, 'List of sections for the test page has not been added to sections list.' );
+        $this->assertIsArray( $wp_settings_sections['test-page'], 'List of sections for the test page is not initialized.' );
+        $this->assertArrayHasKey( 'test-section', $wp_settings_sections['test-page'], 'Test section has not been added to the list of sections for the test page.' );
+
+        $this->assertEqualSetsWithIndex(
+            array(
+                'id'             => 'test-section',
+                'title'          => 'Section title',
+                'callback'       => '__return_false',
+                'before_section' => '',
+                'after_section'  => '',
+                'section_class'  => '',
+            ),
+            $wp_settings_sections['test-page']['test-section'],
+            'Test section data does not match the expected dataset.'
+        );
+    }
+
+    /**
+     * @ticket 17851
+     *
+     * @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_with_extra_args( $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 );
+        add_settings_field( 'test-field', 'Field title', '__return_false', 'test-page', 'test-section' );
+
+        global $wp_settings_sections;
+        $this->assertIsArray( $wp_settings_sections, 'List of sections is not initialized.' );
+        $this->assertArrayHasKey( 'test-page', $wp_settings_sections, 'List of sections for the test page has not been added to sections list.' );
+        $this->assertIsArray( $wp_settings_sections['test-page'], 'List of sections for the test page is not initialized.' );
+        $this->assertArrayHasKey( 'test-section', $wp_settings_sections['test-page'], 'Test section has not been added to the list of sections for the test page.' );
+
+        $this->assertEqualSetsWithIndex(
+            $expected_section_data,
+            $wp_settings_sections['test-page']['test-section'],
+            'Test section data does not match the expected dataset.'
+        );
+
+        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()`.
+     *
+     * @return array
+     */
+    public function data_extra_args_for_add_settings_section() {
+        return array(
+            'class placeholder section_class present' => array(
+                array(
+                    'before_section' => '<div class="%s">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => 'test-section-wrap',
+                ),
+                array(
+                    'id'             => 'test-section',
+                    'title'          => 'Section title',
+                    'callback'       => '__return_false',
+                    'before_section' => '<div class="%s">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => 'test-section-wrap',
+                ),
+                '<div class="test-section-wrap">',
+                '</div><!-- end of the test section -->',
+            ),
+            'missing class placeholder section_class' => array(
+                array(
+                    'before_section' => '<div class="testing-section-wrapper">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => 'test-section-wrap',
+                ),
+                array(
+                    'id'             => 'test-section',
+                    'title'          => 'Section title',
+                    'callback'       => '__return_false',
+                    'before_section' => '<div class="testing-section-wrapper">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => 'test-section-wrap',
+                ),
+                '<div class="testing-section-wrapper">',
+                '</div><!-- end of the test section -->',
+            ),
+            'empty section_class'                     => array(
+                array(
+                    'before_section' => '<div class="test-section-container">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => '',
+                ),
+                array(
+                    'id'             => 'test-section',
+                    'title'          => 'Section title',
+                    'callback'       => '__return_false',
+                    'before_section' => '<div class="test-section-container">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => '',
+                ),
+                '<div class="test-section-container">',
+                '</div><!-- end of the test section -->',
+            ),
+            'section_class missing'                   => array(
+                array(
+                    'before_section' => '<div class="wp-whitelabel-section">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                ),
+                array(
+                    'id'             => 'test-section',
+                    'title'          => 'Section title',
+                    'callback'       => '__return_false',
+                    'before_section' => '<div class="wp-whitelabel-section">',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => '',
+                ),
+                '<div class="wp-whitelabel-section">',
+                '</div><!-- end of the test section -->',
+            ),
+            'disallowed tag in before_section'        => array(
+                array(
+                    'before_section' => '<div class="video-settings-section"><iframe src="https://www.wordpress.org/" />',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                ),
+                array(
+                    'id'             => 'test-section',
+                    'title'          => 'Section title',
+                    'callback'       => '__return_false',
+                    'before_section' => '<div class="video-settings-section"><iframe src="https://www.wordpress.org/" />',
+                    'after_section'  => '</div><!-- end of the test section -->',
+                    'section_class'  => '',
+                ),
+                '<div class="video-settings-section">',
+                '</div><!-- end of the test section -->',
+            ),
+            'disallowed tag in after_section'         => array(
+                array(
+                    'before_section' => '<div class="video-settings-section">',
+                    'after_section'  => '</div><iframe src="https://www.wordpress.org/" />',
+                ),
+                array(
+                    'id'             => 'test-section',
+                    'title'          => 'Section title',
+                    'callback'       => '__return_false',
+                    'before_section' => '<div class="video-settings-section">',
+                    'after_section'  => '</div><iframe src="https://www.wordpress.org/" />',
+                    'section_class'  => '',
+                ),
+                '<div class="video-settings-section">',
+                '</div>',
+            ),
+        );
+    }
 
     public function assertTemplateHierarchy( $url, array $expected, $message = '' ) {