X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/4713a14935b83517997f3c88f808eb41da55033d..e0feb3b2e5b436a06bbb04fbc838d1cd6ec95399:/wp-includes/class-wp-customize-widgets.php diff --git a/wp-includes/class-wp-customize-widgets.php b/wp-includes/class-wp-customize-widgets.php index 8efead24..8569228e 100644 --- a/wp-includes/class-wp-customize-widgets.php +++ b/wp-includes/class-wp-customize-widgets.php @@ -1,13 +1,21 @@ '/^(widget_.+?)(?:\[(\d+)\])?$/', + 'sidebar_widgets' => '/^sidebars_widgets\[(.+?)\]$/', + ); /** * Initial loader. @@ -78,7 +84,8 @@ final class WP_Customize_Widgets { public function __construct( $manager ) { $this->manager = $manager; - add_action( 'after_setup_theme', array( $this, 'setup_widget_addition_previews' ) ); + add_filter( 'customize_dynamic_setting_args', array( $this, 'filter_customize_dynamic_setting_args' ), 10, 2 ); + add_action( 'after_setup_theme', array( $this, 'register_settings' ) ); add_action( 'wp_loaded', array( $this, 'override_sidebars_widgets_for_theme_switch' ) ); add_action( 'customize_controls_init', array( $this, 'customize_controls_init' ) ); add_action( 'customize_register', array( $this, 'schedule_customize_register' ), 1 ); @@ -88,6 +95,7 @@ final class WP_Customize_Widgets { add_action( 'customize_controls_print_footer_scripts', array( $this, 'print_footer_scripts' ) ); add_action( 'customize_controls_print_footer_scripts', array( $this, 'output_widget_control_templates' ) ); add_action( 'customize_preview_init', array( $this, 'customize_preview_init' ) ); + add_filter( 'customize_refresh_nonces', array( $this, 'refresh_nonces' ) ); add_action( 'dynamic_sidebar', array( $this, 'tally_rendered_widgets' ) ); add_filter( 'is_active_sidebar', array( $this, 'tally_sidebars_via_is_active_sidebar_calls' ), 10, 2 ); @@ -95,199 +103,101 @@ final class WP_Customize_Widgets { } /** - * Get an unslashed post value or return a default. - * - * @since 3.9.0 + * Get the widget setting type given a setting ID. * + * @since 4.2.0 * @access protected * - * @param string $name Post value. - * @param mixed $default Default post value. - * @return mixed Unslashed post value or default value. + * @staticvar array $cache + * + * @param $setting_id Setting ID. + * @return string|void Setting type. */ - protected function get_post_value( $name, $default = null ) { - if ( ! isset( $_POST[ $name ] ) ) { - return $default; + protected function get_setting_type( $setting_id ) { + static $cache = array(); + if ( isset( $cache[ $setting_id ] ) ) { + return $cache[ $setting_id ]; + } + foreach ( $this->setting_id_patterns as $type => $pattern ) { + if ( preg_match( $pattern, $setting_id ) ) { + $cache[ $setting_id ] = $type; + return $type; + } } - - return wp_unslash( $_POST[$name] ); } /** - * Set up widget addition previews. - * - * Since the widgets get registered on 'widgets_init' before the customizer - * settings are set up on 'customize_register', we have to filter the options - * similarly to how the setting previewer will filter the options later. - * - * @since 3.9.0 + * Inspect the incoming customized data for any widget settings, and dynamically add them up-front so widgets will be initialized properly. * + * @since 4.2.0 * @access public */ - public function setup_widget_addition_previews() { - $is_customize_preview = false; - - if ( ! empty( $this->manager ) && ! is_admin() && 'on' === $this->get_post_value( 'wp_customize' ) ) { - $is_customize_preview = check_ajax_referer( 'preview-customize_' . $this->manager->get_stylesheet(), 'nonce', false ); - } - - $is_ajax_widget_update = false; - if ( $this->manager->doing_ajax() && 'update-widget' === $this->get_post_value( 'action' ) ) { - $is_ajax_widget_update = check_ajax_referer( 'update-widget', 'nonce', false ); - } - - $is_ajax_customize_save = false; - if ( $this->manager->doing_ajax() && 'customize_save' === $this->get_post_value( 'action' ) ) { - $is_ajax_customize_save = check_ajax_referer( 'save-customize_' . $this->manager->get_stylesheet(), 'nonce', false ); - } - - $is_valid_request = ( $is_ajax_widget_update || $is_customize_preview || $is_ajax_customize_save ); - if ( ! $is_valid_request ) { - return; - } - - // Input from customizer preview. - if ( isset( $_POST['customized'] ) ) { - $this->_customized = json_decode( $this->get_post_value( 'customized' ), true ); - } else { // Input from ajax widget update request. - $this->_customized = array(); - $id_base = $this->get_post_value( 'id_base' ); - $widget_number = $this->get_post_value( 'widget_number', false ); - $option_name = 'widget_' . $id_base; - $this->_customized[ $option_name ] = array(); - if ( preg_match( '/^[0-9]+$/', $widget_number ) ) { - $option_name .= '[' . $widget_number . ']'; - $this->_customized[ $option_name ][ $widget_number ] = array(); + public function register_settings() { + $widget_setting_ids = array(); + $incoming_setting_ids = array_keys( $this->manager->unsanitized_post_values() ); + foreach ( $incoming_setting_ids as $setting_id ) { + if ( ! is_null( $this->get_setting_type( $setting_id ) ) ) { + $widget_setting_ids[] = $setting_id; } } + if ( $this->manager->doing_ajax( 'update-widget' ) && isset( $_REQUEST['widget-id'] ) ) { + $widget_setting_ids[] = $this->get_setting_id( wp_unslash( $_REQUEST['widget-id'] ) ); + } - $function = array( $this, 'prepreview_added_sidebars_widgets' ); - - $hook = 'option_sidebars_widgets'; - add_filter( $hook, $function ); - $this->_prepreview_added_filters[] = compact( 'hook', 'function' ); - - $hook = 'default_option_sidebars_widgets'; - add_filter( $hook, $function ); - $this->_prepreview_added_filters[] = compact( 'hook', 'function' ); - - $function = array( $this, 'prepreview_added_widget_instance' ); - foreach ( $this->_customized as $setting_id => $value ) { - if ( preg_match( '/^(widget_.+?)(?:\[(\d+)\])?$/', $setting_id, $matches ) ) { - $option = $matches[1]; - - $hook = sprintf( 'option_%s', $option ); - if ( ! has_filter( $hook, $function ) ) { - add_filter( $hook, $function ); - $this->_prepreview_added_filters[] = compact( 'hook', 'function' ); - } - - $hook = sprintf( 'default_option_%s', $option ); - if ( ! has_filter( $hook, $function ) ) { - add_filter( $hook, $function ); - $this->_prepreview_added_filters[] = compact( 'hook', 'function' ); - } + $settings = $this->manager->add_dynamic_settings( array_unique( $widget_setting_ids ) ); - /* - * Make sure the option is registered so that the update_option() - * won't fail due to the filters providing a default value, which - * causes the update_option() to get confused. - */ - add_option( $option, array() ); + /* + * Preview settings right away so that widgets and sidebars will get registered properly. + * But don't do this if a customize_save because this will cause WP to think there is nothing + * changed that needs to be saved. + */ + if ( ! $this->manager->doing_ajax( 'customize_save' ) ) { + foreach ( $settings as $setting ) { + $setting->preview(); } } } /** - * Ensure that newly-added widgets will appear in the widgets_sidebars. + * Determine the arguments for a dynamically-created setting. * - * This is necessary because the customizer's setting preview filters - * are added after the widgets_init action, which is too late for the - * widgets to be set up properly. - * - * @since 3.9.0 + * @since 4.2.0 * @access public * - * @param array $sidebars_widgets Associative array of sidebars and their widgets. - * @return array Filtered array of sidebars and their widgets. + * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor. + * @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`. + * @return false|array Setting arguments, false otherwise. */ - public function prepreview_added_sidebars_widgets( $sidebars_widgets ) { - foreach ( $this->_customized as $setting_id => $value ) { - if ( preg_match( '/^sidebars_widgets\[(.+?)\]$/', $setting_id, $matches ) ) { - $sidebar_id = $matches[1]; - $sidebars_widgets[ $sidebar_id ] = $value; - } + public function filter_customize_dynamic_setting_args( $args, $setting_id ) { + if ( $this->get_setting_type( $setting_id ) ) { + $args = $this->get_setting_args( $setting_id ); } - return $sidebars_widgets; + return $args; } /** - * Ensure newly-added widgets have empty instances so they - * will be recognized. - * - * This is necessary because the customizer's setting preview - * filters are added after the widgets_init action, which is - * too late for the widgets to be set up properly. + * Get an unslashed post value or return a default. * * @since 3.9.0 - * @access public * - * @param array|bool|mixed $value Widget instance(s), false if open was empty. - * @return array|mixed Widget instance(s) with additions. - */ - public function prepreview_added_widget_instance( $value = false ) { - if ( ! preg_match( '/^(?:default_)?option_(widget_(.+))/', current_filter(), $matches ) ) { - return $value; - } - $id_base = $matches[2]; - - foreach ( $this->_customized as $setting_id => $setting ) { - $parsed_setting_id = $this->parse_widget_setting_id( $setting_id ); - if ( is_wp_error( $parsed_setting_id ) || $id_base !== $parsed_setting_id['id_base'] ) { - continue; - } - $widget_number = $parsed_setting_id['number']; - - if ( is_null( $widget_number ) ) { - // Single widget. - if ( false === $value ) { - $value = array(); - } - } else { - // Multi widget. - if ( empty( $value ) ) { - $value = array( '_multiwidget' => 1 ); - } - if ( ! isset( $value[ $widget_number ] ) ) { - $value[ $widget_number ] = array(); - } - } - } - - return $value; - } - - /** - * Remove pre-preview filters. - * - * Removes filters added in setup_widget_addition_previews() - * to ensure widgets are populating the options during - * 'widgets_init'. + * @access protected * - * @since 3.9.0 - * @access public + * @param string $name Post value. + * @param mixed $default Default post value. + * @return mixed Unslashed post value or default value. */ - public function remove_prepreview_filters() { - foreach ( $this->_prepreview_added_filters as $prepreview_added_filter ) { - remove_filter( $prepreview_added_filter['hook'], $prepreview_added_filter['function'] ); + protected function get_post_value( $name, $default = null ) { + if ( ! isset( $_POST[ $name ] ) ) { + return $default; } - $this->_prepreview_added_filters = array(); + + return wp_unslash( $_POST[ $name ] ); } /** * Override sidebars_widgets for theme switch. * - * When switching a theme via the customizer, supply any previously-configured + * When switching a theme via the Customizer, supply any previously-configured * sidebars_widgets from the target theme as the initial sidebars_widgets * setting. Also store the old theme's existing settings so that they can * be passed along for storing in the sidebars_widgets theme_mod when the @@ -295,6 +205,9 @@ final class WP_Customize_Widgets { * * @since 3.9.0 * @access public + * + * @global array $sidebars_widgets + * @global array $_wp_sidebars_widgets */ public function override_sidebars_widgets_for_theme_switch() { global $sidebars_widgets; @@ -310,10 +223,12 @@ final class WP_Customize_Widgets { $sidebars_widgets = $this->old_sidebars_widgets; $sidebars_widgets = retrieve_widgets( 'customize' ); add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 ); + // reset global cache var used by wp_get_sidebars_widgets() + unset( $GLOBALS['_wp_sidebars_widgets'] ); } /** - * Filter old_sidebars_widgets_data customizer setting. + * Filter old_sidebars_widgets_data Customizer setting. * * When switching themes, filter the Customizer setting * old_sidebars_widgets_data to supply initial $sidebars_widgets before they @@ -325,7 +240,8 @@ final class WP_Customize_Widgets { * @since 3.9.0 * @access public * - * @param array $sidebars_widgets + * @param array $old_sidebars_widgets + * @return array */ public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) { return $this->old_sidebars_widgets; @@ -342,7 +258,10 @@ final class WP_Customize_Widgets { * @since 3.9.0 * @access public * + * @global array $sidebars_widgets + * * @param array $sidebars_widgets + * @return array */ public function filter_option_sidebars_widgets_for_theme_switch( $sidebars_widgets ) { $sidebars_widgets = $GLOBALS['sidebars_widgets']; @@ -380,7 +299,7 @@ final class WP_Customize_Widgets { * @access public */ public function schedule_customize_register() { - if ( is_admin() ) { // @todo for some reason, $wp_customize->is_preview() is true here? + if ( is_admin() ) { $this->customize_register(); } else { add_action( 'wp', array( $this, 'customize_register' ) ); @@ -388,17 +307,21 @@ final class WP_Customize_Widgets { } /** - * Register customizer settings and controls for all sidebars and widgets. + * Register Customizer settings and controls for all sidebars and widgets. * * @since 3.9.0 * @access public + * + * @global array $wp_registered_widgets + * @global array $wp_registered_widget_controls + * @global array $wp_registered_sidebars */ public function customize_register() { global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars; $sidebars_widgets = array_merge( array( 'wp_inactive_widgets' => array() ), - array_fill_keys( array_keys( $GLOBALS['wp_registered_sidebars'] ), array() ), + array_fill_keys( array_keys( $wp_registered_sidebars ), array() ), wp_get_sidebars_widgets() ); @@ -412,12 +335,9 @@ final class WP_Customize_Widgets { foreach ( array_keys( $wp_registered_widgets ) as $widget_id ) { $setting_id = $this->get_setting_id( $widget_id ); $setting_args = $this->get_setting_args( $setting_id ); - - $setting_args['sanitize_callback'] = array( $this, 'sanitize_widget_instance' ); - $setting_args['sanitize_js_callback'] = array( $this, 'sanitize_widget_js_instance' ); - - $this->manager->add_setting( $setting_id, $setting_args ); - + if ( ! $this->manager->get_setting( $setting_id ) ) { + $this->manager->add_setting( $setting_id, $setting_args ); + } $new_setting_ids[] = $setting_id; } @@ -429,16 +349,23 @@ final class WP_Customize_Widgets { $setting_id = 'old_sidebars_widgets_data'; $setting_args = $this->get_setting_args( $setting_id, array( 'type' => 'global_variable', + 'dirty' => true, ) ); $this->manager->add_setting( $setting_id, $setting_args ); } + $this->manager->add_panel( 'widgets', array( + 'title' => __( 'Widgets' ), + 'description' => __( 'Widgets are independent sections of content that can be placed into widgetized areas provided by your theme (commonly called sidebars).' ), + 'priority' => 110, + ) ); + foreach ( $sidebars_widgets as $sidebar_id => $sidebar_widget_ids ) { if ( empty( $sidebar_widget_ids ) ) { $sidebar_widget_ids = array(); } - $is_registered_sidebar = isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ); + $is_registered_sidebar = isset( $wp_registered_sidebars[ $sidebar_id ] ); $is_inactive_widgets = ( 'wp_inactive_widgets' === $sidebar_id ); $is_active_sidebar = ( $is_registered_sidebar && ! $is_inactive_widgets ); @@ -446,11 +373,12 @@ final class WP_Customize_Widgets { if ( $is_registered_sidebar || $is_inactive_widgets ) { $setting_id = sprintf( 'sidebars_widgets[%s]', $sidebar_id ); $setting_args = $this->get_setting_args( $setting_id ); - - $setting_args['sanitize_callback'] = array( $this, 'sanitize_sidebar_widgets' ); - $setting_args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' ); - - $this->manager->add_setting( $setting_id, $setting_args ); + if ( ! $this->manager->get_setting( $setting_id ) ) { + if ( ! $this->manager->is_theme_active() ) { + $setting_args['dirty'] = true; + } + $this->manager->add_setting( $setting_id, $setting_args ); + } $new_setting_ids[] = $setting_id; // Add section to contain controls. @@ -458,10 +386,11 @@ final class WP_Customize_Widgets { if ( $is_active_sidebar ) { $section_args = array( - /* translators: %s: sidebar name */ - 'title' => sprintf( __( 'Widgets: %s' ), $GLOBALS['wp_registered_sidebars'][$sidebar_id]['name'] ), - 'description' => $GLOBALS['wp_registered_sidebars'][$sidebar_id]['description'], - 'priority' => 1000 + array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ), + 'title' => $wp_registered_sidebars[ $sidebar_id ]['name'], + 'description' => $wp_registered_sidebars[ $sidebar_id ]['description'], + 'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ), + 'panel' => 'widgets', + 'sidebar_id' => $sidebar_id, ); /** @@ -475,7 +404,8 @@ final class WP_Customize_Widgets { */ $section_args = apply_filters( 'customizer_widgets_section_args', $section_args, $section_id, $sidebar_id ); - $this->manager->add_section( $section_id, $section_args ); + $section = new WP_Customize_Sidebar_Section( $this->manager, $section_id, $section_args ); + $this->manager->add_section( $section ); $control = new WP_Widget_Area_Customize_Control( $this->manager, $setting_id, array( 'section' => $section_id, @@ -492,13 +422,13 @@ final class WP_Customize_Widgets { foreach ( $sidebar_widget_ids as $i => $widget_id ) { // Skip widgets that may have gone away due to a plugin being deactivated. - if ( ! $is_active_sidebar || ! isset( $GLOBALS['wp_registered_widgets'][$widget_id] ) ) { + if ( ! $is_active_sidebar || ! isset( $wp_registered_widgets[$widget_id] ) ) { continue; } - $registered_widget = $GLOBALS['wp_registered_widgets'][$widget_id]; + $registered_widget = $wp_registered_widgets[$widget_id]; $setting_id = $this->get_setting_id( $widget_id ); - $id_base = $GLOBALS['wp_registered_widget_controls'][$widget_id]['id_base']; + $id_base = $wp_registered_widget_controls[$widget_id]['id_base']; $control = new WP_Widget_Form_Customize_Control( $this->manager, $setting_id, array( 'label' => $registered_widget['name'], @@ -515,20 +445,17 @@ final class WP_Customize_Widgets { } } - /* - * We have to register these settings later than customize_preview_init - * so that other filters have had a chance to run. - */ - if ( did_action( 'customize_preview_init' ) ) { + if ( ! $this->manager->doing_ajax( 'customize_save' ) ) { foreach ( $new_setting_ids as $new_setting_id ) { $this->manager->get_setting( $new_setting_id )->preview(); } } - $this->remove_prepreview_filters(); + + add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 ); } /** - * Covert a widget_id into its corresponding customizer setting ID (option name). + * Covert a widget_id into its corresponding Customizer setting ID (option name). * * @since 3.9.0 * @access public @@ -550,15 +477,17 @@ final class WP_Customize_Widgets { * Determine whether the widget is considered "wide". * * Core widgets which may have controls wider than 250, but can - * still be shown in the narrow customizer panel. The RSS and Text + * still be shown in the narrow Customizer panel. The RSS and Text * widgets in Core, for example, have widths of 400 and yet they - * still render fine in the customizer panel. This method will + * still render fine in the Customizer panel. This method will * return all Core widgets as being not wide, but this can be * overridden with the is_wide_widget_in_customizer filter. * * @since 3.9.0 * @access public * + * @global $wp_registered_widget_controls + * * @param string $widget_id Widget ID. * @return bool Whether or not the widget is a "wide" widget. */ @@ -658,12 +587,18 @@ final class WP_Customize_Widgets { } /** - * Enqueue scripts and styles for customizer panel and export data to JavaScript. + * Enqueue scripts and styles for Customizer panel and export data to JavaScript. * * @since 3.9.0 * @access public + * + * @global WP_Scripts $wp_scripts + * @global array $wp_registered_sidebars + * @global array $wp_registered_widgets */ public function enqueue_scripts() { + global $wp_scripts, $wp_registered_sidebars, $wp_registered_widgets; + wp_enqueue_style( 'customize-widgets' ); wp_enqueue_script( 'customize-widgets' ); @@ -707,12 +642,10 @@ final class WP_Customize_Widgets { ' ); - global $wp_scripts; - $settings = array( 'nonce' => wp_create_nonce( 'update-widget' ), - 'registeredSidebars' => array_values( $GLOBALS['wp_registered_sidebars'] ), - 'registeredWidgets' => $GLOBALS['wp_registered_widgets'], + 'registeredSidebars' => array_values( $wp_registered_sidebars ), + 'registeredWidgets' => $wp_registered_widgets, 'availableWidgets' => $available_widgets, // @todo Merge this with registered_widgets 'l10n' => array( 'saveBtnLabel' => __( 'Apply' ), @@ -720,6 +653,8 @@ final class WP_Customize_Widgets { 'removeBtnLabel' => __( 'Remove' ), 'removeBtnTooltip' => __( 'Trash widget by moving it to the inactive widgets sidebar.' ), 'error' => __( 'An error has occurred. Please reload the page and try again.' ), + 'widgetMovedUp' => __( 'Widget moved up' ), + 'widgetMovedDown' => __( 'Widget moved down' ), ), 'tpl' => array( 'widgetReorderNav' => $widget_reorder_nav_tpl, @@ -734,7 +669,7 @@ final class WP_Customize_Widgets { $wp_scripts->add_data( 'customize-widgets', 'data', - sprintf( 'var _wpCustomizeWidgetsSettings = %s;', json_encode( $settings ) ) + sprintf( 'var _wpCustomizeWidgetsSettings = %s;', wp_json_encode( $settings ) ) ); } @@ -748,15 +683,29 @@ final class WP_Customize_Widgets { ?>