<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54247] trunk: Administration: Allow to wrap Settings sections with custom HTML content.</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54247">54247</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54247","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-20 09:57:43 +0000 (Tue, 20 Sep 2022)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/17851">#17851</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludestemplatephp">trunk/src/wp-admin/includes/template.php</a></li>
<li><a href="#trunktestsphpunitteststemplatephp">trunk/tests/phpunit/tests/template.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludestemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/template.php  2022-09-20 09:35:46 UTC (rev 54246)
+++ trunk/src/wp-admin/includes/template.php    2022-09-20 09:57:43 UTC (rev 54247)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1561,6 +1561,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">  * fields. It can output nothing if you want.
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.1.0 Added an `$args` parameter for the section's HTML wrapper and class name.
</ins><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @global array $wp_settings_sections Storage array of all settings sections added to admin pages.
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1570,10 +1571,29 @@
</span><span class="cx" style="display: block; padding: 0 10px">  * @param string   $page     The slug-name of the settings page on which to show the section. Built-in pages include
</span><span class="cx" style="display: block; padding: 0 10px">  *                           'general', 'reading', 'writing', 'discussion', 'media', etc. Create your own using
</span><span class="cx" style="display: block; padding: 0 10px">  *                           add_options_page();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array    $args     {
+ *     Arguments used to create the settings section.
+ *
+ *     @type string $before_section HTML content to prepend to the section's HTML output.
+ *                                  Receives the section's class name as `%s`. Default empty.
+ *     @type string $after_section  HTML content to append to the section's HTML output. Default empty.
+ *     @type string $section_class  The class name to use for the section. Default empty.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px">  */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function add_settings_section( $id, $title, $callback, $page ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function add_settings_section( $id, $title, $callback, $page, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">         global $wp_settings_sections;
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        $defaults = array(
+               'id'             => $id,
+               'title'          => $title,
+               'callback'       => $callback,
+               'before_section' => '',
+               'after_section'  => '',
+               'section_class'  => '',
+       );
+
+       $section = wp_parse_args( $args, $defaults );
+
</ins><span class="cx" style="display: block; padding: 0 10px">         if ( 'misc' === $page ) {
</span><span class="cx" style="display: block; padding: 0 10px">                _deprecated_argument(
</span><span class="cx" style="display: block; padding: 0 10px">                        __FUNCTION__,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1600,11 +1620,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                $page = 'reading';
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        $wp_settings_sections[ $page ][ $id ] = array(
-               'id'       => $id,
-               'title'    => $title,
-               'callback' => $callback,
-       );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_settings_sections[ $page ][ $id ] = $section;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1700,6 +1716,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        foreach ( (array) $wp_settings_sections[ $page ] as $section ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                if ( '' !== $section['before_section'] ) {
+                       if ( '' !== $section['section_class'] ) {
+                               echo wp_kses_post( sprintf( $section['before_section'], esc_attr( $section['section_class'] ) ) );
+                       } else {
+                               echo wp_kses_post( $section['before_section'] );
+                       }
+               }
+
</ins><span class="cx" style="display: block; padding: 0 10px">                 if ( $section['title'] ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        echo "<h2>{$section['title']}</h2>\n";
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1714,6 +1738,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">                echo '<table class="form-table" role="presentation">';
</span><span class="cx" style="display: block; padding: 0 10px">                do_settings_fields( $page, $section['id'] );
</span><span class="cx" style="display: block; padding: 0 10px">                echo '</table>';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+               if ( '' !== $section['after_section'] ) {
+                       echo wp_kses_post( $section['after_section'] );
+               }
</ins><span class="cx" style="display: block; padding: 0 10px">         }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span></span></pre></div>
<a id="trunktestsphpunitteststemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/template.php    2022-09-20 09:35:46 UTC (rev 54246)
+++ trunk/tests/phpunit/tests/template.php      2022-09-20 09:57:43 UTC (rev 54247)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -456,7 +456,179 @@
</span><span class="cx" style="display: block; padding: 0 10px">                );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        /**
+        * @ticket 17851
+        * @covers ::add_settings_section
+        */
+       public function test_add_settings_section() {
+               add_settings_section( 'test-section', 'Section title', '__return_false', 'test-page' );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                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>',
+                       ),
+               );
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         public function assertTemplateHierarchy( $url, array $expected, $message = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $this->go_to( $url );
</span><span class="cx" style="display: block; padding: 0 10px">                $hierarchy = $this->get_template_hierarchy();
</span></span></pre>
</div>
</div>

</body>
</html>