wp_login_url( string $redirect = '', bool $force_reauth = false )
Retrieves the login URL.
Parameters
- $redirect
-
(Optional) Path to redirect to on log in.
Default value: ''
- $force_reauth
-
(Optional) Whether to force reauthorization, even if a cookie is present.<br>
Default value: false
Return
(string) The login URL. Not HTML-encoded.
Source
File: wp-includes/general-template.php
function wp_login_url($redirect = '', $force_reauth = false) {
$login_url = site_url('wp-login.php', 'login');
if ( !empty($redirect) )
$login_url = add_query_arg('redirect_to', urlencode($redirect), $login_url);
if ( $force_reauth )
$login_url = add_query_arg('reauth', '1', $login_url);
/**
* Filters the login URL.
*
* @since WP-2.8.0
* @since WP-4.2.0 The `$force_reauth` parameter was added.
*
* @param string $login_url The login URL. Not HTML-encoded.
* @param string $redirect The path to redirect to on login, if supplied.
* @param bool $force_reauth Whether to force reauthorization, even if a cookie is present.
*/
return apply_filters( 'login_url', $login_url, $redirect, $force_reauth );
}
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |