WP_Customize_Manager::get_return_url() WordPress Method

The WP_Customize_Manager::get_return_url() method is used to get the URL to which the user should be redirected when they click the "Return" button in the Customizer.

WP_Customize_Manager::get_return_url() #

Gets URL to link the user to when closing the Customizer.


Return

(string) URL for link to close Customizer.


Top ↑

Source

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

	public function get_return_url() {
		global $_registered_pages;

		$referer                    = wp_get_referer();
		$excluded_referer_basenames = array( 'customize.php', 'wp-login.php' );

		if ( $this->return_url ) {
			$return_url = $this->return_url;
		} elseif ( $referer && ! in_array( wp_basename( parse_url( $referer, PHP_URL_PATH ) ), $excluded_referer_basenames, true ) ) {
			$return_url = $referer;
		} elseif ( $this->preview_url ) {
			$return_url = $this->preview_url;
		} else {
			$return_url = home_url( '/' );
		}

		$return_url_basename = wp_basename( parse_url( $this->return_url, PHP_URL_PATH ) );
		$return_url_query    = parse_url( $this->return_url, PHP_URL_QUERY );

		if ( 'themes.php' === $return_url_basename && $return_url_query ) {
			parse_str( $return_url_query, $query_vars );

			/*
			 * If the return URL is a page added by a theme to the Appearance menu via add_submenu_page(),
			 * verify that it belongs to the active theme, otherwise fall back to the Themes screen.
			 */
			if ( isset( $query_vars['page'] ) && ! isset( $_registered_pages[ "appearance_page_{$query_vars['page']}" ] ) ) {
				$return_url = admin_url( 'themes.php' );
			}
		}

		return $return_url;
	}


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More