* @package WooCommerce\Classes
use Automattic\WooCommerce\Enums\ProductStatus;
use Automattic\WooCommerce\Enums\ProductType;
defined( 'ABSPATH' ) || exit;
* WooCommerce Shortcodes class.
public static function init() {
'product' => __CLASS__ . '::product',
'product_page' => __CLASS__ . '::product_page',
'product_category' => __CLASS__ . '::product_category',
'product_categories' => __CLASS__ . '::product_categories',
'add_to_cart' => __CLASS__ . '::product_add_to_cart',
'add_to_cart_url' => __CLASS__ . '::product_add_to_cart_url',
'products' => __CLASS__ . '::products',
'recent_products' => __CLASS__ . '::recent_products',
'sale_products' => __CLASS__ . '::sale_products',
'best_selling_products' => __CLASS__ . '::best_selling_products',
'top_rated_products' => __CLASS__ . '::top_rated_products',
'featured_products' => __CLASS__ . '::featured_products',
'product_attribute' => __CLASS__ . '::product_attribute',
'related_products' => __CLASS__ . '::related_products',
'shop_messages' => __CLASS__ . '::shop_messages',
'woocommerce_order_tracking' => __CLASS__ . '::order_tracking',
'woocommerce_cart' => __CLASS__ . '::cart',
'woocommerce_checkout' => __CLASS__ . '::checkout',
'woocommerce_my_account' => __CLASS__ . '::my_account',
foreach ( $shortcodes as $shortcode => $function ) {
add_shortcode( apply_filters( "{$shortcode}_shortcode_tag", $shortcode ), $function );
// Alias for pre 2.1 compatibility.
add_shortcode( 'woocommerce_messages', __CLASS__ . '::shop_messages' );
* @param string[] $function Callback function.
* @param array $atts Attributes. Default to empty array.
* @param array $wrapper Customer wrapper data.
public static function shortcode_wrapper(
'class' => 'woocommerce',
// @codingStandardsIgnoreStart
echo empty( $wrapper['before'] ) ? '<div class="' . esc_attr( $wrapper['class'] ) . '">' : $wrapper['before'];
call_user_func( $function, $atts );
echo empty( $wrapper['after'] ) ? '</div>' : $wrapper['after'];
// @codingStandardsIgnoreEnd
public static function cart() {
return is_null( WC()->cart ) ? '' : self::shortcode_wrapper( array( 'WC_Shortcode_Cart', 'output' ) );
* Checkout page shortcode.
* @param array $atts Attributes.
public static function checkout( $atts ) {
return self::shortcode_wrapper( array( 'WC_Shortcode_Checkout', 'output' ), $atts );
* Order tracking page shortcode.
* @param array $atts Attributes.
public static function order_tracking( $atts ) {
return self::shortcode_wrapper( array( 'WC_Shortcode_Order_Tracking', 'output' ), $atts );
* My account page shortcode.
* @param array $atts Attributes.
public static function my_account( $atts ) {
return self::shortcode_wrapper( array( 'WC_Shortcode_My_Account', 'output' ), $atts );
* List products in a category shortcode.
* @param array $atts Attributes.
public static function product_category( $atts ) {
if ( empty( $atts['category'] ) ) {
'orderby' => 'menu_order title',
$shortcode = new WC_Shortcode_Products( $atts, 'product_category' );
return $shortcode->get_content();
* List all (or limited) product categories.
* @param array $atts Attributes.
public static function product_categories( $atts ) {
if ( isset( $atts['number'] ) ) {
$atts['limit'] = $atts['number'];
$ids = array_filter( array_map( 'trim', explode( ',', $atts['ids'] ) ) );
$hide_empty = ( true === $atts['hide_empty'] || 'true' === $atts['hide_empty'] || 1 === $atts['hide_empty'] || '1' === $atts['hide_empty'] ) ? 1 : 0;
// Get terms and workaround WP bug with parents/pad counts.
'orderby' => $atts['orderby'],
'order' => $atts['order'],
'hide_empty' => $hide_empty,
'child_of' => $atts['parent'],
$product_categories = apply_filters(
'woocommerce_product_categories',
get_terms( 'product_cat', $args )
if ( '' !== $atts['parent'] ) {
$product_categories = wp_list_filter(
'parent' => $atts['parent'],
foreach ( $product_categories as $key => $category ) {
if ( 0 === $category->count ) {
unset( $product_categories[ $key ] );
$atts['limit'] = '-1' === $atts['limit'] ? null : intval( $atts['limit'] );
$product_categories = array_slice( $product_categories, 0, $atts['limit'] );
$columns = absint( $atts['columns'] );
wc_set_loop_prop( 'columns', $columns );
wc_set_loop_prop( 'is_shortcode', true );
if ( $product_categories ) {
woocommerce_product_loop_start();
foreach ( $product_categories as $category ) {
'content-product_cat.php',
woocommerce_product_loop_end();
return '<div class="woocommerce columns-' . $columns . '">' . ob_get_clean() . '</div>';
* Recent Products shortcode.
* @param array $atts Attributes.
public static function recent_products( $atts ) {
$shortcode = new WC_Shortcode_Products( $atts, 'recent_products' );
return $shortcode->get_content();
* List multiple products shortcode.
* @param array $atts Attributes.
public static function products( $atts ) {
// Allow list product based on specific cases.
if ( isset( $atts['on_sale'] ) && wc_string_to_bool( $atts['on_sale'] ) ) {
} elseif ( isset( $atts['best_selling'] ) && wc_string_to_bool( $atts['best_selling'] ) ) {
$type = 'best_selling_products';
} elseif ( isset( $atts['top_rated'] ) && wc_string_to_bool( $atts['top_rated'] ) ) {
$type = 'top_rated_products';
$shortcode = new WC_Shortcode_Products( $atts, $type );
return $shortcode->get_content();
* Display a single product.
* @param array $atts Attributes.
public static function product( $atts ) {
$atts['skus'] = isset( $atts['sku'] ) ? $atts['sku'] : '';
$atts['ids'] = isset( $atts['id'] ) ? $atts['id'] : '';
$shortcode = new WC_Shortcode_Products( (array) $atts, 'product' );
return $shortcode->get_content();
* Display a single product price + cart button.
* @param array $atts Attributes.
public static function product_add_to_cart( $atts ) {
'style' => 'border:4px solid #ccc; padding: 12px;',
if ( ! empty( $atts['id'] ) ) {
$product_data = get_post( $atts['id'] );
} elseif ( ! empty( $atts['sku'] ) ) {
$product_id = wc_get_product_id_by_sku( $atts['sku'] );
$product_data = get_post( $product_id );
$product = is_object( $product_data ) && in_array( $product_data->post_type, array( 'product', 'product_variation' ), true ) ? wc_setup_product_data( $product_data ) : false;
echo '<p class="product woocommerce add_to_cart_inline ' . esc_attr( $atts['class'] ) . '" style="' . ( empty( $atts['style'] ) ? '' : esc_attr( $atts['style'] ) ) . '">';
if ( wc_string_to_bool( $atts['show_price'] ) ) {
// @codingStandardsIgnoreStart
echo $product->get_price_html();
// @codingStandardsIgnoreEnd
woocommerce_template_loop_add_to_cart(
'quantity' => $atts['quantity'],
// Restore Product global in case this is shown inside a product post.
wc_setup_product_data( $post );
* Get the add to cart URL for a product.
* @param array $atts Attributes.
public static function product_add_to_cart_url( $atts ) {
if ( isset( $atts['id'] ) ) {
$product_data = get_post( $atts['id'] );
} elseif ( isset( $atts['sku'] ) ) {
$product_id = wc_get_product_id_by_sku( $atts['sku'] );
$product_data = get_post( $product_id );
$product = is_object( $product_data ) && in_array( $product_data->post_type, array( 'product', 'product_variation' ), true ) ? wc_setup_product_data( $product_data ) : false;
$_product = wc_get_product( $product_data );
return esc_url( $_product->add_to_cart_url() );
* List all products on sale.
* @param array $atts Attributes.
public static function sale_products( $atts ) {
$shortcode = new WC_Shortcode_Products( $atts, 'sale_products' );
return $shortcode->get_content();
* List best selling products on sale.
* @param array $atts Attributes.
public static function best_selling_products( $atts ) {
$shortcode = new WC_Shortcode_Products( $atts, 'best_selling_products' );
return $shortcode->get_content();
* List top rated products on sale.
* @param array $atts Attributes.
public static function top_rated_products( $atts ) {
$shortcode = new WC_Shortcode_Products( $atts, 'top_rated_products' );
return $shortcode->get_content();
* Output featured products.
* @param array $atts Attributes.
public static function featured_products( $atts ) {
$atts['visibility'] = 'featured';
$shortcode = new WC_Shortcode_Products( $atts, 'featured_products' );
return $shortcode->get_content();