auth_redirect()

Description

Compatibility

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

Performance profile

How much work a call to auth_redirect() 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

Heavy

Reaches the database via get_user_by().

Scaling

Constant

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

Instructions

27–79

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

Plugin surface

3 hooks

Third-party callbacks on 'secure_auth_redirect', 'auth_redirect_scheme', 'auth_redirect' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_user_by()one call below auth_redirect()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 56 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while auth_redirect() runs, in this order:

1. 1
   apply_filters( secure_auth_redirect )filterline 1205 (+10 into the body)

   Filters whether to use a secure authentication redirect.

2. 2
   apply_filters( auth_redirect_scheme )filterline 1225 (+30 into the body)

   Filters the authentication redirect scheme.

3. 3
   do_action( auth_redirect )actionline 1236 (+41 into the body)

   Fires before the authentication redirect.

Uses · 13

• is_ssl()Determines if SSL is used.
• force_ssl_admin()Determines whether to force SSL used for the Administration Screens.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_redirect()Redirects to another page.
• set_url_scheme()Sets the scheme for a URL.
• wp_validate_auth_cookie()Validates authentication cookie.
• do_action()Calls the callback functions that have been added to an action hook.
• get_user_option()Retrieves user option that can be either per Site or per Network.
• nocache_headers()Sets the HTTP headers to prevent caching for the different browsers.
• wp_get_referer()Retrieves referer from '_wp_http_referer' or HTTP referer.

Used by · 1

• WP_Customize_Manager::setup_theme()Starts preview and customize theme.

Source code

View on Trac ↗View on GitHub ↗

1195	function auth_redirect() {1196		$secure = ( is_ssl() || force_ssl_admin() );1197 1198		/**1199		 * Filters whether to use a secure authentication redirect.1200		 *1201		 * @since 3.1.01202		 *1203		 * @param bool $secure Whether to use a secure authentication redirect. Default false.1204		 */1205		$secure = apply_filters( 'secure_auth_redirect', $secure );1206 1207		// If https is required and request is http, redirect.1208		if ( $secure && ! is_ssl() && str_contains( $_SERVER['REQUEST_URI'], 'wp-admin' ) ) {1209			if ( str_starts_with( $_SERVER['REQUEST_URI'], 'http' ) ) {1210				wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );1211				exit;1212			} else {1213				wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );1214				exit;1215			}1216		}1217 1218		/**1219		 * Filters the authentication redirect scheme.1220		 *1221		 * @since 2.9.01222		 *1223		 * @param string $scheme Authentication redirect scheme. Default empty.1224		 */1225		$scheme = apply_filters( 'auth_redirect_scheme', '' );1226 1227		$user_id = wp_validate_auth_cookie( '', $scheme );1228		if ( $user_id ) {1229			/**1230			 * Fires before the authentication redirect.1231			 *1232			 * @since 2.8.01233			 *1234			 * @param int $user_id User ID.1235			 */1236			do_action( 'auth_redirect', $user_id );1237 1238			// If the user wants ssl but the session is not ssl, redirect.1239			if ( ! $secure && get_user_option( 'use_ssl', $user_id ) && str_contains( $_SERVER['REQUEST_URI'], 'wp-admin' ) ) {1240				if ( str_starts_with( $_SERVER['REQUEST_URI'], 'http' ) ) {1241					wp_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );1242					exit;1243				} else {1244					wp_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );1245					exit;1246				}1247			}1248 1249			return; // The cookie is good, so we're done.1250		}1251 1252		// The cookie is no good, so force login.1253		nocache_headers();1254 1255		if ( str_contains( $_SERVER['REQUEST_URI'], '/options.php' ) && wp_get_referer() ) {1256			$redirect = wp_get_referer();1257		} else {1258			$redirect = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );1259		}1260 1261		$login_url = wp_login_url( $redirect, true );1262 1263		wp_redirect( $login_url );1264		exit;1265	}

Changelog

Introduced in 1.5.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 6.8.8 tag, from src/wp-includes/pluggable.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.