1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Suggested_Plugins
*/
/**
* Class WPSEO_Suggested_Plugins
*/
class WPSEO_Suggested_Plugins implements WPSEO_WordPress_Integration {
/**
* @var WPSEO_Plugin_Availability
*/
protected $availability_checker;
/**
* @var Yoast_Notification_Center
*/
protected $notification_center;
/**
* WPSEO_Suggested_Plugins constructor.
*
* @param WPSEO_Plugin_Availability $availability_checker The availability checker to use.
* @param Yoast_Notification_Center $notification_center The notification center to add notifications to.
*/
public function __construct( WPSEO_Plugin_Availability $availability_checker, Yoast_Notification_Center $notification_center ) {
$this->availability_checker = $availability_checker;
$this->notification_center = $notification_center;
}
/**
* Registers all hooks to WordPress.
*
* @return void
*/
public function register_hooks() {
add_action( 'admin_init', array( $this->availability_checker, 'register' ) );
add_action( 'admin_init', array( $this, 'add_notifications' ) );
}
/**
* Adds notifications (when necessary).
*
* @return void
*/
public function add_notifications() {
$checker = $this->availability_checker;
// Get all Yoast plugins that have dependencies.
$plugins = $checker->get_plugins_with_dependencies();
foreach ( $plugins as $plugin_name => $plugin ) {
if ( ! $checker->dependencies_are_satisfied( $plugin ) ) {
continue;
}
$dependency_names = $checker->get_dependency_names( $plugin );
$notification = $this->get_yoast_seo_suggested_plugins_notification( $plugin_name, $plugin, $dependency_names[0] );
if ( ! WPSEO_Utils::is_yoast_seo_premium() && ( ! $checker->is_installed( $plugin ) || ! $checker->is_active( $plugin['slug'] ) ) ) {
$this->notification_center->add_notification( $notification );
continue;
}
$this->notification_center->remove_notification( $notification );
}
}
/**
* Build Yoast SEO suggested plugins notification.
*
* @param string $name The plugin name to use for the unique ID.
* @param array $plugin The plugin to retrieve the data from.
* @param string $dependency_name The name of the dependency.
*
* @return Yoast_Notification The notification containing the suggested plugin.
*/
protected function get_yoast_seo_suggested_plugins_notification( $name, $plugin, $dependency_name ) {
$message = $this->create_install_suggested_plugin_message( $plugin, $dependency_name );
if ( $this->availability_checker->is_installed( $plugin ) && ! $this->availability_checker->is_active( $plugin['slug'] ) ) {
$message = $this->create_activate_suggested_plugin_message( $plugin, $dependency_name );
}
return new Yoast_Notification(
$message,
array(
'id' => 'wpseo-suggested-plugin-' . $name,
'type' => Yoast_Notification::WARNING,
'capabilities' => array( 'install_plugins' ),
)
);
}
/**
* Creates a message to suggest the installation of a particular plugin.
*
* @param array $suggested_plugin The suggested plugin.
* @param array $third_party_plugin The third party plugin that we have a suggested plugin for.
*
* @return string The install suggested plugin message.
*/
protected function create_install_suggested_plugin_message( $suggested_plugin, $third_party_plugin ) {
/* translators: %1$s expands to Yoast SEO, %2$s expands to the dependency name, %3$s expands to the install link, %4$s expands to the more info link. */
$message = __( '%1$s and %2$s can work together a lot better by adding a helper plugin. Please install %3$s to make your life better. %4$s.', 'wordpress-seo' );
$install_link = WPSEO_Admin_Utils::get_install_link( $suggested_plugin );
return sprintf(
$message,
'Yoast SEO',
$third_party_plugin,
$install_link,
$this->create_more_information_link( $suggested_plugin['url'], $suggested_plugin['title'] )
);
}
/**
* Creates a more information link that directs the user to WordPress.org Plugin repository.
*
* @param string $url The URL to the plugin's page.
* @param string $name The name of the plugin.
*
* @return string The more information link.
*/
protected function create_more_information_link( $url, $name ) {
return sprintf(
'<a href="%s" aria-label="%s" target="_blank" rel="noopener noreferrer">%s</a>',
$url,
/* translators: %1$s expands to the dependency name. */
sprintf( __( 'More information about %1$s', 'wordpress-seo' ), $name ),
__( 'More information', 'wordpress-seo' )
);
}
/**
* Creates a message to suggest the activation of a particular plugin.
*
* @param array $suggested_plugin The suggested plugin.
* @param array $third_party_plugin The third party plugin that we have a suggested plugin for.
*
* @return string The activate suggested plugin message.
*/
protected function create_activate_suggested_plugin_message( $suggested_plugin, $third_party_plugin ) {
/* translators: %1$s expands to Yoast SEO, %2$s expands to the dependency name, %3$s expands to activation link. */
$message = __( '%1$s and %2$s can work together a lot better by adding a helper plugin. Please activate %3$s to make your life better.', 'wordpress-seo' );
$activation_url = WPSEO_Admin_Utils::get_activation_url( $suggested_plugin['slug'] );
return sprintf(
$message,
'Yoast SEO',
$third_party_plugin,
sprintf( '<a href="%s">%s</a>', $activation_url, $suggested_plugin['title'] )
);
}
}
|