wc_locate_template() │ WC 1.0

Locate a template and return the path for inclusion.

This is the load order:

yourtheme/$template_path/$template_name yourtheme/$template_name $default_path/$template_name

Return

String.

Usage

wc_locate_template( $template_name, $template_path, $default_path );

$template_name(string) (required)

Template name.

$template_path(string)

Template path. (default: '').
Default: ''

$default_path(string)

Default path. (default: '').
Default: ''

Code of wc_locate_template() wc locate template ^{WC 6.5.1}

function wc_locate_template( $template_name, $template_path = '', $default_path = '' ) {
	if ( ! $template_path ) {
		$template_path = WC()->template_path();
	}

	if ( ! $default_path ) {
		$default_path = WC()->plugin_path() . '/templates/';
	}

	// Look within passed path within the theme - this is priority.
	if ( false !== strpos( $template_name, 'product_cat' ) || false !== strpos( $template_name, 'product_tag' ) ) {
		$cs_template = str_replace( '_', '-', $template_name );
		$template    = locate_template(
			array(
				trailingslashit( $template_path ) . $cs_template,
				$cs_template,
			)
		);
	}

	if ( empty( $template ) ) {
		$template = locate_template(
			array(
				trailingslashit( $template_path ) . $template_name,
				$template_name,
			)
		);
	}

	// Get default template/.
	if ( ! $template || WC_TEMPLATE_DEBUG_MODE ) {
		if ( empty( $cs_template ) ) {
			$template = $default_path . $template_name;
		} else {
			$template = $default_path . $cs_template;
		}
	}

	// Return what we found.
	return apply_filters( 'woocommerce_locate_template', $template, $template_name, $template_path );
}