W3cubDocs

/WordPress

WP_Customize_Manager::customize_preview_settings()

Print JavaScript settings for preview frame.

Source

File: wp-includes/class-wp-customize-manager.php 

public function customize_preview_settings() {
		$post_values                 = $this->unsanitized_post_values( array( 'exclude_changeset' => true ) );
		$setting_validities          = $this->validate_setting_values( $post_values );
		$exported_setting_validities = array_map( array( $this, 'prepare_setting_validity_for_js' ), $setting_validities );

		// Note that the REQUEST_URI is not passed into home_url() since this breaks subdirectory installations.
		$self_url           = empty( $_SERVER['REQUEST_URI'] ) ? home_url( '/' ) : esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) );
		$state_query_params = array(
			'customize_theme',
			'customize_changeset_uuid',
			'customize_messenger_channel',
		);
		$self_url           = remove_query_arg( $state_query_params, $self_url );

		$allowed_urls  = $this->get_allowed_urls();
		$allowed_hosts = array();
		foreach ( $allowed_urls as $allowed_url ) {
			$parsed = wp_parse_url( $allowed_url );
			if ( empty( $parsed['host'] ) ) {
				continue;
			}
			$host = $parsed['host'];
			if ( ! empty( $parsed['port'] ) ) {
				$host .= ':' . $parsed['port'];
			}
			$allowed_hosts[] = $host;
		}

		$switched_locale = switch_to_locale( get_user_locale() );
		$l10n            = array(
			'shiftClickToEdit'  => __( 'Shift-click to edit this element.' ),
			'linkUnpreviewable' => __( 'This link is not live-previewable.' ),
			'formUnpreviewable' => __( 'This form is not live-previewable.' ),
		);
		if ( $switched_locale ) {
			restore_previous_locale();
		}

		$settings = array(
			'changeset'         => array(
				'uuid'      => $this->changeset_uuid(),
				'autosaved' => $this->autosaved(),
			),
			'timeouts'          => array(
				'selectiveRefresh' => 250,
				'keepAliveSend'    => 1000,
			),
			'theme'             => array(
				'stylesheet' => $this->get_stylesheet(),
				'active'     => $this->is_theme_active(),
			),
			'url'               => array(
				'self'          => $self_url,
				'allowed'       => array_map( 'esc_url_raw', $this->get_allowed_urls() ),
				'allowedHosts'  => array_unique( $allowed_hosts ),
				'isCrossDomain' => $this->is_cross_domain(),
			),
			'channel'           => $this->messenger_channel,
			'activePanels'      => array(),
			'activeSections'    => array(),
			'activeControls'    => array(),
			'settingValidities' => $exported_setting_validities,
			'nonce'             => current_user_can( 'customize' ) ? $this->get_nonces() : array(),
			'l10n'              => $l10n,
			'_dirty'            => array_keys( $post_values ),
		);

		foreach ( $this->panels as $panel_id => $panel ) {
			if ( $panel->check_capabilities() ) {
				$settings['activePanels'][ $panel_id ] = $panel->active();
				foreach ( $panel->sections as $section_id => $section ) {
					if ( $section->check_capabilities() ) {
						$settings['activeSections'][ $section_id ] = $section->active();
					}
				}
			}
		}
		foreach ( $this->sections as $id => $section ) {
			if ( $section->check_capabilities() ) {
				$settings['activeSections'][ $id ] = $section->active();
			}
		}
		foreach ( $this->controls as $id => $control ) {
			if ( $control->check_capabilities() ) {
				$settings['activeControls'][ $id ] = $control->active();
			}
		}

		?>
		<script type="text/javascript">
			var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
			_wpCustomizeSettings.values = {};
			(function( v ) {
				<?php
				/*
				 * Serialize settings separately from the initial _wpCustomizeSettings
				 * serialization in order to avoid a peak memory usage spike.
				 * @todo We may not even need to export the values at all since the pane syncs them anyway.
				 */
				foreach ( $this->settings as $id => $setting ) {
					if ( $setting->check_capabilities() ) {
						printf(
							"v[%s] = %s;\n",
							wp_json_encode( $id ),
							wp_json_encode( $setting->js_value() )
						);
					}
				}
				?>
			})( _wpCustomizeSettings.values );
		</script>
		<?php
	}

Uses

Uses Description
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::autosaved()

Gets whether data from a changeset’s autosaved revision should be loaded if it exists.
wp-includes/l10n.php: restore_previous_locale()

Restores the translations according to the previous locale.
wp-includes/l10n.php: switch_to_locale()

Switches the translations according to the given locale.
wp-includes/l10n.php: get_user_locale()

Retrieves the locale of a user.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_allowed_urls()

Get URLs allowed to be previewed.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::is_cross_domain()

Determines whether the admin and the frontend are on different domains.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::changeset_uuid()

Get the changeset UUID.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::validate_setting_values()

Validates setting values.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_nonces()

Get nonces for the Customizer.
wp-includes/http.php: wp_parse_url()

A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versions.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::unsanitized_post_values()

Get dirty pre-sanitized setting values in the current customized state.
wp-includes/functions.php: wp_json_encode()

Encode a variable into JSON, with some sanity checks.
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_stylesheet()

Retrieve the stylesheet name of the previewed theme.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::is_theme_active()

Checks if the current theme is active.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: wp_unslash()

Remove slashes from a string or array of strings.
wp-includes/formatting.php: esc_url_raw()

Performs esc_url() for database usage.
wp-includes/functions.php: remove_query_arg()

Removes an item or items from a query string.
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.

Changelog

Version Description
3.4.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_manager/customize_preview_settings