|
 |
| {FIELD-WISH-LIST-IS-PUBLIC} |
Updated: 05/17/2013 |
The {FIELD-WISH-LIST-IS-PUBLIC} QuickCode Tag may be used to create a dropdown menu, from which a customer may select "Yes" to set the wish list as publicly viewable, or "No" to set the wish list as not publicly viewable.
Only the customer who created the wish list, or a store admin, may alter a wish list's publicly viewable setting.
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). When a wish list is first created, this QuickCode Tag will give the customer the option of setting the wish list to be publicly viewable or not. The wish list may also be edited later, and so this QuickCode Tag should also be included in any forms related to editing wish lists, to allow the customer to update the setting.
Store admins may use the Search Wish Lists page (located at [Modules > Wish Lists > Search Wish Lists] to view all wish lists. The publicly viewable setting may be altered directly from the Search Wish Lists page, or an individual wish list may be selected to view and edit all of its settings in the Wish List Editor. |
|
 Requirements / Prerequisites |
The {FIELD-WISH-LIST-IS-PUBLIC} QuickCode Tag may be used within the {WISH-LIST-BLOCK-BEGIN} {WISH-LIST-BLOCK-END} block, in order to display the dropdown menu for each of the customer's current wish lists.
The {FIELD-WISH-LIST-IS-PUBLIC} QuickCode Tag may also be used outside of the {WISH-LIST-BLOCK-BEGIN} {WISH-LIST-BLOCK-END} block, in order to display the dropdown menu when the customer creates a new wish list.
Since {FIELD-WISH-LIST-IS-PUBLIC} 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-IS-PUBLIC} to actually function. If {FIELD-WISH-LIST-IS-PUBLIC} 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.
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.
Additionally, only logged in customers may create or edit wish lists, so it is recommended to place content related to editing wish lists between the {IF-CUSTOMER-LOGGED-IN-BEGIN} and {IF-CUSTOMER-LOGGED-IN-END} QuickCode Tags.
|
|
 Example of Use |
- Add the following code to a storefront template:
ExampleWelcome to my store!<br />
<!-- Show the content between IF-USING-WISH-LISTS-BEGIN and IF-USING-WISH-LISTS-END only if the store's Wish List Module is enabled. -->
{IF-USING-WISH-LISTS-BEGIN}
<!-- Show the content between IF-CUSTOMER-LOGGED-IN-BEGIN and ELSE only if a customer is currently logged in. -->
{IF-CUSTOMER-LOGGED-IN-BEGIN}
<!-- New wish list form. -->
<div style="border:2px solid gray;padding:15px;width:500px;">
<form name="new_wish_list_form" method="post" action="{THIS-PAGE}">
<h3>Create a new wish list...</h3><br />
<strong>Wish list name</strong> {FIELD-WISH-LIST-NAME}<br />
<strong>Is this wish list publicly viewable?</strong> {FIELD-WISH-LIST-IS-PUBLIC}<br />
<input type="submit" name="submit_new_wish_list" value="Create this Wish List" />
</form>
</div>
<br />
<!-- Show the content between IF-WISH-LIST-BEGIN and ELSE only if the customer already has a wish list. -->
{IF-WISH-LIST-BEGIN}
<div style="border:2px solid gray;padding:15px;width:500px;">
<form name="wish_list_form" method="post" action="{THIS-PAGE}">
<h3>Edit your wish lists...</h3><br />
<!-- Show the content between WISH-LIST-BLOCK-BEGIN and WISH-LIST-BLOCK-END once for each of the user's wish lists. -->
{WISH-LIST-BLOCK-BEGIN}
<div style="border:1px dashed black;padding:5px;width:auto;">
<strong>Wish list name</strong> {FIELD-WISH-LIST-NAME}<br />
<strong>Is this wish list publicly viewable?</strong> {FIELD-WISH-LIST-IS-PUBLIC}<br />
</div>
<br />
<!-- End of content to be displayed once for each of the user's lists. -->
{WISH-LIST-BLOCK-END}
<input type="submit" name="submit_wish_list_form" value="Update wish lists" />
</form>
</div>
<!-- End of content to show/hide based on whether the customer has a wish list. -->
{IF-WISH-LIST-END}
<!-- Show the content between ELSE and IF-CUSTOMER-LOGGED-IN-END only if a customer is not currently logged in. -->
{ELSE}
<a href="{URL-STORE-HOME}customer_login.php">Login</a> or <a href="{URL-STORE-HOME}customer_register.php">create an account</a> to create and edit wish lists.
<!-- End of content to show/hide based on whether a customer is logged in. -->
{IF-CUSTOMER-LOGGED-IN-END}
<!-- End of content to show/hide based on whether the store's Wish List Module is enabled. -->
{IF-USING-WISH-LISTS-END}
Thanks for visiting, please come again soon...
- If the store's Wish List Module is not enabled, the following would display:
Example
Welcome to my store!
Thanks for visiting, please come again soon...
- If the store's Wish List Module is enabled, but a customer is not currently logged in, the following would display:
Example
Welcome to my store!
Login or create an account to create an edit wish lists.
Thanks for visiting, please come again soon...
- If the store's Wish List Module is enabled, and a customer is logged in, but does not yet have any wish lists, the following would display:
- If the store's Wish List Module is enabled, and a customer is logged in, and has one public wish list named "What I want for my birthday", and one private wish list named "What I want to buy later", the following would display:
|
|
 Source Code |
Source Code Updated: |
LOG IN TO ADD COMMENTS
|
{FIELD-WISH-LIST-IS-PUBLIC}
