Shortcode: Subscription Form

Article Table of Contents

  • Introduction
    •
  • Uses of the Subscription Form Shortcode
    •
  • The 'Subscription Form' Box Option Settings
    •

    Introduction

    In version 1.7+, the 'Subscription Form' shortcode ( tag: [pum_sub_form] ) becomes available to all Popup Maker plugin users. Previously available only for users of the  MailChimp Integration plugin extension for Popup Maker, the shortcode is accessible from the Shortcode Button in either the Popup, Post, or Page editor. 

    Above: (1) Popup Maker shortcode button on Popup Editor 'Visual' tab. (2) Subscription Form shortcode option in drop-down menu. 

    [    Back to top   ]

    Uses of the Subscription Form Shortcode

    The shortcode builds an email marketing subscription form in the content editor to display inside a popup.   At present, the form only integrates with the MailChimp email marketing application.  Plugin users must maintain an active license for the MailChimp Integration plugin extension to transfer data directly from Popup Maker to a MailChimp email marketing list.  The Subscription Form shortcode is built to allow future integration with other WordPress-compatible email marketing plugins or applications.

    Related article:  MailChimp Integration Shortcode

    Submitted form data is displayed on a 'Subscribers' view page, accessible from the WordPress Admin at 'Popup Maker' -> 'Subscribers'.  

    Data is stored in a custom database table named '{prefix}_pum_subscribers' for later export to 3rd party email applications. 

    The Popup Maker 'Subscription Form' shortcode can substitute for other form plugins for users who manually transfer subscriber data to their email marketing list or application.

    Developers for 3rd party email marketing applications can consult the related article link below for information on how to register and integrate their application with Popup Maker. 

    Related article: Email Marketing Integration with Popup Maker.

    [   Back to top   ]

    The 'Subscription Form' Box Option Settings

    When the Subscription Form option is selected from the Shortcode Button, it opens a 'Subscription Form' option settings box.  The shortcode builds the subscription form inside the 'Visual' tab of the content editor based on the option settings. Each option setting is assigned to a shortcode attribute, which can be viewed on the 'Text' tab of the content editor.  

    'General' Option Settings Tab

    'Service Provider' -- Options: 'None' (plugin default), or 'Default'. The latter value is intended for future integration between 3rd party email marketing applications and Popup Maker.

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- value = 'none' (plugin default) --> 
[pum_sub_form provider="none" ]

<!-- value = 'default' --> 
no attribute displayed

    [   Back to top   ]

    'Form' Option Settings Tab

    'Fields' option submenu

    'Name Field Type' -- ( required )  The style of the input to the 'Name' form field. Options: 

    • None, 
    • Full (plugin default), 
    • First Only, and 
    • First & Last. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- value = 'none' -->  
[pum_sub_form name_field_type="disabled" ]

<!-- value = 'full' (plugin default) --> 
[pum_sub_form name_field_type="fullname" ]

<!-- value = 'first_only' --> 
[pum_sub_form name_field_type="first_only" ]

<!-- value = 'first_last' --> 
[pum_sub_form name_field_type="first_last" ]

    'Name Optional' -- ( checkbox; plugin default = unchecked). This checkbox displays when either the 'Full', 'First Only', or 'First & Last' name field types are selected above. Plugin default is 'unchecked' (name field is required). Selecting the checkbox turns the 'required' attribute 'off' in the 'Name' field above. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Name Optional' checkbox = 'unchecked' (plugin default) --> 
no attribute displayed 

<!-- 'Name Optional' checkbox = 'checked' --> 
[pum_sub_form name_optional ]

    [   Back to top   ]

    'Labels' option submenu

    'Disable Labels' -- ( checkbox; plugin default = 'unchecked' or 'off'. )  When checked, this option removes the display of the 'Name' and 'Email' field labels positioned above each form field. It also removes the 'Name' and 'Email' fields from showing in the option settings box.

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Disable Labels' checkbox = 'unchecked' (plugin default) -->  
no attribute displayed 

<!-- 'Disable Labels' checkbox = 'checked' -->  
[pum_sub_form disable_labels ]

    'Field Label Text' -- The label text that will appear above each name field. Displays the fields based on the selection of the 'Name Field Type' option above.  These custom fields are visible when the 'Disable Labels' checkbox above is unchecked. Options include:

    • 'Full Name' as 'Name'; 
    • 'First Name' as 'First Name'; and 
    • 'First & Last' as 'First Name' (field 1) and 'Last Name' (field 2).

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Field Label Text' depends on 'Name Field Type' label option  --> 
<!-- set to 'Full Name', 'First Only', or 'First & Last' --> 
[pum_sub_form label_name="Name" ]

