wp_login_form() │ WP 3.0.0

Outputs the HTML code for the login form.

Hooks from the function

login_form_defaults

login_form_top

login_form_middle

login_form_bottom

Returns

null|String. Displays the HTML code for the login form on the screen. If the parameter echo=0 is specified, the result will be returned for further processing.

Usage Template

wp_login_form( array(
	'echo'           => true,
	'redirect'       => site_url( $_SERVER['REQUEST_URI'] ),
	'form_id'        => 'loginform',
	'label_username' => __( 'Username' ),
	'label_password' => __( 'Password' ),
	'label_remember' => __( 'Remember Me' ),
	'label_log_in'   => __( 'Log In' ),
	'id_username'    => 'user_login',
	'id_password'    => 'user_pass',
	'id_remember'    => 'rememberme',
	'id_submit'      => 'wp-submit',
	'remember'       => true,
	'value_username' => NULL,
	'value_remember' => false
) );

Usage

<?php wp_login_form( $args ); ?>

$args(string/array): Array of arguments controlling the result.
Default: default parameters

Arguments for the $args parameter

echo(boolean): Display on screen (1) or return (0).
Default: 1
redirect(string): URL to redirect to after login.
Default: current page
form_id(string): id attribute of the tag <form id="loginform">.
Default: 'loginform'
label_username(string): Text for the "username" field label.
Default: '__( 'Username' )'
label_password(string): Text for the "password" field label.
Default: '__( 'Password' )'
label_remember(string): Text for the "remember me" field label.
Default: '__( 'Remember Me' )'
label_log_in(string): Text for the submit button.
Default: '__( 'Log In' )'
id_username(string): Value of the id attribute: <input id="user_login" />
Default: 'user_login'
id_password(string): Value of the id attribute: <input id="user_login" />
Default: 'user_pass'
id_remember(string): Value of the id attribute: <input id="user_login" />
Default: 'rememberme'
id_submit(string): Value of the id attribute: <input id="user_login" />
Default: 'wp-submit'
remember(boolean): Remember field values (1) or not (0).
Default: 1
value_username(string): Default username.
Default: ''
value_remember(string): Value of the value attribute for the "remember me" field. Default 1 - checkbox checked. 0 - checkbox unchecked.
Default: 1

Examples

#1 Usage example

<?php wp_login_form(); ?>

It displays it on the screen:

<form name="loginform" id="loginform" action="http://wp-kama.com/wp-login.php" method="post">

	<p class="login-username">
		<label for="user_login">Login</label>

		<input type="text" name="log" id="user_login" class="input" value="" size="20" tabindex="10" />
	</p>
	<p class="login-password">
		<label for="user_pass">Password</label>
		<input type="password" name="pwd" id="user_pass" class="input" value="" size="20" tabindex="20" />
	</p>

	<p class="login-remember"><label><input name="rememberme" type="checkbox" id="rememberme" value="forever" tabindex="90" /> Remember me</label></p>

	<p class="login-submit">
		<input type="submit" name="wp-submit" id="wp-submit" class="button-primary" value="Login" tabindex="100" />
		<input type="hidden" name="redirect_to" value="http://wp-kama.com/s" />
	</p>

</form>

#2 Stay on the same page when entering an incorrect login/password

By default, if an invalid login is entered in such a form, the user will be redirected to the main login page with an error.

To change this and leave the user on the same page, even if he has entered the wrong data, you can use the wp_login_failed hook:

// Leaves user on the same page if wrong login/password is 
// entered in login form wp_login_form()
add_action( 'wp_login_failed', 'my_front_end_login_fail' );

function my_front_end_login_fail( $username ) {

	$referrer = $_SERVER['HTTP_REFERER']; // where the request came from

	// If there is a referrer and it is not the wp-login.php page
	if( !empty($referrer) && !strstr($referrer,'wp-login') && !strstr($referrer,'wp-admin') ) {

		wp_redirect( add_query_arg('login', 'failed', $referrer ) ); // redirect and add the query parameter ?login=failed
		exit;
	}
}

#3 WordPress registration form

There is no special function for outputting the registration form. Therefore, you can output the form by writing your own HTML code. Here is an example of such HTML code of registration form:

<form id="registerform" action="<?php site_url('wp-login.php?action=register'); ?>" method="post">
	<p>
		<label for="user_login">
			Username<br>
			<input type="text" name="user_login" id="user_login" class="input" value="" size="20" style="">
		</label>
	</p>
	<p>
		<label for="user_email">
			E-mail<br>
			<input type="email" name="user_email" id="user_email" class="input" value="" size="25">
		</label>
	</p>

	<p id="reg_passmail">Registration confirmation will be sent to your email.</p>

	<br class="clear">
	<input type="hidden" name="redirect_to" value="">

	<p class="submit"><input type="submit" name="wp-submit" id="wp-submit" class="button-primary button-large" value="Register"></p>
</form>

#4 Disable administration email verification

I have found this function is often broken by the admin_email_check update for WP 5.3 resulting in a silent login failure.

