-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from mailchimp/update/dotorg-standards
Update/dotorg standards
- Loading branch information
Showing
12 changed files
with
546 additions
and
103 deletions.
There are no files selected for viewing
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # Mailchimp List Subscribe Form === | ||
|
|
||
| > Add a Mailchimp signup form widget to your WordPress site. | ||
| [](#support-level) [](https://github.com/mailchimp/wordpress/blob/develop/LICENSE.md)     | ||
|
|
||
| ## Overview | ||
|
|
||
| Use the Mailchimp List Subscribe plugin to quickly add a Mailchimp signup form widget to your WordPress 2.8 or higher site. | ||
|
|
||
|  | ||
|
|
||
| After installation, you’ll log in with your API key, select your Mailchimp list, choose merge fields and groups, and add the widget to your site. Typically, installation and setup will take about 5-10 minutes, and absolutely everything can be done via the WordPress Setting GUI, with no file editing at all. | ||
|
|
||
|  | ||
|
|
||
| WordPress.com compatibility is limited to Business tier users only. [How to add a signup form if you have a WordPress.com site](https://mailchimp.com/help/ways-to-add-a-signup-form-in-wordpress/). | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| This section describes how to install the plugin and get started using it. | ||
|
|
||
| ### Version 2.8+ | ||
|
|
||
| 1. Unzip our archive and upload the entire mailchimp directory to your `/wp-content/plugins/ directory` | ||
| 2. Activate the plugin through the **Plugins** menu in WordPress | ||
| 3. Navigate to **Settings** click **Mailchimp Setup**. | ||
| 4. Enter your Mailchimp API Key and let the plugin verify it. | ||
| 5. Select the list where you want to send new Mailchimp subscribers. | ||
| 6. Optional: turn **MonkeyRewards** on or off. | ||
| 7. Optional: Turn **Merge Fields** and **Groups** on or off. Navigate to **Appearance**, and click **Widgets**. Drag the Mailchimp Widget into one of your Widget Areas. | ||
|
|
||
|  | ||
|
|
||
| ### Advanced | ||
|
|
||
| If you have a custom coded sidebar or bells and whistles that prevent enabling widgets through the WordPress GUI, complete these steps instead. | ||
|
|
||
| WordPress v2.8 or higher: | ||
| ` [mailchimpsf_form] ` | ||
|
|
||
| If you are adding it inside a php code block, pop this in: | ||
|
|
||
| ` mailchimpSF_signup_form(); ` | ||
|
|
||
| Or, if you are dropping it in between a bunch of HTML, use this: | ||
|
|
||
| `<?php mailchimpSF_signup_form(); ?>` | ||
|
|
||
| Where ever you want it to show up. | ||
|
|
||
| ## Upgrading | ||
|
|
||
| If you are upgrading to version 1.2.1 and you used the widget in your sidebar previously, all you need to do is drag the `Mailchimp Widget` back into the sidebar, visit the Mailchimp settings page (which will have maintained your prior settings), click the "Update List" button, and you're done! | ||
|
|
||
| ## Internationalization (i18n) | ||
|
|
||
| Currently we have the plugin configured so it can be translated and the following languages supported: | ||
|
|
||
| * bg_BG - Bulgarian in Bulgaria (thanks to [SiteGround](http://www.siteground.com/wordpress-hosting.htm) for contributing) | ||
| * cs_CZ - Czech in the Czech Republic (thanks to [Peter Kahoun](http://kahi.cz/) for contributing) | ||
| * da_DK - Danish in Denmark (thanks to Jan Lund for contributing) | ||
| * de_DE - German in Germany (thanks to Michael Jaekel for contributing) | ||
| * el_GR - Modern Greek in Greece (thanks to Ιωάννης Δημοφέρλιας (John Dimoferlias) for contributing) | ||
| * en_US - English in the U.S. | ||
| * es_CL - Spanish in Chile (thanks to Tomás Nader for contributing) | ||
| * es_ES - Spanish in Spain (thanks to [Claudia Mansilla](http://cricava.com/) for contributing) | ||
| * et_ET - Estonian in Estonia (thanks to [Helen Urbanik](http://www.motomaania.ee/) for contributing) | ||
| * fr_FR - French in France (thanks to [Maxime Toulliou](http://www.maximetoulliou.com/) for contributing) | ||
| * he_IL - Hebrew in Israel (thanks to [שגיב בית](http://www.sagive.co.il) for contributing) | ||
| * hu_HU - Hungarian in Hungary (thanks to Okostobi for contributing) | ||
| * it_IT - Italian in Italy (thanks to [Stefan Des](http://www.stefandes.com) for contributing) | ||
| * ko_KR - Korean (thanks to 백선기 (SK Baek) for contributing) | ||
| * nb_NO - Norwegian (thanks to [Alexander Roterud aka Defrag](http://www.tigerpews.com) for contributing) | ||
| * nl_BE - Dutch (thanks to [Filip Stas](http://suddenelfilio.net/) for contributing) | ||
| * pt_BR - Portuguese in Brazil (thanks to Maria Manoela Porto for contributing) | ||
| * pt_PT - Portuguese in Portugal (thanks to [Tiago Faria](http://xroot.org) for contributing) | ||
| * ro_RO - Romanian in Romania (thanks to Alexandru Armin Roșu for contributing) | ||
| * ru_RU - Russian in the Russian Federation (thanks to [Илья](http://fatcow.com) for contributing) | ||
| * sv_SE - Swedish in Sweden (thanks to [Sebastian Johnsson](http://www.agiley.se/) for contributing) | ||
| * tr_TR - Turkish in Turkey (thanks to [Hakan E.](http://kazancexpert.com/) for contributing) | ||
|
|
||
| If your language is not listed above, feel free to create a translation. Here are the basic steps: | ||
|
|
||
| 1. Copy "mailchimp_i18n-en_US.po" to "mailchimp_i18n-LANG_COUNTRY.po" - fill in LANG and COUNTRY with whatever you use for WPLANG in wp-config.php | ||
| 2. Grab a translation editor. [POedit](http://www.poedit.net/) works for us | ||
| 3. Translate each line - if you need some context, open up mailchimp.php and search for the line number or text | ||
| 4. [Fork](http://help.github.com/fork-a-repo/) the [repository on github](https://github.com/mailchimp/wordpress) | ||
| 5. [Clone](http://help.github.com/remotes/#clone) the _develop_ branch | ||
| 6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed | ||
| 7. Make a [pull request](http://help.github.com/send-pull-requests/) | ||
|
|
||
| ## Support Level | ||
|
|
||
| **Active:** Mailchimp is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,17 @@ | ||
| <?php | ||
| /* | ||
| Plugin Name: MailChimp | ||
| Plugin URI: http://www.mailchimp.com/plugins/mailchimp-wordpress-plugin/ | ||
| Description: The MailChimp plugin allows you to quickly and easily add a signup form for your MailChimp list. | ||
| Version: 1.5.8 | ||
| Author: MailChimp | ||
| Author URI: https://mailchimp.com/ | ||
| * Plugin Name: Mailchimp | ||
| * Plugin URI: https://mailchimp.com/help/connect-or-disconnect-list-subscribe-for-wordpress/ | ||
| * Description: Add a Mailchimp signup form widget to your WordPress site. | ||
| * Version: 1.5.8 | ||
| * Requires at least: 2.8 | ||
| * Requires PHP: 5.6 | ||
| * Author: Mailchimp | ||
| * Author URI: https://mailchimp.com/ | ||
| * License: GPL-2.0-or-later | ||
| * License URI: https://spdx.org/licenses/GPL-2.0-or-later.html | ||
| */ | ||
| /* Copyright 2008-2012 MailChimp.com (email : [email protected]) | ||
| /* Copyright 2008-2012 Mailchimp.com (email : [email protected]) | ||
| This program is free software; you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
|
|
@@ -33,7 +37,7 @@ | |
| // Define our location constants, both MCSF_DIR and MCSF_URL | ||
| mailchimpSF_where_am_i(); | ||
|
|
||
| // Get our MailChimp API class in scope | ||
| // Get our Mailchimp API class in scope | ||
| if (!class_exists('MailChimp_API')) { | ||
| $path = plugin_dir_path(__FILE__); | ||
| require_once($path . 'lib/mailchimp/mailchimp.php'); | ||
|
|
@@ -73,7 +77,7 @@ function mailchimpSF_plugin_init() { | |
|
|
||
|
|
||
| /** | ||
| * Add the settings link to the MailChimp plugin row | ||
| * Add the settings link to the Mailchimp plugin row | ||
| * | ||
| * @param array $links - Links for the plugin | ||
| * @return array - Links | ||
|
|
@@ -124,7 +128,7 @@ function mailchimpSF_load_resources() { | |
|
|
||
|
|
||
| /** | ||
| * Loads resources for the MailChimp admin page | ||
| * Loads resources for the Mailchimp admin page | ||
| * | ||
| * @return void | ||
| */ | ||
|
|
@@ -177,7 +181,7 @@ function mailchimpSF_main_css() { | |
| */ | ||
| function mailchimpSF_add_pages(){ | ||
| // Add settings page for users who can edit plugins | ||
| add_options_page( __( 'MailChimp Setup', 'mailchimp_i18n' ), __( 'MailChimp Setup', 'mailchimp_i18n' ), MCSF_CAP_THRESHOLD, 'mailchimpSF_options', 'mailchimpSF_setup_page'); | ||
| add_options_page( __( 'Mailchimp Setup', 'mailchimp_i18n' ), __( 'Mailchimp Setup', 'mailchimp_i18n' ), MCSF_CAP_THRESHOLD, 'mailchimpSF_options', 'mailchimpSF_setup_page'); | ||
| } | ||
| add_action('admin_menu', 'mailchimpSF_add_pages'); | ||
|
|
||
|
|
@@ -264,7 +268,7 @@ function mailchimpSF_migrate_sopresto() { | |
| 'timeout' => 500, | ||
| 'redirection' => 5, | ||
| 'httpversion' => '1.0', | ||
| 'user-agent' => 'MailChimp WordPress Plugin/' . get_bloginfo( 'url' ), | ||
| 'user-agent' => 'Mailchimp WordPress Plugin/' . get_bloginfo( 'url' ), | ||
| 'body' => $body | ||
| ); | ||
|
|
||
|
|
@@ -317,7 +321,7 @@ function mailchimpSF_auth_nonce_salt() { | |
| } | ||
|
|
||
| /** | ||
| * Creates new MailChimp API v3 object | ||
| * Creates new Mailchimp API v3 object | ||
| * | ||
| * @return MailChimp_API | false | ||
| */ | ||
|
|
@@ -355,7 +359,7 @@ function mailchimpSF_needs_upgrade() { | |
| } | ||
|
|
||
| /** | ||
| * Deletes all mailchimp options | ||
| * Deletes all Mailchimp options | ||
| **/ | ||
| function mailchimpSF_delete_setup() { | ||
| $options = array('mc_user_id', 'mc_sopresto_user', 'mc_sopresto_public_key', 'mc_sopresto_secret_key', 'mc_rewards', 'mc_use_javascript', 'mc_use_datepicker', 'mc_use_unsub_link', 'mc_list_id', 'mc_list_name', 'mc_interest_groups', 'mc_merge_vars'); | ||
|
|
@@ -477,11 +481,11 @@ function mailchimpSF_save_general_form_settings() { | |
| /* NUKE the CSS! */ | ||
| if(isset($_POST['mc_nuke_all_styles'])) { | ||
| update_option('mc_nuke_all_styles', true); | ||
| $msg = '<p class="success_msg">'.__('MailChimp CSS turned Off!', 'mailchimp_i18n').'</p>'; | ||
| $msg = '<p class="success_msg">'.__('Mailchimp CSS turned Off!', 'mailchimp_i18n').'</p>'; | ||
| mailchimpSF_global_msg($msg); | ||
| }elseif (get_option('mc_nuke_all_styles') !== false) { | ||
| update_option('mc_nuke_all_styles', false); | ||
| $msg = '<p class="success_msg">'.__('MailChimp CSS turned On!', 'mailchimp_i18n').'</p>'; | ||
| $msg = '<p class="success_msg">'.__('Mailchimp CSS turned On!', 'mailchimp_i18n').'</p>'; | ||
| mailchimpSF_global_msg($msg); | ||
| } | ||
|
|
||
|
|
@@ -627,7 +631,7 @@ function mailchimpSF_change_list_if_necessary() { | |
| count($mv) | ||
| ).' '. | ||
| __('from your list').' "'.$list_name.'"<br/><br/>'. | ||
| __('Now you should either Turn On the MailChimp Widget or change your options below, then turn it on.', 'mailchimp_i18n').'</p>'; | ||
| __('Now you should either Turn On the Mailchimp Widget or change your options below, then turn it on.', 'mailchimp_i18n').'</p>'; | ||
| mailchimpSF_global_msg($msg); | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.