W3cubDocs

/WordPress

wp_login_url( string $redirect = '', bool $force_reauth = false )

Retrieves the login URL.

Parameters

$redirect

(string) (Optional) Path to redirect to on log in.

Default value: ''

$force_reauth

(bool) (Optional) Whether to force reauthorization, even if a cookie is present.

Default value: false

Return

(string) The login URL. Not HTML-encoded.

More Information

$redirect argument must be absolute, such as http://example.com/mypage/. For best results, use site_url( ‘/mypage/ ‘ ).

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 2.8.0
	 * @since 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 );
}

Uses

Uses Description
wp-includes/general-template.php: login_url

Filters the login URL.
wp-includes/functions.php: add_query_arg()

Retrieves a modified URL query string.
wp-includes/link-template.php: site_url()

Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By Description
wp-includes/class-wp-recovery-mode-link-service.php: WP_Recovery_Mode_Link_Service::handle_begin_link()

Enters recovery mode when the user hits wp-login.php with a valid recovery mode link.
wp-includes/class-wp-recovery-mode-link-service.php: WP_Recovery_Mode_Link_Service::get_recovery_mode_begin_url()

Gets a URL to begin recovery mode.
wp-includes/admin-bar.php: wp_admin_bar_recovery_mode_menu()

Add a link to exit recovery mode when Recovery Mode is active.
wp-admin/includes/update.php: wp_recovery_mode_nag()

Displays a notice when the user is in recovery mode.
wp-includes/user.php: wp_send_user_request()

Send a confirmation request email to confirm an action.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::customize_pane_settings()

Print JavaScript settings for parent window.
wp-signup.php: confirm_another_blog_signup()

Confirm a new site signup.
wp-admin/includes/network.php: network_step2()

Prints step 2 for Network installation process.
wp-admin/includes/upgrade.php: wp_new_blog_notification()

Notifies the site admin that the setup is complete.
wp-includes/pluggable.php: wp_new_user_notification()

Email login credentials to a newly-registered user.
wp-includes/pluggable.php: auth_redirect()

Checks if a user is logged in, if not it redirects them to the login page.
wp-includes/general-template.php: wp_loginout()

Display the Log In/Out link.
wp-includes/functions.php: wp_auth_check_html()

Output the HTML that shows the wp-login dialog when the user is no longer logged in.
wp-includes/canonical.php: wp_redirect_admin_locations()

Redirects a variety of shorthand URLs to the admin.
wp-includes/ms-functions.php: wpmu_welcome_user_notification()

Notify a user that their account activation has been successful.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::initialise_blog_option_info()

Set up blog options property.
wp-includes/comment-template.php: get_post_reply_link()

Retrieves HTML content for reply to post link.
wp-includes/comment-template.php: comment_form()

Outputs a complete commenting form for use within a template.
wp-includes/comment-template.php: get_comment_reply_link()

Retrieves HTML content for reply to comment link.

Changelog

Version Description
2.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_login_url