get_header( string $name = null, array $args = array() )
Loads header template.
Description
Includes the header template for a theme or if a name is specified then a specialized header will be included.
For the parameter, if the file is called "header-special.php" then specify "special".
Parameters
- $name
-
(Optional) The name of the specialized header.
Default value: null
- $args
-
(Optional) Additional arguments passed to the header template.<br>
Default value: array()
Return
(void|false) Void on success, false if the template does not exist.
Source
File: wp-includes/general-template.php
function get_header( $name = null ) {
/**
* Fires before the header template file is loaded.
*
* @since WP-2.1.0
* @since WP-2.8.0 $name parameter added.
*
* @param string|null $name Name of the specific header file to use. null for the default header.
*/
do_action( 'get_header', $name );
$templates = array();
$name = (string) $name;
if ( '' !== $name ) {
$templates[] = "header-{$name}.php";
}
$templates[] = 'header.php';
locate_template( $templates, true );
}
Changelog
Version | Description |
---|---|
5.5.0 | The $args parameter was added. |
1.5.0 | Introduced. |