wc_get_template( string $template_name, array $args = array(), string $template_path = '', string $default_path = '' )

Get other templates (e.g. product attributes) passing attributes and including the file.

Contents

Description Description

Parameters Parameters

$template_name

(Required) Template name.

$args

(Optional) Arguments. (default: array).

Default value: array()

$template_path

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

Default value: ''

$default_path

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

Default value: ''

Top ↑

Source Source

File: includes/wc-core-functions.php 

function wc_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
	$cache_key = sanitize_key( implode( '-', array( 'template', $template_name, $template_path, $default_path, Constants::get_constant( 'WC_VERSION' ) ) ) );
	$template  = (string) wp_cache_get( $cache_key, 'woocommerce' );

	if ( ! $template ) {
		$template = wc_locate_template( $template_name, $template_path, $default_path );

		// Don't cache the absolute path so that it can be shared between web servers with different paths.
		$cache_path = wc_tokenize_path( $template, wc_get_path_define_tokens() );

		wc_set_template_cache( $cache_key, $cache_path );
	} else {
		// Make sure that the absolute path to the template is resolved.
		$template = wc_untokenize_path( $template, wc_get_path_define_tokens() );
	}

	// Allow 3rd party plugin filter template file from their plugin.
	$filter_template = apply_filters( 'wc_get_template', $template, $template_name, $args, $template_path, $default_path );

	if ( $filter_template !== $template ) {
		if ( ! file_exists( $filter_template ) ) {
			/* translators: %s template */
			wc_doing_it_wrong( __FUNCTION__, sprintf( __( '%s does not exist.', 'woocommerce' ), '<code>' . $template . '</code>' ), '2.1' );
			return;
		}
		$template = $filter_template;
	}

	$action_args = array(
		'template_name' => $template_name,
		'template_path' => $template_path,
		'located'       => $template,
		'args'          => $args,
	);

	if ( ! empty( $args ) && is_array( $args ) ) {
		if ( isset( $args['action_args'] ) ) {
			wc_doing_it_wrong(
				__FUNCTION__,
				__( 'action_args should not be overwritten when calling wc_get_template.', 'woocommerce' ),
				'3.6.0'
			);
			unset( $args['action_args'] );
		}
		extract( $args ); // @codingStandardsIgnoreLine
	}

	do_action( 'woocommerce_before_template_part', $action_args['template_name'], $action_args['template_path'], $action_args['located'], $action_args['args'] );

	include $action_args['located'];

	do_action( 'woocommerce_after_template_part', $action_args['template_name'], $action_args['template_path'], $action_args['located'], $action_args['args'] );
}

Expand full source code Collapse full source code

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
vendor/automattic/jetpack-constants/src/class-constants.php: Constants::get_constant()

Attempts to retrieve the “constant” from constants Manager, and if it hasn’t been set, then attempts to get the constant with the constant() function. If that also hasn’t been set, attempts to get a value from filters.
includes/wc-core-functions.php: wc_set_template_cache()

Add a template to the template cache.
includes/wc-core-functions.php: wc_locate_template()

Locate a template and return the path for inclusion.
includes/wc-core-functions.php: wc_tokenize_path()

Given a path, this will convert any of the subpaths into their corresponding tokens.
includes/wc-core-functions.php: wc_get_path_define_tokens()

Fetches an array containing all of the configurable path constants to be used in tokenization.
includes/wc-core-functions.php: wc_untokenize_path()

Given a tokenized path, this will expand the tokens to their full path.
includes/wc-deprecated-functions.php: wc_doing_it_wrong()

Wrapper for _doing_it_wrong().
includes/rest-api/Controllers/Version2/class-wc-rest-system-status-v2-controller.php: wc_get_template

Scan the theme directory for all WC templates to see if our theme overrides any of them.
Show 3 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
includes/emails/class-wc-email.php: WC_Email::style_inline()

Apply inline styles to dynamic content.
includes/wc-notice-functions.php: wc_print_notices()

Prints messages and errors which are stored in the session, then clears them.
includes/wc-notice-functions.php: wc_print_notice()

Print a single notice immediately.
includes/wc-core-functions.php: wc_get_template_html()

Like wc_get_template, but returns the HTML instead of outputting.
includes/class-wc-shortcodes.php: WC_Shortcodes::product_categories()

List all (or limited) product categories.
includes/class-wc-frontend-scripts.php: WC_Frontend_Scripts::get_script_data()

Return data for script handles.
includes/wc-template-functions.php: wc_get_formatted_cart_item_data()

