get_header

函数


get_header ( $name = null, $args = array() )
参数
  • (string)
    $name
    The name of the specialised header.
    Required:
    Default: null
  • (array)
    $args
    Optional. Additional arguments passed to the header template. Default empty array.
    Required:
    Default: array()
返回值
  • (void|false) Void on success, false if the template does not exist.
定义位置
  • wp-includes/general-template.php
    , line 27
引入
1.5.0
弃用

Loads header template.

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

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;
	}
}