WordPress.org

China 简体中文

获取 WordPress
WordPress.org

Plugin Directory

NoticePilot – Remote Campaign Hub for WordPress Plugin & Theme Authors

NoticePilot – Remote Campaign Hub for WordPress Plugin & Theme Authors

作者：Spider Themes
下载

描述

NoticePilot is not another admin notice plugin. It is a self-hosted remote campaign distribution platform built specifically for WordPress plugin and theme authors.

If you maintain a WordPress plugin or theme that runs on hundreds or thousands of sites, you need a reliable way to push announcements, update prompts, sale banners, or deprecation warnings to your users — without shipping a new plugin release for every message. NoticePilot solves this with a hub-to-remote architecture: you manage campaigns centrally on your own site, and a lightweight PHP SDK bundled in your plugin automatically fetches and displays them on every remote installation.

Who Is This For?

NoticePilot is purpose-built for WordPress plugin and theme developers who need to communicate with their users across multiple remote installations from a single, self-hosted dashboard. It is not a tool for managing or suppressing admin notices on a single site — there are many plugins already serving that purpose.

What Makes It Different?

Unlike most admin-notice plugins, NoticePilot is a complete developer communication platform:

  • Hub-to-Remote Architecture — One central dashboard pushes campaigns to unlimited remote WordPress sites via a REST API. No third-party SaaS, no external dependencies — everything runs on your own WordPress installation.
  • Single-File PHP SDK — Bundle one PHP file into your plugin or theme. Initialize with a single line of code. The SDK handles fetching, caching, rendering, and dismissal automatically.
  • Privacy-First Analytics — Track impressions, clicks, and dismissals across all remote sites without collecting personal data. Remote site URLs are MD5-hashed before storage — no IP addresses, usernames, or cookies are ever saved.
  • Audience Targeting — Deliver the right message to the right users by targeting campaigns based on plan type (free or pro), plugin version (with comparison operators like <, >, =), and WordPress user roles.
  • Campaign Scheduling — Set start and end dates for time-sensitive campaigns. Expired campaigns are auto-disabled via WP-Cron — no manual clean-up required.
  • Rich HTML Support — Write full HTML including inline CSS, <style> blocks, and custom layouts. Your content renders exactly as authored on every remote site.
  • Smart Dismissal Handling — Users who dismiss a notice won’t see it again for a configurable duration. Dismissals are stored locally on the remote site using a FIFO strategy, keeping only the 20 most recent dismissed IDs.
  • Scalable Analytics Engine — Raw events roll up into daily summaries via an hourly WP-Cron job with automatic pruning. Built for scale — no unbounded table growth.

How It Works

  1. Create a Product — Each product represents a plugin, theme, or service you maintain. NoticePilot generates a unique REST API endpoint for it automatically.
  2. Add Campaigns — Write rich HTML content, set optional scheduling and audience-targeting rules, then enable the campaign.
  3. Integrate the SDK — Download the single-file PHP SDK from your product card, bundle it with your plugin or theme, and initialize it with one line of code. The SDK polls your hub on a configurable schedule and renders active campaigns as WordPress admin notices on remote sites.
  4. Track Performance — Monitor impressions, clicks, dismissals, and click-through rates from the analytics dashboard. Drill down by product or by individual campaign with daily breakdowns.

Real-World Use Cases

  • Plugin authors: Push update prompts, deprecation warnings, or feature announcements to all users of your plugin — without shipping a new release.
  • Theme authors: Announce seasonal sales, new theme versions, or compatibility updates directly inside the WordPress admin on every active installation.
  • Agency developers: Broadcast maintenance windows, policy changes, or onboarding tips across all client sites from a single central hub.
  • Freemium plugins: Show upgrade prompts exclusively to free-plan users while displaying different messaging to pro users — all without code changes on the remote site.

A Self-Hosted Alternative

Plugin authors today face a difficult choice: build a custom notice system from scratch for every product (duplicating effort), or rely on third-party SaaS platforms (adding external dependencies and data-privacy concerns). NoticePilot offers a self-hosted, privacy-respecting, zero-external-dependency alternative that runs entirely on your own WordPress installation — giving you full control over your data and your users’ experience.

屏幕截图

  • NoticePilot Dashboard – Centralized hub to manage products, launch campaigns, and configure SDK integrations.
  • Campaign Analytics – Track performance, impressions, clicks, and conversion rates across all remote installations.
  • SDK Integration – Simple, step-by-step guide to download and initialize the remote notice client SDK.
  • Add Campaign – Create HTML campaigns with customized start dates, end dates, and targeting rules.

安装

Installing the Hub Plugin

  1. Upload the noticepilot folder to the /wp-content/plugins/ directory of your central management site.
  2. Activate the plugin through the Plugins menu in WordPress.
  3. Navigate to NoticePilot in your WordPress admin sidebar to begin creating products and campaigns.

Integrating the SDK With Your Plugin or Theme

