<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WPSEO\Suggested_Plugins

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

use Yoast\WP\SEO\Conditionals\Conditional;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class WPSEO_Suggested_Plugins

[10] Fix | Delete

*/

[11] Fix | Delete

class WPSEO_Suggested_Plugins implements WPSEO_WordPress_Integration {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Holds the availability checker.

[15] Fix | Delete

*

[16] Fix | Delete

* @var WPSEO_Plugin_Availability

[17] Fix | Delete

*/

[18] Fix | Delete

protected $availability_checker;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Holds the notification center.

[22] Fix | Delete

*

[23] Fix | Delete

* @var Yoast_Notification_Center

[24] Fix | Delete

*/

[25] Fix | Delete

protected $notification_center;

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* WPSEO_Suggested_Plugins constructor.

[29] Fix | Delete

*

[30] Fix | Delete

* @param WPSEO_Plugin_Availability $availability_checker The availability checker to use.

[31] Fix | Delete

* @param Yoast_Notification_Center $notification_center The notification center to add notifications to.

[32] Fix | Delete

*/

[33] Fix | Delete

public function __construct( WPSEO_Plugin_Availability $availability_checker, Yoast_Notification_Center $notification_center ) {

[34] Fix | Delete

$this->availability_checker = $availability_checker;

[35] Fix | Delete

$this->notification_center = $notification_center;

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Registers all hooks to WordPress.

[40] Fix | Delete

*

[41] Fix | Delete

* @return void

[42] Fix | Delete

*/

[43] Fix | Delete

public function register_hooks() {

[44] Fix | Delete

add_action( 'admin_init', [ $this->availability_checker, 'register' ] );

[45] Fix | Delete

add_action( 'admin_init', [ $this, 'add_notifications' ] );

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Adds notifications (when necessary).

[50] Fix | Delete

*

[51] Fix | Delete

* @return void

[52] Fix | Delete

*/

[53] Fix | Delete

public function add_notifications() {

[54] Fix | Delete

$checker = $this->availability_checker;

[55] Fix | Delete

[56] Fix | Delete

// Get all Yoast plugins that have dependencies.

[57] Fix | Delete

$plugins = $checker->get_plugins_with_dependencies();

[58] Fix | Delete

[59] Fix | Delete

foreach ( $plugins as $plugin_name => $plugin ) {

[60] Fix | Delete

$notification_id = 'wpseo-suggested-plugin-' . $plugin_name;

[61] Fix | Delete

[62] Fix | Delete

if ( ! $checker->dependencies_are_satisfied( $plugin ) ) {

[63] Fix | Delete

$this->notification_center->remove_notification_by_id( $notification_id );

[64] Fix | Delete

[65] Fix | Delete

continue;

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

if ( ! $checker->is_installed( $plugin ) ) {

[69] Fix | Delete

$notification = $this->get_yoast_seo_suggested_plugins_notification( $notification_id, $plugin );

[70] Fix | Delete

$this->notification_center->add_notification( $notification );

[71] Fix | Delete

[72] Fix | Delete

continue;

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

$this->notification_center->remove_notification_by_id( $notification_id );

[76] Fix | Delete

}

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Build Yoast SEO suggested plugins notification.

[81] Fix | Delete

*

[82] Fix | Delete

* @param string $notification_id The id of the notification to be created.

[83] Fix | Delete

* @param array<string, string|bool|array<string, Conditional>> $plugin The plugin to retrieve the data from.

[84] Fix | Delete

*

[85] Fix | Delete

* @return Yoast_Notification The notification containing the suggested plugin.

[86] Fix | Delete

*/

[87] Fix | Delete

protected function get_yoast_seo_suggested_plugins_notification( $notification_id, $plugin ) {

[88] Fix | Delete

$message = $this->create_install_suggested_plugin_message( $plugin );

[89] Fix | Delete

[90] Fix | Delete

return new Yoast_Notification(

[91] Fix | Delete

$message,

[92] Fix | Delete

[

[93] Fix | Delete

'id' => $notification_id,

[94] Fix | Delete

'type' => Yoast_Notification::WARNING,

[95] Fix | Delete

'capabilities' => [ 'install_plugins' ],

[96] Fix | Delete

]

[97] Fix | Delete

);

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Creates a message to suggest the installation of a particular plugin.

[102] Fix | Delete

*

[103] Fix | Delete

* @param array $suggested_plugin The suggested plugin.

[104] Fix | Delete

*

[105] Fix | Delete

* @return string The install suggested plugin message.

[106] Fix | Delete

*/

[107] Fix | Delete

protected function create_install_suggested_plugin_message( $suggested_plugin ) {

[108] Fix | Delete

/* translators: %1$s expands to an opening strong tag, %2$s expands to the dependency name, %3$s expands to a closing strong tag, %4$s expands to an opening anchor tag, %5$s expands to a closing anchor tag. */

[109] Fix | Delete

$message = __( 'It looks like you aren\'t using our %1$s%2$s addon%3$s. %4$sUpgrade today%5$s to unlock more tools and SEO features to make your products stand out in search results.', 'wordpress-seo' );

[110] Fix | Delete

$install_link = WPSEO_Admin_Utils::get_install_link( $suggested_plugin );

[111] Fix | Delete

[112] Fix | Delete

return sprintf(

[113] Fix | Delete

$message,

[114] Fix | Delete

'<strong>',

[115] Fix | Delete

$install_link,

[116] Fix | Delete

'</strong>',

[117] Fix | Delete

$this->create_more_information_link( $suggested_plugin['url'], $suggested_plugin['title'] ),

[118] Fix | Delete

'</a>'

[119] Fix | Delete

);

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Creates a more information link that directs the user to WordPress.org Plugin repository.

[124] Fix | Delete

*

[125] Fix | Delete

* @param string $url The URL to the plugin's page.

[126] Fix | Delete

* @param string $name The name of the plugin.

[127] Fix | Delete

*

[128] Fix | Delete

* @return string The more information link.

[129] Fix | Delete

*/

[130] Fix | Delete

protected function create_more_information_link( $url, $name ) {

[131] Fix | Delete

return sprintf(

[132] Fix | Delete

'<a href="%s" aria-label="%s" target="_blank" rel="noopener noreferrer">',

[133] Fix | Delete

$url,

[134] Fix | Delete

/* translators: Hidden accessibility text; %1$s expands to the dependency name */

[135] Fix | Delete

sprintf( __( 'More information about %1$s', 'wordpress-seo' ), $name )

[136] Fix | Delete

);

[137] Fix | Delete

}

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete