Add_Item_View
Class Add_Item_View
Adds the “Add to Wish List” template after the purchase form on the product single view. This class manages the display of the “Add to Wishlist” button and the wishlist functionality on product detail pages. It checks whether the feature is enabled, if the user is logged in, and then allows the user to add a product to an existing wishlist.
- Full name:
\BigCommerce\Accounts\Wishlists\Add_Item_View
Methods
__construct
Add_Item_View constructor.
public __construct(\BigCommerce\Api\v3\Api\WishlistsApi $wishlists): mixedInitializes the Add_Item_View class with the provided WishlistsApi instance, which is used to interact with the BigCommerce API to manage wishlists.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$wishlists | \BigCommerce\Api\v3\Api\WishlistsApi | The WishlistsApi instance to interact with BigCommerce wishlists. |
filter_product_single_template
Filters the data of the product single template to add the “Add to Wish List” button.
public filter_product_single_template(array $data, string $template, array $options): arrayThis method checks if the “Add to Wishlist” feature is enabled, if the user is logged in, and if the customer has a wishlist. If all conditions are met, it adds the “Add to Wish List” button to the product single template.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$data | array | The template data for the product single page. |
$template | string | The name of the template file. |
$options | array | Additional options for rendering the template. |
Return Value:
The modified template data with the “Add to Wish List” button included.
Automatically generated on 2025-01-21