WP_Customize_Manager::__construct( array $args = array() )

Parameters

$argsarrayoptional

Args.Default: array()

• $changeset_uuidnull|string|false

  Changeset UUID, the post_name for the customize_changeset post containing the customized state. Defaults to null resulting in a UUID to be immediately generated. If false is provided, then then the changeset UUID will be determined during after_setup_theme: when the customize_changeset_branching filter returns false, then the default UUID will be that of the most recent customize_changeset post that has a status other than 'auto-draft', 'publish', or 'trash'. Otherwise, if changeset branching is enabled, then a random UUID will be used.

• $themestring

  Theme to be previewed (for theme switch). Defaults to customize_theme or theme query params.

• $messenger_channelstring

  Messenger channel. Defaults to customize_messenger_channel query param.

• $settings_previewedbool

  If settings should be previewed. Defaults to true.

• $branchingbool

  If changeset branching is allowed; otherwise, changesets are linear. Defaults to true.

• $autosavedbool

  If data from a changeset's autosaved revision should be loaded if it exists. Defaults to false.

Hooks fired · 1

One hook fires while WP_Customize_Manager::__construct() runs, in this order:

1. 1
   apply_filters( customize_loaded_components )filterline 359 (+97 into the body)

   Filters the core Customizer components to load.

Uses · 15

• wp_generate_uuid4()Generates a random UUID (version 4).
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• sanitize_key()Sanitizes a string key.
• wp_is_block_theme()Returns whether the active theme is a block-based theme or not.
• get_stylesheet()Retrieves name of the current stylesheet.
• wp_get_theme()Gets a WP_Theme object for a theme.
• validate_file()Validates a file name and path against an allowed set of rules.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• add_action()Adds a callback function to an action hook.
• remove_action()Removes a callback function from an action hook.
• add_filter()Adds a callback function to a filter hook.
• current_user_can()Returns whether the current user has the specified capability.

Used by · 2

• _wp_customize_include()Includes and instantiates the WP_Customize_Manager class.
• _wp_customize_publish_changeset()Publishes a snapshot's changes.

Source

View on Trac ↗View on GitHub ↗

262	public function __construct( $args = array() ) {263 264		$args = array_merge(265			array_fill_keys( array( 'changeset_uuid', 'theme', 'messenger_channel', 'settings_previewed', 'autosaved', 'branching' ), null ),266			$args267		);268 269		// Note that the UUID format will be validated in the setup_theme() method.270		if ( ! isset( $args['changeset_uuid'] ) ) {271			$args['changeset_uuid'] = wp_generate_uuid4();272		}273 274		/*275		 * The theme and messenger_channel should be supplied via $args,276		 * but they are also looked at in the $_REQUEST global here for back-compat.277		 */278		if ( ! isset( $args['theme'] ) ) {279			if ( isset( $_REQUEST['customize_theme'] ) ) {280				$args['theme'] = wp_unslash( $_REQUEST['customize_theme'] );281			} elseif ( isset( $_REQUEST['theme'] ) ) { // Deprecated.282				$args['theme'] = wp_unslash( $_REQUEST['theme'] );283			}284		}285		if ( ! isset( $args['messenger_channel'] ) && isset( $_REQUEST['customize_messenger_channel'] ) ) {286			$args['messenger_channel'] = sanitize_key( wp_unslash( $_REQUEST['customize_messenger_channel'] ) );287		}288 289		// Do not load 'widgets' component if a block theme is activated.290		if ( ! wp_is_block_theme() ) {291			$this->components[] = 'widgets';292		}293 294		$this->original_stylesheet = get_stylesheet();295		$this->theme               = wp_get_theme( 0 === validate_file( $args['theme'] ) ? $args['theme'] : null );296		$this->messenger_channel   = $args['messenger_channel'];297		$this->_changeset_uuid     = $args['changeset_uuid'];298 299		foreach ( array( 'settings_previewed', 'autosaved', 'branching' ) as $key ) {300			if ( isset( $args[ $key ] ) ) {301				$this->$key = (bool) $args[ $key ];302			}303		}304 305		require_once ABSPATH . WPINC . '/class-wp-customize-setting.php';306		require_once ABSPATH . WPINC . '/class-wp-customize-panel.php';307		require_once ABSPATH . WPINC . '/class-wp-customize-section.php';308		require_once ABSPATH . WPINC . '/class-wp-customize-control.php';309 310		require_once ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php';311		require_once ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php';312		require_once ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php';313		require_once ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php';314		require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php';315		require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php';316		require_once ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php';317		require_once ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php';318		require_once ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php';319		require_once ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php';320		require_once ABSPATH . WPINC . '/customize/class-wp-customize-code-editor-control.php';321		require_once ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php';322		require_once ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php';323		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php';324		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php';325		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php';326		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php';327		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-locations-control.php';328		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php';329 330		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menus-panel.php';331 332		require_once ABSPATH . WPINC . '/customize/class-wp-customize-themes-panel.php';333		require_once ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php';334		require_once ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php';335		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php';336 337		require_once ABSPATH . WPINC . '/customize/class-wp-customize-custom-css-setting.php';338		require_once ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php';339		require_once ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php';340		require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php';341		require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php';

History

Introduced in 3.4.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 6.8.8 tag, from src/wp-includes/class-wp-customize-manager.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.