Ticket #37355: remove-settings-section.diff

src/wp-admin/includes/template.php

@@ -1217 +1217 @@
 }
 
 /**
+ * Remove a section from a settings page.
+ *
+ * @since 4.7.0
+ *
+ * @global $wp_settings_sections Storage array of all settings sections added to admin pages
+ *
+ * @param string   $id       Slug-name to identify the section. Used in the 'id' attribute of tags.
+ * @param string   $page     The slug-name of the settings page on which the section has been added.
+ *                           Built-in pages include
+ *                           'general', 'reading', 'writing', 'discussion', 'media', etc. Create your own using
+ *                           add_options_page();
+ */
+function remove_settings_section( $id, $page ) {
+        global $wp_settings_sections;
+        unset( $wp_settings_sections[ $page ][ $id ] );
+}
+
+/**
  * Add a new field to a section of a settings page
  *
  * Part of the Settings API. Use this to define a settings field that will show

new file tests/phpunit/tests/settings-api.php

@@ +1 @@
+<?php
+
+/**
+ * @group settings-api
+ */
+class Tests_Settings_API extends WP_UnitTestCase {
+
+
+        function assertHasSettingsSection( $id, $page ) {
+                global $wp_settings_sections;
+                $this->assertArrayHasKey(
+                        $page,
+                        $wp_settings_sections,
+                        sprintf( 'Settings page "%s" not registered', $page )
+                );
+                $this->assertArrayHasKey(
+                        $id,
+                        $wp_settings_sections[$page],
+                        sprintf( 'Settings section "%s" not registered for page "%s"', $id, $page )
+                );
+        }
+
+        function assertNotHasSettingsSection( $id, $page ) {
+                global $wp_settings_sections;
+                $this->assertArrayNotHasKey(
+                        $id,
+                        $wp_settings_sections[$page],
+                        sprintf( 'Settings section "%s" is registered for page "%s"', $id, $page )
+                );
+        }
+
+        function test_add_settings_section() {
+                add_settings_section(
+                        'custom_settings_section',
+                        __( 'Custom Settings Section', 'textdomain' ),
+                        '__return_false',
+                        'reading'
+                );
+                $this->assertHasSettingsSection( 'custom_settings_section', 'reading' );
+        }
+
+        function test_remove_settings_section() {
+                add_settings_section(
+                        'custom_settings_section',
+                        __( 'Custom Settings Section', 'textdomain' ),
+                        '__return_false',
+                        'reading'
+                );
+                remove_settings_section( 'custom_settings_section', 'reading' );
+                $this->assertNotHasSettingsSection( 'custom_settings_section', 'reading' );
+        }
+
+}