函数原型
get_header( string $name = null, array $args = array() ): void|false
函数描述
Loads header template.
是否弃用
未弃用
函数参数
-
$name
string
Optional - The name of the specialised header.
Default:
null -
$args
array
Optional - Additional arguments passed to the header template.
Default:
array()
函数返回值
void|false Void on success, false if the template does not exist.
函数位置
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;
}
}
源码链接
变更日志
| Version | Description |
|---|---|
| 5.5.0 | The $args parameter was added. |
| 1.5.0 | Introduced. |

