外掛說明
Simple Newsletter Signup for Mailgun, crafted by the team at Unfinished Man, allows you to add a newsletter signup form to your WordPress site via widget or shortcode. It connects directly to your Mailgun mailing lists for subscribing/unsubscribing users.
Features
- Integrated Subscribe/Unsubscribe: Users can subscribe and unsubscribe using the same form
- Widget Support: Add to sidebars with customizable title and intro text
- Shortcode Support: Embed via
[sns_newslettersignup title="Your Title"] - Mailgun Integration: Direct API integration with your Mailgun account
- reCAPTCHA v3: Optional bot protection with configurable score threshold
- AJAX-Powered: Seamless form submissions without page reload
- Rate Limiting: Prevents spam with 5 attempts per 15 minutes per IP
- Custom CSS Editor: Built-in CSS editor with syntax highlighting for easy styling
- Responsive Design: Mobile-friendly forms that work on all devices
- Dark Mode Support: Automatic styling for dark mode preferences
- Accessibility: WCAG compliant with proper ARIA labels and keyboard navigation
- Developer Friendly: Custom hooks and events for advanced customization
- Translation Ready: Fully internationalized and ready for translation
Requirements
- WordPress 5.0 or higher
- PHP 7.4 or higher
- Mailgun account with API access
- (Optional) Google reCAPTCHA v3 keys
Shortcode Attributes
title– Form title (default: “Newsletter Signup”)show_name– Show name field: true/false (default: true)show_help_text– Show help text: true/false (default: true)
Example: [sns_newslettersignup title="Join Our Newsletter" show_name="false"]
Developer Hooks
JavaScript Events:
* sns:success – Triggered on successful submission
* sns:error – Triggered on error
* sns:ajax_error – Triggered on AJAX error
* sns:recaptcha_error – Triggered on reCAPTCHA error
Support
For bugs or feature requests:
* WordPress Support Forum
* Visit Unfinished Man
Privacy Policy
This plugin does not collect or store any personal data locally. All email addresses and names are sent directly to Mailgun via their API. Please review Mailgun’s privacy policy and ensure your own privacy policy covers newsletter signups.
Credits
Created by the team at Unfinished Man.
License
This plugin is licensed under the GNU General Public License version 2 or later (GPLv2+). You are free to use, modify, and distribute this plugin under the terms of the GPL. For more details, see the License URI.
安裝方式
- Upload the plugin files to
/wp-content/plugins/simple-newsletter-signup/or install through the WordPress plugins screen - Activate the plugin through the ‘Plugins’ menu in WordPress
- Go to Settings > SNS Settings to configure:
- Mailgun API Key, Domain, and Mailing List
- Optional reCAPTCHA v3 keys for bot protection
- Custom CSS for styling (optional)
- Add the widget to sidebars via Appearance > Widgets, or use the shortcode in posts/pages
Getting Mailgun Credentials
- Sign up at mailgun.com
- Add and verify your domain
- Create a mailing list
- Get your API key from the dashboard
- Enter these details in the plugin settings
Getting reCAPTCHA Keys
- Visit Google reCAPTCHA Admin
- Register a new site with reCAPTCHA v3
- Add your domain
- Copy the site key and secret key
- Enter them in the plugin settings
常見問題集
-
How do I get Mailgun API credentials?
-
Sign up at mailgun.com, create a domain and mailing list, then grab your API key from the dashboard.
-
Does it handle unsubscribes?
-
Yes! Users can resubmit their email to unsubscribe if they’re already subscribed.
-
Can I customize the form?
-
Yes! You can use the built-in CSS editor in Settings > SNS Settings, customize via your theme’s CSS, or use the widget/shortcode attributes to show/hide fields.
-
What if reCAPTCHA fails?
-
Check your keys at Google reCAPTCHA. You can adjust the score threshold in the plugin settings (default is 0.5).
-
How does rate limiting work?
-
The plugin limits each IP address to 5 submission attempts per 15 minutes to prevent spam and abuse.
-
Is it GDPR compliant?
-
The plugin itself doesn’t store personal data. However, you should ensure your Mailgun account and privacy policy comply with GDPR requirements.
-
Can I use it with other email services?
-
Currently, the plugin only supports Mailgun. Support for other services may be added in future versions.
-
Does it work with page builders?
-
Yes! Use the shortcode in any page builder that supports WordPress shortcodes.
-
How do I style the form?
-
Three ways:
1. Use the built-in CSS editor in Settings > SNS Settings (includes syntax highlighting)
2. Add CSS to your theme’s stylesheet
3. Use a custom CSS pluginThe settings page includes helpful CSS examples and a complete selector reference.
使用者評論
這個外掛目前沒有任何使用者評論。
參與者及開發者
變更記錄
1.3 (2025-01-XX)
- Major refactor with improved code organization
- Added proper OOP structure with separate classes
- Improved security with rate limiting (5 attempts per 15 minutes)
- Fixed JavaScript bug with reCAPTCHA integration
- Added custom CSS editor with CodeMirror syntax highlighting
- Added CSS styling for better user experience
- Added dark mode support
- Improved error handling and logging
- Fixed text domain consistency (simple-newsletter-signup-for-mailgun)
- Added translation support (internationalization)
- Added accessibility improvements (ARIA labels, keyboard navigation)
- Added custom JavaScript events for developers
- Better mobile responsiveness
- Added configurable reCAPTCHA score threshold
- Improved admin interface with helpful resources and CSS examples
- Added plugin action links (Settings link on plugins page)
- Better code documentation
- Performance improvements
- Added proper activation/deactivation hooks
- Improved sanitization and validation
- Full WordPress Coding Standards (WPCS) compliance
- Better debugging with wp_json_encode() logging
1.2
- Security fixes: ESC output, isset checks, unslashing, sanitized settings
- Button text changed to “Subscribe” with clearer help text
- Fixed settings page display issues
1.1
- Added reCAPTCHA v3 support
- Updated widget with intro text field
- Integrated unsubscribe functionality
1.0
- Initial release with Mailgun integration, widget, and shortcode