Gets and formats a list of cart item data + variations for display on the frontend.
includes/wc-template-functions.php: wc_get_stock_html()

Get HTML to show product stock.
includes/wc-template-functions.php: wc_no_products_found()

Handles the loop when no products were found/no product exist.
includes/wc-template-functions.php: wc_get_email_order_items()

Get HTML for the order items to be shown in emails.
includes/wc-template-functions.php: woocommerce_photoswipe()

Get the shop sidebar template.
includes/wc-template-functions.php: wc_display_product_attributes()

Outputs a list of product attributes for a product.
includes/wc-template-functions.php: woocommerce_account_downloads()

My Account > Downloads template.
includes/wc-template-functions.php: woocommerce_account_payment_methods()

My Account > Downloads template.
includes/wc-template-functions.php: woocommerce_single_variation_add_to_cart_button()

Output the add to cart button for variations.
includes/wc-template-functions.php: woocommerce_account_content()

My Account content output.
includes/wc-template-functions.php: woocommerce_account_navigation()

My Account navigation template.
includes/wc-template-functions.php: woocommerce_account_orders()

My Account > Orders template.
includes/wc-template-functions.php: get_product_search_form()

Display product search form.
includes/wc-template-functions.php: woocommerce_output_auth_header()

Output the Auth header.
includes/wc-template-functions.php: woocommerce_output_auth_footer()

Output the Auth footer.
includes/wc-template-functions.php: woocommerce_order_details_table()

Displays order details in a table.
includes/wc-template-functions.php: woocommerce_order_downloads_table()

Displays order downloads in a table.
includes/wc-template-functions.php: woocommerce_order_again_button()

Display an ‘order again’ button on the view order page.
includes/wc-template-functions.php: woocommerce_checkout_coupon_form()

Output the Coupon form for the checkout.
includes/wc-template-functions.php: woocommerce_output_product_categories()

Display product sub categories as thumbnails.
includes/wc-template-functions.php: woocommerce_checkout_login_form()

Output the WooCommerce Checkout Login Form.
includes/wc-template-functions.php: woocommerce_breadcrumb()

Output the WooCommerce Breadcrumb.
includes/wc-template-functions.php: woocommerce_order_review()

Output the Order review table for the checkout.
includes/wc-template-functions.php: woocommerce_checkout_payment()

Output the Payment Methods on the checkout.
includes/wc-template-functions.php: woocommerce_mini_cart()

Output the Mini-cart – used by cart widget.
includes/wc-template-functions.php: woocommerce_login_form()

Output the WooCommerce Login Form.
includes/wc-template-functions.php: woocommerce_shipping_calculator()

Output the cart shipping calculator.
includes/wc-template-functions.php: woocommerce_cart_totals()

Output the cart totals.
includes/wc-template-functions.php: woocommerce_cross_sell_display()

Output the cart cross-sells.
includes/wc-template-functions.php: woocommerce_button_proceed_to_checkout()

Output the proceed to checkout button.
includes/wc-template-functions.php: woocommerce_upsell_display()

Output product up sells.
includes/wc-template-functions.php: woocommerce_review_display_meta()

Display the review authors meta (name, verified owner, review date)
includes/wc-template-functions.php: woocommerce_related_products()

Output the related products.
includes/wc-template-functions.php: woocommerce_comments()

Output the Review comments template.
includes/wc-template-functions.php: woocommerce_review_display_rating()

Display the reviewers star rating
includes/wc-template-functions.php: woocommerce_quantity_input()

Output the quantity input for add to cart forms.
includes/wc-template-functions.php: woocommerce_product_description_tab()

Output the description tab content.
includes/wc-template-functions.php: woocommerce_product_additional_information_tab()

Output the attributes tab content.
includes/wc-template-functions.php: woocommerce_show_product_sale_flash()

Output the product sale flash.
includes/wc-template-functions.php: woocommerce_simple_add_to_cart()

Output the simple product add to cart area.
includes/wc-template-functions.php: woocommerce_grouped_add_to_cart()

Output the grouped product add to cart area.
includes/wc-template-functions.php: woocommerce_variable_add_to_cart()

Output the variable product add to cart area.
includes/wc-template-functions.php: woocommerce_external_add_to_cart()

Output the external product add to cart area.
includes/wc-template-functions.php: woocommerce_template_single_sharing()

Output the product sharing.
includes/wc-template-functions.php: woocommerce_template_single_rating()

