QC: {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED}

The {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} QuickCode Tag may be used to create a dropdown menu, from which a customer may toggle whether or not an item will automatically be removed from the wish list when it is purchased.

If the item is set to be removed from the wish list when purchased, then the item will be removed from the with list if it is purchased by the wish list's owner, or if the public access code of the wish list containing the item was entered during the same shopping session as the item's purchase.

If multiple units have been requested for the wish list item, and the item is set to be removed when purchased, then purchasing one unit of the item will reduce the requested quantity by one, and so on. The item will only be completely removed from the wish list after the full requested quantity has been purchased.

Only the customer who created the wish list, or a store admin, may alter a wish list item's settings.

If the customer who created the wish list is logged into their customer account, they may manage their wish lists through the storefront wish list page (http://[storedomain]/wish_list.php).

Store admins may use the Search Wish Lists page (located at [Modules > Wish Lists > Search Wish Lists] to view all wish lists. An individual wish list may be selected to view and edit all of its settings.

Requirements / Prerequisites

Since {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} creates an input (the dropdown menu), this QuickCode Tag must be placed within a properly formatted HTML form, and the form must include a submit button, in order for the dropdown menu created by {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} to actually function. If {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} is not within a property formatted HTML form with a submit button, changes to the value in the dropdown menu will not be applied to the wish list.

The {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} QuickCode Tag may be used within the {WISH-LIST-ITEM-BLOCK-BEGIN} {WISH-LIST-ITEM-BLOCK-END} QuickCode Block, in order to display the priority dropdown menu for each of the customer's current wish list items. For this use, the {WISH-LIST-ITEM-BLOCK-BEGIN} {WISH-LIST-ITEM-BLOCK-END} QuickCode Block must be contained within the {WISH-LIST-BLOCK-BEGIN}{WISH-LIST-BLOCK-END} QuickCode Block, which in turn must be contained within the {IF-WISH-LIST-OWNER-BEGIN}{IF-WISH-LIST-OWNER-END} QuickCode Block.

The {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} QuickCode Tag may also be used in an HTML form in the product template (product.tpl), to allow customers to assign a wish list priority when adding the product to a wish list. For this use, the form that contains {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} must also contain {FIELD-WISH-LIST-SELECT} and {FIELD-PRODUCT-QUANTITY}.

It is recommended to always place any content related to wish lists between the {IF-USING-WISH-LISTS-BEGIN} and {IF-USING-WISH-LISTS-END} QuickCode Tags, so that the content will be shown when the store's Wish List Module is enabled, but hidden if the store's Wish List Module is disabled.

Example of Use

1. Add the following code to a storefront template:

Example

{IF-USING-WISH-LISTS-BEGIN}

<h3>Wish Lists</h3>

{IF-WISH-LIST-BEGIN}

{IF-WISH-LIST-OWNER-BEGIN}

<form name="wish_list_form" method="post" action="{THIS-PAGE}">
<h3>Edit your wish lists...</h3><br />

{WISH-LIST-BLOCK-BEGIN}

<li>

{WISH-LIST-ITEM-BLOCK-BEGIN}

<li><strong>Product Name:</strong> {PRODUCT-NAME}</li>

<li><strong>Price:</strong> {PRODUCT-PRICE}</li>

<li><strong>Remove When Purchased:</strong> {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED}</li>

</ul><br />

{WISH-LIST-ITEM-BLOCK-END}

</li>

<li style="text-align:center;"><a href="{URL-ADD-WISH-LIST-TO-BASKET}">Add entire wish list to my order.</a></li>

</ul><br />

{WISH-LIST-BLOCK-END}

</form>

{IF-WISH-LIST-OWNER-END}

</div>

{IF-WISH-LIST-END}

{IF-USING-WISH-LISTS-END}

<hr />

2. If the store's Wish List Module is enabled -AND- the logged in customer owns two wish lists (named "What I want for my birthday" and "What I want to buy later"), then the following would display:

Example
Wish Lists

Wish List Name: What I want for my birthday
- Product Name: Blue T-Shirt
- Price: $10.00
- Remove When Purchased:
- Product Name: Blue Sneakers
- Price: $50.00
- Remove When Purchased:
Add entire wish list to my order.

Wish List Name: What I want to buy later
- Product Name: Red T-Shirt
- Price: $12.00
- Remove When Purchased:
- Product Name: Red Travel Mug
- Price: $20.00
- Remove When Purchased:
Add entire wish list to my order.

3. If the store's Wish List Module is enabled -BUT- the current customer does not own any wish lists, then the following would display:

Example
Wish Lists

4. If the store's Wish List Module is not enabled, then the following would display:

Example

Source Code

Source Code Updated:

When a web page using a template that contains this QuickCode Tag is viewed in the storefront, the {FIELD-WISH-LIST-ITEM-REMOVE-WHEN-PURCHASED} QuickCode Tag is changed into the source code below prior to the web page being displayed.