W3cubDocs

/WordPress

WP_Customize_Manager::add_state_query_params( string $url )

Add customize state query params to a given URL if preview is allowed.

Description

See also

Parameters

$url

(string) (Required) URL.

Return

(string) URL.

Source

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

public function add_state_query_params( $url ) {
		$parsed_original_url = wp_parse_url( $url );
		$is_allowed          = false;
		foreach ( $this->get_allowed_urls() as $allowed_url ) {
			$parsed_allowed_url = wp_parse_url( $allowed_url );
			$is_allowed         = (
				$parsed_allowed_url['scheme'] === $parsed_original_url['scheme']
				&&
				$parsed_allowed_url['host'] === $parsed_original_url['host']
				&&
				0 === strpos( $parsed_original_url['path'], $parsed_allowed_url['path'] )
			);
			if ( $is_allowed ) {
				break;
			}
		}

		if ( $is_allowed ) {
			$query_params = array(
				'customize_changeset_uuid' => $this->changeset_uuid(),
			);
			if ( ! $this->is_theme_active() ) {
				$query_params['customize_theme'] = $this->get_stylesheet();
			}
			if ( $this->messenger_channel ) {
				$query_params['customize_messenger_channel'] = $this->messenger_channel;
			}
			$url = add_query_arg( $query_params, $url );
		}

		return $url;
	}

Uses

Uses Description
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::changeset_uuid()

Get the changeset UUID.
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::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/functions.php: add_query_arg()

Retrieves a modified URL query string.

Changelog

Version Description
4.7.0 Introduced.

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