Search by

automattic / jetpack-my-jetpack

kraftjehervedereksmartautomattic

WP Admin page with information and configuration shared among all Jetpack stand-alone plugins

Package info

github.com/Automattic/jetpack-my-jetpack

Type:jetpack-library

pkg:composer/automattic/jetpack-my-jetpack

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 45 479

Dependents: 8

Suggesters: 0

Stars: 2

v6.12.0 2026-10-20 16:05 UTC

Requires

Requires (Dev)

Suggests

Provides

None

Conflicts

None

Replaces

None

GPL-2.0-or-later 57265140221d4d754cc12aff1cea70dc6ea60fac

Published on Packagist.org on 2026-10-20 16:05 UTC

This package is auto-updated.

Last update: 2026-10-22 07:48:56 UTC

README

WP Admin page with information and configuration shared among all Jetpack stand-alone plugins

Overview

My Jetpack is a centralized WordPress admin page that provides a unified interface for managing all Jetpack products and services. It serves as the main dashboard where users can view, install, configure, and manage their Jetpack products.

Usage

Every Jetpack plugin must include the My Jetpack package.

Require this package and initialize it:

add_action( 'init', function() {
 Automattic\Jetpack\My_Jetpack\Initializer::init();
} );

Conditionally loading licensing UI behind a feature flag

To disable the licensing UI at /wp-admin/admin.php?page=my-jetpack#/add-license, add a filter on jetpack_my_jetpack_should_enable_add_license_screen and return false: add_filter( 'jetpack_my_jetpack_should_enable_add_license_screen', '__return_false' ); My Jetpack applies this filter automatically when initializing the offline Features entry described below.

Managing features

Where Features opens (sites registered with WordPress.com, and offline sites with the offline entry enabled), My Jetpack Features shows all eligible features by default, including unavailable modules and their reasons. Unavailable modules have no switch or bulk selection. Choose Available to exclude unavailable features, forced-off modules, and installed plugins forced inactive. Search spans all eligible features, and choosing a filter clears the search. Feature filters, search, layout, and an open feature remain in the URL across reloads.

When a standalone plugin provides an alternative, its card retains the install or activation action and explains the Jetpack module's limitation. Plan and connection restrictions retain applicable upgrade routes. Backup, Firewall, and Ads remain unavailable on multisite. Features hidden by the host stay hidden; forced and network-activated features retain their existing controls, with host reasons only in the details window of main cards; forced modules the site cannot run are listed as unavailable with their reasons.

Enable the default-off my-jetpack-account-connect flag with add_filter( 'jetpack_feature_flag_enabled_my-jetpack-account-connect', '__return_true' ); to connect the WordPress.com account from the features that need one. This applies on a site registered with WordPress.com without a connected owner, for an administrator whose own account is not connected either, while the connection reports no errors. Those features, such as Activity Log, Newsletter, Social and Backup, show Needs user account on the card and in its details, whether or not their plugin or Jetpack is installed, unless the host forces them off or multisite blocks them. A missing Social or Backup plugin, or a missing or inactive Jetpack, keeps Install or Activate, which turns the plugin on and then starts the account connection. An installed plugin or a module offers Connect instead of its switch, whether it is on or off: Connect starts the connection and changes nothing else, and the switch returns once the account is connected. A feature already on keeps Deactivate in its details. Available and bulk actions leave these features out, and the connection returns to the same Features view without its status filter. With the flag on, Available also leaves out features whose only action is an install the current user cannot make. A blocked install does not exclude a product that already runs without its plugin.

Enable the default-off my-jetpack-modules-to-features flag with add_filter( 'jetpack_feature_flag_enabled_my-jetpack-modules-to-features', '__return_true' ); to send eligible legacy Modules links to Features through browser navigation, carrying saved searches and recognized module tags. Search and tag together narrow the results; Clear tag removes only the tag. These views include a Classic Modules list link that preserves the current search and tag and remains available if feature data fails to load. Purpose-group and active/inactive filters, unknown tags, and tags or saved searches matching only hidden features stay on Modules. Links reach Features only when My Jetpack detects Jetpack as installed and active, including Jetpack Beta with both jetpack/ and jetpack-dev/ installed and only Beta active. Features and Modules links prefer an active copy when several declared copies are installed; with none active, they keep the first installed copy. Must-use installations without an active plugin file retain Modules and their existing module controls. Sites or users without Features access, sites where My Jetpack would redirect to setup or a partner coupon screen, offline sites (even with the offline entry enabled), and disabled REST access retain Modules with the search and tag arguments preserved. Without JavaScript, legacy links and repointed management links also reach Modules; the server-printed fallback and its REST probe run only while the Modules-to-Features flag is enabled. The pinned footer and its Reset action remain available. Hosts that do not show My Jetpack can keep all management links on Modules with add_filter( 'jetpack_my_jetpack_modules_management_available', '__return_false' );.

Offline Mode

