do_action( 'get_header', string|null $name, array $args )

Fires before the header template file is loaded.


Parameters Parameters

$name

(string|null) Name of the specific header file to use. Null for the default header.

$args

(array) Additional arguments passed to the header template.


Top ↑

More Information More Information

get_header is a hook that gets run at the very start of the get_header function call. If you pass in the name for a specific header file into the function get_header(), like get_header( 'new' ), the do_action will pass in the same name as a parameter for the hook. This allows you to limit your add_action calls to specific templates if you wish. Actions added to this hook should be added to your functions.php file.

Note: This hook is best to use to set up and execute code that doesn’t get echoed to the browser until later in the page load. Anything you echo will show up before any of the markups is displayed.


Top ↑

Source Source

File: wp-includes/general-template.php

View on Trac



Top ↑

Changelog Changelog

Changelog
Version Description
5.5.0 The $args parameter was added.
2.8.0 The $name parameter was added.
2.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Collins Mbaka

    The following example will enqueue stylesheets conditionally for different headers. This is just one example of how you may use the hook and will use a secondary template file of header-new.php

    function wpdocs_themeslug_header_hook( $name ) {
    	if ( 'new' == $name ) {
    		add_action( 'wp_enqueue_scripts', 'wpdocs_themeslug_header_style' );
    	}
    }
    add_action( 'get_header', 'wpdocs_themeslug_header_hook' );
    
    function wpdocs_themeslug_header_style() {
    	wp_enqueue_style( 'wpdocs-header-new-style', get_template_directory_uri() . '/css/header-new.css' );
    }
    

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