load_template( string $_template_file, bool $load_once = true, array $args = array() )
Requires the template file with WordPress environment.
Contents
Description
The globals are set up for the template file to ensure that the WordPress environment is available from within the function. The query variables are also available.
Parameters
-
$_template_filestring Required -
Path to template file.
-
$load_oncebool Optional -
Whether to require_once or require.
Default:
true -
$argsarray Optional -
Additional arguments passed to the template.
Default:
array()
More Information
Uses global: (object) $wp_query to extract extract() global variables returned by the query_vars method while protecting the current values in these global variables:
- (unknown type) $posts
- (unknown type) $post
- (boolean) $wp_did_header Returns true if the WordPress header was already loaded. See the /wp-blog-header.php file for details.
- (boolean) $wp_did_template_redirect
- (object) $wp_rewrite
- (object) $wpdb
- (string) $wp_version holds the installed WordPress version number.
- (string) $wp
- (string) $id
- (string) $comment
- (string) $user_ID
Source
File: wp-includes/template.php.
View all references
function load_template( $_template_file, $load_once = true, $args = array() ) {
global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID;
if ( is_array( $wp_query->query_vars ) ) {
/*
* This use of extract() cannot be removed. There are many possible ways that
* templates could depend on variables that it creates existing, and no way to
* detect and deprecate it.
*
* Passing the EXTR_SKIP flag is the safest option, ensuring globals and
* function variables cannot be overwritten.
*/
// phpcs:ignore WordPress.PHP.DontExtract.extract_extract
extract( $wp_query->query_vars, EXTR_SKIP );
}
if ( isset( $s ) ) {
$s = esc_attr( $s );
}
/**
* Fires before a template file is loaded.
*
* @since 6.1.0
*
* @param string $_template_file The full path to the template file.
* @param bool $load_once Whether to require_once or require.
* @param array $args Additional arguments passed to the template.
*/
do_action( 'wp_before_load_template', $_template_file, $load_once, $args );
if ( $load_once ) {
require_once $_template_file;
} else {
require $_template_file;
}
/**
* Fires after a template file is loaded.
*
* @since 6.1.0
*
* @param string $_template_file The full path to the template file.
* @param bool $load_once Whether to require_once or require.
* @param array $args Additional arguments passed to the template.
*/
do_action( 'wp_after_load_template', $_template_file, $load_once, $args );
}
Hooks
-
do_action( 'wp_after_load_template',
string $_template_file ,bool $load_once ,array $args ) -
Fires after a template file is loaded.
-
do_action( 'wp_before_load_template',
string $_template_file ,bool $load_once ,array $args ) -
Fires before a template file is loaded.
Changelog
| Version | Description |
|---|---|
| 5.5.0 | The $args parameter was added. |
| 1.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Loading a template in a plugin, but allowing theme and child theme to override template
Send variable with load_template()
you can send additional variable with load_template(). load_template() extracts all of the WP_Query query variables, into the scope of the loaded template.
use set_query_var() to make your variable available to the template part.
In template.php file you can access this variable like this
Top ↑
Feedback
Note that in recent WordPress `load_template` has a 3rd parameter for passing arguments to the template. — By strarsis —
Note that the arguments set in `$args` are not simply made available as variables of the same name (as the key) in the template. Instead they are available in the `$args` variable in the template.