Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
93.65%
59 / 63
66.67%
6 / 9
 CRAP
0.00%
0 / 1
Initializer
93.65%
59 / 63
66.67%
6 / 9
 24.15
0.00%
0 / 1
 init
93.55%
29 / 31
0.00%
0 / 1
 8.02
 is_available
83.33%
5 / 6
0.00%
0 / 1
 3.04
 is_seo_surface_visible
100.00%
1 / 1
100.00%
1 / 1
 1
 is_optin_available
100.00%
1 / 1
100.00%
1 / 1
 1
 is_gated
100.00%
2 / 2
100.00%
1 / 1
 2
 get_upsell_url
100.00%
17 / 17
100.00%
1 / 1
 5
 is_seo_tools_module_active
66.67%
2 / 3
0.00%
0 / 1
 2.15
 flag_sitemap_user_disabled
100.00%
1 / 1
100.00%
1 / 1
 1
 clear_sitemap_user_disabled
100.00%
1 / 1
100.00%
1 / 1
 1
1<?php
2/**
3 * Jetpack SEO — the visibility command center for WordPress sites.
4 *
5 * Gates the surface behind its feature flag and cohort, then wires the admin
6 * page ({@see Admin_Page}), the dashboard's REST reads ({@see Dashboard_Data}),
7 * the content-coverage cache invalidation ({@see Content_Coverage}), and the
8 * opt-in surface ({@see Surface_Visibility}).
9 *
10 * @package automattic/jetpack-seo-package
11 */
12
13namespace Automattic\Jetpack\SEO;
14
15use Automattic\Jetpack\Current_Plan;
16use Automattic\Jetpack\Modules;
17use Automattic\Jetpack\Status;
18use Automattic\Jetpack\Status\Host;
19
20/**
21 * Boots the package and carries its cross-plugin contract: the feature flag,
22 * the script-data key, and the option names / visibility reads other plugins consume.
23 */
24class Initializer {
25
26    /**
27     * Jetpack SEO package version.
28     *
29     * @var string
30     */
31    const PACKAGE_VERSION = '0.10.3';
32
33    /**
34     * WordPress.com site feature that enables the Jetpack SEO surface.
35     *
36     * Kept separate from `advanced-seo`, which gates the paid parts of the
37     * dashboard after this product-level availability check has passed.
38     *
39     * @var string
40     */
41    const FEATURE_SLUG = 'seo-admin-ui';
42
43    /**
44     * Filter name that can enable the entire Jetpack SEO surface.
45     *
46     * The surface is available when this filter returns true or the current site's
47     * active features include {@see self::FEATURE_SLUG}. When neither is enabled,
48     * the package registers no admin menu or assets and changes nothing about the
49     * existing Jetpack UI.
50     *
51     * @var string
52     */
53    const FEATURE_FILTER = 'rsm_jetpack_seo';
54
55    /**
56     * Key under `window.JetpackScriptData` the React app reads its state from
57     * (`window.JetpackScriptData.seo`). Must match the JS-side reader in
58     * `_inc/data/get-overview.ts`.
59     */
60    const SCRIPT_DATA_KEY = 'seo';
61
62    /**
63     * Option recording that the user has deliberately turned the site's sitemap OFF,
64     * so WordPress core's own sitemap should be suppressed too ("off" means no sitemap
65     * at all, not a fallback to `/wp-sitemap.xml`).
66     *
67     * Set when the sitemaps module is switched off and cleared when it's switched on
68     * (see {@see self::flag_sitemap_user_disabled()} / {@see self::clear_sitemap_user_disabled()}),
69     * so it captures a deliberate off — a *transition* — rather than the ambient
70     * off-state. A site that simply never enabled the sitemap never fires the toggle,
71     * so the flag stays absent and its existing (e.g. WordPress-native) sitemap is left
72     * untouched.
73     *
74     * @var string
75     */
76    const SUPPRESS_WP_SITEMAP_OPTION = 'jetpack_seo_suppress_wp_sitemap';
77
78    /**
79     * Option recording whether the Jetpack SEO surface is discoverable on this site.
80     *
81     * Gates whether the SEO admin menu registers on self-hosted sites. Seeded once by the
82     * Jetpack plugin on install/upgrade: fresh installs default to visible, existing
83     * installs default to hidden and opt in via the legacy Traffic page or My Jetpack.
84     * WordPress.com (Simple + Atomic) bypasses this option entirely and is always visible.
85     * Absent until seeded, in which case self-hosted defaults to hidden (the non-disruptive
86     * default). See {@see Surface_Visibility::is_visible()}.
87     *
88     * Replaces `jetpack_seo_surface_visible`, which was seeded before the self-hosted rollout and
89     * marked every install since as fresh; a new key makes every site re-seed once on upgrade.
90     *
91     * @var string
92     */
93    const VISIBILITY_OPTION = 'jetpack_seo_surface_visible_v2';
94
95    /**
96     * Whether the package has been initialized.
97     *
98     * @var bool
99     */
100    private static $initialized = false;
101
102    /**
103     * Initialize the package.
104     *
105     * Called from the Jetpack plugin's `late_initialization()` hook.
106     *
107     * @return void
108     */
109    public static function init() {
110        if ( self::$initialized ) {
111            return;
112        }
113        self::$initialized = true;
114
115        // Gate the entire SEO surface behind its legacy filter or per-site feature.
116        if ( ! self::is_available() ) {
117            return;
118        }
119
120        // Before anything can read the AI crawler choices.
121        Ai_Crawlers::register_legacy_migration();
122
123        // The opt-in endpoint must be reachable even before the surface is visible, so
124        // existing self-hosted installs can switch to the new experience from the legacy
125        // Traffic page or My Jetpack (JETPACK-1700). Registered ahead of the cohort gate.
126        add_action( 'rest_api_init', array( Surface_Visibility::class, 'register_optin_route' ) );
127
128        // Expose opt-in availability to other admin surfaces (the legacy Traffic-page
129        // banner reads it via `@automattic/jetpack-script-data`). Hooked here — after the
130        // feature flag, before the cohort gate — so a still-hidden install gets the signal.
131        add_filter( 'jetpack_admin_js_script_data', array( Surface_Visibility::class, 'inject_optin_availability' ) );
132
133        // Sitemap output is a front-end concern tied to the SEO feature itself, not to
134        // whether the admin dashboard is visible — so register it here, ahead of the
135        // cohort gate. This keeps the deliberate-off behavior consistent in the two
136        // edges the surface gate would otherwise break: a site that turns the sitemap
137        // off while the dashboard is still hidden (an existing self-hosted install that
138        // hasn't opted in), and a flag set while the dashboard was visible that must
139        // stay honored if the dashboard is later hidden.
140        //
141        // Maintain the deliberate-off flag as the sitemap is toggled: these fire only on
142        // a genuine module toggle (not wpcomsh's private-site suppression, which is a
143        // filter, not a deactivation), and are registered before the toggle's REST write.
144        add_action( 'jetpack_deactivate_module_sitemaps', array( __CLASS__, 'flag_sitemap_user_disabled' ) );
145        add_action( 'jetpack_activate_module_sitemaps', array( __CLASS__, 'clear_sitemap_user_disabled' ) );
146
147        // When the user has deliberately turned the sitemap off, suppress WordPress
148        // core's own sitemap too — otherwise "off" silently falls back to core's
149        // `/wp-sitemap.xml` (and its `/sitemap.xml` → `/wp-sitemap.xml` redirect). Keyed
150        // on the deliberate-off flag, NOT the ambient off-state, so a site that never
151        // enabled the sitemap keeps whatever sitemap it already had. Runs on
152        // `plugins_loaded`, before core registers its sitemap server on `init`, so the
153        // filter is in place; with core sitemaps disabled, `/sitemap.xml` and
154        // `/wp-sitemap.xml` both return a proper 404. (When the sitemap is ON, the
155        // Jetpack sitemaps module already disables core's duplicate.)
156        if ( get_option( self::SUPPRESS_WP_SITEMAP_OPTION, false ) ) {
157            add_filter( 'wp_sitemaps_enabled', '__return_false' );
158        }
159
160        // Discoverability cohort gate: the SEO surface is auto-discoverable for fresh
161        // installs and all WordPress.com sites; existing self-hosted installs opt in via
162        // the legacy Traffic page or My Jetpack (JETPACK-1700). Until it's visible we
163        // register nothing else here and let those opt-in surfaces drive discovery.
164        if ( ! self::is_seo_surface_visible() ) {
165            return;
166        }
167
168        // Each SEO module's configure URL defaults to Jetpack › Settings filtered to the
169        // module. Once the surface is visible that view only points here, so link here.
170        foreach ( array( 'seo-tools', 'verification-tools', 'sitemaps' ) as $module ) {
171            add_filter( 'jetpack_module_configuration_url_' . $module, array( Admin_Page::class, 'get_url' ) );
172        }
173
174        // The page registers whenever the surface is visible, even with `seo-tools` off, so
175        // a saved link still offers "Enable SEO tools"; the menu item hides with the module.
176        //
177        // Priority 1: load the wp-build bundle (and define its render function)
178        // before `add_menu_item()` runs at the default priority and needs it.
179        add_action( 'admin_menu', array( Admin_Page::class, 'maybe_load_wp_build' ), 1 );
180        add_action( 'admin_menu', array( Admin_Page::class, 'add_menu_item' ), 10 );
181
182        // Read-only REST routes the dashboard hydrates its initial state from. Preloaded
183        // into the page (see Admin_Page::inject_script_data) so a normal load resolves
184        // them with no request, and fetched by the app when that preload is missing or
185        // stale — so the dashboard recovers its data instead of dead-ending. Registered
186        // whenever the surface is visible (independent of the seo-tools module, like the
187        // Overview).
188        add_action( 'rest_api_init', array( Dashboard_Data::class, 'register_rest_reads' ) );
189
190        // Keep the Overview's cached content-coverage counts honest. Hooked here rather than
191        // alongside the admin surface above because posts are written from everywhere — the
192        // block editor (REST), the classic editor, wp-cli, cron, other plugins — and the
193        // cache has to be dropped wherever that happens, not just where it's read.
194        Content_Coverage::register_invalidation();
195
196        // The settings surface only comes online once SEO tools are active — there's
197        // nothing to configure while the module is off, so we don't register its REST
198        // endpoints until then. Everything the dashboard saves is exposed to WordPress
199        // core's `/wp/v2/settings` endpoint, which exists on every platform the package
200        // runs on and capability-gates writes itself; module activation, the one thing
201        // `register_setting()` can't express, has its own package-owned route.
202        if ( self::is_seo_tools_module_active() ) {
203            // Front-end JSON-LD schema output and author profile schema fields.
204            // Intentionally NOT gated: every site keeps emitting its structured data —
205            // a plan-gated site loses the schema *settings* card (a paid control), but
206            // stripping the schema its pages already carry would hurt SEO it has today.
207            // (Finer per-type gating — e.g. sitewide LocalBusiness to paid plans on
208            // self-hosted — is a separate follow-up, tracked in the schema project.)
209            Schema_Builder::init();
210            Author_Schema_Node::init();
211
212            // Paid front-end output. A plan-gated WordPress.com site has these controls
213            // hidden from its dashboard, so it must not keep emitting their output either —
214            // otherwise it would still serve /llms.txt, AI-crawler robots.txt directives and
215            // Simple's archive canonical tags it doesn't qualify for. Self-hosted is never gated.
216            if ( ! self::is_gated() ) {
217                Canonical_Urls::init();
218                // The /llms.txt handler. Self-hooks a front-end action, so it no-ops off
219                // the front end and stays behind the same gates as the schema above.
220                Llms_Txt::init();
221                // robots.txt directives for blocked AI crawlers. Self-hooks the
222                // `robots_txt` filter, so it stays inert off the front end.
223                Ai_Crawlers::init();
224            }
225
226            // On `rest_api_init` rather than here: which option the front page description
227            // is stored in depends on `jetpack_disable_seo_tools`, which a conflicting SEO
228            // plugin can add from anywhere up to the end of `init`. Priority 5 is after all
229            // of those and before core builds the settings route at 99.
230            add_action( 'rest_api_init', array( Dashboard_Data::class, 'register_rest_settings' ), 5 );
231            // Package-owned route for the three settings whose write switches a Jetpack module.
232            add_action( 'rest_api_init', array( Dashboard_Data::class, 'register_module_routes' ) );
233            // Package-owned route for the site-level Schema settings (see the controller).
234            add_action( 'rest_api_init', array( Schema_Settings_Controller::class, 'register_routes' ) );
235        }
236
237        /**
238         * Fires after the Jetpack SEO package is initialized.
239         *
240         * @since 0.1.0
241         */
242        do_action( 'jetpack_seo_init' );
243    }
244
245    /**
246     * Whether the Jetpack SEO product is available on this site.
247     *
248     * Keep the existing filter as an override while allowing WordPress.com to
249     * enable the product for individual sites through its feature registry.
250     *
251     * @return bool
252     */
253    public static function is_available() {
254        if ( (bool) apply_filters( self::FEATURE_FILTER, false ) ) {
255            return true;
256        }
257
258        // Only active features are needed for this check.
259        $features = ( new Host() )->is_wpcom_simple()
260            ? Current_Plan::get_simple_site_specific_features( false )
261            : Current_Plan::get()['features'];
262
263        return in_array( self::FEATURE_SLUG, $features['active'] ?? array(), true );
264    }
265
266    /**
267     * Whether the Jetpack SEO surface should be discoverable (admin menu registered).
268     *
269     * @return bool
270     */
271    public static function is_seo_surface_visible() {
272        return Surface_Visibility::is_visible();
273    }
274
275    /**
276     * Whether to offer an existing install the chance to opt into the new SEO experience.
277     *
278     * @return bool
279     */
280    public static function is_optin_available() {
281        return Surface_Visibility::is_optin_available();
282    }
283
284    /**
285     * Whether the SEO dashboard is plan-gated for this site.
286     *
287     * Gating applies only on WordPress.com (Simple + Atomic): `advanced-seo` is in the
288     * FREE plan's supports list, so `Current_Plan::supports( 'advanced-seo' )` returns
289     * true on self-hosted (never gated) and hijacks to `wpcom_site_has_feature()` on
290     * WordPress.com, where it's false below the Premium plan. Mirrors the AI SEO
291     * Enhancer's plan check in {@see Dashboard_Data::get_geo_data()}.
292     *
293     * Public because {@see Admin_Page::inject_script_data()} reads it to build the
294     * dashboard's gating payload, and {@see self::init()} uses it to decide whether the
295     * paid front-end output registers at all.
296     *
297     * @return bool
298     */
299    public static function is_gated() {
300        return ( new Host() )->is_wpcom_platform()
301            && ! Current_Plan::supports( 'advanced-seo' );
302    }
303
304    /**
305     * Return the Premium checkout URL, or an empty string when upgrades are unavailable.
306     *
307     * @return string
308     */
309    public static function get_upsell_url() {
310        $host = new Host();
311        if ( $host->is_p2_site() ) {
312            return '';
313        }
314
315        $plan       = $host->is_wpcom_simple() && class_exists( '\WPCOM_Store_API' )
316            ? \WPCOM_Store_API::get_current_plan( get_current_blog_id() )
317            : Current_Plan::get();
318        $term       = substr( $plan['product_slug'] ?? '', -3 );
319        $product    = in_array( $term, array( '-2y', '-3y' ), true ) ? 'value_bundle' . $term : 'value_bundle';
320        $site_slug  = ( new Status() )->get_site_suffix();
321        $return_url = rawurlencode( Admin_Page::get_url() );
322
323        return add_query_arg(
324            array(
325                'redirect_to'     => $return_url,
326                'checkoutBackUrl' => $return_url,
327            ),
328            sprintf( 'https://wordpress.com/checkout/%s/%s', $site_slug, $product )
329        );
330    }
331
332    /**
333     * Whether the `seo-tools` Jetpack module is currently active.
334     *
335     * @return bool
336     */
337    private static function is_seo_tools_module_active() {
338        if ( ! class_exists( 'Automattic\\Jetpack\\Modules' ) ) {
339            return false;
340        }
341        return ( new Modules() )->is_active( 'seo-tools' );
342    }
343
344    /**
345     * Record that the user has turned the sitemap off, so WordPress core's own sitemap
346     * is suppressed too. Hooked to the sitemaps module's deactivation, which fires only
347     * on a real toggle from a surface (the SEO Settings tab, the legacy Traffic page, or
348     * WP-CLI) — not wpcomsh's private-site suppression, which is a filter on the
349     * active-modules read rather than a deactivation.
350     *
351     * @return void
352     */
353    public static function flag_sitemap_user_disabled() {
354        update_option( self::SUPPRESS_WP_SITEMAP_OPTION, true );
355    }
356
357    /**
358     * Clear the deliberate-off flag when the sitemap is turned back on — the Jetpack
359     * sitemaps module then serves `/sitemap.xml` and suppresses core's duplicate itself.
360     *
361     * @return void
362     */
363    public static function clear_sitemap_user_disabled() {
364        delete_option( self::SUPPRESS_WP_SITEMAP_OPTION );
365    }
366}