<!-- 'Field Label Text' depends on 'Name Field Type' label option  --> 
<!-- set to 'First Only' or 'First & Last' --> 
[pum_sub_form label_fname="First Name" ]

<!-- 'Field Label Text' depends on 'Name Field Type' label option  --> 
<!-- set to 'First & Last' --> 
[pum_sub_form label_lname="Last Name" ]

    'Email' -- The label text that will appear above the email field. Plugin default = 'Email'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Field label text for 'Email' label option -->    
[pum_sub_form label_email="Email" ]

    'Submit Button' -- The label text that will appear on the submit button. Plugin default = 'Subscribe'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Field label text for 'Submit Button' label option -->     
<!-- (plugin default) -->     
[pum_sub_form label_submit="Subscribe" ]

    [   Back to top   ]

    'Placeholders' option submenu

    Optional text that appears inside each 'Name' and 'Email' field described above. By default, the plugin adds placeholder text into each custom field. The default values are listed below depending on the 'Name Field Type' option selected.

    • 'Full Name' as 'Name'; 
    • 'First Name' as 'First Name'; and 
    • 'First & Last' as 'First Name' (field 1) and 'Last Name' (field 2).

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Placeholder text for 'Full Name' custom field (plugin default) -->   
[pum_sub_form placeholder_name="Name" ]

<!-- Placeholder text for 'First Name' custom field (plugin default) -->  
[pum_sub_form placeholder_fname="First Name" ]

<!-- Placeholder text for 'Last Name' custom field (plugin default) -->  
[pum_sub_form placeholder_lname="Last Name" ]

    'Email':  Uses 'Email' as placeholder text (plugin default). 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Placeholder text for 'Email' custom field (plugin default) -->      
[pum_sub_form placeholder_email="Email" ]

    [   Back to top   ]

    'Appearance' option submenu

    Form Layout: Choose a form layout.  Options: 'Block' or 'Inline'. Plugin default: 'Block'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Form layout attributes; option value="block" (plugin default) -->    
[pum_sub_form form_layout="block" | "inline" ]

    Form Alignment: Choose a form alignment. Options: 'Left', 'Center', or 'Right'.  Plugin default: 'Center'.

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Form alignment attributes; option value="center" (plugin default) -->
[pum_sub_form form_alignment="left" | "center" | "right" ]

    Form Style: Choose how you want your form styled.  Options: 'Default', or 'None'.  Plugin default: 'Default'.

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- Form style attributes; option value="default" (plugin default) -->   
[pum_sub_form form_style="display" (option value="default") ]  or 
[pum_sub_form style="display" (option value="none") ]

    [   Back to top   ]

    'Privacy' Option Settings Tab

    Note: The default custom field settings for all forms created with the Subscription Form shortcode are located in the plugin admin at: 

    'Popup Maker' -> 'Settings' -> 'Privacy (option tab)' -> 'Subscriptions Forms (category)'. 

    Related article:  6. Settings submenu // See section: Privacy option.

    See the related article below for information on how Popup Maker collects personal data via the plugin's subscription form. This section allows plugin users to set up the subscription form to enable data privacy consent before form submission.

    Related article:  How to Use Popup Maker and Meet the GDPR Data Privacy Requirements

    'Enabled' (boolean) -- Options: 'Yes' / 'No'.  Plugin default: 'Yes'. 

    When the privacy option setting is enabled ( 'yes' ), plugin users are prompted to set up the remaining settings on this option tab.  When the privacy option setting is disabled ( 'no' ), the remaining option tab settings are removed from view. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Enable or disable subscription form privacy option setting-->
<!--option value="yes" (plugin default) -->
[pum_sub_form privacy_consent_enabled="yes" | "no" ]


    'Consent Field' Label (text field) -- Plugin default text: 'Notify me about related content and special offers.

    Note: The default content can be modified within the setup for each Popup Maker subscription form.  The plugin-wide default text for all Popup Maker subscription forms is set in the WordPress admin at:
    • 'Popup Maker' ->
    • 'Settings (option page)' ->
    • 'Privacy (tab)' ->
    • 'Subscription Form (option category)'.

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to display consent field label.-->
<!--This attribute depends on 'privacy_consent_enabled' option set to "yes".-->
<!--option value="Notify me about related content and special offers." (default text)-->
[pum_sub_form privacy_consent_label="{text}" ]

    [   Back to top   ]

    'Consent Required' (checkbox) -- Plugin default: unchecked.  Select whether to require a visitor give their consent to process and collect their personal data using the subscription form. When the checkbox is set to 'checked', visitors will be prompted to give their consent before the form can submit.

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to require visitors to give consent to collect their personal data-->
<!--checkbox = 'unchecked' (plugin default);-->
<!--attribute displays when checkbox = 'checked'-->
[pum_sub_form privacy_consent_required ]

    'Field Type' -- Options: 'Radio'  / 'Checkbox' . Plugin default: 'Radio'. 

    The 'radio' style field type displays 2 radio buttons labeled 'yes' and 'no'.  The 'checkbox' field type displays a single checkbox. The 'radio' field type forces site visitors to choose between 2 visible options. This type of display typically leads to higher rates of opt-in by visitors. 

    The selection of the 'radio' option displays the following option settings within the Subscription Form settings box: 

    - 'Consent Radio Layout'; 

    - 'Consent Yes Label'; and 

    - 'Consent No Label'.  

    The selection of the 'checkbox' option removes these option settings from display within the Subscription Form settings box. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to set consent option field type-->
