woocommerce_product_dimensions
The WooCommerce MyParcel woocommerce product dimensions hook.
Description
apply_filters( 'woocommerce_product_dimensions', (string) $wc_format_dimensions, (unknown) $product );
Parameters (2)
- 0. $wc_format_dimensions (string) =>
wc_format_dimensions( $dimensions )
- The wc format dimensions.
- 1. $product (unknown)
- The
product
.
Usage
- To run the hook, copy the example below.
- $wc_format_dimensions = apply_filters( 'woocommerce_product_dimensions', $wc_format_dimensions, $product );
- if ( !empty( $wc_format_dimensions ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the woocommerce_product_dimensions callback
- function filter_woocommerce_product_dimensions( $wc_format_dimensions, $product ) {
- // make filter magic happen here...
- return $wc_format_dimensions;
- };
- // add the filter
- add_filter( 'woocommerce_product_dimensions', 'filter_woocommerce_product_dimensions', 10, 2 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'woocommerce_product_dimensions', 'filter_woocommerce_product_dimensions', 10, 2 );
Defined (1)
The filter is defined in the following location(s).
- /includes/compatibility/class-wc-product-compatibility.php
- return apply_filters( 'woocommerce_product_dimensions', wc_format_dimensions( $dimensions ), $product );