wppaste
WordPress

WP_Customize_Manager::get_return_url(): string

Since
4.4.0
Source
wp-includes/class-wp-customize-manager.php:4718
Gets URL to link the user to when closing the Customizer.

Compatibility

WordPress
since 4.4.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Return value

string
URL for link to close Customizer.

Performance profile

How much work a call to WP_Customize_Manager::get_return_url() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
11–40

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 7 distinct outcomes

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

WhenInstructionsCalls it makes
always11wp_get_referer()
always14wp_get_referer(), home_url()
always18–20wp_get_referer(), parse_url(), wp_basename()
always23wp_get_referer(), parse_url(), wp_basename(), home_url()
always25–26wp_get_referer(), parse_url(), wp_basename(), parse_url()
$return_url_basename === "themes.php"32–36wp_get_referer(), parse_url(), wp_basename(), parse_url(), parse_str()
$return_url_basename === "themes.php" && isset($query_vars) && !isset($_registered_pages)40wp_get_referer(), parse_url(), wp_basename(), parse_url(), parse_str(), admin_url()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 61 instructions, 11–40 executed per call, 8 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 4

  • wp_get_referer()Retrieves referer from '_wp_http_referer' or HTTP referer.
  • wp_basename()i18n-friendly version of basename().
  • admin_url()Retrieves the URL to the admin area for the current site.
  • home_url()Retrieves the URL for the current site where the front end is accessible.

Used by · 1

Source code

View on Trac View on GitHub 

	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; 			$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' );				}			}		} 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 $return_url;	}

Changelog

Introduced in 4.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.