get_header( string $name = null )

Load header template.

Contents

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

Parameters Parameters

$name

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

Default value: null

Top ↑

Source Source

File: wp-includes/general-template.php 

function get_header( $name = null ) {
	/**
	 * Fires before the header template file is loaded.
	 *
	 * @since 2.1.0
	 * @since 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 );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/general-template.php: get_header

Fires before the header template file is loaded.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/template.php: locate_template()

Retrieve the name of the highest priority template file that exists.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    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.

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
    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.