Changeset 36689

Timestamp:

02/24/2016 06:27:45 PM (9 years ago)

Author:

westonruter

Message:

Customize: Allow controls to be registered without any associated settings.

• Improves parity between partials and controls. A partial or control can be settingless if instantiated with settings param as empty array (otherwise, if null, then the partial/control ID is used).
• Eliminate need to create dummy settings that serve no purpose except to place a control in the UI.
• Removes dummy settings for create_new_menu and new_menu_name.
• Introduces WP_Customize_Control::$capability and WP_Customize_Partial::$capability, and if set checks them in the respective check_capabilities() methods.
• Prevents PHP fatal error from happening when non-existing settings are provided to control: "Call to a member function check_capabilities() on a non-object".
• Fixes issue where nav menu items and widgets were no longer working with selective refresh because cap check was failing.

See #27355.
Fixes #35926.

Location:

trunk

Files:

• src/wp-admin/js/customize-controls.js (modified) (1 diff)
• src/wp-includes/class-wp-customize-control.php (modified) (5 diffs)
• src/wp-includes/class-wp-customize-nav-menus.php (modified) (3 diffs)
• src/wp-includes/class-wp-customize-widgets.php (modified) (2 diffs)
• src/wp-includes/customize/class-wp-customize-partial.php (modified) (3 diffs)
• tests/phpunit/tests/customize/control.php (added)
• tests/phpunit/tests/customize/partial.php (modified) (1 diff)
• tests/qunit/fixtures/customize-menus.js (modified) (1 diff)
• tests/qunit/wp-admin/js/customize-controls.js (modified) (1 diff)

trunk/src/wp-admin/js/customize-controls.js

@@ -1522 +1522 @@
                 return value;
             });
-            api.apply( api, settings.concat( function () {
-                var key;
-
+
+            if ( 0 === settings.length ) {
+                control.setting = null;
                 control.settings = {};
-                for ( key in control.params.settings ) {
-                    control.settings[ key ] = api( control.params.settings[ key ] );
-                }
-
-                control.setting = control.settings['default'] || null;
-
                 control.embed();
-            }) );
+            } else {
+                api.apply( api, settings.concat( function() {
+                    var key;
+
+                    control.settings = {};
+                    for ( key in control.params.settings ) {
+                        control.settings[ key ] = api( control.params.settings[ key ] );
+                    }
+
+                    control.setting = control.settings['default'] || null;
+
+                    control.embed();
+                }) );
+            }
 
             // After the control is embedded on the page, invoke the "ready" method.

trunk/src/wp-includes/class-wp-customize-control.php

@@ -64 +64 @@
      */
     public $setting = 'default';
+
+    /**
+     * Capability required to use this control.
+     *
+     * Normally this is empty and the capability is derived from the capabilities
+     * of the associated `$settings`.
+     *
+     * @since 4.5.0
+     * @access public
+     * @var string
+     */
+    public $capability;
 
     /**
@@ -188 +200 @@
 
         // Process settings.
-        if ( empty( $this->settings ) ) {
+        if ( ! isset( $this->settings ) ) {
             $this->settings = $id;
         }
@@ -197 +209 @@
                 $settings[ $key ] = $this->manager->get_setting( $setting );
             }
-        } else {
+        } else if ( is_string( $this->settings ) ) {
             $this->setting = $this->manager->get_setting( $this->settings );
             $settings['default'] = $this->setting;
@@ -300 +312 @@
 
     /**
-     * Check if the theme supports the control and check user capabilities.
+     * Checks if the user can use this control.
+     *
+     * Returns false if the user cannot manipulate one of the associated settings,
+     * or if one of the associated settings does not exist. Also returns false if
+     * the associated section does not exist or if its capability check returns
+     * false.
      *
      * @since 3.4.0
@@ -307 +324 @@
      */
     final public function check_capabilities() {
+        if ( ! empty( $this->capability ) && ! current_user_can( $this->capability ) ) {
+            return false;
+        }
+
         foreach ( $this->settings as $setting ) {
-            if ( ! $setting->check_capabilities() )
+            if ( ! $setting || ! $setting->check_capabilities() ) {
                 return false;
+            }
         }
 
         $section = $this->manager->get_section( $this->section );
-        if ( isset( $section ) && ! $section->check_capabilities() )
+        if ( isset( $section ) && ! $section->check_capabilities() ) {
             return false;
+        }
 
         return true;

trunk/src/wp-includes/class-wp-customize-nav-menus.php

@@ -607 +607 @@
         ) ) );
 
