get_header( string $name = null, array $args = array() )

Load header template.


Description 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".


Top ↑

Parameters Parameters

$name

(string) (Optional) The name of the specialised header.

Default value: null

$args

(array) (Optional) Additional arguments passed to the header template.

Default value: array()


Top ↑

Return Return

(void|false) Void on success, false if the template does not exist.


Top ↑

More Information More Information

If the theme contains no header.php file then the header from the default theme wp-includes/theme-compat/header.php will be included.


Top ↑

Source Source

File: wp-includes/general-template.php

function get_header( $name = null, $args = array() ) {
	/**
	 * Fires before the header template file is loaded.
	 *
	 * @since 2.1.0
	 * @since 2.8.0 The `$name` parameter was added.
	 * @since 5.5.0 The `$args` parameter was added.
	 *
	 * @param string|null $name Name of the specific header file to use. Null for the default header.
	 * @param array       $args Additional arguments passed to the header template.
	 */
	do_action( 'get_header', $name, $args );

	$templates = array();
	$name      = (string) $name;
	if ( '' !== $name ) {
		$templates[] = "header-{$name}.php";
	}

	$templates[] = 'header.php';

	if ( ! locate_template( $templates, true, true, $args ) ) {
		return false;
	}
}


Top ↑

Changelog Changelog

Changelog
Version Description
5.5.0 The $args parameter was added.
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Multiple Headers
    Different header for different pages.

    <?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.

  2. Skip to note 3 content
    Contributed by Codex

    Simple 404 page
    The following code is a simple example of a template for an “HTTP 404: Not Found” error (which you could include in your theme as 404.php).

    <?php get_header(); ?>
    
    <h2><?php esc_html_e( 'Error 404 - Not Found', 'textdomain' ); ?></h2>
    
    <?php get_sidebar(); ?>
    <?php get_footer(); ?>
    

You must log in before being able to contribute a note or feedback.