wp_auth_check_html()
- Since
- 3.6.0
- Source
wp-includes/functions.php:7446
Compatibility
- WordPress
- since 3.6.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.
Performance profile
How much work a call to wp_auth_check_html() 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
- Scaling
- Constant
- Instructions
- 46–63
- Plugin surface
- 1 hook
- Called by
- 0
Reaches the database via get_user_by().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 65.
Third-party callbacks on 'wp_auth_check_same_domain' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_user_by()one call below wp_auth_check_html()
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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_auth_check_html() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$login_url | 46–48 | wp_login_url(), is_ssl(), apply_filters(), _e(), _e(), esc_url(), _e(), _e() |
$login_url | 61–63 | wp_login_url(), is_ssl(), apply_filters(), _e(), get_user_locale(), 1(), esc_url(), _e(), esc_url(), _e(), _e() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 65 | 46–63 | 3 | |
| 8.5 | 65 | 46–63 | 3 | |
| 8.4 | 65 | 46–63 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 68 | 49–66 | 3 | |
| 8.2 | 68 | 49–66 | 3 | |
| 8.1 | 68 | 49–66 | 3 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 69 | 50–67 | 3 |
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.
Hooks and filters fired · 1
One hook fires while wp_auth_check_html() runs, in this order:
- apply_filters( wp_auth_check_same_domain )filterline 7458 (+12 into the body)
Filters whether the authentication check originated at the same domain.
Uses · 8
- wp_login_url()Retrieves the login URL.
- is_ssl()Determines if SSL is used.
- str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- _e()Displays translated text.
- add_query_arg()Retrieves a modified URL query string.
- get_user_locale()Retrieves the locale of a user.
- esc_url()Checks and cleans a URL.
Source code
function wp_auth_check_html() { $login_url = wp_login_url(); $current_domain = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST']; $same_domain = str_starts_with( $login_url, $current_domain ); /** * Filters whether the authentication check originated at the same domain. * * @since 3.6.0 * * @param bool $same_domain Whether the authentication check originated at the same domain. */ $same_domain = apply_filters( 'wp_auth_check_same_domain', $same_domain ); $wrap_class = $same_domain ? 'hidden' : 'hidden fallback'; ?> <div id="wp-auth-check-wrap" class="<?php echo $wrap_class; ?>"> <div id="wp-auth-check-bg"></div> <div id="wp-auth-check"> <button type="button" class="wp-auth-check-close button-link"><span class="screen-reader-text"> <?php /* translators: Hidden accessibility text. */ _e( 'Close dialog' ); ?> </span></button> <?php if ( $same_domain ) { $login_src = add_query_arg( array( 'interim-login' => '1', 'wp_lang' => get_user_locale(), ), $login_url ); ?> <div id="wp-auth-check-form" class="loading" data-src="<?php echo esc_url( $login_src ); ?>"></div> <?php } ?> <div class="wp-auth-fallback"> <p><b class="wp-auth-fallback-expired" tabindex="0"><?php _e( 'Session expired' ); ?></b></p> <p><a href="<?php echo esc_url( $login_url ); ?>" target="_blank"><?php _e( 'Please log in again.' ); ?></a> <?php _e( 'The login page will open in a new tab. After logging in you can close it and return to this page.' ); ?></p> </div> </div> </div> <?php}Changelog
Introduced in 3.6.0. Unchanged from 6.7.7 through 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/functions.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.