login_header( string|null $title = null, string $message = '', WP_Error|null $wp_error = null )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$titlestring|nulloptional

WordPress login page title to display in the <title> element.
Defaults to 'Log In'.Default: null

$messagestringoptional

Message to display in header. Default empty.Default: ''

$wp_errorWP_Error|nulloptional

The error to pass. Defaults to a WP_Error instance.Default: null

Performance profile

How much work a call to login_header() 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

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

176–247

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 308.

Plugin surface

12 hooks

Third-party callbacks on 'shake_error_codes', 'login_title', 'login_enqueue_scripts' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below login_header()

Further down the call graph this can also reach 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 · 32 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost login_header() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 12

12 hooks fire while login_header() runs, in this order:

1. 1
   apply_filters( shake_error_codes )filterline 67 (+26 into the body)

   Filters the error codes array for shaking the login form.

2. 2
   apply_filters( login_title )filterline 91 (+50 into the body)

   Filters the title tag content for login page.

3. 3
   do_action( login_enqueue_scripts )actionline 120 (+79 into the body)

   Enqueues scripts and styles for the login page.

4. 4
   do_action( login_head )actionline 127 (+86 into the body)

   Fires in the login page header after scripts are enqueued.

5. 5
   apply_filters( login_headerurl )filterline 138 (+97 into the body)

   Filters link URL of the header logo above login form.

6. 6
   do_action( login_headertitle )filter_deprecatedline 150 (+109 into the body)

   Filters the title attribute of the header logo above login form.

7. 7
   apply_filters( login_headertext )filterline 167 (+126 into the body)

   Filters the link text of the header logo above the login form.

8. 8
   apply_filters( login_body_class )filterline 197 (+156 into the body)

   Filters the login page body classes.

9. 9
   do_action( login_header )actionline 212 (+171 into the body)

   Fires in the login page header after the body tag is opened.

10. 10
    apply_filters( login_message )filterline 231 (+190 into the body)

    Filters the message to display above the login form.

11. 11
    apply_filters( login_errors )filterline 280 (+239 into the body)

    Filters the error messages displayed above the login form.

12. 12
    apply_filters( login_messages )filterline 300 (+259 into the body)

    Filters instructional messages displayed above the login form.

Uses · 21

• __()Retrieves the translation of $text.
• add_filter()Adds a callback function to a filter hook.
• add_action()Adds a callback function to an action hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_bloginfo()Retrieves information about the current site.
• wp_is_recovery_mode()Determines whether WordPress is in Recovery Mode.
• language_attributes()Displays the language attributes for the 'html' tag.
• bloginfo()Displays information about the current site.
• wp_enqueue_style()Enqueues a CSS stylesheet.
• wp_print_inline_script_tag()Prints an inline script tag.
• wp_remove_surrounding_empty_script_tags()Removes leading and trailing _empty_ script tags.

Source code

View on Trac ↗View on GitHub ↗

41function login_header( $title = null, $message = '', $wp_error = null ) {42	global $error, $interim_login, $action;43 44	if ( null === $title ) {45		$title = __( 'Log In' );46	}47 48	// Don't index any of these forms.49	add_filter( 'wp_robots', 'wp_robots_sensitive_page' );50	add_action( 'login_head', 'wp_strict_cross_origin_referrer' );51 52	add_action( 'login_head', 'wp_login_viewport_meta' );53 54	if ( ! is_wp_error( $wp_error ) ) {55		$wp_error = new WP_Error();56	}57 58	// Shake it!59	$shake_error_codes = array( 'empty_password', 'empty_email', 'invalid_email', 'invalidcombo', 'empty_username', 'invalid_username', 'incorrect_password', 'retrieve_password_email_failure' );60	/**61	 * Filters the error codes array for shaking the login form.62	 *63	 * @since 3.0.064	 *65	 * @param string[] $shake_error_codes Error codes that shake the login form.66	 */67	$shake_error_codes = apply_filters( 'shake_error_codes', $shake_error_codes );68 69	if ( $shake_error_codes && $wp_error->has_errors() && in_array( $wp_error->get_error_code(), $shake_error_codes, true ) ) {70		add_action( 'login_footer', 'wp_shake_js', 12 );71	}72 73	$login_title = get_bloginfo( 'name', 'display' );74 75	/* translators: Login screen title. 1: Login screen name, 2: Network or site name. */76	$login_title = sprintf( __( '%1$s &lsaquo; %2$s &#8212; WordPress' ), $title, $login_title );77 78	if ( wp_is_recovery_mode() ) {79		/* translators: %s: Login screen title. */80		$login_title = sprintf( __( 'Recovery Mode &#8212; %s' ), $login_title );81	}82 83	/**84	 * Filters the title tag content for login page.85	 *86	 * @since 4.9.087	 *88	 * @param string $login_title The page title, with extra context added.89	 * @param string $title       The original page title.90	 */91	$login_title = apply_filters( 'login_title', $login_title, $title );92 93	?><!DOCTYPE html>94	<html <?php language_attributes(); ?>>95	<head>96	<meta http-equiv="Content-Type" content="<?php bloginfo( 'html_type' ); ?>; charset=<?php bloginfo( 'charset' ); ?>" />97	<title><?php echo $login_title; ?></title>98	<?php99 100	wp_enqueue_style( 'login' );101 102	/*103	 * Remove all stored post data on logging out.104	 * This could be added by add_action('login_head'...) like wp_shake_js(),105	 * but maybe better if it's not removable by plugins.106	 */107	if ( 'loggedout' === $wp_error->get_error_code() ) {108		ob_start();109		?>110		<script>if("sessionStorage" in window){try{for(var key in sessionStorage){if(key.indexOf("wp-autosave-")!=-1){sessionStorage.removeItem(key)}}}catch(e){}};</script>111		<?php112		wp_print_inline_script_tag( wp_remove_surrounding_empty_script_tags( ob_get_clean() ) );113	}114 115	/**116	 * Enqueues scripts and styles for the login page.117	 *118	 * @since 3.1.0119	 */120	do_action( 'login_enqueue_scripts' );

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-login.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.