README

This package provides some of the newsletter functionality for Jetpack, including:

Settings page — A wp-admin settings screen for newsletter configuration (Jetpack > Newsletter).
URL helper — Centralized logic for generating the correct newsletter settings URL based on site type and configuration.
Reader link — An admin bar link to the WordPress.com Reader.
Daily Writing Prompt widget — A wp-admin dashboard widget that surfaces blogging prompts and Freshly Pressed posts.

Other functionality remains in the subscriptions module of Jetpack itself.

Initialization

Settings, Reader_Link, and Writing_Prompt_Widget use singleton-style initialization. Call their init() methods early (e.g., on plugins_loaded):

use Automattic\Jetpack\Newsletter\Settings;
use Automattic\Jetpack\Newsletter\Reader_Link;
use Automattic\Jetpack\Newsletter\Writing_Prompt_Widget;

Settings::init();
Reader_Link::init();
Writing_Prompt_Widget::init();

Settings page

Registers a Jetpack > Newsletter submenu page in wp-admin with a React-based settings UI.

Filters

`jetpack_show_newsletter_menu_item`

Controls visibility of the Jetpack > Newsletter menu item. Defaults to true. Set to false to hide the menu item while keeping the page accessible via direct URL.

add_filter( 'jetpack_show_newsletter_menu_item', '__return_false' );

Reading page notice

When the subscriptions module is active, a notice is added to the wp-admin Settings → Reading page next to the "For each post in a feed" option. It clarifies that the RSS excerpt setting does not control newsletter emails and links to the Newsletter settings page.

URL helper

Urls::get_newsletter_settings_url() returns the wp-admin newsletter settings URL.

Reader link

`activate_on_connection()`

Reader_Link::activate_on_connection() auto-activates the wpcom-reader module when a site is first connected to WordPress.com. It skips activation if modules were previously initialized (e.g., the user disconnected and reconnected), respecting prior module choices.

Daily Writing Prompt widget

Writing_Prompt_Widget::init() registers a Daily Writing Prompt dashboard widget for users who can manage_options. The widget renders a hydration container and enqueues the writing-prompt build assets, which mount a React app that fetches the latest blogging prompts from /wpcom/v3/blogging-prompts and lets the user jump into answering one.

Freshly Pressed

When WordPress.com is featuring posts, the widget grows a second tab listing ten of them, each linking to the post in the WordPress.com Reader.

Freshly_Pressed::get_posts() reads them from whichever source the site can reach:

Simple sites query the wpcom database directly through the FreshlyPressed plugin. No HTTP request is involved.
Everywhere else (Atomic and self-hosted Jetpack) fetches https://public-api.wordpress.com/rest/v1.1/freshly-pressed.

Either way the result is cached in a transient for an hour, and for five minutes when the source failed, then reaches the React app through the jetpack_admin_js_script_data filter. The tab is left out entirely when the list is empty, so the widget stays single-view rather than offering an empty tab.

Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

License

Jetpack Newsletter is licensed under GNU General Public License v2 (or later)

automattic / jetpack-newsletter

Package info

Security

Statistics

README

Initialization

Settings page

Filters

`jetpack_show_newsletter_menu_item`

Reading page notice

URL helper

Reader link

`activate_on_connection()`

Daily Writing Prompt widget

Freshly Pressed

Using this package in your WordPress plugin

Security

License