docs/code-snippets/useful-functions.md
WooCommerce core functions are available on both front-end and admin. They can be found in includes/wc-core-functions.php and can be used by themes in plugins.
WooCommerce conditional functions help determine the current query/page.
Returns true if on a page which uses WooCommerce templates (cart and checkout are standard pages with shortcodes and thus are not included).
is_woocommerce()
Returns true when viewing the product type archive (shop).
is_shop()
Returns true when viewing a single product.
is_product()
Get coupon code by coupon ID.
wc_get_coupon_code_by_id( $id )
The argument $id is the coupon ID.
Gets the coupon ID by code.
wc_get_coupon_id_by_code( $code, $exclude = 0 )
$code is the coupon code and $exclude is to exclude an ID from the check if you're checking existence.
Checks if a customer has bought an item. The check can be done by email or user ID or both.
wc_customer_bought_product( $customer_email, $user_id, $product_id )
Gets the total spent for a customer.
wc_get_customer_total_spent( $user_id )
$user_id is the user ID of the customer.
Gets the total orders for a customer.
wc_get_customer_order_count( $user_id )
$user_id is the user ID of the customer.
Takes a measurement $dimension measured in WooCommerce's dimension unit and converts it to the target unit $to_unit.
wc_get_dimension( $dimension, $to_unit, $from_unit = '' )
Example usages:
wc_get_dimension( 55, 'in' );
wc_get_dimension( 55, 'in', 'm' );
Takes a weight $weight weighed in WooCommerce's weight unit and converts it to the target weight unit $to_unit.
wc_get_weight( $weight, $to_unit, $from_unit = '' )
Example usages:
wc_get_weight( 55, 'kg' );
wc_get_weight( 55, 'kg', 'lbs' );
Clean variables using sanitize_text_field. Arrays are cleaned recursively. Non-scalar values are ignored.
wc_clean( $var )
Formats a passed price with the correct number of decimals and currency symbol.
wc_price( $price, $args = array() )
The $args array has an option called ex_tax_label - if true then an excluding tax message will be appended.
This function is the standard way of retrieving orders based on certain parameters. This function should be used for order retrieval so that when we move to custom tables, functions still work.
wc_get_orders( $args )
This is the main function for returning orders, uses the WC_Order_Factory class.
wc_get_order( $the_order = false )
The the_order parameter can be a post object or post ID of the order.
Returns the orders count of a specific order status.
wc_orders_count( $status, string $type = '' )
Searches orders based on the given $term.
wc_order_search( $term )
Gets a WooCommerce page ID by name, e.g. thankyou
wc_get_page_id( $page )
Gets the URL for an $endpoint, which varies depending on permalink settings.
wc_get_endpoint_url( $endpoint, $value = '', $permalink = '' )
This function is the standard way of retrieving products based on certain parameters.
wc_get_products( $args )
This is the main function for returning products. It uses the WC_Product_Factory class.
wc_get_product( $the_product = false )
The argument $the_product can be a post object or post ID of the product.
Returns an array containing the IDs of the products that are on sale.
wc_get_product_ids_on_sale()
Returns an array containing the IDs of the featured products.
wc_get_featured_product_ids()
Gets the related products for product based on product category and tags.
wc_get_related_products( $product_id, $limit = 5, $exclude_ids = array() )
Gets the account endpoint URL.
wc_get_account_endpoint_url( $endpoint )
Gets the taxonomies of product attributes.
wc_get_attribute_taxonomies()
Gets the taxonomy name for a given product attribute.
wc_attribute_taxonomy_name( $attribute_name )
Gets a product attribute ID by name.
wc_attribute_taxonomy_id_by_name( $name )
Parses and formats a date for ISO8601/RFC3339.
wc_rest_prepare_date_response( $date, $utc = true )
Pass $utc as false to get local/offset time.
Uploads an image from a given URL.
wc_rest_upload_image_from_url( $image_url )
Encodes a $value according to RFC 3986.
wc_rest_urlencode_rfc3986( $value )
Checks permissions of posts on REST API.
wc_rest_check_post_permissions( $post_type, $context = 'read', $object_id = 0 )
The available values for $context which is the request context are read, create, edit, delete and batch.