-        $this->manager->add_setting( 'new_menu_name', array(
-            'type'      => 'new_menu',
-            'default'   => '',
-            'transport' => isset( $this->manager->selective_refresh ) ? 'postMessage' : 'refresh',
-        ) );
-
         $this->manager->add_control( 'new_menu_name', array(
             'label'       => '',
             'section'     => 'add_menu',
             'type'        => 'text',
+            'settings'    => array(),
             'input_attrs' => array(
                 'class'       => 'menu-name-field',
@@ -623 +618 @@
         ) );
 
-        $this->manager->add_setting( 'create_new_menu', array(
-            'type' => 'new_menu',
-        ) );
-
         $this->manager->add_control( new WP_Customize_New_Menu_Control( $this->manager, 'create_new_menu', array(
-            'section' => 'add_menu',
+            'section'  => 'add_menu',
+            'settings' => array(),
         ) ) );
     }
@@ -852 +844 @@
                     'render_callback'     => array( $this, 'render_nav_menu_partial' ),
                     'container_inclusive' => true,
+                    'settings'            => array(), // Empty because the nav menu instance may relate to a menu or a location.
+                    'capability'          => 'edit_theme_options',
                 )
             );

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -1486 +1486 @@
     public function customize_dynamic_partial_args( $partial_args, $partial_id ) {
 
-        if ( preg_match( '/^widget\[.+\]$/', $partial_id ) ) {
+        if ( preg_match( '/^widget\[(?P<widget_id>.+)\]$/', $partial_id, $matches ) ) {
             if ( false === $partial_args ) {
                 $partial_args = array();
@@ -1493 +1493 @@
                 $partial_args,
                 array(
-                    'type' => 'widget',
-                    'render_callback' => array( $this, 'render_widget_partial' ),
+                    'type'                => 'widget',
+                    'render_callback'     => array( $this, 'render_widget_partial' ),
                     'container_inclusive' => true,
+                    'settings'            => array( $this->get_setting_id( $matches['widget_id'] ) ),
+                    'capability'          => 'edit_theme_options',
                 )
             );

trunk/src/wp-includes/customize/class-wp-customize-partial.php

@@ -91 +91 @@
 
     /**
+     * Capability required to edit this partial.
+     *
+     * Normally this is empty and the capability is derived from the capabilities
+     * of the associated `$settings`.
+     *
+     * @since 4.5.0
+     * @access public
+     * @var string
+     */
+    public $capability;
+
+    /**
      * Render callback.
      *
@@ -158 +170 @@
 
         // Process settings.
-        if ( empty( $this->settings ) ) {
+        if ( ! isset( $this->settings ) ) {
             $this->settings = array( $id );
         } else if ( is_string( $this->settings ) ) {
@@ -300 +312 @@
      */
     final public function check_capabilities() {
+        if ( ! empty( $this->capability ) && ! current_user_can( $this->capability ) ) {
+            return false;
+        }
         foreach ( $this->settings as $setting_id ) {
             $setting = $this->component->manager->get_setting( $setting_id );

trunk/tests/phpunit/tests/customize/partial.php

@@ -326 +326 @@
         ) );
         $this->assertFalse( $partial->check_capabilities() );
+
+        $partial = new WP_Customize_Partial( $this->selective_refresh, 'no_setting', array(
+            'settings' => array(),
+        ) );
+        $this->assertTrue( $partial->check_capabilities() );
+
+        $partial = new WP_Customize_Partial( $this->selective_refresh, 'no_setting', array(
+            'settings' => array(),
+            'capability' => 'top_secret_clearance',
+        ) );
+        $this->assertFalse( $partial->check_capabilities() );
+
+        $partial = new WP_Customize_Partial( $this->selective_refresh, 'no_setting', array(
+            'settings' => array(),
+            'capability' => 'edit_theme_options',
+        ) );
+        $this->assertTrue( $partial->check_capabilities() );
     }
 

trunk/tests/qunit/fixtures/customize-menus.js

@@ -395 +395 @@
     'instanceNumber': 46
 };
-window._wpCustomizeSettings.settings.new_menu_name = {
-    'value': '',
-    'transport': 'postMessage',
-    'dirty': false
-};
 
 // From nav-menu.js

trunk/tests/qunit/wp-admin/js/customize-controls.js

@@ -99 +99 @@
         var control = wp.customize.control( 'fixture-control' );
         equal( control.section(), 'fixture-section' );
+    } );
+
+    module( 'Customizer control without associated settings' );
+    test( 'Control can be created without settings', function() {
+        var control = new wp.customize.Control( 'settingless', {
+            params: {
+                content: jQuery( '<li class="settingless">Hello World</li>' ),
+                section: 'fixture-section'
+            }
+        } );
+        wp.customize.control.add( control.id, control );
+        equal( control.deferred.embedded.state(), 'resolved' );
+        ok( null === control.setting );
+        ok( jQuery.isEmptyObject( control.settings ) );
     } );