Title: WP_Customize_Manager::add_state_query_params
Published: December 7, 2016
Last modified: April 28, 2025

---

# WP_Customize_Manager::add_state_query_params( string $url ): string

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#description)
    - [See also](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#see-also)
 * [Parameters](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#wp--skip-link--target)

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

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#description)󠁿

### 󠀁[See also](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#see-also)󠁿

 * [wp_redirect()](https://developer.wordpress.org/reference/functions/wp_redirect/)
 * [WP_Customize_Manager::get_allowed_url()](https://developer.wordpress.org/reference/classes/WP_Customize_Manager/get_allowed_url/)

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#parameters)󠁿

 `$url`stringrequired

URL.

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#return)󠁿

 string URL.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#source)󠁿

    ```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']
    			&&
    			str_starts_with( $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;
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/class-wp-customize-manager.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/class-wp-customize-manager.php#L1988)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/class-wp-customize-manager.php#L1988-L2019)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#related)󠁿

| Uses | Description | 
| [WP_Customize_Manager::get_allowed_urls()](https://developer.wordpress.org/reference/classes/wp_customize_manager/get_allowed_urls/)`wp-includes/class-wp-customize-manager.php` |

Gets URLs allowed to be previewed.

  | 
| [WP_Customize_Manager::changeset_uuid()](https://developer.wordpress.org/reference/classes/wp_customize_manager/changeset_uuid/)`wp-includes/class-wp-customize-manager.php` |

Gets the changeset UUID.

  | 
| [wp_parse_url()](https://developer.wordpress.org/reference/functions/wp_parse_url/)`wp-includes/http.php` |

A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versions.

  | 
| [WP_Customize_Manager::get_stylesheet()](https://developer.wordpress.org/reference/classes/wp_customize_manager/get_stylesheet/)`wp-includes/class-wp-customize-manager.php` |

Retrieves the stylesheet name of the previewed theme.

  | 
| [WP_Customize_Manager::is_theme_active()](https://developer.wordpress.org/reference/classes/wp_customize_manager/is_theme_active/)`wp-includes/class-wp-customize-manager.php` |

Checks if the current theme is active.

  | 
| [add_query_arg()](https://developer.wordpress.org/reference/functions/add_query_arg/)`wp-includes/functions.php` |

Retrieves a modified URL query string.

  |

[Show 1 more](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#)

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_customize_manager/add_state_query_params/?output_format=md#changelog)󠁿

| Version | Description | 
| [4.7.0](https://developer.wordpress.org/reference/since/4.7.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_customize_manager%2Fadd_state_query_params%2F)
before being able to contribute a note or feedback.