Once you have created a product and added campaigns on your hub site, integrate the SDK into your own plugin or theme to start displaying notices on remote sites:

  1. In the NoticePilot dashboard, click the How To Integrate button on your product card.
  2. Click Download SDK to download the class-remote-notice-client.php file.
  3. Copy the file into your plugin or theme (e.g., into an includes/ subdirectory).

  4. Add the following initialization code to your plugin’s main file or your theme’s functions.php:

    // Load the NoticePilot SDK.
    require_once DIR . ‘/includes/class-remote-notice-client.php’;

    add_action( ‘plugins_loaded’, function() {
    Noticepilot_Remote_Notice_Client::init( ‘your-product-slug’, [
    ‘api_url’ => ‘https://your-hub-site.com/wp-json/noticepilot/v1/content/your-product-slug’,
    ‘schedule’ => ‘daily’,
    ‘dismiss_duration’ => WEEK_IN_SECONDS,
    ] );
    } );

Replace your-product-slug with the slug shown on your NoticePilot product card, and your-hub-site.com with the domain of the site running the NoticePilot hub plugin.

SDK configuration options:

  • api_url — (Required) The full REST API URL to your product’s content endpoint.
  • schedule — How often the SDK checks for new campaigns. Accepted values: hourly, twicedaily, or daily. Default: daily.
  • capability — The WordPress capability a user must have to see notices. Default: manage_options.
  • dismiss_duration — How long a dismissed notice remains hidden before it can reappear. Default: WEEK_IN_SECONDS.

Once initialized, the SDK automatically handles fetching, caching, rendering, and dismissing notices — no additional code required.

常见问题

How is NoticePilot different from other admin notice plugins?

Most admin-notice plugins manage, dismiss, or suppress notices on a single WordPress installation. NoticePilot serves an entirely different purpose — it is a remote campaign distribution platform for plugin and theme authors. You create and manage campaigns on a central hub site, and a lightweight SDK embedded in your plugin automatically fetches and displays those campaigns across hundreds or thousands of remote installations. It also includes campaign analytics, audience targeting, and scheduling — capabilities not found in typical notice-management plugins.

Can I use custom HTML and CSS in my campaigns?

Yes. Campaign content supports full HTML, including inline styles, <style> blocks, and custom layouts. Your content renders exactly as written on every remote site.

Is it safe to store and serve raw HTML campaign content?

Yes, within its intended use case. Campaign content can only be created by administrators who have the manage_options capability, and all form submissions are protected by WordPress nonce verification. HTML is stored without additional sanitization intentionally, to preserve inline CSS and custom styling. NoticePilot is a developer tool designed for trusted authors — not for end-user-generated content.

Does the plugin collect personal data from remote sites?

No. Analytics events are recorded using fire-and-forget navigator.sendBeacon() calls. Before any data is written to the database, remote site URLs are MD5-hashed server-side. No IP addresses, usernames, cookies, user agents, or other personally identifiable information is ever collected or stored.

Can I target campaigns to specific users or plan types?

Yes. Each campaign supports three independent targeting dimensions:

  • Plan type — Show to all users, free-plan users only, or pro-plan users only.
  • Plugin version — Target by version number using comparison operators (<, >, =, <=, >=).
  • WordPress user role — Restrict visibility to specific roles such as Administrator, Editor, and others.

Leave all targeting fields blank to display the campaign to every eligible user.

What happens when a user dismisses a notice?

The notice is hidden for the duration configured via the dismiss_duration SDK option. Dismissals are recorded locally on the remote site in wp_options using a FIFO cleanup strategy that retains only the 20 most recent dismissed campaign IDs. During each fetch cycle, the SDK also automatically prunes stale IDs for campaigns that no longer exist on the hub.

Does installing NoticePilot add notices to my own site’s dashboard?

No. NoticePilot does not inject any admin notices into the WordPress dashboard of the site where it is installed. It provides only a management interface under its own admin menu page. Campaign notices are displayed exclusively on remote sites — and only when a plugin or theme author explicitly integrates the SDK.

评价

此插件暂无评价。

贡献者及开发者

「NoticePilot – Remote Campaign Hub for WordPress Plugin & Theme Authors」是开源软件。 以下人员对此插件做出了贡献。

贡献者

帮助将「NoticePilot – Remote Campaign Hub for WordPress Plugin & Theme Authors」翻译成简体中文。

对开发感兴趣吗?

您可以浏览代码，查看SVN仓库，或通过RSS订阅开发日志。

更新日志

1.0.1

  • Security: Sanitized nonce input in the admin form handler.
  • Security: Replaced inline <style> output in the SDK with the proper wp_add_inline_style() API.
  • Security: Replaced inline <script> output in the SDK with the proper wp_add_inline_script() API.
  • Improvement: Added an explicit __return_true permission callback to the public analytics REST API route to comply with WP REST API guidelines.
  • Improvement: Added plugin owner to the contributors list.
  • Improvement: Updated readme tags and short description to better reflect the plugin’s developer-focused, remote-distribution use case.

1.0.0

  • Initial public release.
  • Multi-product management with support for unlimited campaigns per product.
  • Rich HTML campaign editor with full CSS and custom layout support.
  • Campaign scheduling with automatic expiration handling via WP-Cron.
  • Built-in analytics tracking for impressions, clicks, and dismissals.
  • Analytics dashboard with both product-level and campaign-level breakdowns.
  • Lightweight single-file PHP SDK for remote site integration, with auto-fetch, transient caching, and dismissal handling.
  • Privacy-first analytics — remote site URLs are MD5-hashed before storage; no personal data is collected.

额外信息

评级

尚未提交反馈。

Your review

查看全部评论

支持

有话要说吗？是否需要帮助？

查看支持论坛