|
 |
| {FIELD-WISH-LIST-NAME} |
Updated: 05/29/2013 |
The {FIELD-WISH-LIST-NAME} QuickCode Tag may be used to create a text field to view and edit a wish lists's name. The name of a wish list may only be edited by the customer who created the wish list, or a store admin.
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 provides the option for the customer to set the name of the new wish list. 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 rename wish list, if desired.
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, including its name, in the Wish List Editor. |
|
 Requirements / Prerequisites |
The {FIELD-WISH-LIST-NAME} QuickCode Tag may be used within the {WISH-LIST-BLOCK-BEGIN} {WISH-LIST-BLOCK-END} block, in order to create a text field to view and edit the name of each of the customer's current wish lists.
The {FIELD-WISH-LIST-NAME} QuickCode Tag may also be used outside of the {WISH-LIST-BLOCK-BEGIN} {WISH-LIST-BLOCK-END} block, in order to create a text field for the wish list name, when the customer creates a new wish list.
Since {FIELD-WISH-LIST-NAME} creates an input (the text field), this QuickCode Tag should be placed within a properly formatted HTML form, and the form must include a submit button, in order for the text field created by {FIELD-WISH-LIST-NAME} to actually function. If {FIELD-WISH-LIST-NAME} is not within a property formatted HTML form with a submit button, the text field will still correctly display the wish list's current name, but any changes to the wish list name 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.
|
|
 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 />
<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 />
</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 and 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 wish list named "What I want for my birthday", and one 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-NAME}
