Extension:MailChimpForms

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
MailChimpForms
Release status: beta
Implementation Parser extension , Tag
Description Adds MailChimp subscription management forms to your wiki. Currently only supports the sign-up form.
Author(s) Andrew Mahr (jamahrtalk)
Latest version 1.0
MediaWiki 1.16+
Database changes No
License No license specified
Download MailChimpForms.php
<mailchimpforms />
Translate the MailChimpForms extension if it is available at translatewiki.net
Check usage and version matrix.

The MailChimpForms extension allows the insertion of MailChimp forms easy on your wiki. Currently it only supports the sign-up form, but should be easy to add more functionality if you're interested in doing so.

Usage[edit]

Insert a form using the new tag <mailchimpforms> using these parameters.

Required parameters[edit]

  • prefix: the text that comes before us1.list-manage.com in the URLs that MailChimp uses to manage your lists (usually it is the name of your organization, all lower-case, no spaces)
  • account: your 24-character account id with MailChimp. You can get this by looking at the sign-up form code that MailChimp provides you, and looking for the parameter u=xxxxxxxxxxxxxxxxxxxxxxx
  • list: the 10-character id of the list you want the form to work with, found in the same place as the account id above
  • type: the type of form to insert, which right now can only be set to subscribe

Optional parameters[edit]

  • bordercss: if you want to customize the border around your form, enter the code here, e.g. 1px solid black
  • closelink: set to true if you want the "Close" link to appear under your form

Example[edit]

This following code will insert a form for a Mediawiki mailing list (fictional) with no border and no "Close" link:

<mailchimpforms prefix="mediawiki" account="abcdefghijklmnopqrstuvwx" list="0123456789" type="subscribe" />

Installation[edit]

  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/MailChimpForms/MailChimpForms.php";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.