LearnDash MailChimp

Documentation

The LearnDash – MailChimp plugin is designed to make communicating with LearnDash students both easier and more efficient. This is accomplished by enabling MailChimp subscription functionality during the course enrollment process and also by segmenting those students according to the courses they enroll in.

Settings

To enable automatic updates and premium support, navigate to LearnDash LMS – > Settings – > LMS License and activate your license key (which you can find on your purchase history page)

To get started using LearnDash – MailChimp, it is first necessary to obtain an API key from within your MailChimp account. To get this, login to your account at mailchimp.com, then proceed to Account – > Extras – > API Keys. Clicking on the Create A Key button will generate a new API key which you will copy and enter into the LearnDash – MailChimp settings.

MailChimp API Keys Settings

Once you have obtained your API key from MailChimp, login to your WordPress site where the LearnDash – MailChimp extension is installed and navigate to LearnDash LMS – > Settings – > MailChimp. There you will see a text field which is patiently waiting for your new API key. Paste it into that field and hit the Save Changes button.

After you have saved your API key, if the key is valid, you will see a “Valid API key” message and a select field for choosing your list. Select a list and then hit Save Changes again. This time, if you have existing courses, you should see a Create Segments button. When you hit this button, MailChimp segments will be created within your list which correspond with each existing course on your site.

The next settings on this page are the Registration subscribe and success message field. These options allow you to set the text shown to prospective students before and after they subscribe to a list.

You will also see a toggle switch for enabling Auto-Subscription of Students. This renders the Message fields unused and will instead handle all subscriptions in the background automatically on enrollment.

If Auto-Subscription is turned on, a button will appear which will allow you to auto-subscribe all current and past students already existing on your site.

The final button operates as a sort of “uninstall” button. This will delete the Tags created in MailChimp for your Courses and will delete the saved Tag on the WordPress-side for each Course.

Enabling Subscription Form

In order to enable the subscription form for a course, edit the course and check the Show Subscription Form box on the right side of the screen. This will not show if you have Auto-Subscription enabled as the Subscription Form is not required under these circumstances.

Shortcode

The LearnDash – MailChimp plugin includes a shortcode which allows a subscription button to be displayed within content anywhere on your site. To use this shortcode, enter the following within the contents of any page or post:

[ld_mailchimp course_id=”123″]

To make this work on your site, edit a course from the site dashboard and you will see the ID number of that course in the page’s URL. Enter that number in place of the 123 above in order to associate the subscription button with the correct course.

Important Notes

When using the LearnDash – MailChimp extension, there are a few important facts to remember.

The subscription form will only appear for logged in users

Visitors to your site will not see a subscription form until they login. If they do not yet have a user account they will need to register for one before seeing any MailChimp subscription features.

MailChimp does not always show segment subscribers immediately

If you are testing the segmentation functionality or have users subscribing and login to MailChimp to verify that the subscribers are being added to the right list segment, do not be surprised if they are not there initially. Please wait at least an hour to be sure.

Changelog

1.1.2 05/05/2020

  • Fixes an issue where Course Tags would no longer be created automatically on Course Creation once Auto-Subscribe was enabled.
  • Adds Tags for Groups if Auto-Subscribe is enabled. Students will be automatically added to a Tag for the Group as well as each Course within the Group on being added to a Group.
  • Adds the learndash_mailchimp_auto_subscribe_user Filter for bailing on Auto-Subscription.

1.1.1 02/05/2020

  • Prevents Manual Subscription form from showing if Auto-Subscribe is enabled.

1.1.0 11/25/2019

  • Auto-Subscription on Course Enrollment is here!
    • This will not trigger for Open Courses due to how LearnDash handles Course Enrollment. Your Course Access Mode will need to be set to something else.
  • If Auto-Subscription is enabled, a new button will appear on the settings page to automatically Tag all of your existing Students with the appropriate Tags for each Course they are enrolled in and/or have begun.

1.0.5 09/18/2019

  • Fixes an issue where if a Tag with a matching name already existed in Mailchimp the plugin would not save the corresponding Tag ID to the Course
  • Fixes an issue where if you had more than 10 Lists they would not all show on the Settings Page
  • Changes references to “Segments” to “Tags” to match up with how Mailchimp now calls them
  • Changes all references to “MailChimp” to “Mailchimp” to match their new branding
  • Allows updating the Success Message via the Settings Page
  • Updates our Licensing and Support module to the latest version

1.0.4 05/29/2018

  • Revert change from v1.0.3
  • Added button to clear all created List Segments by the Plugin in MailChimp. This allows you “uninstall”/”reinstall” the plugin by starting fresh.
    • Keep in mind, this will remove any Subscribers from these Segments!
  • Added a checkbox below the License Key field at LearnDash LMS -> Settings -> LMS License to opt-in to Beta Releases.

1.0.3 05/21/2018

  • Fixes a bug caused by a change to the MainChimp API

1.0.2 02/02/2018

  • Fixes typo in Plugin Header
  • Updates our Licensing and Support module to the latest version

1.0.1 01/22/2018

  • Fixes PHP error if ld_mailchimp_get_list_segment_emails() fails
  • Updates our Licensing and Support module to the latest version

1.0.0 11/17/2017

  • Initial release