get_header()
Includes the header.php template file from your current theme's directory. If a $name is specified then header-{name}.php file will be included.
If the theme contains no header.php file then the header from the default theme wp-includes/theme-compat/header.php
will be included.
Uses: locate_template()
Hooks from the function
Return
null|false
. Void on success, false if the template does not exist.
Usage
get_header( $name, $args );
- $name(string)
- The name of the specialized header.
Default: null - $args(array)
- Additional arguments passed to the header template.
Default: empty array
Examples
#1 Simple 404 page
<?php get_header(); ?> <h2>Error 404 - Not Found</h2> <?php get_sidebar(); ?> <?php get_footer(); ?>
#2 Multiple Headers
<?php if ( is_home() ) : get_header( 'home' ); elseif ( is_404() ) : get_header( '404' ); else : get_header(); endif; ?>
The file names for the home and 404 headers should be header-home.php
and header-404.php
respectively.
Changelog
Since 1.5.0 | Introduced. |
Since 5.5.0 | A return value was added. |
Since 5.5.0 | The $args parameter was added. |