WP_Customize_Widgets::customize_register()

Hooks fired · 1

One hook fires while WP_Customize_Widgets::customize_register() runs, in this order:

1. 1
   apply_filters( customizer_widgets_section_args )filterline 475 (+105 into the body)

   Filters Customizer widget section arguments for a given sidebar.

Uses · 13

• wp_use_widgets_block_editor()Determines whether or not to use the block editor to manage widgets.
• add_filter()Adds a callback function to a filter hook.
• wp_get_sidebars_widgets()Retrieves the full list of sidebars and their widget instance IDs.
• __()Retrieves the translation of $text.
• is_registered_sidebar()Checks if a sidebar is registered.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Customize_Widgets::get_setting_id()Converts a widget_id into its corresponding Customizer setting ID (option name).
• WP_Customize_Widgets::get_setting_args()Retrieves common arguments to supply when constructing a Customizer setting.
• WP_Customize_Sidebar_Section::__construct()
• WP_Sidebar_Block_Editor_Control::__construct()
• WP_Widget_Area_Customize_Control::__construct()
• WP_Widget_Form_Customize_Control::__construct()

Used by · 1

• WP_Customize_Widgets::schedule_customize_register()Ensures widgets are available for all types of previews.

Source

View on Trac ↗View on GitHub ↗

370	public function customize_register() {371		global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars;372 373		$use_widgets_block_editor = wp_use_widgets_block_editor();374 375		add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 );376 377		$sidebars_widgets = array_merge(378			array( 'wp_inactive_widgets' => array() ),379			array_fill_keys( array_keys( $wp_registered_sidebars ), array() ),380			wp_get_sidebars_widgets()381		);382 383		$new_setting_ids = array();384 385		/*386		 * Register a setting for all widgets, including those which are active,387		 * inactive, and orphaned since a widget may get suppressed from a sidebar388		 * via a plugin (like Widget Visibility).389		 */390		foreach ( array_keys( $wp_registered_widgets ) as $widget_id ) {391			$setting_id   = $this->get_setting_id( $widget_id );392			$setting_args = $this->get_setting_args( $setting_id );393			if ( ! $this->manager->get_setting( $setting_id ) ) {394				$this->manager->add_setting( $setting_id, $setting_args );395			}396			$new_setting_ids[] = $setting_id;397		}398 399		/*400		 * Add a setting which will be supplied for the theme's sidebars_widgets401		 * theme_mod when the theme is switched.402		 */403		if ( ! $this->manager->is_theme_active() ) {404			$setting_id   = 'old_sidebars_widgets_data';405			$setting_args = $this->get_setting_args(406				$setting_id,407				array(408					'type'  => 'global_variable',409					'dirty' => true,410				)411			);412			$this->manager->add_setting( $setting_id, $setting_args );413		}414 415		$this->manager->add_panel(416			'widgets',417			array(418				'type'                     => 'widgets',419				'title'                    => __( 'Widgets' ),420				'description'              => __( 'Widgets are independent sections of content that can be placed into widgetized areas provided by your theme (commonly called sidebars).' ),421				'priority'                 => 110,422				'active_callback'          => array( $this, 'is_panel_active' ),423				'auto_expand_sole_section' => true,424				'theme_supports'           => 'widgets',425			)426		);427 428		foreach ( $sidebars_widgets as $sidebar_id => $sidebar_widget_ids ) {429			if ( empty( $sidebar_widget_ids ) ) {430				$sidebar_widget_ids = array();431			}432 433			$is_registered_sidebar = is_registered_sidebar( $sidebar_id );434			$is_inactive_widgets   = ( 'wp_inactive_widgets' === $sidebar_id );435			$is_active_sidebar     = ( $is_registered_sidebar && ! $is_inactive_widgets );436 437			// Add setting for managing the sidebar's widgets.438			if ( $is_registered_sidebar || $is_inactive_widgets ) {439				$setting_id   = sprintf( 'sidebars_widgets[%s]', $sidebar_id );440				$setting_args = $this->get_setting_args( $setting_id );441				if ( ! $this->manager->get_setting( $setting_id ) ) {442					if ( ! $this->manager->is_theme_active() ) {443						$setting_args['dirty'] = true;444					}445					$this->manager->add_setting( $setting_id, $setting_args );446				}447				$new_setting_ids[] = $setting_id;448 449				// Add section to contain controls.

History

Introduced in 3.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-customize-widgets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.