wp_lostpassword_url() – Function | Developer.WordPress.org

Returns the URL that allows the user to reset the lost password.

Parameters

$redirectstringoptional: Path to redirect to on login.
Default:''

Return

string Lost password URL.

Source

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘lostpassword_url’, string $lostpassword_url, string $redirect ): Filters the Lost Password URL.

Uses	Description
get_site()`wp-includes/ms-site.php`	Retrieves site data given a site ID or site object.
network_site_url()`wp-includes/link-template.php`	Retrieves the site URL for the current network.
is_multisite()`wp-includes/load.php`	Determines whether Multisite is enabled.
add_query_arg()`wp-includes/functions.php`	Retrieves a modified URL query string.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 3 more Show less

Used by	Description
wp_authenticate_email_password()`wp-includes/user.php`	Authenticates a user using the email and password.
wp_authenticate_username_password()`wp-includes/user.php`	Authenticates a user, confirming the username and password are valid.

Changelog

Version	Description
2.8.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Default Usage
```
<a href="<?php echo esc_url( wp_lostpassword_url() ); ?>" alt="<?php esc_attr_e( 'Lost Password', 'textdomain' ); ?>">
	<?php esc_html_e( 'Lost Password', 'textdomain' ); ?>
</a>
```
Log in to add feedback
Skip to note 5 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Lost Password and redirect to current page
```
<a href="<?php echo esc_url( wp_lostpassword_url( get_permalink() ) ); ?>" alt="<?php esc_attr_e( 'Lost Password', 'textdomain' ); ?>">
	<?php esc_html_e( 'Lost Password', 'textdomain' ); ?>
</a>
```
Log in to add feedback
Skip to note 6 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Lost Password and redirect to homepage
```
<a href="<?php echo esc_url( wp_lostpassword_url( get_home_url() ) ); ?>" alt="<?php esc_attr_e( 'Lost Password', 'textdomain' ); ?>">
	<?php esc_html_e( 'Lost Password', 'textdomain' ); ?>
</a>
```
Log in to add feedback

wp_lostpassword_url( string $redirect = ” ): string

In this article

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes

wp_lostpassword_url( string $redirect = ” ): string

In this article

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes