get_header( string $name = null )
Load header template.
Description
Includes the header template for a theme or if a name is specified then a specialised header will be included.
For the parameter, if the file is called "header-special.php" then specify "special".
Parameters
- $name
-
(string) (Optional) The name of the specialised header.
Default value: null
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 |
---|---|
WP-1.5.0 | Introduced. |