load_template

Require the template file with WordPress environment.

Description

load_template( (string) $_template_file, (bool) $require_once = true ); 

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 (2)

0. $template_file (string)
Path to template file.
1. $require_once — Optional. (bool) => true
Whether to require_once or require. Default true.

Usage

  1. if ( !function_exists( 'load_template' ) ) { 
  2.     require_once ABSPATH . WPINC . '/template.php'; 
  3. } 
  4.   
  5. // Path to template file. 
  6. $template_file = ''; 
  7.   
  8. // Whether to require_once or require. Default true. 
  9. $require_once = true; 
  10.   
  11. // NOTICE! Understand what this does before running. 
  12. $result = load_template($template_file, $require_once); 
  13.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/template.php  
  1. function load_template( $_template_file, $require_once = true ) { 
  2.     global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID; 
  3.  
  4.     if ( is_array( $wp_query->query_vars ) ) { 
  5.         extract( $wp_query->query_vars, EXTR_SKIP ); 
  6.     } 
  7.  
  8.     if ( isset( $s ) ) { 
  9.         $s = esc_attr( $s ); 
  10.     } 
  11.  
  12.     if ( $require_once ) { 
  13.         require_once( $_template_file ); 
  14.     } else { 
  15.         require( $_template_file ); 
  16.     } 
  17. }