wp_lostpassword_url( string $redirect = '' ): string
- Since
- 2.8.0
- Source
wp-includes/general-template.php:658
Compatibility
- WordPress
- since 2.8.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.
Parameters
$redirectstringoptional- Path to redirect to on login.Default:
''
Return value
string- Lost password URL.
Performance profile
How much work a call to wp_lostpassword_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
- Scaling
- Constant
- Instructions
- 23–33
- Plugin surface
- 1 hook
- Called by
- 2
Touches nothing outside its own arguments.
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 34.
Third-party callbacks on 'lostpassword_url' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize, query 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_lostpassword_url() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($redirect) && !is_multisite() | 23 | is_multisite(), network_site_url(), add_query_arg(), apply_filters() |
empty($redirect) && is_multisite() | 28 | is_multisite(), get_site(), network_site_url(), add_query_arg(), apply_filters() |
!empty($redirect) && !is_multisite() | 28 | urlencode(), is_multisite(), network_site_url(), add_query_arg(), apply_filters() |
!empty($redirect) && is_multisite() | 33 | urlencode(), is_multisite(), get_site(), network_site_url(), add_query_arg(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 34 instructions, 23–33 executed per call, 2 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.
Hooks and filters fired · 1
One hook fires while wp_lostpassword_url() runs, in this order:
Uses · 5
- is_multisite()Determines whether Multisite is enabled.
- get_site()Retrieves site data given a site ID or site object.
- add_query_arg()Retrieves a modified URL query string.
- network_site_url()Retrieves the site URL for the current network.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- wp_authenticate_email_password()Authenticates a user using the email and password.
- wp_authenticate_username_password()Authenticates a user, confirming the username and password are valid.
Source code
function wp_lostpassword_url( $redirect = '' ) { $args = array( 'action' => 'lostpassword', ); if ( ! empty( $redirect ) ) { $args['redirect_to'] = urlencode( $redirect ); } if ( is_multisite() ) { $blog_details = get_site(); $wp_login_path = $blog_details->path . 'wp-login.php'; } else { $wp_login_path = 'wp-login.php'; } $lostpassword_url = add_query_arg( $args, network_site_url( $wp_login_path, 'login' ) ); /** * Filters the Lost Password URL. * * @since 2.8.0 * * @param string $lostpassword_url The lost password page URL. * @param string $redirect The path to redirect to on login. */ return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );}Changelog
Introduced in 2.8.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.9.7 tag, from
src/wp-includes/general-template.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.