+global\EEH_Template::locate_template()

Complexity

Conditions	22
Paths	1306

Size

Total Lines	104
Code Lines	53

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
	public static function locate_template( $templates = array(), $template_args = array(), $load = TRUE, $return_string = TRUE, $check_if_custom = FALSE ) {
		// first use WP locate_template to check for template in the current theme folder
		$template_path = locate_template( $templates );

		if ( $check_if_custom && !empty( $template_path ) )
			return TRUE;

		// not in the theme
		if ( empty( $template_path )) {
			// not even a template to look for ?
			if ( empty( $templates )) {
				// get post_type
				$post_type = EE_Registry::instance()->REQ->get( 'post_type' );
				// get array of EE Custom Post Types
				$EE_CPTs = EE_Register_CPTs::get_CPTs();
				// build template name based on request
				if ( isset( $EE_CPTs[ $post_type ] )) {
					$archive_or_single =  is_archive() ? 'archive' : '';
					$archive_or_single =  is_single() ? 'single' : $archive_or_single;
					$templates = $archive_or_single . '-' . $post_type . '.php';
				}
			}
			// currently active EE template theme
			$current_theme = EE_Config::get_current_theme();

			// array of paths to folders that may contain templates
			$template_folder_paths = array(
				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
				// then in the root of the /wp-content/uploads/espresso/templates/ folder
				EVENT_ESPRESSO_TEMPLATE_DIR
			);

			//add core plugin folders for checking only if we're not $check_if_custom
			if ( ! $check_if_custom ) {
				$core_paths = array(
					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
					EE_PUBLIC . $current_theme,
					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
					EE_TEMPLATES . $current_theme,
					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
					EE_PLUGIN_DIR_PATH
					);
				$template_folder_paths = array_merge( $template_folder_paths, $core_paths );
			}

			// now filter that array
			$template_folder_paths = apply_filters( 'FHEE__EEH_Template__locate_template__template_folder_paths', $template_folder_paths );
			$templates = is_array( $templates ) ? $templates : array( $templates );
			$template_folder_paths = is_array( $template_folder_paths ) ? $template_folder_paths : array( $template_folder_paths );
			// array to hold all possible template paths
			$full_template_paths = array();

			// loop through $templates
			foreach ( $templates as $template ) {
				// normalize directory separators
				$template = EEH_File::standardise_directory_separators( $template );
				$file_name = basename( $template );
				$template_path_minus_file_name = substr( $template, 0, ( strlen( $file_name ) * -1 ) );
				// while looping through all template folder paths
				foreach ( $template_folder_paths as $template_folder_path ) {
					// normalize directory separators
					$template_folder_path = EEH_File::standardise_directory_separators( $template_folder_path );
					// determine if any common base path exists between the two paths
					$common_base_path = EEH_Template::_find_common_base_path(
						array( $template_folder_path, $template_path_minus_file_name )
					);
					if ( $common_base_path !== '' ) {
						// both paths have a common base, so just tack the filename onto our search path
						$resolved_path = EEH_File::end_with_directory_separator( $template_folder_path ) . $file_name;
					} else {
						// no common base path, so let's just concatenate
						$resolved_path = EEH_File::end_with_directory_separator( $template_folder_path ) . $template;
					}
					// build up our template locations array by adding our resolved paths
					$full_template_paths[] = $resolved_path;
				}
				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
				array_unshift( $full_template_paths, $template );
				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
				array_unshift( $full_template_paths, get_stylesheet_directory() . DS . $file_name );
			}
			// filter final array of full template paths
			$full_template_paths = apply_filters( 'FHEE__EEH_Template__locate_template__full_template_paths', $full_template_paths, $file_name );

The variable $file_name does not seem to be defined for all execution paths leading up to this point.

			// now loop through our final array of template location paths and check each location
			foreach ( (array)$full_template_paths as $full_template_path ) {
				if ( is_readable( $full_template_path )) {
					$template_path = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $full_template_path );
					// hook that can be used to display the full template path that will be used
					do_action( 'AHEE__EEH_Template__locate_template__full_template_path', $template_path );
					break;
				}
			}
		}
		// if we got it and you want to see it...
		if ( $template_path && $load && ! $check_if_custom  ) {
			if ( $return_string ) {
				return EEH_Template::display_template( $template_path, $template_args, TRUE );
			} else {
				EEH_Template::display_template( $template_path, $template_args, FALSE );
			}
		}
		return $check_if_custom && ! empty( $template_path ) ? TRUE : $template_path;
	}

}