Flexa Unsubscribe
| 开发者 | flexatech |
|---|---|
| 更新时间 | 2026年8月22日 09:13 |
| PHP版本: | 7.4 及以上 |
| WordPress版本: | 7.1 |
| 版权: | GPL v2 or later |
| 版权网址: | 版权信息 |
详情介绍:
Flexa Unsubscribe adds a complete unsubscribe workflow to every email WordPress sends, with a fully-branded admin UI for managing opt-outs, analytics, and the public unsubscribe page.
- Auto-appends a secure unsubscribe button to outgoing single-recipient emails. Tokens are HMAC-signed using the
AUTH_KEYinwp-config.php, so no database lookup is needed to verify a link. - Blocks outbound mail to unsubscribed addresses before it reaches the mail server. Blocked attempts are logged to a dedicated audit table.
- Honours an exclude-keywords list (default:
Order, Password, Invoice) so transactional mail never gets an unsubscribe link and never gets blocked. - Re-subscribe URL is supported as a first-class action - the plugin can tell opt-outs from opt-backs.
- Customisable public page - every color, font, and string on the unsubscribe/re-subscribe templates is editable from the admin with a live preview.
/wp-json/flexa-unsubscribe/v1/, so external integrations can plug in too.
Source code for compiled JavaScript and CSS
The plugin ships with minified/compiled JavaScript and CSS in assets/dist/. The human-readable source code for these assets is publicly available and maintained at:
https://github.com/flexatech/flexa-unsubscribe
Source lives in the apps/admin (admin UI) directory. Build tools used: pnpm, Vite, React, TypeScript. To build from source: clone the repository, run pnpm install in apps/admin, then pnpm build (see the repository README for exact commands). This allows the code to be reviewed, studied, and forked.
Documentation
Full user guide, technical reference, and REST API documentation are hosted at:
https://unsubscribe-doc.flexacommerce.com/
A "Documentation" link is also added to the plugin row on the Plugins screen for one-click access from inside WordPress.
安装:
- Upload the plugin files to
/wp-content/plugins/flexa-unsubscribe, or install through the WordPress Plugins screen. - Activate the plugin through the Plugins screen.
- On activation the plugin provisions three database tables:
{prefix}flexa_unsubscribes,{prefix}flexa_blocked_emails,{prefix}flexa_unsubscribe_reasons(the last seeded with three default reasons). - Visit Unsubscribe in the admin sidebar to configure.
屏幕截图:
常见问题:
Do I need to change anything in my existing email sending code?
No. The plugin hooks wp_mail with standard WordPress filters. Any plugin or theme that sends mail via wp_mail is covered automatically.
What happens if I rotate AUTH_KEY?
Every in-flight unsubscribe/resubscribe link becomes invalid, because the HMAC key is AUTH_KEY. New links issued after rotation work normally. Existing records in the database are unaffected.
How are blocked emails different from unsubscribed addresses?
Unsubscribes is the list of addresses that opted out. Blocked emails is the audit log of outgoing sends that were stopped because they targeted an unsubscribed address. One unsubscribe can cause many blocked-email entries over time.
Are CSV exports safe to share publicly?
No - CSV exports contain email addresses. Treat them as PII. The download link is nonce-protected so it's not trivially shareable across sessions.
Are there developer hooks I can extend?
Yes. Three action hooks fire on opt-out events so you can sync opt-outs to a CRM, ESP, or your own logging:
do_action( 'flexa_unsubscribe_unsubscribed', $email, $reason )- fires when an address is recorded as unsubscribed.$reasonis '' for link-based opt-outs because the public page collects the reason in a follow-up step.do_action( 'flexa_unsubscribe_resubscribed', $email )- fires when an address is re-subscribed (opted back in).do_action( 'flexa_unsubscribe_email_blocked', $email, $subject )- fires for each recipient whose outbound email is blocked because they had opted out.
更新日志:
3.1.9
- Compatibility: Tested against WordPress 7.1 and bumped "Tested up to" to 7.1. No code changes were required - the plugin's admin app (Radix + Tailwind,
@wordpress/i18nonly) is unaffected by the 7.1@wordpress/componentsand jQuery UI updates, and the plugin does not touch the post editor, media processing, or the editor toolbar.
- i18n: Removed the manual
load_plugin_textdomain()call. WordPress loads translations just-in-time for the plugin slug (language packs + bundledlanguages/files), so the call was redundant and flagged by Plugin Check. - Packaging: Exclude the dev-only Vite HMR registration (
RegisterDev.php) from the distributed build so the WordPress.org Plugin Check no longer flags its dev-only inline script. - Docs: Correct the source-code build instructions in the readme (single
apps/adminapp) and clarify a code comment about how the public unsubscribe/re-subscribe templates sanitize HTML message fields.
- New: Added three developer action hooks so external plugins can react to opt-out events:
flexa_unsubscribe_unsubscribed(fires with the email and reason when an address opts out),flexa_unsubscribe_resubscribed(fires with the email when an address opts back in), andflexa_unsubscribe_email_blocked(fires with the recipient and subject when an outbound email is blocked). See the FAQ for signatures and usage.
- New: Added a
flexa_unsubscribe_hmac_keyfilter so developers can supply a custom, stable secret for signing unsubscribe/resubscribe links instead ofAUTH_KEY. With no filter hooked, behavior is unchanged and existing links keep verifying.
- Fix: The Screenshots section on the WordPress.org plugin page now renders correctly. A non-ASCII arrow character in screenshot caption 3 broke the page rendering; the caption now describes the reorder buttons in plain text.
- Fix: Destructive confirmation dialogs (e.g. "Clear all" on the Blocked emails screen) now focus the Cancel button when they open, so holding Enter on the triggering button can no longer accidentally confirm the deletion. Non-destructive dialogs still focus Confirm.
- Fix: Inline-editing a reason on the Reasons screen now commits the new value when you click anywhere outside the input. Previously, clicking away discarded the typed value - only pressing Enter would save. Enter still saves; Esc still discards.
- New: Plugins-list row now shows Settings and Documentation links next to Deactivate, plus a View documentation link in the row's meta line. The doc site is https://unsubscribe-doc.flexacommerce.com/.
- i18n: 3 new translatable strings ("Settings", "Documentation", "View documentation").
- New: CSV import on the Unsubscribes screen. Bulk-add opt-out records by uploading a CSV file - the same
Email, Reason, Dateshape produced by the existing CSV export, so an export from one site can be re-imported on another. Email is the only required column; Reason and Date are optional. A header row is auto-detected; headerless files are also accepted. - Behavior: Existing emails are skipped (the import is idempotent - it never overwrites the original
unsubscribed_ator reason for a row already on the list). The dialog reports imported / skipped / failed counts and lists the first 100 row-level errors so you can correct the source file. - Safety limits: 2 MiB max file size, 10,000 rows per import, requires
manage_optionsplus the standard REST nonce. - REST: new
POST /flexa-unsubscribe/v1/unsubscribes/importendpoint accepts amultipart/form-dataupload (fieldfile). - i18n: 29 new translatable strings (8 PHP, 21 admin UI), translated across all seven bundled locales.
- Security: Sanitize
$_GET['email']and$_GET['token']at the read site in the public unsubscribe/resubscribe handler (sanitize_email/sanitize_text_field+wp_unslash), with a documentedphpcs:disable WordPress.Security.NonceVerification.Recommendedsince the HMAC token is the CSRF protection layer for these public links. - Compatibility: Replace inline
<style>and<script>blocks intemplates/unsubscribe-page.phpandtemplates/resubscribe-page.phpwithwp_register_style/wp_enqueue_style/wp_add_inline_style(and the script equivalents), so the public templates pass the WP.org Plugin Check enqueue rule. - Docs: Fix the source-code repository URL in
readme.txt.
- Complete admin rewrite. The seven admin pages are now a React single-page app (Vite + TypeScript + shadcn/ui + Tailwind v4) instead of individual PHP-rendered screens.
- New: REST API under
/wp-json/flexa-unsubscribe/v1/covering unsubscribes, blocked emails, re-subscribes, reasons, settings, appearance, and analytics. Every admin screen consumes this API. - New: Dashboard with time-series and reasons charts (recharts).
- New: Live preview panel on the Appearance screen - see your colors, fonts, and copy applied to a replica of the public unsubscribe page while you edit.
- New: Client-side search + server-side sort + server-side pagination on every list screen.
- New: URL-synced table state (
?page=2&sort=email&order=descbookmarkable) on every list screen. - Security: CSV export
admin-post.phphandlers now verify nonces viacheck_admin_referer(). - Change: Admin menu label is "Unsubscribe" (same as pre-2.x) and sits at menu position 60. Slug changed from
flexa-sutoflexa-unsubscribe- legacy admin bookmarks will 404. - Change: Removed the
flexa_get_analytics_dataAJAX endpoint, superseded by the REST/analytics/*routes. - Requires PHP 7.4 (was previously unspecified; the plugin now declares the floor).
- Pagination for large lists.
- Menu refinements.
- Analytics page introduced.