The offline Features entry is off by default. Register add_filter( 'jetpack_my_jetpack_offline_features', '__return_true' ); before My Jetpack initializes, for example in a must-use plugin, and visit /wp-admin/admin.php?page=my-jetpack#/features on a site in offline mode. My Jetpack opens Features without connection onboarding; other hash routes redirect there while preserving the query string.

Users need permission to edit posts and activate plugins, plus manage the network on multisite. The Jetpack plugin keeps its Modules and Settings entry for users who cannot access Features. Local modules can be switched and retain their state after reload. The Features controller refuses to activate modules that require a connection; standalone plugins can still be activated and may run their own activation steps, including Social enabling its module.

The offline page skips product, ownership, notification, and history queries. It does not prevent requests elsewhere in shared Jetpack code: the Search plan lookup with copied credentials and connected-user script data on a cold cache can still contact WordPress.com.

Architecture

Core Components

PHP Backend (src/)

  • Initializer (class-initializer.php): Main entry point that sets up admin menu, REST endpoints, and asset enqueuing
  • Products (class-products.php): Core product management system with status constants and lifecycle handling
  • Product Classes (src/products/): Individual product implementations inheriting from base Product class
  • REST API (class-rest-*.php): API endpoints for product management, purchases, and AI functionality

React Frontend (_inc/)

  • Main App (app.jsx): React Router setup, rendered by the wp-build route in routes/dashboard/
  • Onboarding (onboarding.jsx): Webpack entry for the full-screen onboarding takeover
  • Components (components/): Reusable UI components for product cards, screens, and interstitials
  • Data Layer (data/): Custom hooks and API integration using React Query (see Data Layer Documentation)
  • Context (context/): Global state management for notices and values

Product System

  • Products inherit from base Product class with standardized interface
  • Status constants define product lifecycle: active, inactive, needs_plan, plugin_absent, etc.
  • Hybrid products can function as both standalone plugins and Jetpack modules
  • Product cards dynamically display status, actions, and pricing information

Key Features

  • Connection Management: Handles WordPress.com site and user connections
  • Product Interstitials: Purchase/activation flows for each product
  • Onboarding Flow: Guided setup for new users
  • Licensing: License key management and validation
  • Activity Log: Integration with Jetpack activity monitoring
  • Speed Score: Boost performance metrics integration

Frontend Architecture

  • React 18 with functional components and hooks
  • React Router for client-side navigation
  • CSS Modules for component styling
  • TypeScript for type safety
  • Custom data hooks using React Query for API state management

Build System

  • Webpack with Jetpack-specific configuration
  • Babel for JavaScript transpilation
  • Sass for CSS preprocessing
  • Asset optimization for production builds
  • Textdomain replacement for internationalization

Development

Commands

Build Commands:

  • jetpack build packages/my-jetpack - Build from monorepo root
  • jetpack watch packages/my-jetpack - Watch mode from monorepo root
  • pnpm run build - Build from package directory
  • pnpm run test - Run tests from package directory

Testing Strategy

Testing:

  • PHP: PHPUnit with WordPress test environment and polyfills
  • JavaScript: Jest with React Testing Library
  • E2E: Integration with monorepo Playwright setup

Development Notes

Code Standards:

  • Uses WordPress coding standards and Jetpack extensions
  • Requires WordPress.com connection for full functionality
  • Integrates with Jetpack licensing and purchase systems
  • Supports feature flags for gradual rollouts
  • Compatible with WordPress multisite (when enabled)

API Endpoints

REST API Patterns

  • Base namespace: jetpack/v4/my-jetpack
  • Products endpoint: /products - main product data and actions
  • Purchases endpoint: /purchases - user purchase information
  • Feature endpoints: Various feature-specific endpoints

Data Flow

  1. React components call API via apiFetch
  2. WordPress routes to appropriate REST controller
  3. Controller validates permissions and processes request
  4. Product classes handle business logic
  5. Response returned to frontend for UI updates

Key Files Reference

PHP Files

  • src/class-initializer.php - Main initialization, admin menu setup
  • src/class-products.php - Core product management, status constants
  • src/products/class-product.php - Base product class
  • src/class-rest-products.php - Main products API endpoint
  • src/class-wpcom-products.php - WordPress.com product integration

React Files

  • _inc/app.jsx - Main React application, rendered by routes/dashboard/stage.tsx
  • _inc/onboarding.jsx - Onboarding takeover entry point
  • _inc/providers.tsx - Context providers wrapper
  • _inc/constants.ts - Route definitions and constants
  • _inc/components/my-jetpack-screen/ - Main dashboard screen
  • _inc/components/product-interstitial/ - Product setup flows
  • _inc/data/ - API hooks and data management using React Query

Configuration Files

  • package.json - Dependencies and scripts
  • webpack.config.js - Build configuration
  • babel.config.js - JavaScript transpilation
  • tsconfig.json - TypeScript configuration

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

my-jetpack is licensed under GNU General Public License v2 (or later)