PluginProbe ʕ •ᴥ•ʔ
Jetpack – WP Security, Backup, Speed, & Growth / 12.5.2
Jetpack – WP Security, Backup, Speed, & Growth v12.5.2
12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 14.4.2 14.5.1 14.6.1 14.7.1 14.8.1 14.9.2 15.0.3 15.1.2 15.2.1 15.3.2 15.4.1 15.5.1 15.6.1 15.7.2 15.8.1 15.9.2 16.0.2 16.1.3 16.2-a.5 16.2-a.3 16.1.2 16.2-a.1 16.1.1 16.1 16.1-beta 16.1-beta.2 16.1-beta.3 16.1-a.5 16.1-a.3 16.0.1 16.1-a.1 16.0 16.0-beta 16.0-a.7 16.0-a.5 15.9.1 16.0-a.3 16.0-a.1 15.9 15.9-beta 15.9-a.7 15.9-a.5 15.9-a.3 15.9-a.1 15.8 15.8-beta 15.8-a.7 15.8-a.5 5.2.5 5.3.4 5.4.4 5.5.5 5.6.5 5.7.5 5.8.4 5.9.4 6.0.4 6.1 6.1.1 6.1.2 6.1.3 6.1.4 6.1.5 6.2 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.3 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 6.3.7 6.4 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.5 6.5.1 6.5.2 6.5.3 6.5.4 6.6 6.6.1 6.6.2 6.6.3 6.6.4 6.6.5 6.7 6.7.1 6.7.2 6.7.3 6.7.4 6.8 6.8.1 6.8.2 6.8.3 6.8.4 6.8.5 6.9 6.9.1 6.9.2 6.9.3 6.9.4 7.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.1 7.1.1 7.1.2 7.1.3 7.1.4 7.1.5 7.2 7.2.1 7.2.1.1 7.2.2 7.2.3 7.2.4 7.2.5 7.3 7.3.0.1 7.3.1 7.3.1.1 7.3.2 7.3.3 7.3.4 7.3.5 7.4 7.4.1 7.4.2 7.4.3 7.4.4 7.4.5 7.5 7.5.0.1 7.5.1 7.5.2 7.5.3 7.5.4 7.5.5 7.5.6 7.5.7 7.6 7.6.1 7.6.2 7.6.3 7.6.4 7.7 7.7.1 7.7.2 7.7.3 7.7.4 7.7.5 7.7.6 7.8 7.8.1 7.8.2 7.8.3 7.8.4 7.9 7.9.1 7.9.2 7.9.3 7.9.4 8.0 8.0.1 8.0.2 8.0.3 8.1 8.1.1 8.1.2 8.1.3 8.1.4 8.2 8.2.0.1 8.2.1 8.2.2 8.2.3 8.2.4 8.2.5 8.2.6 8.3 8.3.1 8.3.2 8.3.3 8.4 8.4.1 8.4.2 8.4.3 8.4.4 8.4.5 8.5 8.5.1 8.5.2 8.5.3 8.6 8.6.1 8.6.2 8.6.3 8.6.4 8.7 8.7.0.1 8.7.1 8.7.2 8.7.3 8.7.4 8.8 8.8.1 8.8.2 8.8.3 8.8.4 8.8.5 8.9 8.9.1 8.9.2 8.9.3 8.9.4 9.0 9.0.1 9.0.2 9.0.3 9.0.4 9.0.5 9.1 9.1.1 9.1.2 9.1.3 9.2 9.2.1 9.2.2 9.2.3 9.2.4 9.3 9.3.1 9.3.2 9.3.3 9.3.4 9.3.5 9.4 9.4.1 9.4.2 9.4.3 9.4.4 9.5 9.5.1 9.5.2 9.5.3 9.5.4 9.5.5 9.6 9.6.1 9.6.2 9.6.3 9.6.4 9.7 9.7.1 9.7.2 15.7-beta.2 9.7.3 15.7.1 9.8 15.8-a.1 9.8.1 15.8-a.3 9.8.2 2.0.9 9.8.3 2.1.7 9.9 2.2.10 9.9.1 2.3.10 9.9.2 2.4.7 9.9.3 2.5.5 2.6.6 2.7.5 2.8.5 2.9.6 3.0.6 3.1.5 3.2.5 3.3.6 3.4.6 3.5.6 3.6.4 3.7.5 3.8.5 3.9.10 4.0.7 4.1.4 4.2.5 4.3.5 4.4.5 4.5.3 4.6.3 4.7.4 4.8.5 4.9.3 5.0.3 5.1.4 trunk 10.0 10.0.1 10.0.2 10.1 10.1.1 10.1.2 10.2 10.2.1 10.2.2 10.2.3 10.3 10.3.1 10.3.2 10.4 10.4.1 10.4.2 10.5 10.5.1 10.5.2 10.5.3 10.6 10.6.1 10.6.2 10.7 10.7.1 10.7.2 10.8 10.8.1 10.8.2 10.9 10.9.1 10.9.2 10.9.3 11.0 11.0.1 11.0.2 11.1 11.1.1 11.1.2 11.1.3 11.1.4 11.2 11.2.1 11.2.2 11.3 11.3.1 11.3.2 11.3.3 11.3.4 11.4 11.4.1 11.4.2 11.5 11.5.1 11.5.2 11.5.3 11.6 11.6.1 11.6.2 11.7 11.7.1 11.7.2 11.7.3 11.8 11.8.3 11.8.4 11.8.5 11.8.6 11.9 11.9.1 11.9.2 11.9.3 12.0 12.0.1 12.0.2 12.1 12.1.1 12.1.2 12.2 12.2.1 12.2.2 12.3 12.3.1 12.4 12.4.1 12.5 12.5.1 12.6 12.6.1 12.6.2 12.6.3 12.7 12.7.1 12.7.2 12.8 12.8.1 12.8.2 12.9 12.9.1 12.9.2 12.9.3 12.9.4 13.0 13.0.1 13.1 13.1.1 13.1.2 13.1.3 13.1.4 13.2 13.2.1 13.2.2 13.2.3 13.3 13.3.1 13.3.2 13.4 13.4.1 13.4.2 13.4.3 13.4.4 13.5 13.5.1 13.6 13.6.1 13.7 13.7.1 13.8 13.8.1 13.8.2 13.9 13.9.1 14.0 14.1 14.2 14.2.1 14.3 14.4 14.4.1 14.5 14.6 14.7 14.8 14.9 14.9.1 15.0 15.0.1 15.0.2 15.1 15.1.1 15.2 15.3 15.3.1 15.4 15.5 15.6 15.7 15.7-a.1 15.7-a.3 15.7-a.5 15.7-a.7 15.7-beta
jetpack / modules / plugin-search.php
jetpack / modules Last commit date
calypsoify 3 years ago carousel 3 years ago cloudflare-analytics 4 years ago comment-likes 5 years ago comments 3 years ago contact-form 1 year ago custom-css 3 years ago custom-post-types 3 years ago geo-location 4 years ago google-analytics 3 years ago gravatar 6 years ago infinite-scroll 3 years ago likes 3 years ago markdown 3 years ago masterbar 3 years ago memberships 3 years ago photon-cdn 3 years ago plugin-search 4 years ago post-by-email 3 years ago related-posts 3 years ago scan 3 years ago seo-tools 3 years ago sharedaddy 3 years ago shortcodes 3 years ago simple-payments 3 years ago site-icon 4 years ago sitemaps 3 years ago sso 3 years ago stats 3 years ago subscriptions 3 years ago theme-tools 3 years ago tiled-gallery 3 years ago verification-tools 4 years ago videopress 3 years ago widget-visibility 3 years ago widgets 3 years ago woocommerce-analytics 3 years ago wordads 3 years ago wpcom-block-editor 3 years ago wpcom-tos 5 years ago action-bar.php 3 years ago blaze.php 3 years ago carousel.php 4 years ago comment-likes.php 3 years ago comments.php 4 years ago contact-form.php 3 years ago copy-post.php 3 years ago custom-content-types.php 4 years ago custom-css.php 3 years ago enhanced-distribution.php 4 years ago geo-location.php 4 years ago google-analytics.php 4 years ago google-fonts.php 3 years ago gravatar-hovercards.php 3 years ago infinite-scroll.php 3 years ago json-api.php 5 years ago latex.php 4 years ago lazy-images.php 4 years ago likes.php 3 years ago markdown.php 4 years ago masterbar.php 4 years ago module-extras.php 4 years ago module-headings.php 3 years ago module-info.php 3 years ago monitor.php 4 years ago notes.php 3 years ago photon-cdn.php 3 years ago photon.php 3 years ago plugin-search.php 3 years ago post-by-email.php 5 years ago post-list.php 4 years ago protect.php 3 years ago publicize.php 3 years ago related-posts.php 4 years ago search.php 4 years ago seo-tools.php 4 years ago sharedaddy.php 4 years ago shortcodes.php 3 years ago shortlinks.php 4 years ago sitemaps.php 4 years ago sso.php 3 years ago stats.php 3 years ago subscriptions.php 3 years ago theme-tools.php 3 years ago tiled-gallery.php 4 years ago vaultpress.php 4 years ago verification-tools.php 5 years ago videopress.php 4 years ago waf.php 3 years ago widget-visibility.php 4 years ago widgets.php 3 years ago woocommerce-analytics.php 5 years ago wordads.php 5 years ago wpgroho.js 6 years ago
plugin-search.php
625 lines
1 <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2 /**
3 * Adds the PSH functionality to Jetpack.
4 *
5 * @package automattic/jetpack
6 */
7
8 // phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
9
10 use Automattic\Jetpack\Constants;
11 use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
12 use Automattic\Jetpack\Redirect;
13 use Automattic\Jetpack\Tracking;
14
15 /**
16 * Disable direct access and execution.
17 */
18 if ( ! defined( 'ABSPATH' ) ) {
19 exit;
20 }
21
22 if (
23 is_admin() &&
24 Jetpack::is_connection_ready() &&
25 /** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
26 apply_filters( 'jetpack_show_promotions', true ) &&
27 // Disable feature hints when plugins cannot be installed.
28 ! Constants::is_true( 'DISALLOW_FILE_MODS' ) &&
29 jetpack_is_psh_active()
30 ) {
31 Jetpack_Plugin_Search::init();
32 }
33
34 // Register endpoints when WP REST API is initialized.
35 add_action( 'rest_api_init', array( 'Jetpack_Plugin_Search', 'register_endpoints' ) );
36
37 /**
38 * Class that includes cards in the plugin search results when users enter terms that match some Jetpack feature.
39 * Card can be dismissed and includes a title, description, button to enable the feature and a link for more information.
40 *
41 * @since 7.1.0
42 */
43 class Jetpack_Plugin_Search {
44
45 /**
46 * PSH slug name.
47 *
48 * @var string
49 */
50 public static $slug = 'jetpack-plugin-search';
51
52 /**
53 * Singleton constructor.
54 *
55 * @return Jetpack_Plugin_Search
56 */
57 public static function init() {
58 static $instance = null;
59
60 if ( ! $instance ) {
61 $instance = new Jetpack_Plugin_Search();
62 }
63
64 return $instance;
65 }
66
67 /**
68 * Jetpack_Plugin_Search constructor.
69 */
70 public function __construct() {
71 add_action( 'current_screen', array( $this, 'start' ) );
72 }
73
74 /**
75 * Add actions and filters only if this is the plugin installation screen and it's the first page.
76 *
77 * @param object $screen WP SCreen object.
78 *
79 * @since 7.1.0
80 */
81 public function start( $screen ) {
82 if ( 'plugin-install' === $screen->base && ( ! isset( $_GET['paged'] ) || 1 === intval( $_GET['paged'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
83 add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) );
84 add_filter( 'plugins_api_result', array( $this, 'inject_jetpack_module_suggestion' ), 10, 3 );
85 add_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
86 add_filter( 'plugin_install_action_links', array( $this, 'insert_module_related_links' ), 10, 2 );
87 }
88 }
89
90 /**
91 * Modify URL used to fetch to plugin information so it pulls Jetpack plugin page.
92 *
93 * @param string $url URL to load in dialog pulling the plugin page from wporg.
94 *
95 * @since 7.1.0
96 *
97 * @return string The URL with 'jetpack' instead of 'jetpack-plugin-search'.
98 */
99 public function plugin_details( $url ) {
100 return false !== stripos( $url, 'tab=plugin-information&amp;plugin=' . self::$slug )
101 ? 'plugin-install.php?tab=plugin-information&amp;plugin=jetpack&amp;TB_iframe=true&amp;width=600&amp;height=550'
102 : $url;
103 }
104
105 /**
106 * Register REST API endpoints.
107 *
108 * @since 7.1.0
109 */
110 public static function register_endpoints() {
111 register_rest_route(
112 'jetpack/v4',
113 '/hints',
114 array(
115 'methods' => WP_REST_Server::EDITABLE,
116 'callback' => __CLASS__ . '::dismiss',
117 'permission_callback' => __CLASS__ . '::can_request',
118 'args' => array(
119 'hint' => array(
120 'default' => '',
121 'type' => 'string',
122 'required' => true,
123 'validate_callback' => __CLASS__ . '::is_hint_id',
124 ),
125 ),
126 )
127 );
128 }
129
130 /**
131 * A WordPress REST API permission callback method that accepts a request object and
132 * decides if the current user has enough privileges to act.
133 *
134 * @since 7.1.0
135 *
136 * @return bool does a current user have enough privileges.
137 */
138 public static function can_request() {
139 return current_user_can( 'jetpack_admin_page' );
140 }
141
142 /**
143 * Validates that the ID of the hint to dismiss is a string.
144 *
145 * @since 7.1.0
146 *
147 * @param string|bool $value Value to check.
148 * @param WP_REST_Request $request The request sent to the WP REST API.
149 * @param string $param Name of the parameter passed to endpoint holding $value.
150 *
151 * @return bool|WP_Error
152 */
153 public static function is_hint_id( $value, $request, $param ) {
154 return in_array( $value, Jetpack::get_available_modules(), true )
155 ? true
156 /* translators: %s is the name of a parameter passed to an endpoint. */
157 : new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
158 }
159
160 /**
161 * A WordPress REST API callback method that accepts a request object and decides what to do with it.
162 *
163 * @param WP_REST_Request $request {
164 * Array of parameters received by request.
165 *
166 * @type string $hint Slug of card to dismiss.
167 * }
168 *
169 * @since 7.1.0
170 *
171 * @return bool|array|WP_Error a resulting value or object, or an error.
172 */
173 public static function dismiss( WP_REST_Request $request ) {
174 return self::add_to_dismissed_hints( $request['hint'] )
175 ? rest_ensure_response( array( 'code' => 'success' ) )
176 : new WP_Error( 'not_dismissed', esc_html__( 'The card could not be dismissed', 'jetpack' ), array( 'status' => 400 ) );
177 }
178
179 /**
180 * Returns a list of previously dismissed hints.
181 *
182 * @since 7.1.0
183 *
184 * @return array List of dismissed hints.
185 */
186 protected static function get_dismissed_hints() {
187 $dismissed_hints = Jetpack_Options::get_option( 'dismissed_hints' );
188 return isset( $dismissed_hints ) && is_array( $dismissed_hints )
189 ? $dismissed_hints
190 : array();
191 }
192
193 /**
194 * Save the hint in the list of dismissed hints.
195 *
196 * @since 7.1.0
197 *
198 * @param string $hint The hint id, which is a Jetpack module slug.
199 *
200 * @return bool Whether the card was added to the list and hence dismissed.
201 */
202 protected static function add_to_dismissed_hints( $hint ) {
203 return Jetpack_Options::update_option( 'dismissed_hints', array_merge( self::get_dismissed_hints(), array( $hint ) ) );
204 }
205
206 /**
207 * Checks that the module slug passed should be displayed.
208 *
209 * A feature hint will be displayed if it has not been dismissed before or if 2 or fewer other hints have been dismissed.
210 *
211 * @since 7.2.1
212 *
213 * @param string $hint The hint id, which is a Jetpack module slug.
214 *
215 * @return bool True if $hint should be displayed.
216 */
217 protected function should_display_hint( $hint ) {
218 $dismissed_hints = static::get_dismissed_hints();
219 // If more than 2 hints have been dismissed, then show no more.
220 if ( 2 < count( $dismissed_hints ) ) {
221 return false;
222 }
223
224 $plan = Jetpack_Plan::get();
225 if ( isset( $plan['class'] ) && ( 'free' === $plan['class'] || 'personal' === $plan['class'] ) && 'vaultpress' === $hint ) {
226 return false;
227 }
228
229 return ! in_array( $hint, $dismissed_hints, true );
230 }
231
232 /**
233 * Load the search scripts and CSS for PSH.
234 */
235 public function load_plugins_search_script() {
236 wp_enqueue_script( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION, true );
237 wp_localize_script(
238 self::$slug,
239 'jetpackPluginSearch',
240 array(
241 'nonce' => wp_create_nonce( 'wp_rest' ),
242 'base_rest_url' => rest_url( '/jetpack/v4' ),
243 'poweredBy' => esc_html__( 'by Jetpack (installed)', 'jetpack' ),
244 'manageSettings' => esc_html__( 'Configure', 'jetpack' ),
245 'activateModule' => esc_html__( 'Activate Module', 'jetpack' ),
246 'getStarted' => esc_html__( 'Get started', 'jetpack' ),
247 'activated' => esc_html__( 'Activated', 'jetpack' ),
248 'activating' => esc_html__( 'Activating', 'jetpack' ),
249 'logo' => 'https://ps.w.org/jetpack/assets/icon.svg?rev=1791404',
250 'legend' => esc_html__(
251 'This suggestion was made by Jetpack, the security and performance plugin already installed on your site.',
252 'jetpack'
253 ),
254 'supportText' => esc_html__(
255 'Learn more about these suggestions.',
256 'jetpack'
257 ),
258 'supportLink' => Redirect::get_url( 'plugin-hint-learn-support' ),
259 'hideText' => esc_html__( 'Hide this suggestion', 'jetpack' ),
260 )
261 );
262
263 wp_enqueue_style( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
264 }
265
266 /**
267 * Get the plugin repo's data for Jetpack to populate the fields with.
268 *
269 * @return array|mixed|object|WP_Error
270 */
271 public static function get_jetpack_plugin_data() {
272 $data = get_transient( 'jetpack_plugin_data' );
273
274 if ( false === $data || is_wp_error( $data ) ) {
275 include_once ABSPATH . 'wp-admin/includes/plugin-install.php';
276 $data = plugins_api(
277 'plugin_information',
278 array(
279 'slug' => 'jetpack',
280 'is_ssl' => is_ssl(),
281 'fields' => array(
282 'banners' => true,
283 'reviews' => true,
284 'active_installs' => true,
285 'versions' => false,
286 'sections' => false,
287 ),
288 )
289 );
290 set_transient( 'jetpack_plugin_data', $data, DAY_IN_SECONDS );
291 }
292
293 return $data;
294 }
295
296 /**
297 * Create a list with additional features for those we don't have a module, like Akismet.
298 *
299 * @since 7.1.0
300 *
301 * @return array List of features.
302 */
303 public function get_extra_features() {
304 return array(
305 'akismet' => array(
306 'name' => 'Akismet',
307 'search_terms' => 'akismet, anti-spam, antispam, comments, spam, spam protection, form spam, captcha, no captcha, nocaptcha, recaptcha, phising, google',
308 'short_description' => esc_html__( 'Keep your visitors and search engines happy by stopping comment and contact form spam with Akismet.', 'jetpack' ),
309 'requires_connection' => true,
310 'module' => 'akismet',
311 'sort' => '16',
312 'learn_more_button' => Redirect::get_url( 'plugin-hint-upgrade-akismet' ),
313 'configure_url' => admin_url( 'admin.php?page=akismet-key-config' ),
314 ),
315 );
316 }
317
318 /**
319 * Intercept the plugins API response and add in an appropriate card for Jetpack
320 *
321 * @param object $result Plugin search results.
322 * @param string $action unused.
323 * @param object $args Search args.
324 */
325 public function inject_jetpack_module_suggestion( $result, $action, $args ) {
326 /*
327 * Bail if something else hooks into the Plugins' API response
328 * and does not return results.
329 */
330 if ( empty( $result->plugins ) || is_wp_error( $result ) ) {
331 return $result;
332 }
333
334 // Looks like a search query; it's matching time.
335 if ( ! empty( $args->search ) ) {
336 require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
337 $tracking = new Tracking();
338 $jetpack_modules_list = array_intersect_key(
339 array_merge( $this->get_extra_features(), Jetpack_Admin::init()->get_modules() ),
340 array_flip(
341 array(
342 'contact-form',
343 'lazy-images',
344 'monitor',
345 'photon',
346 'photon-cdn',
347 'protect',
348 'publicize',
349 'related-posts',
350 'sharedaddy',
351 'akismet',
352 'vaultpress',
353 'videopress',
354 'search',
355 )
356 )
357 );
358 uasort( $jetpack_modules_list, array( $this, 'by_sorting_option' ) );
359
360 // Record event when user searches for a term over 3 chars (less than 3 is not very useful).
361 if ( strlen( $args->search ) >= 3 ) {
362 $tracking->record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
363 }
364
365 // Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'.
366 $normalized_term = $this->sanitize_search_term( $args->search );
367
368 $matching_module = null;
369
370 // Try to match a passed search term with module's search terms.
371 foreach ( $jetpack_modules_list as $module_slug => $module_opts ) {
372 /*
373 * Does the site's current plan support the feature?
374 * We don't use Jetpack_Plan::supports() here because
375 * that check always returns Akismet as supported,
376 * since Akismet has a free version.
377 */
378 $current_plan = Jetpack_Plan::get();
379 $is_supported_by_plan = in_array( $module_slug, $current_plan['supports'], true );
380
381 if (
382 false !== stripos( $module_opts['search_terms'] . ', ' . $module_opts['name'], $normalized_term )
383 && $is_supported_by_plan
384 ) {
385 $matching_module = $module_slug;
386 break;
387 }
388 }
389
390 if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) {
391 // Record event when a matching feature is found.
392 $tracking->record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );
393
394 $inject = (array) self::get_jetpack_plugin_data();
395 $image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE );
396 $overrides = array(
397 'plugin-search' => true, // Helps to determine if that an injected card.
398 'name' => sprintf( // Supplement name/description so that they clearly indicate this was added.
399 /* translators: Jetpack module name */
400 esc_html_x( 'Jetpack: %s', 'Jetpack: Module Name', 'jetpack' ),
401 $jetpack_modules_list[ $matching_module ]['name']
402 ),
403 'short_description' => $jetpack_modules_list[ $matching_module ]['short_description'],
404 'requires_connection' => (bool) $jetpack_modules_list[ $matching_module ]['requires_connection'],
405 'slug' => self::$slug,
406 'version' => JETPACK__VERSION,
407 'icons' => array(
408 '1x' => "$image_url-128.png",
409 '2x' => "$image_url-256.png",
410 'svg' => "$image_url.svg",
411 ),
412 );
413
414 // Splice in the base module data.
415 $inject = array_merge( $inject, $jetpack_modules_list[ $matching_module ], $overrides );
416
417 // Add it to the top of the list.
418 $result->plugins = array_filter( $result->plugins, array( $this, 'filter_cards' ) );
419 array_unshift( $result->plugins, $inject );
420 }
421 }
422 return $result;
423 }
424
425 /**
426 * Remove cards for Jetpack plugins since we don't want duplicates.
427 *
428 * @since 7.1.0
429 * @since 7.2.0 Only remove Jetpack.
430 * @since 7.4.0 Simplify for WordPress 5.1+.
431 *
432 * @param array|object $plugin WordPress search result card.
433 *
434 * @return bool
435 */
436 public function filter_cards( $plugin ) {
437 /*
438 * $plugin is normally an array.
439 * However, since the response data can be filtered,
440 * we cannot fully trust its format.
441 * Let's handle both arrays and objects, and bail if it's neither.
442 */
443 if ( is_array( $plugin ) && ! empty( $plugin['slug'] ) ) {
444 $slug = $plugin['slug'];
445 } elseif ( is_object( $plugin ) && ! empty( $plugin->slug ) ) {
446 $slug = $plugin->slug;
447 } else {
448 return false;
449 }
450
451 return ! in_array( $slug, array( 'jetpack' ), true );
452 }
453
454 /**
455 * Take a raw search query and return something a bit more standardized and
456 * easy to work with.
457 *
458 * @param string $term The raw search term.
459 * @return string A simplified/sanitized version.
460 */
461 private function sanitize_search_term( $term ) {
462 $term = strtolower( urldecode( $term ) );
463
464 // remove non-alpha/space chars.
465 $term = preg_replace( '/[^a-z ]/', '', $term );
466
467 // remove strings that don't help matches.
468 $term = trim( str_replace( array( 'jetpack', 'jp', 'free', 'wordpress' ), '', $term ) );
469
470 return $term;
471 }
472
473 /**
474 * Callback function to sort the array of modules by the sort option.
475 *
476 * @param array $m1 Array 1 to sort.
477 * @param array $m2 Array 2 to sort.
478 */
479 private function by_sorting_option( $m1, $m2 ) {
480 return $m1['sort'] - $m2['sort'];
481 }
482
483 /**
484 * Modify the URL to the feature settings, for example Publicize.
485 * Sharing is included here because while we still have a page in WP Admin,
486 * we prefer to send users to Calypso.
487 *
488 * @param string $feature Feature.
489 * @param string $configure_url URL to configure feature.
490 *
491 * @return string
492 * @since 7.1.0
493 */
494 private function get_configure_url( $feature, $configure_url ) {
495 switch ( $feature ) {
496 case 'sharing':
497 case 'publicize':
498 $configure_url = Redirect::get_url( 'calypso-marketing-connections' );
499 break;
500 case 'seo-tools':
501 $configure_url = Redirect::get_url(
502 'calypso-marketing-traffic',
503 array(
504 'anchor' => 'seo',
505 )
506 );
507 break;
508 case 'google-analytics':
509 $configure_url = Redirect::get_url(
510 'calypso-marketing-traffic',
511 array(
512 'anchor' => 'analytics',
513 )
514 );
515 break;
516 case 'wordads':
517 $configure_url = Redirect::get_url( 'wpcom-ads-settings' );
518 break;
519 }
520 return $configure_url;
521 }
522
523 /**
524 * Put some more appropriate links on our custom result cards.
525 *
526 * @param array $links Related links.
527 * @param array $plugin Plugin result information.
528 */
529 public function insert_module_related_links( $links, $plugin ) {
530 if ( self::$slug !== $plugin['slug'] ) {
531 return $links;
532 }
533
534 // By the time this filter is applied, self_admin_url was already applied and we don't need it anymore.
535 remove_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
536
537 $links = array();
538
539 if ( 'akismet' === $plugin['module'] || 'vaultpress' === $plugin['module'] ) {
540 $links['jp_get_started'] = '<a
541 id="plugin-select-settings"
542 class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
543 href="' . esc_url( Redirect::get_url( 'plugin-hint-learn-' . $plugin['module'] ) ) . '"
544 data-module="' . esc_attr( $plugin['module'] ) . '"
545 data-track="get_started"
546 >' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
547 // Jetpack installed, active, feature not enabled; prompt to enable.
548 } elseif (
549 current_user_can( 'jetpack_activate_modules' ) &&
550 ! Jetpack::is_module_active( $plugin['module'] ) &&
551 Jetpack_Plan::supports( $plugin['module'] )
552 ) {
553 $links[] = '<button
554 id="plugin-select-activate"
555 class="jetpack-plugin-search__primary button"
556 data-module="' . esc_attr( $plugin['module'] ) . '"
557 data-configure-url="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
558 > ' . esc_html__( 'Enable', 'jetpack' ) . '</button>';
559
560 // Jetpack installed, active, feature enabled; link to settings.
561 } elseif (
562 ! empty( $plugin['configure_url'] ) &&
563 current_user_can( 'jetpack_configure_modules' ) &&
564 Jetpack::is_module_active( $plugin['module'] ) &&
565 /** This filter is documented in class.jetpack-admin.php */
566 apply_filters( 'jetpack_module_configurable_' . $plugin['module'], false )
567 ) {
568 $links[] = '<a
569 id="plugin-select-settings"
570 class="jetpack-plugin-search__primary button jetpack-plugin-search__configure"
571 href="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
572 data-module="' . esc_attr( $plugin['module'] ) . '"
573 data-track="configure"
574 >' . esc_html__( 'Configure', 'jetpack' ) . '</a>';
575 // Module is active, doesn't have options to configure.
576 } elseif ( Jetpack::is_module_active( $plugin['module'] ) ) {
577 $links['jp_get_started'] = '<a
578 id="plugin-select-settings"
579 class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
580 href="' . esc_url( Redirect::get_url( 'plugin-hint-learn-' . $plugin['module'] ) ) . '"
581 data-module="' . esc_attr( $plugin['module'] ) . '"
582 data-track="get_started"
583 >' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
584 }
585
586 // Add link pointing to a relevant doc page in jetpack.com only if the Get started button isn't displayed.
587 if ( ! empty( $plugin['learn_more_button'] ) && ! isset( $links['jp_get_started'] ) ) {
588 $links[] = '<a
589 class="jetpack-plugin-search__learn-more"
590 href="' . esc_url( $plugin['learn_more_button'] ) . '"
591 target="_blank"
592 data-module="' . esc_attr( $plugin['module'] ) . '"
593 data-track="learn_more"
594 >' . esc_html__( 'Learn more', 'jetpack' ) . '</a>';
595 }
596
597 // Dismiss link.
598 $links[] = '<a
599 class="jetpack-plugin-search__dismiss"
600 data-module="' . esc_attr( $plugin['module'] ) . '"
601 >' . esc_html__( 'Hide this suggestion', 'jetpack' ) . '</a>';
602
603 return $links;
604 }
605
606 }
607
608 /**
609 * Master control that checks if Plugin search hints is active.
610 *
611 * @since 7.1.1
612 *
613 * @return bool True if PSH is active.
614 */
615 function jetpack_is_psh_active() {
616 /**
617 * Disables the Plugin Search Hints feature found when searching the plugins page.
618 *
619 * @since 8.7.0
620 *
621 * @param bool Set false to disable the feature.
622 */
623 return apply_filters( 'jetpack_psh_active', true );
624 }
625