PHP Class WC_Shortcodes

Author: WooThemes
Datei anzeigen Open project: woocommerce/woocommerce Class Usage Examples

Public Methods

Method Description
best_selling_products ( array $atts ) : string List best selling products on sale.
cart ( ) : string Cart page shortcode.
checkout ( mixed $atts ) : string Checkout page shortcode.
featured_products ( array $atts ) : string Output featured products.
init ( ) Init shortcodes.
my_account ( mixed $atts ) : string My account page shortcode.
order_by_rating_post_clauses ( array $args ) : array woocommerce_order_by_rating_post_clauses function.
order_tracking ( mixed $atts ) : string Order tracking page shortcode.
product ( array $atts ) : string Display a single product.
product_add_to_cart ( array $atts ) : string Display a single product price + cart button.
product_add_to_cart_url ( array $atts ) : string Get the add to cart URL for a product.
product_attribute ( array $atts ) : string List products with an attribute shortcode.
product_categories ( array $atts ) : string List all (or limited) product categories.
product_category ( array $atts ) : string List products in a category shortcode.
product_page ( array $atts ) : string Show a single product page.
products ( array $atts ) : string List multiple products shortcode.
recent_products ( array $atts ) : string Recent Products shortcode.
related_products ( array $atts ) : string List related products.
sale_products ( array $atts ) : string List all products on sale.
shop_messages ( ) : string Show messages.
shortcode_wrapper ( string[] $function, array $atts = [], $wrapper = ['class' => 'woocommerce', 'before' => null, 'after' => null] ) : string Shortcode Wrapper.
top_rated_products ( array $atts ) : string List top rated products on sale.

Private Methods

Method Description
_maybe_add_category_args ( array $args, string $category, string $operator ) : array; Adds a tax_query index to the query to filter by category.
product_loop ( array $query_args, array $atts, string $loop_name ) : string Loop over found products.

Method Details

best_selling_products() public static method

List best selling products on sale.
public static best_selling_products ( array $atts ) : string
$atts array
return string

cart() public static method

Cart page shortcode.
public static cart ( ) : string
return string

checkout() public static method

Checkout page shortcode.
public static checkout ( mixed $atts ) : string
$atts mixed
return string

init() public static method

Init shortcodes.
public static init ( )

my_account() public static method

My account page shortcode.
public static my_account ( mixed $atts ) : string
$atts mixed
return string

order_by_rating_post_clauses() public static method

woocommerce_order_by_rating_post_clauses function.
public static order_by_rating_post_clauses ( array $args ) : array
$args array
return array

order_tracking() public static method

Order tracking page shortcode.
public static order_tracking ( mixed $atts ) : string
$atts mixed
return string

product() public static method

Display a single product.
public static product ( array $atts ) : string
$atts array
return string

product_add_to_cart() public static method

Display a single product price + cart button.
public static product_add_to_cart ( array $atts ) : string
$atts array
return string

product_add_to_cart_url() public static method

Get the add to cart URL for a product.
public static product_add_to_cart_url ( array $atts ) : string
$atts array
return string

product_attribute() public static method

Example [product_attribute attribute='color' filter='black'].
public static product_attribute ( array $atts ) : string
$atts array
return string

product_categories() public static method

List all (or limited) product categories.
public static product_categories ( array $atts ) : string
$atts array
return string

product_category() public static method

List products in a category shortcode.
public static product_category ( array $atts ) : string
$atts array
return string

product_page() public static method

Show a single product page.
public static product_page ( array $atts ) : string
$atts array
return string

products() public static method

List multiple products shortcode.
public static products ( array $atts ) : string
$atts array
return string

recent_products() public static method

Recent Products shortcode.
public static recent_products ( array $atts ) : string
$atts array
return string

sale_products() public static method

List all products on sale.
public static sale_products ( array $atts ) : string
$atts array
return string

shop_messages() public static method

Show messages.
public static shop_messages ( ) : string
return string

shortcode_wrapper() public static method

Shortcode Wrapper.
public static shortcode_wrapper ( string[] $function, array $atts = [], $wrapper = ['class' => 'woocommerce', 'before' => null, 'after' => null] ) : string
$function string[]
$atts array (default: array())
return string

top_rated_products() public static method

List top rated products on sale.
public static top_rated_products ( array $atts ) : string
$atts array
return string