<!--option value="radio" (plugin default);-->
[pum_sub_form privacy_consent_type="radio" | "checkbox" ]

    [   Back to top   ]

    'Consent Radio Layout' -- Options: 'Inline' / 'Stacked'. Plugin default: 'Inline'. 
    Sets the position of the consent radio buttons within the form. 'Inline' position displays the buttons on the same horizontal line. 'Stacked' position displays the buttons vertically, one above the other. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to display the 'radio' style consent option-->
<!--This attribute depends on the 'privacy_consent_type' option set to "radio".-->
<!--option value="inline" (plugin default)-->
[pum_sub_form privacy_consent_radio_layout="inline" | "stacked" ]

    'Consent Yes Label' (text field) -- Plugin default text: 'Yes'.  Sets the label of the first consent radio button. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to display the label of the first consent radio button.-->
<!--This attribute depends on the 'privacy_consent_type' option set to "radio".-->
<!--option value="Yes" (plugin default)-->
[pum_sub_form privacy_consent_yes_label="Yes" ]

    [   Back to top   ]

    'Consent No Label' (text field) -- Plugin default text: 'No'.  Sets the label of the second consent radio button. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to display the label of the second consent radio button.-->
<!--This attribute depends on the 'privacy_consent_type' option set to "radio".-->
<!--option value="No" (plugin default)-->
[pum_sub_form privacy_consent_no_label="No" ]

    'Consent Usage Text' (text field) -- Plugin default text: 'If you opt in above, we use this information to send related content, discounts and other special offers.'
    This text field accepts valid HTML. The field can include a link to the site privacy policy. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!--Attribute to display a statement on the intended use of the visitor's-->
<!--private data prior to submitting the form.-->
<!--option value="If you opt in above, we use this information to send-->
<!--related content, discounts and other special offers." (plugin default)-->
[pum_sub_form privacy_usage_text="{text}" ]

    [   Back to top   ]

    'Actions' Option Settings Tab

    Close Popup (checkbox) -- Plugin default = 'unchecked' or 'off'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Close Popup' checkbox attributes;  checkbox='unchecked' -->   
<!-- (plugin default) -->  
no attribute displayed 

<!-- 'Close Popup' checkbox attributes;  checkbox='checked' -->   
[pum_sub_form closepopup ]

    Delay (range slider; only appears when 'Close Popup' checkbox='checked')

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Close Delay' attributes; 'Close Popup' checkbox='checked' --> 
<!-- 'Delay' range: 0 - 180 seconds. Plugin default = 0 seconds -->      
[pum_sub_form closedelay="0" ]

    Open Popup (checkbox) -- Plugin default = 'unchecked' or 'off'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Open Popup' checkbox attributes; -->  
<!-- 'Open Popup' checkbox='unchecked' (plugin default) -->  
no attribute displayed   

<!-- 'Open Popup' checkbox attributes; 'Open Popup' checkbox='checked' -->openpopup

    Popup ID -- option list of 'published' popups other than the current popup. The list only appears when the 'Open Popup' checkbox='checked'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Open Popup' checkbox attributes; 'Open Popup' checkbox='checked' -->
<!-- NOTE: The value of "popup-{integer}" must be greater than 0. -->
[pum_sub_form openpopup_id="popup-{integer}" ]

    [   Back to top   ]

    'Redirect' option submenu

    Redirect -- Enable refreshing the page or redirecting after form submit success. Plugin default is checkbox='unchecked' or 'off'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Redirect' checkbox attributes; checkbox='unchecked' -->
<!-- (plugin default) -->  
no attribute displayed

<!-- 'Redirect' checkbox attributes; checkbox='checked' -->
[pum_sub_form redirect_enabled ]

    Redirect URL -- Leave blank to refresh, or enter a url that users will be taken to after success. Only appears when checkbox='checked'. 

    Shortcode attributes (visible from the editor 'Text' tab): 

    <!-- 'Redirect URL' attributes --> 
<!-- NOTE: The attribute will not display unless a URL is added. -->
[pum_sub_form redirect=“{url}”<br> ]

    [   Back to top   ]

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Related Articles