| 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 |
// Disable direct access and execution. |
| 16 |
if ( ! defined( 'ABSPATH' ) ) { |
| 17 |
exit; |
| 18 |
} |
| 19 |
|
| 20 |
if ( |
| 21 |
is_admin() && |
| 22 |
Jetpack::is_connection_ready() && |
| 23 |
/** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */ |
| 24 |
apply_filters( 'jetpack_show_promotions', true ) && |
| 25 |
// Disable feature hints when plugins cannot be installed. |
| 26 |
! Constants::is_true( 'DISALLOW_FILE_MODS' ) && |
| 27 |
jetpack_is_psh_active() |
| 28 |
) { |
| 29 |
Jetpack_Plugin_Search::init(); |
| 30 |
} |
| 31 |
|
| 32 |
// Register endpoints when WP REST API is initialized. |
| 33 |
add_action( 'rest_api_init', array( 'Jetpack_Plugin_Search', 'register_endpoints' ) ); |
| 34 |
|
| 35 |
/** |
| 36 |
* Class that includes cards in the plugin search results when users enter terms that match some Jetpack feature. |
| 37 |
* Card can be dismissed and includes a title, description, button to enable the feature and a link for more information. |
| 38 |
* |
| 39 |
* @since 7.1.0 |
| 40 |
*/ |
| 41 |
class Jetpack_Plugin_Search { |
| 42 |
|
| 43 |
/** |
| 44 |
* PSH slug name. |
| 45 |
* |
| 46 |
* @var string |
| 47 |
*/ |
| 48 |
public static $slug = 'jetpack-plugin-search'; |
| 49 |
|
| 50 |
/** |
| 51 |
* Singleton constructor. |
| 52 |
* |
| 53 |
* @return Jetpack_Plugin_Search |
| 54 |
*/ |
| 55 |
public static function init() { |
| 56 |
static $instance = null; |
| 57 |
|
| 58 |
if ( ! $instance ) { |
| 59 |
$instance = new Jetpack_Plugin_Search(); |
| 60 |
} |
| 61 |
|
| 62 |
return $instance; |
| 63 |
} |
| 64 |
|
| 65 |
/** |
| 66 |
* Jetpack_Plugin_Search constructor. |
| 67 |
*/ |
| 68 |
public function __construct() { |
| 69 |
add_action( 'current_screen', array( $this, 'start' ) ); |
| 70 |
} |
| 71 |
|
| 72 |
/** |
| 73 |
* Add actions and filters only if this is the plugin installation screen and it's the first page. |
| 74 |
* |
| 75 |
* @param object $screen WP SCreen object. |
| 76 |
* |
| 77 |
* @since 7.1.0 |
| 78 |
*/ |
| 79 |
public function start( $screen ) { |
| 80 |
if ( 'plugin-install' === $screen->base && ( ! isset( $_GET['paged'] ) || 1 === intval( $_GET['paged'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 81 |
add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) ); |
| 82 |
add_filter( 'plugins_api_result', array( $this, 'inject_jetpack_module_suggestion' ), 10, 3 ); |
| 83 |
add_filter( 'self_admin_url', array( $this, 'plugin_details' ) ); |
| 84 |
add_filter( 'plugin_install_action_links', array( $this, 'insert_module_related_links' ), 10, 2 ); |
| 85 |
} |
| 86 |
} |
| 87 |
|
| 88 |
/** |
| 89 |
* Modify URL used to fetch to plugin information so it pulls Jetpack plugin page. |
| 90 |
* |
| 91 |
* @param string $url URL to load in dialog pulling the plugin page from wporg. |
| 92 |
* |
| 93 |
* @since 7.1.0 |
| 94 |
* |
| 95 |
* @return string The URL with 'jetpack' instead of 'jetpack-plugin-search'. |
| 96 |
*/ |
| 97 |
public function plugin_details( $url ) { |
| 98 |
return false !== stripos( $url, 'tab=plugin-information&plugin=' . self::$slug ) |
| 99 |
? 'plugin-install.php?tab=plugin-information&plugin=jetpack&TB_iframe=true&width=600&height=550' |
| 100 |
: $url; |
| 101 |
} |
| 102 |
|
| 103 |
/** |
| 104 |
* Register REST API endpoints. |
| 105 |
* |
| 106 |
* @since 7.1.0 |
| 107 |
*/ |
| 108 |
public static function register_endpoints() { |
| 109 |
register_rest_route( |
| 110 |
'jetpack/v4', |
| 111 |
'/hints', |
| 112 |
array( |
| 113 |
'methods' => WP_REST_Server::EDITABLE, |
| 114 |
'callback' => __CLASS__ . '::dismiss', |
| 115 |
'permission_callback' => __CLASS__ . '::can_request', |
| 116 |
'args' => array( |
| 117 |
'hint' => array( |
| 118 |
'default' => '', |
| 119 |
'type' => 'string', |
| 120 |
'required' => true, |
| 121 |
'validate_callback' => __CLASS__ . '::is_hint_id', |
| 122 |
), |
| 123 |
), |
| 124 |
) |
| 125 |
); |
| 126 |
} |
| 127 |
|
| 128 |
/** |
| 129 |
* A WordPress REST API permission callback method that accepts a request object and |
| 130 |
* decides if the current user has enough privileges to act. |
| 131 |
* |
| 132 |
* @since 7.1.0 |
| 133 |
* |
| 134 |
* @return bool does a current user have enough privileges. |
| 135 |
*/ |
| 136 |
public static function can_request() { |
| 137 |
return current_user_can( 'jetpack_admin_page' ); |
| 138 |
} |
| 139 |
|
| 140 |
/** |
| 141 |
* Validates that the ID of the hint to dismiss is a string. |
| 142 |
* |
| 143 |
* @since 7.1.0 |
| 144 |
* |
| 145 |
* @param string|bool $value Value to check. |
| 146 |
* @param WP_REST_Request $request The request sent to the WP REST API. |
| 147 |
* @param string $param Name of the parameter passed to endpoint holding $value. |
| 148 |
* |
| 149 |
* @return bool|WP_Error |
| 150 |
*/ |
| 151 |
public static function is_hint_id( $value, $request, $param ) { |
| 152 |
return in_array( $value, Jetpack::get_available_modules(), true ) |
| 153 |
? true |
| 154 |
/* translators: %s is the name of a parameter passed to an endpoint. */ |
| 155 |
: new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) ); |
| 156 |
} |
| 157 |
|
| 158 |
/** |
| 159 |
* A WordPress REST API callback method that accepts a request object and decides what to do with it. |
| 160 |
* |
| 161 |
* @param WP_REST_Request $request { |
| 162 |
* Array of parameters received by request. |
| 163 |
* |
| 164 |
* @type string $hint Slug of card to dismiss. |
| 165 |
* } |
| 166 |
* |
| 167 |
* @since 7.1.0 |
| 168 |
* |
| 169 |
* @return bool|array|WP_Error a resulting value or object, or an error. |
| 170 |
*/ |
| 171 |
public static function dismiss( WP_REST_Request $request ) { |
| 172 |
return self::add_to_dismissed_hints( $request['hint'] ) |
| 173 |
? rest_ensure_response( array( 'code' => 'success' ) ) |
| 174 |
: new WP_Error( 'not_dismissed', esc_html__( 'The card could not be dismissed', 'jetpack' ), array( 'status' => 400 ) ); |
| 175 |
} |
| 176 |
|
| 177 |
/** |
| 178 |
* Returns a list of previously dismissed hints. |
| 179 |
* |
| 180 |
* @since 7.1.0 |
| 181 |
* |
| 182 |
* @return array List of dismissed hints. |
| 183 |
*/ |
| 184 |
protected static function get_dismissed_hints() { |
| 185 |
$dismissed_hints = Jetpack_Options::get_option( 'dismissed_hints' ); |
| 186 |
return isset( $dismissed_hints ) && is_array( $dismissed_hints ) |
| 187 |
? $dismissed_hints |
| 188 |
: array(); |
| 189 |
} |
| 190 |
|
| 191 |
/** |
| 192 |
* Save the hint in the list of dismissed hints. |
| 193 |
* |
| 194 |
* @since 7.1.0 |
| 195 |
* |
| 196 |
* @param string $hint The hint id, which is a Jetpack module slug. |
| 197 |
* |
| 198 |
* @return bool Whether the card was added to the list and hence dismissed. |
| 199 |
*/ |
| 200 |
protected static function add_to_dismissed_hints( $hint ) { |
| 201 |
return Jetpack_Options::update_option( 'dismissed_hints', array_merge( self::get_dismissed_hints(), array( $hint ) ) ); |
| 202 |
} |
| 203 |
|
| 204 |
/** |
| 205 |
* Checks that the module slug passed should be displayed. |
| 206 |
* |
| 207 |
* A feature hint will be displayed if it has not been dismissed before or if 2 or fewer other hints have been dismissed. |
| 208 |
* |
| 209 |
* @since 7.2.1 |
| 210 |
* |
| 211 |
* @param string $hint The hint id, which is a Jetpack module slug. |
| 212 |
* |
| 213 |
* @return bool True if $hint should be displayed. |
| 214 |
*/ |
| 215 |
protected function should_display_hint( $hint ) { |
| 216 |
$dismissed_hints = static::get_dismissed_hints(); |
| 217 |
// If more than 2 hints have been dismissed, then show no more. |
| 218 |
if ( 2 < count( $dismissed_hints ) ) { |
| 219 |
return false; |
| 220 |
} |
| 221 |
|
| 222 |
$plan = Jetpack_Plan::get(); |
| 223 |
if ( isset( $plan['class'] ) && ( 'free' === $plan['class'] || 'personal' === $plan['class'] ) && 'vaultpress' === $hint ) { |
| 224 |
return false; |
| 225 |
} |
| 226 |
|
| 227 |
return ! in_array( $hint, $dismissed_hints, true ); |
| 228 |
} |
| 229 |
|
| 230 |
/** |
| 231 |
* Load the search scripts and CSS for PSH. |
| 232 |
*/ |
| 233 |
public function load_plugins_search_script() { |
| 234 |
wp_enqueue_script( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION, true ); |
| 235 |
wp_localize_script( |
| 236 |
self::$slug, |
| 237 |
'jetpackPluginSearch', |
| 238 |
array( |
| 239 |
'nonce' => wp_create_nonce( 'wp_rest' ), |
| 240 |
'base_rest_url' => rest_url( '/jetpack/v4' ), |
| 241 |
'poweredBy' => esc_html__( 'by Jetpack (installed)', 'jetpack' ), |
| 242 |
'manageSettings' => esc_html__( 'Configure', 'jetpack' ), |
| 243 |
'activateModule' => esc_html__( 'Activate Module', 'jetpack' ), |
| 244 |
'getStarted' => esc_html__( 'Get started', 'jetpack' ), |
| 245 |
'activated' => esc_html__( 'Activated', 'jetpack' ), |
| 246 |
'activating' => esc_html__( 'Activating', 'jetpack' ), |
| 247 |
'logo' => 'https://ps.w.org/jetpack/assets/icon.svg?rev=1791404', |
| 248 |
'legend' => esc_html__( |
| 249 |
'This suggestion was made by Jetpack, the security and performance plugin already installed on your site.', |
| 250 |
'jetpack' |
| 251 |
), |
| 252 |
'supportText' => esc_html__( |
| 253 |
'Learn more about these suggestions.', |
| 254 |
'jetpack' |
| 255 |
), |
| 256 |
'supportLink' => Redirect::get_url( 'plugin-hint-learn-support' ), |
| 257 |
'hideText' => esc_html__( 'Hide this suggestion', 'jetpack' ), |
| 258 |
) |
| 259 |
); |
| 260 |
|
| 261 |
wp_enqueue_style( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION ); |
| 262 |
} |
| 263 |
|
| 264 |
/** |
| 265 |
* Get the plugin repo's data for Jetpack to populate the fields with. |
| 266 |
* |
| 267 |
* @return array|mixed|object|WP_Error |
| 268 |
*/ |
| 269 |
public static function get_jetpack_plugin_data() { |
| 270 |
$data = get_transient( 'jetpack_plugin_data' ); |
| 271 |
|
| 272 |
if ( false === $data || is_wp_error( $data ) ) { |
| 273 |
include_once ABSPATH . 'wp-admin/includes/plugin-install.php'; |
| 274 |
$data = plugins_api( |
| 275 |
'plugin_information', |
| 276 |
array( |
| 277 |
'slug' => 'jetpack', |
| 278 |
'is_ssl' => is_ssl(), |
| 279 |
'fields' => array( |
| 280 |
'banners' => true, |
| 281 |
'reviews' => true, |
| 282 |
'active_installs' => true, |
| 283 |
'versions' => false, |
| 284 |
'sections' => false, |
| 285 |
), |
| 286 |
) |
| 287 |
); |
| 288 |
set_transient( 'jetpack_plugin_data', $data, DAY_IN_SECONDS ); |
| 289 |
} |
| 290 |
|
| 291 |
return $data; |
| 292 |
} |
| 293 |
|
| 294 |
/** |
| 295 |
* Create a list with additional features for those we don't have a module, like Akismet. |
| 296 |
* |
| 297 |
* @since 7.1.0 |
| 298 |
* |
| 299 |
* @return array List of features. |
| 300 |
*/ |
| 301 |
public function get_extra_features() { |
| 302 |
return array( |
| 303 |
'akismet' => array( |
| 304 |
'name' => 'Akismet', |
| 305 |
'search_terms' => 'akismet, anti-spam, antispam, comments, spam, spam protection, form spam, captcha, no captcha, nocaptcha, recaptcha, phising, google', |
| 306 |
'short_description' => esc_html__( 'Keep your visitors and search engines happy by stopping comment and contact form spam with Akismet.', 'jetpack' ), |
| 307 |
'requires_connection' => true, |
| 308 |
'module' => 'akismet', |
| 309 |
'sort' => '16', |
| 310 |
'learn_more_button' => Redirect::get_url( 'plugin-hint-upgrade-akismet' ), |
| 311 |
'configure_url' => admin_url( 'admin.php?page=akismet-key-config' ), |
| 312 |
), |
| 313 |
'sharing-block' => array( |
| 314 |
'name' => esc_html__( 'Sharing buttons block', 'jetpack' ), |
| 315 |
'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', |
| 316 |
'short_description' => esc_html__( 'Add sharing buttons blocks anywhere on your website to help your visitors share your content.', 'jetpack' ), |
| 317 |
'requires_connection' => false, |
| 318 |
'module' => 'sharing-block', |
| 319 |
'sort' => '13', |
| 320 |
'learn_more_button' => Redirect::get_url( 'jetpack-support-sharing-block' ), |
| 321 |
'configure_url' => admin_url( 'site-editor.php?path=%2Fwp_template' ), |
| 322 |
), |
| 323 |
); |
| 324 |
} |
| 325 |
|
| 326 |
/** |
| 327 |
* Intercept the plugins API response and add in an appropriate card for Jetpack |
| 328 |
* |
| 329 |
* @param object $result Plugin search results. |
| 330 |
* @param string $action unused. |
| 331 |
* @param object $args Search args. |
| 332 |
*/ |
| 333 |
public function inject_jetpack_module_suggestion( $result, $action, $args ) { |
| 334 |
/* |
| 335 |
* Bail if something else hooks into the Plugins' API response |
| 336 |
* and does not return results. |
| 337 |
*/ |
| 338 |
if ( empty( $result->plugins ) || is_wp_error( $result ) ) { |
| 339 |
return $result; |
| 340 |
} |
| 341 |
|
| 342 |
// Looks like a search query; it's matching time. |
| 343 |
if ( ! empty( $args->search ) ) { |
| 344 |
$searchable_modules = array( |
| 345 |
'contact-form', |
| 346 |
'monitor', |
| 347 |
'photon', |
| 348 |
'photon-cdn', |
| 349 |
'protect', |
| 350 |
'publicize', |
| 351 |
'related-posts', |
| 352 |
'akismet', |
| 353 |
'vaultpress', |
| 354 |
'videopress', |
| 355 |
'search', |
| 356 |
); |
| 357 |
|
| 358 |
/* |
| 359 |
* Let's handle the Sharing feature differently. |
| 360 |
* If we're using a block-based theme, we should suggest the sharing block. |
| 361 |
* If using a classic theme, we should suggest the old sharing module. |
| 362 |
*/ |
| 363 |
if ( wp_is_block_theme() ) { |
| 364 |
$searchable_modules[] = 'sharing-block'; |
| 365 |
} else { |
| 366 |
$searchable_modules[] = 'sharedaddy'; |
| 367 |
} |
| 368 |
|
| 369 |
require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php'; |
| 370 |
$tracking = new Tracking(); |
| 371 |
$jetpack_modules_list = array_intersect_key( |
| 372 |
array_merge( $this->get_extra_features(), Jetpack_Admin::init()->get_modules() ), |
| 373 |
array_flip( $searchable_modules ) |
| 374 |
); |
| 375 |
uasort( $jetpack_modules_list, array( $this, 'by_sorting_option' ) ); |
| 376 |
|
| 377 |
// Record event when user searches for a term over 3 chars (less than 3 is not very useful). |
| 378 |
if ( strlen( $args->search ) >= 3 ) { |
| 379 |
$tracking->record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) ); |
| 380 |
} |
| 381 |
|
| 382 |
// Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'. |
| 383 |
$normalized_term = $this->sanitize_search_term( $args->search ); |
| 384 |
|
| 385 |
$matching_module = null; |
| 386 |
|
| 387 |
// Try to match a passed search term with module's search terms. |
| 388 |
foreach ( $jetpack_modules_list as $module_slug => $module_opts ) { |
| 389 |
/* |
| 390 |
* Does the site's current plan support the feature? |
| 391 |
* We don't use Jetpack_Plan::supports() here because |
| 392 |
* that check always returns Akismet as supported, |
| 393 |
* since Akismet has a free version. |
| 394 |
*/ |
| 395 |
$current_plan = Jetpack_Plan::get(); |
| 396 |
$is_supported_by_plan = in_array( $module_slug, $current_plan['supports'], true ); |
| 397 |
|
| 398 |
if ( |
| 399 |
false !== stripos( $module_opts['search_terms'] . ', ' . $module_opts['name'], $normalized_term ) |
| 400 |
&& $is_supported_by_plan |
| 401 |
) { |
| 402 |
$matching_module = $module_slug; |
| 403 |
break; |
| 404 |
} |
| 405 |
} |
| 406 |
|
| 407 |
if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) { |
| 408 |
// Record event when a matching feature is found. |
| 409 |
$tracking->record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) ); |
| 410 |
|
| 411 |
$inject = (array) self::get_jetpack_plugin_data(); |
| 412 |
$image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE ); |
| 413 |
$overrides = array( |
| 414 |
'plugin-search' => true, // Helps to determine if that an injected card. |
| 415 |
'name' => sprintf( // Supplement name/description so that they clearly indicate this was added. |
| 416 |
/* translators: Jetpack module name */ |
| 417 |
esc_html_x( 'Jetpack: %s', 'Jetpack: Module Name', 'jetpack' ), |
| 418 |
$jetpack_modules_list[ $matching_module ]['name'] |
| 419 |
), |
| 420 |
'short_description' => $jetpack_modules_list[ $matching_module ]['short_description'], |
| 421 |
'requires_connection' => (bool) $jetpack_modules_list[ $matching_module ]['requires_connection'], |
| 422 |
'slug' => self::$slug, |
| 423 |
'version' => JETPACK__VERSION, |
| 424 |
'icons' => array( |
| 425 |
'1x' => "$image_url-128.png", |
| 426 |
'2x' => "$image_url-256.png", |
| 427 |
'svg' => "$image_url.svg", |
| 428 |
), |
| 429 |
); |
| 430 |
|
| 431 |
// Splice in the base module data. |
| 432 |
$inject = array_merge( $inject, $jetpack_modules_list[ $matching_module ], $overrides ); |
| 433 |
|
| 434 |
// Add it to the top of the list. |
| 435 |
$result->plugins = array_filter( $result->plugins, array( $this, 'filter_cards' ) ); |
| 436 |
array_unshift( $result->plugins, $inject ); |
| 437 |
} |
| 438 |
} |
| 439 |
return $result; |
| 440 |
} |
| 441 |
|
| 442 |
/** |
| 443 |
* Remove cards for Jetpack plugins since we don't want duplicates. |
| 444 |
* |
| 445 |
* @since 7.1.0 |
| 446 |
* @since 7.2.0 Only remove Jetpack. |
| 447 |
* @since 7.4.0 Simplify for WordPress 5.1+. |
| 448 |
* |
| 449 |
* @param array|object $plugin WordPress search result card. |
| 450 |
* |
| 451 |
* @return bool |
| 452 |
*/ |
| 453 |
public function filter_cards( $plugin ) { |
| 454 |
/* |
| 455 |
* $plugin is normally an array. |
| 456 |
* However, since the response data can be filtered, |
| 457 |
* we cannot fully trust its format. |
| 458 |
* Let's handle both arrays and objects, and bail if it's neither. |
| 459 |
*/ |
| 460 |
if ( is_array( $plugin ) && ! empty( $plugin['slug'] ) ) { |
| 461 |
$slug = $plugin['slug']; |
| 462 |
} elseif ( is_object( $plugin ) && ! empty( $plugin->slug ) ) { |
| 463 |
$slug = $plugin->slug; |
| 464 |
} else { |
| 465 |
return false; |
| 466 |
} |
| 467 |
|
| 468 |
return ! in_array( $slug, array( 'jetpack' ), true ); |
| 469 |
} |
| 470 |
|
| 471 |
/** |
| 472 |
* Take a raw search query and return something a bit more standardized and |
| 473 |
* easy to work with. |
| 474 |
* |
| 475 |
* @param string $term The raw search term. |
| 476 |
* @return string A simplified/sanitized version. |
| 477 |
*/ |
| 478 |
private function sanitize_search_term( $term ) { |
| 479 |
$term = strtolower( urldecode( $term ) ); |
| 480 |
|
| 481 |
// remove non-alpha/space chars. |
| 482 |
$term = preg_replace( '/[^a-z ]/', '', $term ); |
| 483 |
|
| 484 |
// remove strings that don't help matches. |
| 485 |
$term = trim( str_replace( array( 'jetpack', 'jp', 'free', 'wordpress' ), '', $term ) ); |
| 486 |
|
| 487 |
return $term; |
| 488 |
} |
| 489 |
|
| 490 |
/** |
| 491 |
* Callback function to sort the array of modules by the sort option. |
| 492 |
* |
| 493 |
* @param array $m1 Array 1 to sort. |
| 494 |
* @param array $m2 Array 2 to sort. |
| 495 |
*/ |
| 496 |
private function by_sorting_option( $m1, $m2 ) { |
| 497 |
return $m1['sort'] <=> $m2['sort']; |
| 498 |
} |
| 499 |
|
| 500 |
/** |
| 501 |
* Modify the URL to the feature settings, for example Publicize. |
| 502 |
* Sharing is included here because while we still have a page in WP Admin, |
| 503 |
* we prefer to send users to Calypso. |
| 504 |
* |
| 505 |
* @param string $feature Feature. |
| 506 |
* @param string $configure_url URL to configure feature. |
| 507 |
* |
| 508 |
* @return string |
| 509 |
* @since 7.1.0 |
| 510 |
*/ |
| 511 |
private function get_configure_url( $feature, $configure_url ) { |
| 512 |
switch ( $feature ) { |
| 513 |
case 'sharing': |
| 514 |
case 'publicize': |
| 515 |
$configure_url = Redirect::get_url( 'calypso-marketing-connections' ); |
| 516 |
break; |
| 517 |
case 'seo-tools': |
| 518 |
$configure_url = Redirect::get_url( |
| 519 |
'calypso-marketing-traffic', |
| 520 |
array( |
| 521 |
'anchor' => 'seo', |
| 522 |
) |
| 523 |
); |
| 524 |
break; |
| 525 |
case 'google-analytics': |
| 526 |
$configure_url = Redirect::get_url( |
| 527 |
'calypso-marketing-traffic', |
| 528 |
array( |
| 529 |
'anchor' => 'analytics', |
| 530 |
) |
| 531 |
); |
| 532 |
break; |
| 533 |
case 'wordads': |
| 534 |
$configure_url = Redirect::get_url( 'wpcom-ads-settings' ); |
| 535 |
break; |
| 536 |
} |
| 537 |
return $configure_url; |
| 538 |
} |
| 539 |
|
| 540 |
/** |
| 541 |
* Put some more appropriate links on our custom result cards. |
| 542 |
* |
| 543 |
* @param array $links Related links. |
| 544 |
* @param array $plugin Plugin result information. |
| 545 |
*/ |
| 546 |
public function insert_module_related_links( $links, $plugin ) { |
| 547 |
if ( self::$slug !== $plugin['slug'] ) { |
| 548 |
return $links; |
| 549 |
} |
| 550 |
|
| 551 |
// By the time this filter is applied, self_admin_url was already applied and we don't need it anymore. |
| 552 |
remove_filter( 'self_admin_url', array( $this, 'plugin_details' ) ); |
| 553 |
|
| 554 |
$links = array(); |
| 555 |
|
| 556 |
if ( 'sharing-block' === $plugin['module'] ) { |
| 557 |
$links['jp_get_started'] = '<a |
| 558 |
id="plugin-select-settings" |
| 559 |
class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button" |
| 560 |
href="' . esc_url( admin_url( 'site-editor.php?path=%2Fwp_template' ) ) . '" |
| 561 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 562 |
data-track="get_started" |
| 563 |
>' . esc_html__( 'Add block', 'jetpack' ) . '</a>'; |
| 564 |
} elseif ( 'akismet' === $plugin['module'] || 'vaultpress' === $plugin['module'] ) { |
| 565 |
$links['jp_get_started'] = '<a |
| 566 |
id="plugin-select-settings" |
| 567 |
class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button" |
| 568 |
href="' . esc_url( Redirect::get_url( 'plugin-hint-learn-' . $plugin['module'] ) ) . '" |
| 569 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 570 |
data-track="get_started" |
| 571 |
>' . esc_html__( 'Get started', 'jetpack' ) . '</a>'; |
| 572 |
// Jetpack installed, active, feature not enabled; prompt to enable. |
| 573 |
} elseif ( |
| 574 |
current_user_can( 'jetpack_activate_modules' ) && |
| 575 |
! Jetpack::is_module_active( $plugin['module'] ) && |
| 576 |
Jetpack_Plan::supports( $plugin['module'] ) |
| 577 |
) { |
| 578 |
$links[] = '<button |
| 579 |
id="plugin-select-activate" |
| 580 |
class="jetpack-plugin-search__primary button" |
| 581 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 582 |
data-configure-url="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '" |
| 583 |
> ' . esc_html__( 'Enable', 'jetpack' ) . '</button>'; |
| 584 |
|
| 585 |
// Jetpack installed, active, feature enabled; link to settings. |
| 586 |
} elseif ( |
| 587 |
! empty( $plugin['configure_url'] ) && |
| 588 |
current_user_can( 'jetpack_configure_modules' ) && |
| 589 |
Jetpack::is_module_active( $plugin['module'] ) && |
| 590 |
/** This filter is documented in class.jetpack-admin.php */ |
| 591 |
apply_filters( 'jetpack_module_configurable_' . $plugin['module'], false ) |
| 592 |
) { |
| 593 |
$links[] = '<a |
| 594 |
id="plugin-select-settings" |
| 595 |
class="jetpack-plugin-search__primary button jetpack-plugin-search__configure" |
| 596 |
href="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '" |
| 597 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 598 |
data-track="configure" |
| 599 |
>' . esc_html__( 'Configure', 'jetpack' ) . '</a>'; |
| 600 |
// Module is active, doesn't have options to configure. |
| 601 |
} elseif ( Jetpack::is_module_active( $plugin['module'] ) ) { |
| 602 |
$links['jp_get_started'] = '<a |
| 603 |
id="plugin-select-settings" |
| 604 |
class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button" |
| 605 |
href="' . esc_url( Redirect::get_url( 'plugin-hint-learn-' . $plugin['module'] ) ) . '" |
| 606 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 607 |
data-track="get_started" |
| 608 |
>' . esc_html__( 'Get started', 'jetpack' ) . '</a>'; |
| 609 |
} |
| 610 |
|
| 611 |
// Add link pointing to a relevant doc page in jetpack.com only if the Get started button isn't displayed. |
| 612 |
if ( ! empty( $plugin['learn_more_button'] ) && ! isset( $links['jp_get_started'] ) ) { |
| 613 |
$links[] = '<a |
| 614 |
class="jetpack-plugin-search__learn-more" |
| 615 |
href="' . esc_url( $plugin['learn_more_button'] ) . '" |
| 616 |
target="_blank" |
| 617 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 618 |
data-track="learn_more" |
| 619 |
>' . esc_html__( 'Learn more', 'jetpack' ) . '</a>'; |
| 620 |
} |
| 621 |
|
| 622 |
// Dismiss link. |
| 623 |
$links[] = '<a |
| 624 |
class="jetpack-plugin-search__dismiss" |
| 625 |
data-module="' . esc_attr( $plugin['module'] ) . '" |
| 626 |
>' . esc_html__( 'Hide this suggestion', 'jetpack' ) . '</a>'; |
| 627 |
|
| 628 |
return $links; |
| 629 |
} |
| 630 |
} |
| 631 |
|
| 632 |
/** |
| 633 |
* Master control that checks if Plugin search hints is active. |
| 634 |
* |
| 635 |
* @since 7.1.1 |
| 636 |
* |
| 637 |
* @return bool True if PSH is active. |
| 638 |
*/ |
| 639 |
function jetpack_is_psh_active() { |
| 640 |
/** |
| 641 |
* Disables the Plugin Search Hints feature found when searching the plugins page. |
| 642 |
* |
| 643 |
* @since 8.7.0 |
| 644 |
* |
| 645 |
* @param bool Set false to disable the feature. |
| 646 |
*/ |
| 647 |
return apply_filters( 'jetpack_psh_active', true ); |
| 648 |
} |
| 649 |
|
