“Subscribe to Download” Documentation by “WP Shuffle” v1.0

“Subscribe to Download”

Table of Contents

1. Subscription Forms
2. General Settings
3. Form Settings
4. Layout Settings
5. Email Settings
6. Custom Settings
7. Subscribers
8. Settings
9. Frontend Use
10. Developer Documentation

Subscription Forms - top

Once you install the plugin, you will get the Subscribe to Download menu item in the backend top level admin menu. When you will click on that menu item, you will get all the subscription form listing.

B) General Settings - top

Once you add or edit the form, then you can configure all the necessary basic settings related with the plugin from the general settings.

In general settings you will find below options.

• Form Status - It can be used to enable or disable the form in frontend.
• Form Title - It is the field for giving the title for the form being created.
• Form Alias - It is the field for giving the alias for the form being created which will be used in the shortcode. Please note that alias should be unique and shouldn't contain any special characters or space. You can use underscore instead.
• Download File - In this field you can enter the file to be downloaded after successful subscription.
• Encrypt Download Link - By enabling this option, you can send the encrypted download link which won't show the real URL of the download file to prevent from direct URL downloading. And by using the encrypted download link, you can track the download status of the users.
• Form Success Message - You can enter the message to be displayed after successful form submission in this field.
• Form Required Error Message - You can enter the message to be displayed whenever the form is submitted without filling the required fields in this field.
• Form Error Message - You can enter the message to be displayed when form submission couldn't be completed or email couldn't be sent to the users due to some error in this field.
• Always Show - By enabling this option you can always show the form to subscribed users too. Else download button will be displayed.
• Mailchimp Lists - This option will only show if you have configured and fetched the Mailchimp List from the Global Settings page of our plugin.
• Constant Contact Lists - This option will only show if you have configured and fetched the Constant Contact List from the Global Settings page of our plugin.

C) Form Settings - top

All the form fields can be enabled or disabled from this section along with their labels. Below are the available form components.

• Heading
• Sub Heading
• Name
• Email
• Terms and Agreement
• Subscribe Button
• Footer

D) Layout Settings - top

In this section you can configure all the layout related settings. You can choose the Template from our 20 pre designed templates, select whether to show the subscription form directly or through popup trigger and also configure the form width.

E) Email Settings - top

In this section, you can find all the options related with email. You can configure Email Subject, From Email, From Name and Email Message

E) Custom Settings - top

In this section you can find all the options regarding the layout customization of the form. Once you enable the custom styles, you can view the options to override the default design provided the pre designed templates. Below are the available options.

• Text Color
• Button Background Color
• Button Text Color
• Button Hover Color
• Button Hover Text Color
• Loader Color
• Background Type - Default, Image or Color
• Background Color
• Background Image

E) Subscribers - top

You can get all the subscribed users in this section. You can export also export the subscribers in the CSV layout.

F) Settings - top

You can configure Mailchimp and Constant contact settings in this section. Also you can disable the fontawesome from multiple loading in the extra settings if your site already has fontawesome loaded.

G) Frontend Use - top

You can use the form in the frontend through shortcode or choose the subscription form in individual page as the delayed popup.

Shortcode[std alias="form_alias"]

H) Developer Documentation - top

If you are a developer and want to customize or extend plugin features from outside the plugin then there are few hooks and filters available in our plugin which are explained in detailed inside the help section of our plugin.

Available Actions

/**
 * Fires when Init hook is fired through plugin *
 * @since 1.0.0
 */
do_action('std_init');
            

/**
 * Triggers just before processing the subscription form *
 * @since 1.0.0
 */
do_action('std_before_form_process');
            

/**
 * Triggers at the end of processing the subscription form successfully *
 * @param array $form_data
 *
 * @since 1.0.0
 */
 do_action('std_end_form_process', $form_data, $form_details);
            

/**
 * Triggers just before displaying the subscription form *
 * @param object $form_row
 *
 * @since 1.0.0
 */
 do_action('std_before_form', $form_row);
            

/**
 * Triggers just after displaying the subscription form *
 * @param object $form_row
 *
 * @since 1.0.0
 */
do_action('std_after_form', $form_row);
            

/**
 * Triggers just before displaying the download button *
 * @param object $form_row
 *
 * @since 1.0.0
 */
do_action('std_before_download', $form_row);
            

/**
 * Triggers just after displaying the download button *
 * @param object $form_row
 *
 * @since 1.0.0
 */
do_action('std_after_download', $form_row);
            

Available Filters

/**
 * Filters csv rows *
 * @param array $csv_rows
 *
 * @since 1.0.0
 */
$csv_rows = apply_filters('std_csv_rows', $csv_rows);
            

/**
 * Filters download path before starting the download *
 * @param string $download_path
 * @param string $encryption_key
 *
 * @since 1.0.0
 */
 $download_path = apply_filters('std_download_path', $download_path, $encryption_key);
            

/**
 * Filters post parameters being sent to Maichimp *
 * @param array $post_parameters
 * @param array $form_data
 * @param array $form_details
 */
 $post_parameters = apply_filters('std_mc_post_parameters', $post_parameters, $form_data, $form_details);
            

/**
 * Filters parameters being sent to Constant Contact *
 * @param array $post_parameters
 * @param array $form_data
 * @param array $form_details
 */
 $post_parameters = apply_filters('std_cc_post_parameters', $post_parameters, $form_data, $form_details);
            

/**
 * Filters email message *
 * @param string $email_message
 * @param array $form_data
 *
 * @since 1.0.0
 */
$email_message = apply_filters('std_email_message', $email_message, $form_data);
            

Once again, thank you so much for purchasing this plugin. As we said at the beginning, we'd be glad to help you if you have any questions relating to this theme. No guarantees, but we'll do our best to assist. If you have a more general question relating to the plugin on Codecanyon, you might consider visiting the forums and asking your question in the "Item Discussion" section.

WP Shuffle

Go To Table of Contents