enmi-conf.org: comparison wp/wp-includes/class-wp-customize-widgets.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	/**
 	 * Initial loader.
 	 *
 	 * @since 3.9.0
 	 *
-	 * @param WP_Customize_Manager $manager Customize manager bootstrap instance.
+	 * @param WP_Customize_Manager $manager Customizer bootstrap instance.
 	 */
 	public function __construct( $manager ) {
 		$this->manager = $manager;
 		// See https://github.com/xwp/wp-customize-snapshots/blob/962586659688a5b1fd9ae93618b7ce2d4e7a421c/php/class-customize-snapshot-manager.php#L420-L449
 	/**
 	 * Retrieves the widget setting type given a setting ID.
 	 *
 	 * @since 4.2.0
 	 *
-	 * @staticvar array $cache
-	 *
 	 * @param string $setting_id Setting ID.
 	 * @return string|void Setting type.
 	 */
 	protected function get_setting_type( $setting_id ) {
 		static $cache = array();
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param false|array $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.
+	 * @return array|false Setting arguments, false otherwise.
 	 */
 	public function filter_customize_dynamic_setting_args( $args, $setting_id ) {
 		if ( $this->get_setting_type( $setting_id ) ) {
 			$args = $this->get_setting_args( $setting_id );
 		}
 		$this->old_sidebars_widgets = wp_get_sidebars_widgets();
 		add_filter( 'customize_value_old_sidebars_widgets_data', array( $this, 'filter_customize_value_old_sidebars_widgets_data' ) );
 		$this->manager->set_post_value( 'old_sidebars_widgets_data', $this->old_sidebars_widgets ); // Override any value cached in changeset.
-		// retrieve_widgets() looks at the global $sidebars_widgets
+		// retrieve_widgets() looks at the global $sidebars_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()
+		// Reset global cache var used by wp_get_sidebars_widgets().
 		unset( $GLOBALS['_wp_sidebars_widgets'] );
 	}
 	/**
 	 * Filters old_sidebars_widgets_data Customizer setting.
 	 *
 	 * @since 3.9.0
 	 */
 	public function customize_controls_init() {
 		/** This action is documented in wp-admin/includes/ajax-actions.php */
-		do_action( 'load-widgets.php' );
+		do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/includes/ajax-actions.php */
-		do_action( 'widgets.php' );
+		do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/widgets.php */
 		do_action( 'sidebar_admin_setup' );
 	}
 				if ( $is_active_sidebar ) {
 					$section_args = array(
 						'title'       => $wp_registered_sidebars[ $sidebar_id ]['name'],
 						'description' => $wp_registered_sidebars[ $sidebar_id ]['description'],
-						'priority'    => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ),
+						'priority'    => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ), true ),
 						'panel'       => 'widgets',
 						'sidebar_id'  => $sidebar_id,
 					);
 					/**
 	 * This method will return all Core widgets as being not wide, but this can be
 	 * overridden with the {@see 'is_wide_widget_in_customizer'} filter.
 	 *
 	 * @since 3.9.0
 	 *
-	 * @global $wp_registered_widget_controls
+	 * @global array $wp_registered_widget_controls
 	 *
 	 * @param string $widget_id Widget ID.
 	 * @return bool Whether or not the widget is a "wide" widget.
 	 */
 	public function is_wide_widget( $widget_id ) {
 		global $wp_registered_widget_controls;
 		$parsed_widget_id = $this->parse_widget_id( $widget_id );
 		$width            = $wp_registered_widget_controls[ $widget_id ]['width'];
-		$is_core          = in_array( $parsed_widget_id['id_base'], $this->core_widget_id_bases );
+		$is_core          = in_array( $parsed_widget_id['id_base'], $this->core_widget_id_bases, true );
 		$is_wide          = ( $width > 250 && ! $is_core );
 		/**
 		 * Filters whether the given widget is considered "wide".
 		 *
 		if ( preg_match( '/^(.+)-(\d+)$/', $widget_id, $matches ) ) {
 			$parsed['id_base'] = $matches[1];
 			$parsed['number']  = intval( $matches[2] );
 		} else {
-			// likely an old single widget
+			// Likely an old single widget.
 			$parsed['id_base'] = $widget_id;
 		}
 		return $parsed;
 	}
 	 * Converts a widget setting ID (option path) to its id_base and number components.
 	 *
 	 * @since 3.9.0
 	 *
 	 * @param string $setting_id Widget setting ID.
-	 * @return WP_Error|array Array containing a widget's id_base and number components,
+	 * @return array|WP_Error Array containing a widget's id_base and number components,
 	 *                        or a WP_Error object.
 	 */
 	public function parse_widget_setting_id( $setting_id ) {
 		if ( ! preg_match( '/^(widget_(.+?))(?:\[(\d+)\])?$/', $setting_id, $matches ) ) {
 			return new WP_Error( 'widget_setting_invalid_id' );
 	 *
 	 * @since 3.9.0
 	 */
 	public function print_styles() {
 		/** This action is documented in wp-admin/admin-header.php */
-		do_action( 'admin_print_styles-widgets.php' );
+		do_action( 'admin_print_styles-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/admin-header.php */
 		do_action( 'admin_print_styles' );
 	}
 	 *
 	 * @since 3.9.0
 	 */
 	public function print_scripts() {
 		/** This action is documented in wp-admin/admin-header.php */
-		do_action( 'admin_print_scripts-widgets.php' );
+		do_action( 'admin_print_scripts-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/admin-header.php */
 		do_action( 'admin_print_scripts' );
 	}
 		);
 		$registered_sidebar_count            = count( $wp_registered_sidebars );
 		for ( $non_rendered_count = 2; $non_rendered_count < $registered_sidebar_count; $non_rendered_count++ ) {
 			$some_non_rendered_areas_messages[ $non_rendered_count ] = html_entity_decode(
 				sprintf(
-					/* translators: %s: the number of other widget areas registered but not rendered */
+					/* translators: %s: The number of other widget areas registered but not rendered. */
 					_n(
 						'Your theme has %s other widget area, but this particular page doesn&#8217;t display it.',
 						'Your theme has %s other widget areas, but this particular page doesn&#8217;t display them.',
 						$non_rendered_count
 					),
 				get_bloginfo( 'charset' )
 			);
 		} else {
 			$no_areas_shown_message = html_entity_decode(
 				sprintf(
-					/* translators: %s: the total number of widget areas registered */
+					/* translators: %s: The total number of widget areas registered. */
 					_n(
 						'Your theme has %s widget area, but this particular page doesn&#8217;t display it.',
 						'Your theme has %s widget areas, but this particular page doesn&#8217;t display them.',
 						$registered_sidebar_count
 					),
 		}
 		$settings = array(
 			'registeredSidebars'          => array_values( $wp_registered_sidebars ),
 			'registeredWidgets'           => $wp_registered_widgets,
-			'availableWidgets'            => $available_widgets, // @todo Merge this with registered_widgets
+			'availableWidgets'            => $available_widgets, // @todo Merge this with registered_widgets.
 			'l10n'                        => array(
 				'saveBtnLabel'     => __( 'Apply' ),
 				'saveBtnTooltip'   => __( 'Save and preview changes before publishing them.' ),
 				'removeBtnLabel'   => __( 'Remove' ),
 				'removeBtnTooltip' => __( 'Keep widget settings and move it to the inactive widgets' ),
 				'someAreasShown'   => $some_non_rendered_areas_messages,
 				'noAreasShown'     => $no_areas_shown_message,
 				'reorderModeOn'    => __( 'Reorder mode enabled' ),
 				'reorderModeOff'   => __( 'Reorder mode closed' ),
 				'reorderLabelOn'   => esc_attr__( 'Reorder widgets' ),
-				/* translators: %d: the number of widgets found */
+				/* translators: %d: The number of widgets found. */
 				'widgetsFound'     => __( 'Number of widgets found: %d' ),
 				'noWidgetsFound'   => __( 'No widgets found.' ),
 			),
 			'tpl'                         => array(
 				'widgetReorderNav' => $widget_reorder_nav_tpl,
 			),
 			'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(),
 		);
 		foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
-			unset( $registered_widget['callback'] ); // may not be JSON-serializeable
+			unset( $registered_widget['callback'] ); // May not be JSON-serializeable.
 		}
 		$wp_scripts->add_data(
 			'customize-widgets',
 			'data',
 					<span class="screen-reader-text"><?php _e( 'Back' ); ?></span>
 				</button>
 				<h3>
 					<span class="customize-action">
 					<?php
-						/* translators: &#9656; is the unicode right-pointing triangle, and %s is the section title in the Customizer */
+						/* translators: &#9656; is the unicode right-pointing triangle. %s: Section title in the Customizer. */
-						echo sprintf( __( 'Customizing &#9656; %s' ), esc_html( $this->manager->get_panel( 'widgets' )->title ) );
+						printf( __( 'Customizing &#9656; %s' ), esc_html( $this->manager->get_panel( 'widgets' )->title ) );
 					?>
 					</span>
 					<?php _e( 'Add a Widget' ); ?>
 				</h3>
 			</div>
 	 *
 	 * @since 3.9.0
 	 */
 	public function print_footer_scripts() {
 		/** This action is documented in wp-admin/admin-footer.php */
-		do_action( 'admin_print_footer_scripts-widgets.php' );
+		do_action( 'admin_print_footer_scripts-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/admin-footer.php */
 		do_action( 'admin_print_footer_scripts' );
 		/** This action is documented in wp-admin/admin-footer.php */
-		do_action( 'admin_footer-widgets.php' );
+		do_action( 'admin_footer-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 	}
 	/**
 	 * Retrieves common arguments to supply when constructing a Customizer setting.
 	 *
 	 *
 	 * @since 3.9.0
 	 *
 	 * @global array $wp_registered_widgets
 	 * @global array $wp_registered_widget_controls
-	 * @staticvar array $available_widgets
 	 *
 	 * @see wp_list_widgets()
 	 *
 	 * @return array List of available widgets.
 	 */
 		if ( ! empty( $available_widgets ) ) {
 			return $available_widgets;
 		}
 		global $wp_registered_widgets, $wp_registered_widget_controls;
-		require_once ABSPATH . 'wp-admin/includes/widgets.php'; // for next_widget_id_number()
+		require_once ABSPATH . 'wp-admin/includes/widgets.php'; // For next_widget_id_number().
 		$sort = $wp_registered_widgets;
 		usort( $sort, array( $this, '_sort_name_callback' ) );
 		$done = array();
 		foreach ( $sort as $widget ) {
-			if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget
+			if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget.
 				continue;
 			}
 			$sidebar = is_active_widget( $widget['callback'], $widget['id'], false, false );
 			$done[]  = $widget['callback'];
 			if ( ! isset( $widget['params'][0] ) ) {
 				$widget['params'][0] = array();
 			}
 			$available_widget = $widget;
-			unset( $available_widget['callback'] ); // not serializable to JSON
+			unset( $available_widget['callback'] ); // Not serializable to JSON.
 			$args = array(
 				'widget_id'   => $widget['id'],
 				'widget_name' => $widget['name'],
 				'_display'    => 'template',
 				$available_widget,
 				array(
 					'temp_id'      => isset( $args['_temp_id'] ) ? $args['_temp_id'] : null,
 					'is_multi'     => $is_multi_widget,
 					'control_tpl'  => $control_tpl,
-					'multi_number' => ( $args['_add'] === 'multi' ) ? $args['_multi_num'] : false,
+					'multi_number' => ( 'multi' === $args['_add'] ) ? $args['_multi_num'] : false,
 					'is_disabled'  => $is_disabled,
 					'id_base'      => $id_base,
 					'transport'    => $this->is_widget_selective_refreshable( $id_base ) ? 'postMessage' : 'refresh',
 					'width'        => $wp_registered_widget_controls[ $widget['id'] ]['width'],
 					'height'       => $wp_registered_widget_controls[ $widget['id'] ]['height'],
 		$args[0]['before_form']           = '<div class="form">';
 		$args[0]['after_form']            = '</div><!-- .form -->';
 		$args[0]['before_widget_content'] = '<div class="widget-content">';
 		$args[0]['after_widget_content']  = '</div><!-- .widget-content -->';
 		ob_start();
-		call_user_func_array( 'wp_widget_control', $args );
+		wp_widget_control( ...$args );
 		$control_tpl = ob_get_clean();
 		return $control_tpl;
 	}
 	/**
 	/**
 	 * Refreshes the nonce for widget updates.
 	 *
 	 * @since 4.2.0
 	 *
-	 * @param  array $nonces Array of nonces.
+	 * @param array $nonces Array of nonces.
-	 * @return array $nonces Array of nonces.
+	 * @return array Array of nonces.
 	 */
 	public function refresh_nonces( $nonces ) {
 		$nonces['update-widget'] = wp_create_nonce( 'update-widget' );
 		return $nonces;
 	}
 	 */
 	public function export_preview_data() {
 		global $wp_registered_sidebars, $wp_registered_widgets;
 		$switched_locale = switch_to_locale( get_user_locale() );
-		$l10n            = array(
+		$l10n = array(
 			'widgetTooltip' => __( 'Shift-click to edit this widget.' ),
 		);
 		if ( $switched_locale ) {
 			restore_previous_locale();
 		}
+		$rendered_sidebars = array_filter( $this->rendered_sidebars );
+		$rendered_widgets  = array_filter( $this->rendered_widgets );
 		// Prepare Customizer settings to pass to JavaScript.
 		$settings = array(
-			'renderedSidebars'            => array_fill_keys( array_unique( $this->rendered_sidebars ), true ),
+			'renderedSidebars'            => array_fill_keys( array_keys( $rendered_sidebars ), true ),
-			'renderedWidgets'             => array_fill_keys( array_keys( $this->rendered_widgets ), true ),
+			'renderedWidgets'             => array_fill_keys( array_keys( $rendered_widgets ), true ),
 			'registeredSidebars'          => array_values( $wp_registered_sidebars ),
 			'registeredWidgets'           => $wp_registered_widgets,
 			'l10n'                        => $l10n,
 			'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(),
 		);
 		foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
-			unset( $registered_widget['callback'] ); // may not be JSON-serializeable
+			unset( $registered_widget['callback'] ); // May not be JSON-serializeable.
 		}
 		?>
 		<script type="text/javascript">
 			var _wpWidgetCustomizerPreviewSettings = <?php echo wp_json_encode( $settings ); ?>;
 	 *
 	 * @param string $widget_id Widget ID to check.
 	 * @return bool Whether the widget is rendered.
 	 */
 	public function is_widget_rendered( $widget_id ) {
-		return in_array( $widget_id, $this->rendered_widgets );
+		return ! empty( $this->rendered_widgets[ $widget_id ] );
 	}
 	/**
 	 * Determines if a sidebar is rendered on the page.
 	 *
 	 *
 	 * @param string $sidebar_id Sidebar ID to check.
 	 * @return bool Whether the sidebar is rendered.
 	 */
 	public function is_sidebar_rendered( $sidebar_id ) {
-		return in_array( $sidebar_id, $this->rendered_sidebars );
+		return ! empty( $this->rendered_sidebars[ $sidebar_id ] );
 	}
 	/**
 	 * Tallies the sidebars rendered via is_active_sidebar().
 	 *
 	 * @param string $sidebar_id Sidebar ID.
 	 * @return bool Whether the sidebar is active.
 	 */
 	public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {
 		if ( is_registered_sidebar( $sidebar_id ) ) {
-			$this->rendered_sidebars[] = $sidebar_id;
+			$this->rendered_sidebars[ $sidebar_id ] = true;
 		}
 		/*
 		 * We may need to force this to true, and also force-true the value
 		 * for 'dynamic_sidebar_has_widgets' if we want to ensure that there
 		 * is an area to drop widgets into, if the sidebar is empty.
 		 */
 	 * @param string $sidebar_id  Sidebar ID.
 	 * @return bool Whether the current sidebar has widgets.
 	 */
 	public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) {
 		if ( is_registered_sidebar( $sidebar_id ) ) {
-			$this->rendered_sidebars[] = $sidebar_id;
+			$this->rendered_sidebars[ $sidebar_id ] = true;
 		}
 		/*
 		 * We may need to force this to true, and also force-true the value
 		 * for 'is_active_sidebar' if we want to ensure there is an area to
 	 *
 	 * @param array $value Widget instance to sanitize.
 	 * @return array|void Sanitized widget instance.
 	 */
 	public function sanitize_widget_instance( $value ) {
-		if ( $value === array() ) {
+		if ( array() === $value ) {
 			return $value;
 		}
 		if ( empty( $value['is_widget_customizer_js_value'] )
 			|| empty( $value['instance_hash_key'] )
 	 * @since 3.9.0
 	 *
 	 * @global array $wp_registered_widget_updates
 	 * @global array $wp_registered_widget_controls
 	 *
-	 * @param  string $widget_id Widget ID.
+	 * @param string $widget_id Widget ID.
-	 * @return WP_Error|array Array containing the updated widget information.
+	 * @return array|WP_Error Array containing the updated widget information.
 	 *                        A WP_Error object, otherwise.
 	 */
 	public function call_widget_update( $widget_id ) {
 		global $wp_registered_widget_updates, $wp_registered_widget_controls;
 			if ( ! is_null( $parsed_id['number'] ) ) {
 				$value                         = array();
 				$value[ $parsed_id['number'] ] = $instance;
 				$key                           = 'widget-' . $parsed_id['id_base'];
-				$_REQUEST[ $key ]              = $_POST[ $key ] = wp_slash( $value );
+				$_REQUEST[ $key ]              = wp_slash( $value );
+				$_POST[ $key ]                 = $_REQUEST[ $key ];
 				$added_input_vars[]            = $key;
 			} else {
 				foreach ( $instance as $key => $value ) {
-					$_REQUEST[ $key ]   = $_POST[ $key ] = wp_slash( $value );
+					$_REQUEST[ $key ]   = wp_slash( $value );
+					$_POST[ $key ]      = $_REQUEST[ $key ];
 					$added_input_vars[] = $key;
 				}
 			}
 		}
 				ob_end_clean();
 				break;
 			}
 		}
-		// Clean up any input vars that were manually added
+		// Clean up any input vars that were manually added.
 		foreach ( $added_input_vars as $key ) {
 			unset( $_POST[ $key ] );
 			unset( $_REQUEST[ $key ] );
 		}
 		if ( empty( $_POST['widget-id'] ) ) {
 			wp_send_json_error( 'missing_widget-id' );
 		}
 		/** This action is documented in wp-admin/includes/ajax-actions.php */
-		do_action( 'load-widgets.php' );
+		do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/includes/ajax-actions.php */
-		do_action( 'widgets.php' );
+		do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 		/** This action is documented in wp-admin/widgets.php */
 		do_action( 'sidebar_admin_setup' );
 		$widget_id = $this->get_post_value( 'widget-id' );
 	/**
 	 * List of the tag names seen for before_widget strings.
 	 *
 	 * This is used in the {@see 'filter_wp_kses_allowed_html'} filter to ensure that the
-	 * data-* attributes can be whitelisted.
+	 * data-* attributes can be allowed.
 	 *
 	 * @since 4.5.0
 	 * @var array
 	 */
 	protected $before_widget_tags_seen = array();
 	/**
 	 * The current request's sidebar_instance_number context.
 	 *
 	 * @since 4.5.0
-	 * @var int
+	 * @var int|null
 	 */
 	protected $context_sidebar_instance_number;
 	/**
 	 * Current sidebar ID being rendered.
 	/**
 	 * Current sidebar being rendered.
 	 *
 	 * @since 4.5.0
-	 * @var string
+	 * @var string|null
 	 */
 	protected $rendering_widget_id;
 	/**
 	 * Current widget being rendered.
 	 *
 	 * @since 4.5.0
-	 * @var string
+	 * @var string|null
 	 */
 	protected $rendering_sidebar_id;
 	/**
 	 * Filters sidebars_widgets to ensure the currently-rendered widget is the only widget in the current sidebar.
 		$filter_callback = array( $this, 'filter_sidebars_widgets_for_rendering_widget' );
 		add_filter( 'sidebars_widgets', $filter_callback, 1000 );
 		// Render the widget.
 		ob_start();
-		dynamic_sidebar( $this->rendering_sidebar_id = $context['sidebar_id'] );
+		$this->rendering_sidebar_id = $context['sidebar_id'];
-		$container                                   = ob_get_clean();
+		dynamic_sidebar( $this->rendering_sidebar_id );
+		$container = ob_get_clean();
 		// Reset variables for next partial render.
 		remove_filter( 'sidebars_widgets', $filter_callback, 1000 );
 		$this->context_sidebar_instance_number = null;
 		return $container;
 	}
 	//
-	// Option Update Capturing
+	// Option Update Capturing.
 	//
 	/**
 	 * List of captured widget option updates.
 	 *
 	 * @param mixed  $old_value   The old option value.
 	 * @return mixed Filtered option value.
 	 */
 	public function capture_filter_pre_update_option( $new_value, $option_name, $old_value ) {
 		if ( $this->is_option_capture_ignored( $option_name ) ) {
-			return;
+			return $new_value;
 		}
 		if ( ! isset( $this->_captured_options[ $option_name ] ) ) {
 			add_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) );
 		}

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a