WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Difference between revisions of "Function Reference/login header"

m
m (link to action & filter reference)
 
Line 20: Line 20:
   
 
==Actions==
 
==Actions==
* Calls <tt>login_head</tt> for outputting HTML in the Log In header.
+
* Calls <tt>[[Plugin_API/Action_Reference/login_head|login_head]]</tt> for outputting HTML in the Log In header.
 
==Filters==
 
==Filters==
* Calls <tt>login_headerurl</tt> for the top login link.
+
* Calls <tt>[[Plugin_API/Filter_Reference/login_headerurl|login_headerurl]]</tt> for the top login link.
* Calls <tt>login_headertitle</tt> for the top login title.
+
* Calls <tt>[[Plugin_API/Filter_Reference/login_headertitle|login_headertitle]]</tt> for the top login title.
* Calls <tt>login_message</tt> on the message to display in the header.
+
* Calls <tt>[[Plugin_API/Filter_Reference/login_message|login_message]]</tt> on the message to display in the header.
* Calls <tt>login_errors</tt> on the display of the error messages.
+
* Calls <tt>[[Plugin_API/Filter_Reference/login_errors|login_errors]]</tt> on the display of the error messages.
* Calls <tt>login_body_class</tt> on the array of class names used for the login page body, additionally passing the <tt>$action</tt>.
+
* Calls <tt>[[Plugin_API/Filter_Reference/login_body_class|login_body_class]]</tt> on the array of class names used for the login page body, additionally passing the <tt>$action</tt>.
   
 
== Change Log ==
 
== Change Log ==

Latest revision as of 16:58, 18 December 2012

Description

Outputs the header for the login page.

Usage

<?php login_header($title, $message, $wp_error) ?>

Parameters

$title
(string) (optional) Login In Page title to display in <title/> element.
Default: 'Log In'
$message
(string) (optional) Message to display in header
Default: ""
$wp_error
(WP_Error) (optional) WordPress Error Object
Default: WP_Error

Examples

From wp_login.php:

<?php
$errors = new WP_Error();
...e 
login_header(__('Reset Password'), '<p class="message reset-pass">' . __('Enter your new password below.') . '</p>', $errors );
?>

Default Usage

Actions

  • Calls login_head for outputting HTML in the Log In header.

Filters

Change Log

Source File

login_header() is located in wp-login.php

Related