If you run into silent login failures try disabling the admin email check.

// Disable administration email verification
add_filter( 'admin_email_check_interval', '__return_false' );

#5 Displays a login form as shortcode `[wpdocs_log_me]`

add_shortcode( 'wpdocs_log_me', 'wpdocs_log_me_shortcode_fn' );

function wpdocs_log_me_shortcode_fn() {

   $args = array(
	  'echo'            => false,
	  'redirect'        => get_permalink( get_the_ID() ),
	  'remember'        => true,
	  'value_remember'  => true,
   );

   return wp_login_form( $args );

}

Changelog

Since 3.0.0	Introduced.
Since 6.6.0	Added `required_username` and `required_password` arguments.

`wp_login_form() wp login form` code ^{WP 6.8.1}

wp-includes/general-template.php

function wp_login_form( $args = array() ) {
	$defaults = array(
		'echo'              => true,
		// Default 'redirect' value takes the user back to the request URI.
		'redirect'          => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'],
		'form_id'           => 'loginform',
		'label_username'    => __( 'Username or Email Address' ),
		'label_password'    => __( 'Password' ),
		'label_remember'    => __( 'Remember Me' ),
		'label_log_in'      => __( 'Log In' ),
		'id_username'       => 'user_login',
		'id_password'       => 'user_pass',
		'id_remember'       => 'rememberme',
		'id_submit'         => 'wp-submit',
		'remember'          => true,
		'value_username'    => '',
		// Set 'value_remember' to true to default the "Remember me" checkbox to checked.
		'value_remember'    => false,
		// Set 'required_username' to true to add the required attribute to username field.
		'required_username' => false,
		// Set 'required_password' to true to add the required attribute to password field.
		'required_password' => false,
	);

	/**
	 * Filters the default login form output arguments.
	 *
	 * @since 3.0.0
	 *
	 * @see wp_login_form()
	 *
	 * @param array $defaults An array of default login form arguments.
	 */
	$args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );

	/**
	 * Filters content to display at the top of the login form.
	 *
	 * The filter evaluates just following the opening form tag element.
	 *
	 * @since 3.0.0
	 *
	 * @param string $content Content to display. Default empty.
	 * @param array  $args    Array of login form arguments.
	 */
	$login_form_top = apply_filters( 'login_form_top', '', $args );

	/**
	 * Filters content to display in the middle of the login form.
	 *
	 * The filter evaluates just following the location where the 'login-password'
	 * field is displayed.
	 *
	 * @since 3.0.0
	 *
	 * @param string $content Content to display. Default empty.
	 * @param array  $args    Array of login form arguments.
	 */
	$login_form_middle = apply_filters( 'login_form_middle', '', $args );

	/**
	 * Filters content to display at the bottom of the login form.
	 *
	 * The filter evaluates just preceding the closing form tag element.
	 *
	 * @since 3.0.0
	 *
	 * @param string $content Content to display. Default empty.
	 * @param array  $args    Array of login form arguments.
	 */
	$login_form_bottom = apply_filters( 'login_form_bottom', '', $args );

	$form =
		sprintf(
			'<form name="%1$s" id="%1$s" action="%2$s" method="post">',
			esc_attr( $args['form_id'] ),
			esc_url( site_url( 'wp-login.php', 'login_post' ) )
		) .
		$login_form_top .
		sprintf(
			'<p class="login-username">
				<label for="%1$s">%2$s</label>
				<input type="text" name="log" id="%1$s" autocomplete="username" class="input" value="%3$s" size="20"%4$s />
			</p>',
			esc_attr( $args['id_username'] ),
			esc_html( $args['label_username'] ),
			esc_attr( $args['value_username'] ),
			( $args['required_username'] ? ' required="required"' : '' )
		) .
		sprintf(
			'<p class="login-password">
				<label for="%1$s">%2$s</label>
				<input type="password" name="pwd" id="%1$s" autocomplete="current-password" spellcheck="false" class="input" value="" size="20"%3$s />
			</p>',
			esc_attr( $args['id_password'] ),
			esc_html( $args['label_password'] ),
			( $args['required_password'] ? ' required="required"' : '' )
		) .
		$login_form_middle .
		( $args['remember'] ?
			sprintf(
				'<p class="login-remember"><label><input name="rememberme" type="checkbox" id="%1$s" value="forever"%2$s /> %3$s</label></p>',
				esc_attr( $args['id_remember'] ),
				( $args['value_remember'] ? ' checked="checked"' : '' ),
				esc_html( $args['label_remember'] )
			) : ''
		) .
		sprintf(
			'<p class="login-submit">
				<input type="submit" name="wp-submit" id="%1$s" class="button button-primary" value="%2$s" />
				<input type="hidden" name="redirect_to" value="%3$s" />
			</p>',
			esc_attr( $args['id_submit'] ),
			esc_attr( $args['label_log_in'] ),
			esc_url( $args['redirect'] )
		) .
		$login_form_bottom .
		'</form>';

	if ( $args['echo'] ) {
		echo $form;
	} else {
		return $form;
	}
}