load_template( string $_template_file, bool $require_once = true )
Require the template file with WordPress environment.
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_file
-
(string) (Required) Path to template file.
- $require_once
-
(bool) (Optional) Whether to require_once or require.
Default value: true
Source
File: wp-includes/template.php
function load_template( $_template_file, $require_once = true ) { 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 ); } if ( $require_once ) { require_once( $_template_file ); } else { require( $_template_file ); } }
Changelog
Version | Description |
---|---|
1.5.0 | Introduced. |
Loading a template in a plugin, but allowing theme and child theme to override template
Expand full source codeCollapse full source code
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