<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
* Plugin Search Hints, aka Feature Suggestions.
* @package automattic/jetpack
// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
use Automattic\Jetpack\Constants;
use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
use Automattic\Jetpack\Redirect;
use Automattic\Jetpack\Tracking;
// Disable direct access and execution.
if ( ! defined( 'ABSPATH' ) ) {
Jetpack::is_connection_ready() &&
/** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
apply_filters( 'jetpack_show_promotions', true ) &&
// Disable feature hints when plugins cannot be installed.
! Constants::is_true( 'DISALLOW_FILE_MODS' ) &&
Jetpack_Plugin_Search::init();
// Register endpoints when WP REST API is initialized.
add_action( 'rest_api_init', array( 'Jetpack_Plugin_Search', 'register_endpoints' ) );
* Class that includes cards in the plugin search results when users enter terms that match some Jetpack feature.
* Card can be dismissed and includes a title, description, button to enable the feature and a link for more information.
class Jetpack_Plugin_Search {
public static $slug = 'jetpack-plugin-search';
* @return Jetpack_Plugin_Search
public static function init() {
$instance = new Jetpack_Plugin_Search();
* Jetpack_Plugin_Search constructor.
public function __construct() {
add_action( 'current_screen', array( $this, 'start' ) );
* Add actions and filters only if this is the plugin installation screen and it's the first page.
* @param object $screen WP SCreen object.
public function start( $screen ) {
if ( 'plugin-install' === $screen->base && ( ! isset( $_GET['paged'] ) || 1 === intval( $_GET['paged'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) );
add_filter( 'plugins_api_result', array( $this, 'inject_jetpack_module_suggestion' ), 10, 3 );
add_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
add_filter( 'plugin_install_action_links', array( $this, 'insert_module_related_links' ), 10, 2 );
* Modify URL used to fetch to plugin information so it pulls Jetpack plugin page.
* @param string $url URL to load in dialog pulling the plugin page from wporg.
* @return string The URL with 'jetpack' instead of 'jetpack-plugin-search'.
public function plugin_details( $url ) {
return false !== stripos( $url, 'tab=plugin-information&plugin=' . self::$slug )
? 'plugin-install.php?tab=plugin-information&plugin=jetpack&TB_iframe=true&width=600&height=550'
* Register REST API endpoints.
public static function register_endpoints() {
'methods' => WP_REST_Server::EDITABLE,
'callback' => __CLASS__ . '::dismiss',
'permission_callback' => __CLASS__ . '::can_request',
'validate_callback' => __CLASS__ . '::is_hint_id',
* A WordPress REST API permission callback method that accepts a request object and
* decides if the current user has enough privileges to act.
* @return bool does a current user have enough privileges.
public static function can_request() {
return current_user_can( 'jetpack_admin_page' );
* Validates that the ID of the hint to dismiss is a string.
* @param string|bool $value Value to check.
* @param WP_REST_Request $request The request sent to the WP REST API.
* @param string $param Name of the parameter passed to endpoint holding $value.
public static function is_hint_id( $value, $request, $param ) {
return in_array( $value, Jetpack::get_available_modules(), true )
/* translators: %s is the name of a parameter passed to an endpoint. */
: new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
* A WordPress REST API callback method that accepts a request object and decides what to do with it.
* @param WP_REST_Request $request {
* Array of parameters received by request.
* @type string $hint Slug of card to dismiss.
* @return bool|array|WP_Error a resulting value or object, or an error.
public static function dismiss( WP_REST_Request $request ) {
return self::add_to_dismissed_hints( $request['hint'] )
? rest_ensure_response( array( 'code' => 'success' ) )
: new WP_Error( 'not_dismissed', esc_html__( 'The card could not be dismissed', 'jetpack' ), array( 'status' => 400 ) );
* Returns a list of previously dismissed hints.
* @return array List of dismissed hints.
protected static function get_dismissed_hints() {
$dismissed_hints = Jetpack_Options::get_option( 'dismissed_hints' );
return isset( $dismissed_hints ) && is_array( $dismissed_hints )
* Save the hint in the list of dismissed hints.
* @param string $hint The hint id, which is a Jetpack module slug.
* @return bool Whether the card was added to the list and hence dismissed.
protected static function add_to_dismissed_hints( $hint ) {
return Jetpack_Options::update_option( 'dismissed_hints', array_merge( self::get_dismissed_hints(), array( $hint ) ) );
* Checks that the module slug passed should be displayed.
* A feature hint will be displayed if it has not been dismissed before or if 2 or fewer other hints have been dismissed.
* @param string $hint The hint id, which is a Jetpack module slug.
* @return bool True if $hint should be displayed.
protected function should_display_hint( $hint ) {
$dismissed_hints = static::get_dismissed_hints();
// If more than 2 hints have been dismissed, then show no more.
if ( 2 < count( $dismissed_hints ) ) {
$plan = Jetpack_Plan::get();
if ( isset( $plan['class'] ) && ( 'free' === $plan['class'] || 'personal' === $plan['class'] ) && 'vaultpress' === $hint ) {
return ! in_array( $hint, $dismissed_hints, true );
* Load the search scripts and CSS for PSH.
public function load_plugins_search_script() {
wp_enqueue_script( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION, true );
'nonce' => wp_create_nonce( 'wp_rest' ),
'base_rest_url' => rest_url( '/jetpack/v4' ),
'manageSettings' => esc_html__( 'Configure', 'jetpack' ),
'activateModule' => esc_html__( 'Activate Module', 'jetpack' ),
'getStarted' => esc_html__( 'Get started', 'jetpack' ),
'activated' => esc_html__( 'Activated', 'jetpack' ),
'activating' => esc_html__( 'Activating', 'jetpack' ),
'logo' => 'https://ps.w.org/jetpack/assets/icon.svg?rev=1791404',
'This suggestion was made by Jetpack, the security and performance plugin already installed on your site.',
'supportText' => esc_html__(
'Learn more about these suggestions.',
'supportLink' => Redirect::get_url( 'plugin-hint-learn-support' ),
'hideText' => esc_html__( 'Hide this suggestion', 'jetpack' ),
wp_enqueue_style( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
* Get the plugin repo's data for Jetpack to populate the fields with.
* @return array|mixed|object|WP_Error
public static function get_jetpack_plugin_data() {
$data = get_transient( 'jetpack_plugin_data' );
if ( false === $data || is_wp_error( $data ) ) {
include_once ABSPATH . 'wp-admin/includes/plugin-install.php';
'active_installs' => true,
set_transient( 'jetpack_plugin_data', $data, DAY_IN_SECONDS );
* Create a list with additional features for those we don't have a module, like Akismet.
* @return array List of features.
public function get_extra_features() {
'search_terms' => 'akismet, anti-spam, antispam, comments, spam, spam protection, form spam, captcha, no captcha, nocaptcha, recaptcha, phising, google',
'short_description' => esc_html__( 'Keep your visitors and search engines happy by stopping comment and contact form spam with Akismet.', 'jetpack' ),
'requires_connection' => true,
'learn_more_button' => Redirect::get_url( 'plugin-hint-upgrade-akismet' ),
'configure_url' => admin_url( 'admin.php?page=akismet-key-config' ),
'sharing-block' => array(
'name' => esc_html__( 'Sharing buttons block', 'jetpack' ),
'search_terms' => 'share, sharing, sharing block, sharing button, social buttons, buttons, share facebook, share twitter, social share, icons, email, facebook, twitter, x, linkedin, pinterest, pocket, social media',
'short_description' => esc_html__( 'Add sharing buttons blocks anywhere on your website to help your visitors share your content.', 'jetpack' ),
'requires_connection' => false,
'module' => 'sharing-block',
'learn_more_button' => Redirect::get_url( 'jetpack-support-sharing-block' ),
'configure_url' => admin_url( 'site-editor.php?path=%2Fwp_template' ),
* Intercept the plugins API response and add in an appropriate card for Jetpack
* @param object $result Plugin search results.
* @param string $action unused.
* @param object $args Search args.
public function inject_jetpack_module_suggestion( $result, $action, $args ) {
* Bail if something else hooks into the Plugins' API response
* and does not return results.
if ( empty( $result->plugins ) || is_wp_error( $result ) ) {
// Looks like a search query; it's matching time.
if ( ! empty( $args->search ) ) {
$searchable_modules = array(
* Let's handle the Sharing feature differently.
* If we're using a block-based theme, we should suggest the sharing block.
* If using a classic theme, we should suggest the old sharing module.
if ( wp_is_block_theme() ) {
$searchable_modules[] = 'sharing-block';
$searchable_modules[] = 'sharedaddy';
require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
$tracking = new Tracking();
$jetpack_modules_list = array_intersect_key(
array_merge( $this->get_extra_features(), Jetpack_Admin::init()->get_modules() ),
array_flip( $searchable_modules )
uasort( $jetpack_modules_list, array( $this, 'by_sorting_option' ) );
// Record event when user searches for a term over 3 chars (less than 3 is not very useful).
if ( strlen( $args->search ) >= 3 ) {
$tracking->record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
// Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'.
$normalized_term = $this->sanitize_search_term( $args->search );
// Try to match a passed search term with module's search terms.
foreach ( $jetpack_modules_list as $module_slug => $module_opts ) {
* Does the site's current plan support the feature?
* We don't use Jetpack_Plan::supports() here because
* that check always returns Akismet as supported,
* since Akismet has a free version.
$current_plan = Jetpack_Plan::get();
$is_supported_by_plan = in_array( $module_slug, $current_plan['supports'], true );
false !== stripos( $module_opts['search_terms'] . ', ' . $module_opts['name'], $normalized_term )
$matching_module = $module_slug;
if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) {
// Record event when a matching feature is found.
$tracking->record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );
$inject = (array) self::get_jetpack_plugin_data();
$image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE );
'plugin-search' => true, // Helps to determine if that an injected card.
'name' => sprintf( // Supplement name/description so that they clearly indicate this was added.
/* translators: Jetpack module name */
esc_html_x( 'Jetpack: %s', 'Jetpack: Module Name', 'jetpack' ),
$jetpack_modules_list[ $matching_module ]['name']
'short_description' => $jetpack_modules_list[ $matching_module ]['short_description'],
'author' => esc_attr__( 'Jetpack (installed)', 'jetpack' ),
'requires_connection' => (bool) $jetpack_modules_list[ $matching_module ]['requires_connection'],
'version' => JETPACK__VERSION,
'1x' => "$image_url-128.png",
'2x' => "$image_url-256.png",
'svg' => "$image_url.svg",
// Splice in the base module data.
$inject = array_merge( $inject, $jetpack_modules_list[ $matching_module ], $overrides );
// Add it to the top of the list.
$result->plugins = array_filter( $result->plugins, array( $this, 'filter_cards' ) );
array_unshift( $result->plugins, $inject );
* Remove cards for Jetpack plugins since we don't want duplicates.
* @since 7.2.0 Only remove Jetpack.
* @since 7.4.0 Simplify for WordPress 5.1+.
* @param array|object $plugin WordPress search result card.
public function filter_cards( $plugin ) {
* $plugin is normally an array.
* However, since the response data can be filtered,
* we cannot fully trust its format.
* Let's handle both arrays and objects, and bail if it's neither.
if ( is_array( $plugin ) && ! empty( $plugin['slug'] ) ) {
} elseif ( is_object( $plugin ) && ! empty( $plugin->slug ) ) {
return ! in_array( $slug, array( 'jetpack' ), true );
* Take a raw search query and return something a bit more standardized and
* @param string $term The raw search term.
* @return string A simplified/sanitized version.
private function sanitize_search_term( $term ) {
$term = strtolower( urldecode( $term ) );
// remove non-alpha/space chars.
$term = preg_replace( '/[^a-z ]/', '', $term );
// remove strings that don't help matches.
$term = trim( str_replace( array( 'jetpack', 'jp', 'free', 'wordpress' ), '', $term ) );
* Callback function to sort the array of modules by the sort option.
* @param array $m1 Array 1 to sort.
* @param array $m2 Array 2 to sort.
private function by_sorting_option( $m1, $m2 ) {
return $m1['sort'] <=> $m2['sort'];
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
