Subscribe 1.0 Unsubscribe Form
Parameters
There are several parameters available for the unsubscribe_form tag.
{exp:subscribe:unsubscribe_form zone_name="bubba" form_name="This Subscription" return="my/template" onsubmit="some_javascript()"}
In the above example, a given user, either logged in or recognized by IP, upon submitting the form, will be unsubscribed from the subscription called bubba. If any mailing lists were connected to the subscription, the user will be unsubscribed from those as well.
zone_name=
zone_name = "some_name"
The 'zone_name' parameter establishes which of the subscriptions that you created in the CP to use. This is a required parameter.
form_name =
form_name = "a_name"
The 'form_name' parameter allows you to name the subscribe form. This name will also be used as the id of the form for DOM targeting.
return =
return = "my/template"
The 'return' parameter determines where to send users once they have submitted the form.
onsubmit =
onsubmit = "some_javascript()"
The 'onsubmit' parameter allows for javascript to be triggered upon the submission of the form.
Variables
The following variables are available with the {exp:subscribe:unsubscribe_form} tag.
subscription_name
{subscription_name}
The 'subscription_name' variable will be replaced by the subscription name.
subscription_title
{subscription_title}
The 'subscription_title' variable will be replaced by the subscription title.
Variable Pairs
The following variable pairs are available with the {exp:subscribe:unsubscribe_form} tag.
subscription_weblogs
{subscription_weblogs}{/subscription_weblogs}
The 'subscription_weblogs' variable pair will allow you to show information about the weblogs that have been attached to the subscription. The following variables are available:
- {weblog_id}
- {blog_name}
- {blog_title}
The backspace parameter is available with this variable pair.
subscription_statuses
{subscription_statuses}{/subscription_statuses}
The 'subscription_statuses' variable pair will allow you to show information about the statuses that have been attached to the subscription. The following variables are available:
- {status_id}
- {status}
The backspace parameter is available with this variable pair.
subscription_categories
{subscription_categories}{/subscription_categories}
The 'subscription_categories' variable pair will allow you to show information about the categories that have been attached to the subscription. The following variables are available:
- {cat_id}
- {cat_name}
- {cat_image}
- {cat_description}
The backspace parameter is available with this variable pair.
subscription_mailing_lists
{subscription_mailing_lists}{/subscription_mailing_lists}
The 'subscription_mailing_lists' variable pair will allow you to show information about the mailing lists that have been attached to the subscription. The following variables are available:
- {list_id}
- {list_name}
The backspace parameter is available with this variable pair.
Conditionals
The following conditionals are available with the {exp:subscribe:unsubscribe_form} tag.
- if subscription_weblogs
- if subscription_statuses
- if subscription_authors
- if subscription_categories
- if subscription_mailing_lists
if subscription_weblogs
{if subscription_weblogs}{/if}
If weblogs have been specified as part of this user's subscription, the contents of this conditional will be shown.
if subscription_statuses
{if subscription_statuses}{/if}
If statuses have been specified as part of this user's subscription, the contents of this conditional will be shown.
if subscription_authors
{if subscription_authors}{/if}
If authors have been specified as part of this user's subscription, the contents of this conditional will be shown.
if subscription_categories
{if subscription_categories}{/if}
If categories have been specified as part of this user's subscription, the contents of this conditional will be shown.
if subscription_mailing_lists
{if subscription_mailing_lists}{/if}
If mailing lists have been specified as part of this user's subscription, the contents of this conditional will be shown.