Output the product rating.
includes/wc-template-functions.php: woocommerce_template_single_price()

Output the product price.
includes/wc-template-functions.php: woocommerce_template_single_excerpt()

Output the product short description (excerpt).
includes/wc-template-functions.php: woocommerce_template_single_meta()

Output the product meta.
includes/wc-template-functions.php: woocommerce_pagination()

Output the pagination.
includes/wc-template-functions.php: woocommerce_show_product_images()

Output the product image before the single product summary.
includes/wc-template-functions.php: woocommerce_show_product_thumbnails()

Output the product thumbnails.
includes/wc-template-functions.php: woocommerce_output_product_data_tabs()

Output the product tabs.
includes/wc-template-functions.php: woocommerce_template_single_title()

Output the product title.
includes/wc-template-functions.php: woocommerce_template_loop_price()

Get the product price for the loop.
includes/wc-template-functions.php: woocommerce_template_loop_rating()

Display the average rating in the loop.
includes/wc-template-functions.php: woocommerce_show_product_loop_sale_flash()

Get the sale flash for the loop.
includes/wc-template-functions.php: woocommerce_result_count()

Output the result count text (Showing x – x of x results).
includes/wc-template-functions.php: woocommerce_catalog_ordering()

Output the product sorting options.
includes/wc-template-functions.php: woocommerce_template_loop_add_to_cart()

Get the add to cart template for the loop.
includes/wc-template-functions.php: woocommerce_product_loop_start()

Output the start of a product loop. By default this is a UL.
includes/wc-template-functions.php: woocommerce_product_loop_end()

Output the end of a product loop. By default this is a UL.
includes/wc-template-functions.php: woocommerce_output_content_wrapper()

Output the start of the page wrapper.
includes/wc-template-functions.php: woocommerce_output_content_wrapper_end()

Output the end of the page wrapper.
includes/wc-template-functions.php: woocommerce_get_sidebar()

Get the shop sidebar template.
includes/class-wc-auth.php: WC_Auth::auth_endpoint()

Auth endpoint.
includes/class-wc-emails.php: WC_Emails::customer_details()

Allows developers to add additional customer details to templates.
includes/class-wc-emails.php: WC_Emails::email_addresses()

Get the email addresses.
includes/class-wc-emails.php: WC_Emails::order_details()

Show the order details table
includes/class-wc-emails.php: WC_Emails::order_downloads()

Show order downloads in a table.
includes/class-wc-emails.php: WC_Emails::email_header()

Get the email header.
includes/class-wc-emails.php: WC_Emails::email_footer()

Get the email footer.
includes/wc-cart-functions.php: wc_cart_totals_shipping_html()

Get shipping methods.
includes/widgets/class-wc-widget-recently-viewed.php: WC_Widget_Recently_Viewed::widget()

Output widget.
includes/widgets/class-wc-widget-price-filter.php: WC_Widget_Price_Filter::widget()

Output widget.
includes/widgets/class-wc-widget-top-rated-products.php: WC_Widget_Top_Rated_Products::widget()

Output widget.
includes/widgets/class-wc-widget-products.php: WC_Widget_Products::widget()

Output widget.
includes/widgets/class-wc-widget-recent-reviews.php: WC_Widget_Recent_Reviews::widget()

Output widget.
includes/class-wc-checkout.php: WC_Checkout::checkout_form_billing()

Output the billing form.
includes/class-wc-checkout.php: WC_Checkout::checkout_form_shipping()

Output the shipping form.
includes/wc-deprecated-functions.php: woocommerce_get_template()
includes/shortcodes/class-wc-shortcode-cart.php: WC_Shortcode_Cart::output()

Output the cart shortcode.
includes/shortcodes/class-wc-shortcode-order-tracking.php: WC_Shortcode_Order_Tracking::output()

Output the shortcode.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::add_payment_method()

Show the add payment method page.
includes/shortcodes/class-wc-shortcode-checkout.php: WC_Shortcode_Checkout::order_pay()

Show the pay page.
includes/shortcodes/class-wc-shortcode-checkout.php: WC_Shortcode_Checkout::order_received()

Show the thanks page.
includes/shortcodes/class-wc-shortcode-checkout.php: WC_Shortcode_Checkout::checkout()

Show the checkout.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::output()

Output the shortcode.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::my_account()

My account page.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::view_order()

View order page.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::edit_account()

Edit account details page.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::edit_address()

Edit address page.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::lost_password()

Lost password page handling.
Show 93 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.