woocommerce_store_api_cart_item_images
Filter the cart product images.
This hook allows the cart item images to be changed. This is specific to the cart endpoint.
Usage
add_filter( 'woocommerce_store_api_cart_item_images', 'wp_kama_woocommerce_store_api_cart_item_images_filter', 10, 3 );
/**
* Function for `woocommerce_store_api_cart_item_images` filter-hook.
*
* @param array $product_images Array of image objects, as defined in ImageAttachmentSchema.
* @param array $cart_item Cart item array.
* @param string $cart_item_key Cart item key.
*
* @return array
*/
function wp_kama_woocommerce_store_api_cart_item_images_filter( $product_images, $cart_item, $cart_item_key ){
// filter...
return $product_images;
}
- $product_images(array)
- Array of image objects, as defined in ImageAttachmentSchema.
- $cart_item(array)
- Cart item array.
- $cart_item_key(string)
- Cart item key.
Changelog
| Since 9.6.0 | Introduced. |
Where the hook is called
woocommerce_store_api_cart_item_images
woocommerce/src/StoreApi/Schemas/V1/CartItemSchema.php 107
$filtered_images = apply_filters( 'woocommerce_store_api_cart_item_images', $product_images, $cart_item, $cart_item_key );