WP_Customize_Manager::customize_preview_settings()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to WP_Customize_Manager::customize_preview_settings() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

142–157

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 243.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::customize_preview_settings() can have, taken from its control-flow graph on PHP 8.5.

Uses · 23

• home_url()Retrieves the URL for the current site where the front end is accessible.
• sanitize_url()Sanitizes a URL for database or redirect usage.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• remove_query_arg()Removes an item or items from a query string.
• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• switch_to_user_locale()Switches the translations according to the given user's locale.
• get_current_user_id()Gets the current user's ID.
• __()Retrieves the translation of $text.
• restore_previous_locale()Restores the translations according to the previous locale.
• wp_is_block_theme()Returns whether the active theme is a block-based theme or not.
• current_user_can()Returns whether the current user has the specified capability.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.

Source code

View on Trac ↗View on GitHub ↗

2116	public function customize_preview_settings() {2117		$post_values                 = $this->unsanitized_post_values( array( 'exclude_changeset' => true ) );2118		$setting_validities          = $this->validate_setting_values( $post_values );2119		$exported_setting_validities = array_map( array( $this, 'prepare_setting_validity_for_js' ), $setting_validities );2120 2121		// Note that the REQUEST_URI is not passed into home_url() since this breaks subdirectory installations.2122		$self_url           = empty( $_SERVER['REQUEST_URI'] ) ? home_url( '/' ) : sanitize_url( wp_unslash( $_SERVER['REQUEST_URI'] ) );2123		$state_query_params = array(2124			'customize_theme',2125			'customize_changeset_uuid',2126			'customize_messenger_channel',2127		);2128		$self_url           = remove_query_arg( $state_query_params, $self_url );2129 2130		$allowed_urls  = $this->get_allowed_urls();2131		$allowed_hosts = array();2132		foreach ( $allowed_urls as $allowed_url ) {2133			$parsed = wp_parse_url( $allowed_url );2134			if ( empty( $parsed['host'] ) ) {2135				continue;2136			}2137			$host = $parsed['host'];2138			if ( ! empty( $parsed['port'] ) ) {2139				$host .= ':' . $parsed['port'];2140			}2141			$allowed_hosts[] = $host;2142		}2143 2144		$switched_locale = switch_to_user_locale( get_current_user_id() );2145		$l10n            = array(2146			'shiftClickToEdit'  => __( 'Shift-click to edit this element.' ),2147			'linkUnpreviewable' => __( 'This link is not live-previewable.' ),2148			'formUnpreviewable' => __( 'This form is not live-previewable.' ),2149		);2150		if ( $switched_locale ) {2151			restore_previous_locale();2152		}2153 2154		$settings = array(2155			'changeset'         => array(2156				'uuid'      => $this->changeset_uuid(),2157				'autosaved' => $this->autosaved(),2158			),2159			'timeouts'          => array(2160				'selectiveRefresh' => 250,2161				'keepAliveSend'    => 1000,2162			),2163			'theme'             => array(2164				'stylesheet'   => $this->get_stylesheet(),2165				'active'       => $this->is_theme_active(),2166				'isBlockTheme' => wp_is_block_theme(),2167			),2168			'url'               => array(2169				'self'          => $self_url,2170				'allowed'       => array_map( 'sanitize_url', $this->get_allowed_urls() ),2171				'allowedHosts'  => array_unique( $allowed_hosts ),2172				'isCrossDomain' => $this->is_cross_domain(),2173			),2174			'channel'           => $this->messenger_channel,2175			'activePanels'      => array(),2176			'activeSections'    => array(),2177			'activeControls'    => array(),2178			'settingValidities' => $exported_setting_validities,2179			'nonce'             => current_user_can( 'customize' ) ? $this->get_nonces() : array(),2180			'l10n'              => $l10n,2181			'_dirty'            => array_keys( $post_values ),2182		);2183 2184		foreach ( $this->panels as $panel_id => $panel ) {2185			if ( $panel->check_capabilities() ) {2186				$settings['activePanels'][ $panel_id ] = $panel->active();2187				foreach ( $panel->sections as $section_id => $section ) {2188					if ( $section->check_capabilities() ) {2189						$settings['activeSections'][ $section_id ] = $section->active();2190					}2191				}2192			}2193		}2194		foreach ( $this->sections as $id => $section ) {2195			if ( $section->check_capabilities() ) {

Changelog

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 7.1.0 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.