Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like TGM_Plugin_Activation often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use TGM_Plugin_Activation, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 50 | class TGM_Plugin_Activation { |
||
| 51 | /** |
||
| 52 | * TGMPA version number. |
||
| 53 | * |
||
| 54 | * @since 2.5.0 |
||
| 55 | * |
||
| 56 | * @const string Version number. |
||
| 57 | */ |
||
| 58 | const TGMPA_VERSION = '2.5.2'; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Regular expression to test if a URL is a WP plugin repo URL. |
||
| 62 | * |
||
| 63 | * @const string Regex. |
||
| 64 | * |
||
| 65 | * @since 2.5.0 |
||
| 66 | */ |
||
| 67 | const WP_REPO_REGEX = '|^http[s]?://wordpress\.org/(?:extend/)?plugins/|'; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Arbitrary regular expression to test if a string starts with a URL. |
||
| 71 | * |
||
| 72 | * @const string Regex. |
||
| 73 | * |
||
| 74 | * @since 2.5.0 |
||
| 75 | */ |
||
| 76 | const IS_URL_REGEX = '|^http[s]?://|'; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Holds a copy of itself, so it can be referenced by the class name. |
||
| 80 | * |
||
| 81 | * @since 1.0.0 |
||
| 82 | * |
||
| 83 | * @var TGM_Plugin_Activation |
||
| 84 | */ |
||
| 85 | public static $instance; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Holds arrays of plugin details. |
||
| 89 | * |
||
| 90 | * @since 1.0.0 |
||
| 91 | * |
||
| 92 | * @since 2.5.0 the array has the plugin slug as an associative key. |
||
| 93 | * |
||
| 94 | * @var array |
||
| 95 | */ |
||
| 96 | public $plugins = array(); |
||
| 97 | |||
| 98 | /** |
||
| 99 | * Holds arrays of plugin names to use to sort the plugins array. |
||
| 100 | * |
||
| 101 | * @since 2.5.0 |
||
| 102 | * |
||
| 103 | * @var array |
||
| 104 | */ |
||
| 105 | protected $sort_order = array(); |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Whether any plugins have the 'force_activation' setting set to true. |
||
| 109 | * |
||
| 110 | * @since 2.5.0 |
||
| 111 | * |
||
| 112 | * @var bool |
||
| 113 | */ |
||
| 114 | protected $has_forced_activation = false; |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Whether any plugins have the 'force_deactivation' setting set to true. |
||
| 118 | * |
||
| 119 | * @since 2.5.0 |
||
| 120 | * |
||
| 121 | * @var bool |
||
| 122 | */ |
||
| 123 | protected $has_forced_deactivation = false; |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Name of the unique ID to hash notices. |
||
| 127 | * |
||
| 128 | * @since 2.4.0 |
||
| 129 | * |
||
| 130 | * @var string |
||
| 131 | */ |
||
| 132 | public $id = 'tgmpa'; |
||
| 133 | |||
| 134 | /** |
||
| 135 | * Name of the query-string argument for the admin page. |
||
| 136 | * |
||
| 137 | * @since 1.0.0 |
||
| 138 | * |
||
| 139 | * @var string |
||
| 140 | */ |
||
| 141 | protected $menu = 'tgmpa-install-plugins'; |
||
| 142 | |||
| 143 | /** |
||
| 144 | * Parent menu file slug. |
||
| 145 | * |
||
| 146 | * @since 2.5.0 |
||
| 147 | * |
||
| 148 | * @var string |
||
| 149 | */ |
||
| 150 | public $parent_slug = 'themes.php'; |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Capability needed to view the plugin installation menu item. |
||
| 154 | * |
||
| 155 | * @since 2.5.0 |
||
| 156 | * |
||
| 157 | * @var string |
||
| 158 | */ |
||
| 159 | public $capability = 'edit_theme_options'; |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Default absolute path to folder containing bundled plugin zip files. |
||
| 163 | * |
||
| 164 | * @since 2.0.0 |
||
| 165 | * |
||
| 166 | * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string. |
||
| 167 | */ |
||
| 168 | public $default_path = ''; |
||
| 169 | |||
| 170 | /** |
||
| 171 | * Flag to show admin notices or not. |
||
| 172 | * |
||
| 173 | * @since 2.1.0 |
||
| 174 | * |
||
| 175 | * @var boolean |
||
| 176 | */ |
||
| 177 | public $has_notices = true; |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Flag to determine if the user can dismiss the notice nag. |
||
| 181 | * |
||
| 182 | * @since 2.4.0 |
||
| 183 | * |
||
| 184 | * @var boolean |
||
| 185 | */ |
||
| 186 | public $dismissable = true; |
||
| 187 | |||
| 188 | /** |
||
| 189 | * Message to be output above nag notice if dismissable is false. |
||
| 190 | * |
||
| 191 | * @since 2.4.0 |
||
| 192 | * |
||
| 193 | * @var string |
||
| 194 | */ |
||
| 195 | public $dismiss_msg = ''; |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Flag to set automatic activation of plugins. Off by default. |
||
| 199 | * |
||
| 200 | * @since 2.2.0 |
||
| 201 | * |
||
| 202 | * @var boolean |
||
| 203 | */ |
||
| 204 | public $is_automatic = false; |
||
| 205 | |||
| 206 | /** |
||
| 207 | * Optional message to display before the plugins table. |
||
| 208 | * |
||
| 209 | * @since 2.2.0 |
||
| 210 | * |
||
| 211 | * @var string Message filtered by wp_kses_post(). Default is empty string. |
||
| 212 | */ |
||
| 213 | public $message = ''; |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Holds configurable array of strings. |
||
| 217 | * |
||
| 218 | * Default values are added in the constructor. |
||
| 219 | * |
||
| 220 | * @since 2.0.0 |
||
| 221 | * |
||
| 222 | * @var array |
||
| 223 | */ |
||
| 224 | public $strings = array(); |
||
| 225 | |||
| 226 | /** |
||
| 227 | * Holds the version of WordPress. |
||
| 228 | * |
||
| 229 | * @since 2.4.0 |
||
| 230 | * |
||
| 231 | * @var int |
||
| 232 | */ |
||
| 233 | public $wp_version; |
||
| 234 | |||
| 235 | /** |
||
| 236 | * Holds the hook name for the admin page. |
||
| 237 | * |
||
| 238 | * @since 2.5.0 |
||
| 239 | * |
||
| 240 | * @var string |
||
| 241 | */ |
||
| 242 | public $page_hook; |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Adds a reference of this object to $instance, populates default strings, |
||
| 246 | * does the tgmpa_init action hook, and hooks in the interactions to init. |
||
| 247 | * |
||
| 248 | * {@internal This method should be `protected`, but as too many TGMPA implementations |
||
| 249 | * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues. |
||
| 250 | * Reverted back to public for the time being.}} |
||
| 251 | * |
||
| 252 | * @since 1.0.0 |
||
| 253 | * |
||
| 254 | * @see TGM_Plugin_Activation::init() |
||
| 255 | */ |
||
| 256 | public function __construct() { |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Magic method to (not) set protected properties from outside of this class. |
||
| 278 | * |
||
| 279 | * {@internal hackedihack... There is a serious bug in v2.3.2 - 2.3.6 where the `menu` property |
||
| 280 | * is being assigned rather than tested in a conditional, effectively rendering it useless. |
||
| 281 | * This 'hack' prevents this from happening.}} |
||
| 282 | * |
||
| 283 | * @see https://github.com/TGMPA/TGM-Plugin-Activation/blob/2.3.6/tgm-plugin-activation/class-tgm-plugin-activation.php#L1593 |
||
| 284 | * |
||
| 285 | * @param string $name Name of an inaccessible property. |
||
| 286 | * @param mixed $value Value to assign to the property. |
||
| 287 | * @return void Silently fail to set the property when this is tried from outside of this class context. |
||
| 288 | * (Inside this class context, the __set() method if not used as there is direct access.) |
||
| 289 | */ |
||
| 290 | public function __set( $name, $value ) { |
||
| 293 | |||
| 294 | /** |
||
| 295 | * Magic method to get the value of a protected property outside of this class context. |
||
| 296 | * |
||
| 297 | * @param string $name Name of an inaccessible property. |
||
| 298 | * @return mixed The property value. |
||
| 299 | */ |
||
| 300 | public function __get( $name ) { |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Initialise the interactions between this class and WordPress. |
||
| 306 | * |
||
| 307 | * Hooks in three new methods for the class: admin_menu, notices and styles. |
||
| 308 | * |
||
| 309 | * @since 2.0.0 |
||
| 310 | * |
||
| 311 | * @see TGM_Plugin_Activation::admin_menu() |
||
| 312 | * @see TGM_Plugin_Activation::notices() |
||
| 313 | * @see TGM_Plugin_Activation::styles() |
||
| 314 | */ |
||
| 315 | public function init() { |
||
| 316 | /** |
||
| 317 | * By default TGMPA only loads on the WP back-end and not in an Ajax call. Using this filter |
||
| 318 | * you can overrule that behaviour. |
||
| 319 | * |
||
| 320 | * @since 2.5.0 |
||
| 321 | * |
||
| 322 | * @param bool $load Whether or not TGMPA should load. |
||
| 323 | * Defaults to the return of `is_admin() && ! defined( 'DOING_AJAX' )`. |
||
| 324 | */ |
||
| 325 | if ( true !== apply_filters( 'tgmpa_load', ( is_admin() && ! defined( 'DOING_AJAX' ) ) ) ) { |
||
| 326 | return; |
||
| 327 | } |
||
| 328 | |||
| 329 | // Load class strings. |
||
| 330 | $this->strings = array( |
||
| 331 | 'page_title' => __( 'Install Required Plugins', 'tgmpa' ), |
||
| 332 | 'menu_title' => __( 'Install Plugins', 'tgmpa' ), |
||
| 333 | /* translators: %s: plugin name. */ |
||
| 334 | 'installing' => __( 'Installing Plugin: %s', 'tgmpa' ), |
||
| 335 | /* translators: %s: plugin name. */ |
||
| 336 | 'updating' => __( 'Updating Plugin: %s', 'tgmpa' ), |
||
| 337 | 'oops' => __( 'Something went wrong with the plugin API.', 'tgmpa' ), |
||
| 338 | 'notice_can_install_required' => _n_noop( |
||
| 339 | /* translators: 1: plugin name(s). */ |
||
| 340 | 'This theme requires the following plugin: %1$s.', |
||
| 341 | 'This theme requires the following plugins: %1$s.', |
||
| 342 | 'tgmpa' |
||
| 343 | ), |
||
| 344 | 'notice_can_install_recommended' => _n_noop( |
||
| 345 | /* translators: 1: plugin name(s). */ |
||
| 346 | 'This theme recommends the following plugin: %1$s.', |
||
| 347 | 'This theme recommends the following plugins: %1$s.', |
||
| 348 | 'tgmpa' |
||
| 349 | ), |
||
| 350 | 'notice_ask_to_update' => _n_noop( |
||
| 351 | /* translators: 1: plugin name(s). */ |
||
| 352 | 'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.', |
||
| 353 | 'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.', |
||
| 354 | 'tgmpa' |
||
| 355 | ), |
||
| 356 | 'notice_ask_to_update_maybe' => _n_noop( |
||
| 357 | /* translators: 1: plugin name(s). */ |
||
| 358 | 'There is an update available for: %1$s.', |
||
| 359 | 'There are updates available for the following plugins: %1$s.', |
||
| 360 | 'tgmpa' |
||
| 361 | ), |
||
| 362 | 'notice_can_activate_required' => _n_noop( |
||
| 363 | /* translators: 1: plugin name(s). */ |
||
| 364 | 'The following required plugin is currently inactive: %1$s.', |
||
| 365 | 'The following required plugins are currently inactive: %1$s.', |
||
| 366 | 'tgmpa' |
||
| 367 | ), |
||
| 368 | 'notice_can_activate_recommended' => _n_noop( |
||
| 369 | /* translators: 1: plugin name(s). */ |
||
| 370 | 'The following recommended plugin is currently inactive: %1$s.', |
||
| 371 | 'The following recommended plugins are currently inactive: %1$s.', |
||
| 372 | 'tgmpa' |
||
| 373 | ), |
||
| 374 | 'install_link' => _n_noop( |
||
| 375 | 'Begin installing plugin', |
||
| 376 | 'Begin installing plugins', |
||
| 377 | 'tgmpa' |
||
| 378 | ), |
||
| 379 | 'update_link' => _n_noop( |
||
| 380 | 'Begin updating plugin', |
||
| 381 | 'Begin updating plugins', |
||
| 382 | 'tgmpa' |
||
| 383 | ), |
||
| 384 | 'activate_link' => _n_noop( |
||
| 385 | 'Begin activating plugin', |
||
| 386 | 'Begin activating plugins', |
||
| 387 | 'tgmpa' |
||
| 388 | ), |
||
| 389 | 'return' => __( 'Return to Required Plugins Installer', 'tgmpa' ), |
||
| 390 | 'dashboard' => __( 'Return to the Dashboard', 'tgmpa' ), |
||
| 391 | 'plugin_activated' => __( 'Plugin activated successfully.', 'tgmpa' ), |
||
| 392 | 'activated_successfully' => __( 'The following plugin was activated successfully:', 'tgmpa' ), |
||
| 393 | /* translators: 1: plugin name. */ |
||
| 394 | 'plugin_already_active' => __( 'No action taken. Plugin %1$s was already active.', 'tgmpa' ), |
||
| 395 | /* translators: 1: plugin name. */ |
||
| 396 | 'plugin_needs_higher_version' => __( 'Plugin not activated. A higher version of %s is needed for this theme. Please update the plugin.', 'tgmpa' ), |
||
| 397 | /* translators: 1: dashboard link. */ |
||
| 398 | 'complete' => __( 'All plugins installed and activated successfully. %1$s', 'tgmpa' ), |
||
| 399 | 'dismiss' => __( 'Dismiss this notice', 'tgmpa' ), |
||
| 400 | 'notice_cannot_install_activate' => __( 'There are one or more required or recommended plugins to install, update or activate.', 'tgmpa' ), |
||
| 401 | 'contact_admin' => __( 'Please contact the administrator of this site for help.', 'tgmpa' ), |
||
| 402 | ); |
||
| 403 | |||
| 404 | do_action( 'tgmpa_register' ); |
||
| 405 | |||
| 406 | /* After this point, the plugins should be registered and the configuration set. */ |
||
| 407 | |||
| 408 | // Proceed only if we have plugins to handle. |
||
| 409 | if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) { |
||
| 410 | return; |
||
| 411 | } |
||
| 412 | |||
| 413 | // Set up the menu and notices if we still have outstanding actions. |
||
| 414 | if ( true !== $this->is_tgmpa_complete() ) { |
||
| 415 | // Sort the plugins. |
||
| 416 | array_multisort( $this->sort_order, SORT_ASC, $this->plugins ); |
||
| 417 | |||
| 418 | add_action( 'admin_menu', array( $this, 'admin_menu' ) ); |
||
| 419 | add_action( 'admin_head', array( $this, 'dismiss' ) ); |
||
| 420 | |||
| 421 | // Prevent the normal links from showing underneath a single install/update page. |
||
| 422 | add_filter( 'install_plugin_complete_actions', array( $this, 'actions' ) ); |
||
| 423 | add_filter( 'update_plugin_complete_actions', array( $this, 'actions' ) ); |
||
| 424 | |||
| 425 | if ( $this->has_notices ) { |
||
| 426 | add_action( 'admin_notices', array( $this, 'notices' ) ); |
||
| 427 | add_action( 'admin_init', array( $this, 'admin_init' ), 1 ); |
||
| 428 | add_action( 'admin_enqueue_scripts', array( $this, 'thickbox' ) ); |
||
| 429 | } |
||
| 430 | } |
||
| 431 | |||
| 432 | // If needed, filter plugin action links. |
||
| 433 | add_action( 'load-plugins.php', array( $this, 'add_plugin_action_link_filters' ), 1 ); |
||
| 434 | |||
| 435 | // Make sure things get reset on switch theme. |
||
| 436 | add_action( 'switch_theme', array( $this, 'flush_plugins_cache' ) ); |
||
| 437 | |||
| 438 | if ( $this->has_notices ) { |
||
| 439 | add_action( 'switch_theme', array( $this, 'update_dismiss' ) ); |
||
| 440 | } |
||
| 441 | |||
| 442 | // Setup the force activation hook. |
||
| 443 | if ( true === $this->has_forced_activation ) { |
||
| 444 | add_action( 'admin_init', array( $this, 'force_activation' ) ); |
||
| 445 | } |
||
| 446 | |||
| 447 | // Setup the force deactivation hook. |
||
| 448 | if ( true === $this->has_forced_deactivation ) { |
||
| 449 | add_action( 'switch_theme', array( $this, 'force_deactivation' ) ); |
||
| 450 | } |
||
| 451 | } |
||
| 452 | |||
| 453 | /** |
||
| 454 | * Load translations. |
||
| 455 | * |
||
| 456 | * @since 2.x.x |
||
| 457 | * |
||
| 458 | * (@internal Uses `load_theme_textdomain()` rather than `load_plugin_textdomain()` to |
||
| 459 | * get round the different ways of handling the path and deprecated notices being thrown |
||
| 460 | * and such. For plugins, the actual file name will be corrected by a filter.}} |
||
| 461 | * |
||
| 462 | * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA |
||
| 463 | * generator on the website.}} |
||
| 464 | */ |
||
| 465 | public function load_textdomain() { |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Correct the .mo file name for (must-use) plugins. |
||
| 482 | * |
||
| 483 | * Themese use `/path/{locale}.mo` while plugins use `/path/{text-domain}-{locale}.mo`. |
||
| 484 | * |
||
| 485 | * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA |
||
| 486 | * generator on the website.}} |
||
| 487 | * |
||
| 488 | * @since 2.x.x |
||
| 489 | * |
||
| 490 | * @param string $mofile Full path to the target mofile. |
||
| 491 | * @param string $domain The domain for which a language file is being loaded. |
||
| 492 | * @return string $mofile |
||
| 493 | */ |
||
| 494 | public function correct_plugin_mofile( $mofile, $domain ) { |
||
| 501 | |||
| 502 | /** |
||
| 503 | * Potentially overload the fall-back translation file for the current language. |
||
| 504 | * |
||
| 505 | * WP, by default since WP 3.7, will load a local translation first and if none |
||
| 506 | * can be found, will try and find a translation in the /wp-content/languages/ directory. |
||
| 507 | * As this library is theme/plugin agnostic, translation files for TGMPA can exist both |
||
| 508 | * in the WP_LANG_DIR /plugins/ subdirectory as well as in the /themes/ subdirectory. |
||
| 509 | * |
||
| 510 | * This method makes sure both directories are checked. |
||
| 511 | * |
||
| 512 | * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA |
||
| 513 | * generator on the website.}} |
||
| 514 | * |
||
| 515 | * @since 2.x.x |
||
| 516 | * |
||
| 517 | * @param string $mofile Full path to the target mofile. |
||
| 518 | * @param string $domain The domain for which a language file is being loaded. |
||
| 519 | * @return string $mofile |
||
| 520 | */ |
||
| 521 | public function overload_textdomain_mofile( $mofile, $domain ) { |
||
| 536 | |||
| 537 | /** |
||
| 538 | * Hook in plugin action link filters for the WP native plugins page. |
||
| 539 | * |
||
| 540 | * - Prevent activation of plugins which don't meet the minimum version requirements. |
||
| 541 | * - Prevent deactivation of force-activated plugins. |
||
| 542 | * - Add update notice if update available. |
||
| 543 | * |
||
| 544 | * @since 2.5.0 |
||
| 545 | */ |
||
| 546 | public function add_plugin_action_link_filters() { |
||
| 561 | |||
| 562 | /** |
||
| 563 | * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the |
||
| 564 | * minimum version requirements. |
||
| 565 | * |
||
| 566 | * @since 2.5.0 |
||
| 567 | * |
||
| 568 | * @param array $actions Action links. |
||
| 569 | * @return array |
||
| 570 | */ |
||
| 571 | public function filter_plugin_action_links_activate( $actions ) { |
||
| 576 | |||
| 577 | /** |
||
| 578 | * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate. |
||
| 579 | * |
||
| 580 | * @since 2.5.0 |
||
| 581 | * |
||
| 582 | * @param array $actions Action links. |
||
| 583 | * @return array |
||
| 584 | */ |
||
| 585 | public function filter_plugin_action_links_deactivate( $actions ) { |
||
| 590 | |||
| 591 | /** |
||
| 592 | * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the |
||
| 593 | * minimum version requirements. |
||
| 594 | * |
||
| 595 | * @since 2.5.0 |
||
| 596 | * |
||
| 597 | * @param array $actions Action links. |
||
| 598 | * @return array |
||
| 599 | */ |
||
| 600 | public function filter_plugin_action_links_update( $actions ) { |
||
| 610 | |||
| 611 | /** |
||
| 612 | * Handles calls to show plugin information via links in the notices. |
||
| 613 | * |
||
| 614 | * We get the links in the admin notices to point to the TGMPA page, rather |
||
| 615 | * than the typical plugin-install.php file, so we can prepare everything |
||
| 616 | * beforehand. |
||
| 617 | * |
||
| 618 | * WP does not make it easy to show the plugin information in the thickbox - |
||
| 619 | * here we have to require a file that includes a function that does the |
||
| 620 | * main work of displaying it, enqueue some styles, set up some globals and |
||
| 621 | * finally call that function before exiting. |
||
| 622 | * |
||
| 623 | * Down right easy once you know how... |
||
| 624 | * |
||
| 625 | * Returns early if not the TGMPA page. |
||
| 626 | * |
||
| 627 | * @since 2.1.0 |
||
| 628 | * |
||
| 629 | * @global string $tab Used as iframe div class names, helps with styling |
||
| 630 | * @global string $body_id Used as the iframe body ID, helps with styling |
||
| 631 | * |
||
| 632 | * @return null Returns early if not the TGMPA page. |
||
| 633 | */ |
||
| 634 | public function admin_init() { |
||
| 656 | |||
| 657 | /** |
||
| 658 | * Enqueue thickbox scripts/styles for plugin info. |
||
| 659 | * |
||
| 660 | * Thickbox is not automatically included on all admin pages, so we must |
||
| 661 | * manually enqueue it for those pages. |
||
| 662 | * |
||
| 663 | * Thickbox is only loaded if the user has not dismissed the admin |
||
| 664 | * notice or if there are any plugins left to install and activate. |
||
| 665 | * |
||
| 666 | * @since 2.1.0 |
||
| 667 | */ |
||
| 668 | public function thickbox() { |
||
| 673 | |||
| 674 | /** |
||
| 675 | * Adds submenu page if there are plugin actions to take. |
||
| 676 | * |
||
| 677 | * This method adds the submenu page letting users know that a required |
||
| 678 | * plugin needs to be installed. |
||
| 679 | * |
||
| 680 | * This page disappears once the plugin has been installed and activated. |
||
| 681 | * |
||
| 682 | * @since 1.0.0 |
||
| 683 | * |
||
| 684 | * @see TGM_Plugin_Activation::init() |
||
| 685 | * @see TGM_Plugin_Activation::install_plugins_page() |
||
| 686 | * |
||
| 687 | * @return null Return early if user lacks capability to install a plugin. |
||
| 688 | */ |
||
| 689 | public function admin_menu() { |
||
| 709 | |||
| 710 | /** |
||
| 711 | * Add the menu item. |
||
| 712 | * |
||
| 713 | * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA |
||
| 714 | * generator on the website.}} |
||
| 715 | * |
||
| 716 | * @since 2.5.0 |
||
| 717 | * |
||
| 718 | * @param array $args Menu item configuration. |
||
| 719 | */ |
||
| 720 | protected function add_admin_menu( array $args ) { |
||
| 731 | |||
| 732 | /** |
||
| 733 | * Echoes plugin installation form. |
||
| 734 | * |
||
| 735 | * This method is the callback for the admin_menu method function. |
||
| 736 | * This displays the admin page and form area where the user can select to install and activate the plugin. |
||
| 737 | * Aborts early if we're processing a plugin installation action. |
||
| 738 | * |
||
| 739 | * @since 1.0.0 |
||
| 740 | * |
||
| 741 | * @return null Aborts early if we're processing a plugin installation action. |
||
| 742 | */ |
||
| 743 | public function install_plugins_page() { |
||
| 775 | |||
| 776 | /** |
||
| 777 | * Installs, updates or activates a plugin depending on the action link clicked by the user. |
||
| 778 | * |
||
| 779 | * Checks the $_GET variable to see which actions have been |
||
| 780 | * passed and responds with the appropriate method. |
||
| 781 | * |
||
| 782 | * Uses WP_Filesystem to process and handle the plugin installation |
||
| 783 | * method. |
||
| 784 | * |
||
| 785 | * @since 1.0.0 |
||
| 786 | * |
||
| 787 | * @uses WP_Filesystem |
||
| 788 | * @uses WP_Error |
||
| 789 | * @uses WP_Upgrader |
||
| 790 | * @uses Plugin_Upgrader |
||
| 791 | * @uses Plugin_Installer_Skin |
||
| 792 | * @uses Plugin_Upgrader_Skin |
||
| 793 | * |
||
| 794 | * @return boolean True on success, false on failure. |
||
| 795 | */ |
||
| 796 | protected function do_plugin_install() { |
||
| 797 | if ( empty( $_GET['plugin'] ) ) { |
||
| 798 | return false; |
||
| 799 | } |
||
| 800 | |||
| 801 | // All plugin information will be stored in an array for processing. |
||
| 802 | $slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) ); |
||
| 803 | |||
| 804 | if ( ! isset( $this->plugins[ $slug ] ) ) { |
||
| 805 | return false; |
||
| 806 | } |
||
| 807 | |||
| 808 | // Was an install or upgrade action link clicked? |
||
| 809 | if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) { |
||
| 810 | |||
| 811 | $install_type = 'install'; |
||
| 812 | if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) { |
||
| 813 | $install_type = 'update'; |
||
| 814 | } |
||
| 815 | |||
| 816 | check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' ); |
||
| 817 | |||
| 818 | // Pass necessary information via URL if WP_Filesystem is needed. |
||
| 819 | $url = wp_nonce_url( |
||
| 820 | add_query_arg( |
||
| 821 | array( |
||
| 822 | 'plugin' => urlencode( $slug ), |
||
| 823 | 'tgmpa-' . $install_type => $install_type . '-plugin', |
||
| 824 | ), |
||
| 825 | $this->get_tgmpa_url() |
||
| 826 | ), |
||
| 827 | 'tgmpa-' . $install_type, |
||
| 828 | 'tgmpa-nonce' |
||
| 829 | ); |
||
| 830 | |||
| 831 | $method = ''; // Leave blank so WP_Filesystem can populate it as necessary. |
||
| 832 | |||
| 833 | if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) { |
||
| 834 | return true; |
||
| 835 | } |
||
| 836 | |||
| 837 | if ( ! WP_Filesystem( $creds ) ) { |
||
| 838 | request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem. |
||
| 839 | return true; |
||
| 840 | } |
||
| 841 | |||
| 842 | /* If we arrive here, we have the filesystem. */ |
||
| 843 | |||
| 844 | // Prep variables for Plugin_Installer_Skin class. |
||
| 845 | $extra = array(); |
||
| 846 | $extra['slug'] = $slug; // Needed for potentially renaming of directory name. |
||
| 847 | $source = $this->get_download_url( $slug ); |
||
| 848 | $api = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null; |
||
| 849 | $api = ( false !== $api ) ? $api : null; |
||
| 850 | |||
| 851 | $url = add_query_arg( |
||
| 852 | array( |
||
| 853 | 'action' => $install_type . '-plugin', |
||
| 854 | 'plugin' => urlencode( $slug ), |
||
| 855 | ), |
||
| 856 | 'update.php' |
||
| 857 | ); |
||
| 858 | |||
| 859 | if ( ! class_exists( 'Plugin_Upgrader', false ) ) { |
||
| 860 | require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
||
| 861 | } |
||
| 862 | |||
| 863 | $title = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing']; |
||
| 864 | $skin_args = array( |
||
| 865 | 'type' => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload', |
||
| 866 | 'title' => sprintf( $title, $this->plugins[ $slug ]['name'] ), |
||
| 867 | 'url' => esc_url_raw( $url ), |
||
| 868 | 'nonce' => $install_type . '-plugin_' . $slug, |
||
| 869 | 'plugin' => '', |
||
| 870 | 'api' => $api, |
||
| 871 | 'extra' => $extra, |
||
| 872 | ); |
||
| 873 | unset( $title ); |
||
| 874 | |||
| 875 | if ( 'update' === $install_type ) { |
||
| 876 | $skin_args['plugin'] = $this->plugins[ $slug ]['file_path']; |
||
| 877 | $skin = new Plugin_Upgrader_Skin( $skin_args ); |
||
| 878 | } else { |
||
| 879 | $skin = new Plugin_Installer_Skin( $skin_args ); |
||
| 880 | } |
||
| 881 | |||
| 882 | // Create a new instance of Plugin_Upgrader. |
||
| 883 | $upgrader = new Plugin_Upgrader( $skin ); |
||
| 884 | |||
| 885 | // Perform the action and install the plugin from the $source urldecode(). |
||
| 886 | add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 ); |
||
| 887 | |||
| 888 | if ( 'update' === $install_type ) { |
||
| 889 | // Inject our info into the update transient. |
||
| 890 | $to_inject = array( $slug => $this->plugins[ $slug ] ); |
||
| 891 | $to_inject[ $slug ]['source'] = $source; |
||
| 892 | $this->inject_update_info( $to_inject ); |
||
| 893 | |||
| 894 | $upgrader->upgrade( $this->plugins[ $slug ]['file_path'] ); |
||
| 895 | } else { |
||
| 896 | $upgrader->install( $source ); |
||
| 897 | } |
||
| 898 | |||
| 899 | remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 ); |
||
| 900 | |||
| 901 | // Make sure we have the correct file path now the plugin is installed/updated. |
||
| 902 | $this->populate_file_path( $slug ); |
||
| 903 | |||
| 904 | // Only activate plugins if the config option is set to true and the plugin isn't |
||
| 905 | // already active (upgrade). |
||
| 906 | if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) { |
||
| 907 | $plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method. |
||
| 908 | if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) { |
||
| 909 | return true; // Finish execution of the function early as we encountered an error. |
||
| 910 | } |
||
| 911 | } |
||
| 912 | |||
| 913 | $this->show_tgmpa_version(); |
||
| 914 | |||
| 915 | // Display message based on if all plugins are now active or not. |
||
| 916 | if ( $this->is_tgmpa_complete() ) { |
||
| 917 | echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>'; |
||
| 918 | echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>'; |
||
| 919 | } else { |
||
| 920 | echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>'; |
||
| 921 | } |
||
| 922 | |||
| 923 | return true; |
||
| 924 | } elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) { |
||
| 925 | // Activate action link was clicked. |
||
| 926 | check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' ); |
||
| 927 | |||
| 928 | if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) { |
||
| 929 | return true; // Finish execution of the function early as we encountered an error. |
||
| 930 | } |
||
| 931 | } |
||
| 932 | |||
| 933 | return false; |
||
| 934 | } |
||
| 935 | |||
| 936 | /** |
||
| 937 | * Inject information into the 'update_plugins' site transient as WP checks that before running an update. |
||
| 938 | * |
||
| 939 | * @since 2.5.0 |
||
| 940 | * |
||
| 941 | * @param array $plugins The plugin information for the plugins which are to be updated. |
||
| 942 | */ |
||
| 943 | public function inject_update_info( $plugins ) { |
||
| 969 | |||
| 970 | /** |
||
| 971 | * Adjust the plugin directory name if necessary. |
||
| 972 | * |
||
| 973 | * The final destination directory of a plugin is based on the subdirectory name found in the |
||
| 974 | * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this |
||
| 975 | * subdirectory name is not the same as the expected slug and the plugin will not be recognized |
||
| 976 | * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to |
||
| 977 | * the expected plugin slug. |
||
| 978 | * |
||
| 979 | * @since 2.5.0 |
||
| 980 | * |
||
| 981 | * @param string $source Path to upgrade/zip-file-name.tmp/subdirectory/. |
||
| 982 | * @param string $remote_source Path to upgrade/zip-file-name.tmp. |
||
| 983 | * @param \WP_Upgrader $upgrader Instance of the upgrader which installs the plugin. |
||
| 984 | * @return string $source |
||
| 985 | */ |
||
| 986 | public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) { |
||
| 987 | if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) { |
||
| 988 | return $source; |
||
| 989 | } |
||
| 990 | |||
| 991 | // Check for single file plugins. |
||
| 992 | $source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) ); |
||
| 993 | if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) { |
||
| 994 | return $source; |
||
| 995 | } |
||
| 996 | |||
| 997 | // Multi-file plugin, let's see if the directory is correctly named. |
||
| 998 | $desired_slug = ''; |
||
| 999 | |||
| 1000 | // Figure out what the slug is supposed to be. |
||
| 1001 | if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) { |
||
| 1002 | $desired_slug = $upgrader->skin->options['extra']['slug']; |
||
| 1003 | } else { |
||
| 1004 | // Bulk installer contains less info, so fall back on the info registered here. |
||
| 1005 | foreach ( $this->plugins as $slug => $plugin ) { |
||
| 1006 | if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) { |
||
| 1007 | $desired_slug = $slug; |
||
| 1008 | break; |
||
| 1009 | } |
||
| 1010 | } |
||
| 1011 | unset( $slug, $plugin ); |
||
| 1012 | } |
||
| 1013 | |||
| 1014 | if ( ! empty( $desired_slug ) ) { |
||
| 1015 | $subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) ); |
||
| 1016 | |||
| 1017 | if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) { |
||
| 1018 | $from_path = untrailingslashit( $source ); |
||
| 1019 | $to_path = trailingslashit( $remote_source ) . $desired_slug; |
||
| 1020 | |||
| 1021 | if ( true === $GLOBALS['wp_filesystem']->move( $from_path, $to_path ) ) { |
||
| 1022 | return trailingslashit( $to_path ); |
||
| 1023 | View Code Duplication | } else { |
|
| 1024 | return new WP_Error( 'rename_failed', esc_html__( 'The remote plugin package does not contain a folder with the desired slug and renaming did not work.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) ); |
||
| 1025 | } |
||
| 1026 | View Code Duplication | } elseif ( empty( $subdir_name ) ) { |
|
| 1027 | return new WP_Error( 'packaged_wrong', esc_html__( 'The remote plugin package consists of more than one file, but the files are not packaged in a folder.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) ); |
||
| 1028 | } |
||
| 1029 | } |
||
| 1030 | |||
| 1031 | return $source; |
||
| 1032 | } |
||
| 1033 | |||
| 1034 | /** |
||
| 1035 | * Activate a single plugin and send feedback about the result to the screen. |
||
| 1036 | * |
||
| 1037 | * @since 2.5.0 |
||
| 1038 | * |
||
| 1039 | * @param string $file_path Path within wp-plugins/ to main plugin file. |
||
| 1040 | * @param string $slug Plugin slug. |
||
| 1041 | * @param bool $automatic Whether this is an automatic activation after an install. Defaults to false. |
||
| 1042 | * This determines the styling of the output messages. |
||
| 1043 | * @return bool False if an error was encountered, true otherwise. |
||
| 1044 | */ |
||
| 1045 | protected function activate_single_plugin( $file_path, $slug, $automatic = false ) { |
||
| 1046 | if ( $this->can_plugin_activate( $slug ) ) { |
||
| 1047 | $activate = activate_plugin( $file_path ); |
||
| 1048 | |||
| 1049 | if ( is_wp_error( $activate ) ) { |
||
| 1050 | echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>', |
||
| 1051 | '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>'; |
||
| 1052 | |||
| 1053 | return false; // End it here if there is an error with activation. |
||
| 1054 | } else { |
||
| 1055 | if ( ! $automatic ) { |
||
| 1056 | // Make sure message doesn't display again if bulk activation is performed |
||
| 1057 | // immediately after a single activation. |
||
| 1058 | if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK. |
||
| 1059 | echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>'; |
||
| 1060 | } |
||
| 1061 | } else { |
||
| 1062 | // Simpler message layout for use on the plugin install page. |
||
| 1063 | echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>'; |
||
| 1064 | } |
||
| 1065 | } |
||
| 1066 | View Code Duplication | } elseif ( $this->is_plugin_active( $slug ) ) { |
|
| 1067 | // No simpler message format provided as this message should never be encountered |
||
| 1068 | // on the plugin install page. |
||
| 1069 | echo '<div id="message" class="error"><p>', |
||
| 1070 | sprintf( |
||
| 1071 | esc_html( $this->strings['plugin_already_active'] ), |
||
| 1072 | '<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>' |
||
| 1073 | ), |
||
| 1074 | '</p></div>'; |
||
| 1075 | } elseif ( $this->does_plugin_require_update( $slug ) ) { |
||
| 1076 | if ( ! $automatic ) { |
||
| 1077 | // Make sure message doesn't display again if bulk activation is performed |
||
| 1078 | // immediately after a single activation. |
||
| 1079 | View Code Duplication | if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK. |
|
| 1080 | echo '<div id="message" class="error"><p>', |
||
| 1081 | sprintf( |
||
| 1082 | esc_html( $this->strings['plugin_needs_higher_version'] ), |
||
| 1083 | '<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>' |
||
| 1084 | ), |
||
| 1085 | '</p></div>'; |
||
| 1086 | } |
||
| 1087 | } else { |
||
| 1088 | // Simpler message layout for use on the plugin install page. |
||
| 1089 | echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>'; |
||
| 1090 | } |
||
| 1091 | } |
||
| 1092 | |||
| 1093 | return true; |
||
| 1094 | } |
||
| 1095 | |||
| 1096 | /** |
||
| 1097 | * Echoes required plugin notice. |
||
| 1098 | * |
||
| 1099 | * Outputs a message telling users that a specific plugin is required for |
||
| 1100 | * their theme. If appropriate, it includes a link to the form page where |
||
| 1101 | * users can install and activate the plugin. |
||
| 1102 | * |
||
| 1103 | * Returns early if we're on the Install page. |
||
| 1104 | * |
||
| 1105 | * @since 1.0.0 |
||
| 1106 | * |
||
| 1107 | * @global object $current_screen |
||
| 1108 | * |
||
| 1109 | * @return null Returns early if we're on the Install page. |
||
| 1110 | */ |
||
| 1111 | public function notices() { |
||
| 1112 | // Remove nag on the install page / Return early if the nag message has been dismissed or user < author. |
||
| 1113 | if ( ( $this->is_tgmpa_page() || $this->is_core_update_page() ) || get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) || ! current_user_can( apply_filters( 'tgmpa_show_admin_notice_capability', 'publish_posts' ) ) ) { |
||
| 1114 | return; |
||
| 1115 | } |
||
| 1116 | |||
| 1117 | // Store for the plugin slugs by message type. |
||
| 1118 | $message = array(); |
||
| 1119 | |||
| 1120 | // Initialize counters used to determine plurality of action link texts. |
||
| 1121 | $install_link_count = 0; |
||
| 1122 | $update_link_count = 0; |
||
| 1123 | $activate_link_count = 0; |
||
| 1124 | $total_required_action_count = 0; |
||
| 1125 | |||
| 1126 | foreach ( $this->plugins as $slug => $plugin ) { |
||
| 1127 | if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) { |
||
| 1128 | continue; |
||
| 1129 | } |
||
| 1130 | |||
| 1131 | if ( ! $this->is_plugin_installed( $slug ) ) { |
||
| 1132 | if ( current_user_can( 'install_plugins' ) ) { |
||
| 1133 | $install_link_count++; |
||
| 1134 | |||
| 1135 | if ( true === $plugin['required'] ) { |
||
| 1136 | $message['notice_can_install_required'][] = $slug; |
||
| 1137 | } else { |
||
| 1138 | $message['notice_can_install_recommended'][] = $slug; |
||
| 1139 | } |
||
| 1140 | } |
||
| 1141 | if ( true === $plugin['required'] ) { |
||
| 1142 | $total_required_action_count++; |
||
| 1143 | } |
||
| 1144 | } else { |
||
| 1145 | if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) { |
||
| 1146 | if ( current_user_can( 'activate_plugins' ) ) { |
||
| 1147 | $activate_link_count++; |
||
| 1148 | |||
| 1149 | if ( true === $plugin['required'] ) { |
||
| 1150 | $message['notice_can_activate_required'][] = $slug; |
||
| 1151 | } else { |
||
| 1152 | $message['notice_can_activate_recommended'][] = $slug; |
||
| 1153 | } |
||
| 1154 | } |
||
| 1155 | if ( true === $plugin['required'] ) { |
||
| 1156 | $total_required_action_count++; |
||
| 1157 | } |
||
| 1158 | } |
||
| 1159 | |||
| 1160 | if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) { |
||
| 1161 | |||
| 1162 | if ( current_user_can( 'update_plugins' ) ) { |
||
| 1163 | $update_link_count++; |
||
| 1164 | |||
| 1165 | if ( $this->does_plugin_require_update( $slug ) ) { |
||
| 1166 | $message['notice_ask_to_update'][] = $slug; |
||
| 1167 | } elseif ( false !== $this->does_plugin_have_update( $slug ) ) { |
||
| 1168 | $message['notice_ask_to_update_maybe'][] = $slug; |
||
| 1169 | } |
||
| 1170 | } |
||
| 1171 | if ( true === $plugin['required'] ) { |
||
| 1172 | $total_required_action_count++; |
||
| 1173 | } |
||
| 1174 | } |
||
| 1175 | } |
||
| 1176 | } |
||
| 1177 | unset( $slug, $plugin ); |
||
| 1178 | |||
| 1179 | // If we have notices to display, we move forward. |
||
| 1180 | if ( ! empty( $message ) || $total_required_action_count > 0 ) { |
||
| 1181 | krsort( $message ); // Sort messages. |
||
| 1182 | $rendered = ''; |
||
| 1183 | |||
| 1184 | // As add_settings_error() wraps the final message in a <p> and as the final message can't be |
||
| 1185 | // filtered, using <p>'s in our html would render invalid html output. |
||
| 1186 | $line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n"; |
||
| 1187 | |||
| 1188 | if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) { |
||
| 1189 | $rendered = esc_html__( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html__( $this->strings['contact_admin'] ); |
||
| 1190 | $rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template ); |
||
| 1191 | } else { |
||
| 1192 | |||
| 1193 | // If dismissable is false and a message is set, output it now. |
||
| 1194 | if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) { |
||
| 1195 | $rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) ); |
||
| 1196 | } |
||
| 1197 | |||
| 1198 | // Render the individual message lines for the notice. |
||
| 1199 | foreach ( $message as $type => $plugin_group ) { |
||
| 1200 | $linked_plugins = array(); |
||
| 1201 | |||
| 1202 | // Get the external info link for a plugin if one is available. |
||
| 1203 | foreach ( $plugin_group as $plugin_slug ) { |
||
| 1204 | $linked_plugins[] = $this->get_info_link( $plugin_slug ); |
||
| 1205 | } |
||
| 1206 | unset( $plugin_slug ); |
||
| 1207 | |||
| 1208 | $count = count( $plugin_group ); |
||
| 1209 | $linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins ); |
||
| 1210 | $last_plugin = array_pop( $linked_plugins ); // Pop off last name to prep for readability. |
||
| 1211 | $imploded = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin ); |
||
| 1212 | |||
| 1213 | $rendered .= sprintf( |
||
| 1214 | $line_template, |
||
| 1215 | sprintf( |
||
| 1216 | translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ), |
||
| 1217 | $imploded, |
||
| 1218 | $count |
||
| 1219 | ) |
||
| 1220 | ); |
||
| 1221 | |||
| 1222 | } |
||
| 1223 | unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded ); |
||
| 1224 | |||
| 1225 | $rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template ); |
||
| 1226 | } |
||
| 1227 | |||
| 1228 | // Register the nag messages and prepare them to be processed. |
||
| 1229 | add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() ); |
||
| 1230 | } |
||
| 1231 | |||
| 1232 | // Admin options pages already output settings_errors, so this is to avoid duplication. |
||
| 1233 | if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) { |
||
| 1234 | $this->display_settings_errors(); |
||
| 1235 | } |
||
| 1236 | } |
||
| 1237 | |||
| 1238 | /** |
||
| 1239 | * Generate the user action links for the admin notice. |
||
| 1240 | * |
||
| 1241 | * @since 2.x.x |
||
| 1242 | * |
||
| 1243 | * @param int $install_count Number of plugins to install. |
||
| 1244 | * @param int $update_count Number of plugins to update. |
||
| 1245 | * @param int $activate_count Number of plugins to activate. |
||
| 1246 | * @param int $line_template Template for the HTML tag to output a line. |
||
| 1247 | * @return string Action links. |
||
| 1248 | */ |
||
| 1249 | protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) { |
||
| 1296 | |||
| 1297 | /** |
||
| 1298 | * Get admin notice class. |
||
| 1299 | * |
||
| 1300 | * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7 |
||
| 1301 | * (lowest supported version by TGMPA). |
||
| 1302 | * |
||
| 1303 | * @since 2.x.x |
||
| 1304 | * |
||
| 1305 | * @return string |
||
| 1306 | */ |
||
| 1307 | protected function get_admin_notice_class() { |
||
| 1320 | |||
| 1321 | /** |
||
| 1322 | * Display settings errors and remove those which have been displayed to avoid duplicate messages showing |
||
| 1323 | * |
||
| 1324 | * @since 2.5.0 |
||
| 1325 | */ |
||
| 1326 | protected function display_settings_errors() { |
||
| 1338 | |||
| 1339 | /** |
||
| 1340 | * Register dismissal of admin notices. |
||
| 1341 | * |
||
| 1342 | * Acts on the dismiss link in the admin nag messages. |
||
| 1343 | * If clicked, the admin notice disappears and will no longer be visible to this user. |
||
| 1344 | * |
||
| 1345 | * @since 2.1.0 |
||
| 1346 | */ |
||
| 1347 | public function dismiss() { |
||
| 1352 | |||
| 1353 | /** |
||
| 1354 | * Add individual plugin to our collection of plugins. |
||
| 1355 | * |
||
| 1356 | * If the required keys are not set or the plugin has already |
||
| 1357 | * been registered, the plugin is not added. |
||
| 1358 | * |
||
| 1359 | * @since 2.0.0 |
||
| 1360 | * |
||
| 1361 | * @param array|null $plugin Array of plugin arguments or null if invalid argument. |
||
| 1362 | * @return null Return early if incorrect argument. |
||
| 1363 | */ |
||
| 1364 | public function register( $plugin ) { |
||
| 1365 | if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) { |
||
| 1366 | return; |
||
| 1367 | } |
||
| 1368 | |||
| 1369 | if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) { |
||
| 1370 | return; |
||
| 1371 | } |
||
| 1372 | |||
| 1373 | $defaults = array( |
||
| 1374 | 'name' => '', // String |
||
| 1375 | 'slug' => '', // String |
||
| 1376 | 'source' => 'repo', // String |
||
| 1377 | 'required' => false, // Boolean |
||
| 1378 | 'version' => '', // String |
||
| 1379 | 'force_activation' => false, // Boolean |
||
| 1380 | 'force_deactivation' => false, // Boolean |
||
| 1381 | 'external_url' => '', // String |
||
| 1382 | 'is_callable' => '', // String|Array. |
||
| 1383 | ); |
||
| 1384 | |||
| 1385 | // Prepare the received data. |
||
| 1386 | $plugin = wp_parse_args( $plugin, $defaults ); |
||
| 1387 | |||
| 1388 | // Standardize the received slug. |
||
| 1389 | $plugin['slug'] = $this->sanitize_key( $plugin['slug'] ); |
||
| 1390 | |||
| 1391 | // Forgive users for using string versions of booleans or floats for version number. |
||
| 1392 | $plugin['version'] = (string) $plugin['version']; |
||
| 1393 | $plugin['source'] = empty( $plugin['source'] ) ? 'repo' : $plugin['source']; |
||
| 1394 | $plugin['required'] = TGMPA_Utils::validate_bool( $plugin['required'] ); |
||
| 1395 | $plugin['force_activation'] = TGMPA_Utils::validate_bool( $plugin['force_activation'] ); |
||
| 1396 | $plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] ); |
||
| 1397 | |||
| 1398 | // Enrich the received data. |
||
| 1399 | $plugin['file_path'] = $this->_get_plugin_basename_from_slug( $plugin['slug'] ); |
||
| 1400 | $plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] ); |
||
| 1401 | |||
| 1402 | // Set the class properties. |
||
| 1403 | $this->plugins[ $plugin['slug'] ] = $plugin; |
||
| 1404 | $this->sort_order[ $plugin['slug'] ] = $plugin['name']; |
||
| 1405 | |||
| 1406 | // Should we add the force activation hook ? |
||
| 1407 | if ( true === $plugin['force_activation'] ) { |
||
| 1408 | $this->has_forced_activation = true; |
||
| 1409 | } |
||
| 1410 | |||
| 1411 | // Should we add the force deactivation hook ? |
||
| 1412 | if ( true === $plugin['force_deactivation'] ) { |
||
| 1413 | $this->has_forced_deactivation = true; |
||
| 1414 | } |
||
| 1415 | } |
||
| 1416 | |||
| 1417 | /** |
||
| 1418 | * Determine what type of source the plugin comes from. |
||
| 1419 | * |
||
| 1420 | * @since 2.5.0 |
||
| 1421 | * |
||
| 1422 | * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path |
||
| 1423 | * (= bundled) or an external URL. |
||
| 1424 | * @return string 'repo', 'external', or 'bundled' |
||
| 1425 | */ |
||
| 1426 | protected function get_plugin_source_type( $source ) { |
||
| 1435 | |||
| 1436 | /** |
||
| 1437 | * Sanitizes a string key. |
||
| 1438 | * |
||
| 1439 | * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are* |
||
| 1440 | * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase |
||
| 1441 | * characters in the plugin directory path/slug. Silly them. |
||
| 1442 | * |
||
| 1443 | * @see https://developer.wordpress.org/reference/hooks/sanitize_key/ |
||
| 1444 | * |
||
| 1445 | * @since 2.5.0 |
||
| 1446 | * |
||
| 1447 | * @param string $key String key. |
||
| 1448 | * @return string Sanitized key |
||
| 1449 | */ |
||
| 1450 | public function sanitize_key( $key ) { |
||
| 1464 | |||
| 1465 | /** |
||
| 1466 | * Amend default configuration settings. |
||
| 1467 | * |
||
| 1468 | * @since 2.0.0 |
||
| 1469 | * |
||
| 1470 | * @param array $config Array of config options to pass as class properties. |
||
| 1471 | */ |
||
| 1472 | public function config( $config ) { |
||
| 1497 | |||
| 1498 | /** |
||
| 1499 | * Amend action link after plugin installation. |
||
| 1500 | * |
||
| 1501 | * @since 2.0.0 |
||
| 1502 | * |
||
| 1503 | * @param array $install_actions Existing array of actions. |
||
| 1504 | * @return false|array Amended array of actions. |
||
| 1505 | */ |
||
| 1506 | public function actions( $install_actions ) { |
||
| 1514 | |||
| 1515 | /** |
||
| 1516 | * Flushes the plugins cache on theme switch to prevent stale entries |
||
| 1517 | * from remaining in the plugin table. |
||
| 1518 | * |
||
| 1519 | * @since 2.4.0 |
||
| 1520 | * |
||
| 1521 | * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache. |
||
| 1522 | * Parameter added in v2.5.0. |
||
| 1523 | */ |
||
| 1524 | public function flush_plugins_cache( $clear_update_cache = true ) { |
||
| 1527 | |||
| 1528 | /** |
||
| 1529 | * Set file_path key for each installed plugin. |
||
| 1530 | * |
||
| 1531 | * @since 2.1.0 |
||
| 1532 | * |
||
| 1533 | * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin. |
||
| 1534 | * Parameter added in v2.5.0. |
||
| 1535 | */ |
||
| 1536 | public function populate_file_path( $plugin_slug = '' ) { |
||
| 1546 | |||
| 1547 | /** |
||
| 1548 | * Helper function to extract the file path of the plugin file from the |
||
| 1549 | * plugin slug, if the plugin is installed. |
||
| 1550 | * |
||
| 1551 | * @since 2.0.0 |
||
| 1552 | * |
||
| 1553 | * @param string $slug Plugin slug (typically folder name) as provided by the developer. |
||
| 1554 | * @return string Either file path for plugin if installed, or just the plugin slug. |
||
| 1555 | */ |
||
| 1556 | protected function _get_plugin_basename_from_slug( $slug ) { |
||
| 1567 | |||
| 1568 | /** |
||
| 1569 | * Retrieve plugin data, given the plugin name. |
||
| 1570 | * |
||
| 1571 | * Loops through the registered plugins looking for $name. If it finds it, |
||
| 1572 | * it returns the $data from that plugin. Otherwise, returns false. |
||
| 1573 | * |
||
| 1574 | * @since 2.1.0 |
||
| 1575 | * |
||
| 1576 | * @param string $name Name of the plugin, as it was registered. |
||
| 1577 | * @param string $data Optional. Array key of plugin data to return. Default is slug. |
||
| 1578 | * @return string|boolean Plugin slug if found, false otherwise. |
||
| 1579 | */ |
||
| 1580 | public function _get_plugin_data_from_name( $name, $data = 'slug' ) { |
||
| 1581 | foreach ( $this->plugins as $values ) { |
||
| 1582 | if ( $name === $values['name'] && isset( $values[ $data ] ) ) { |
||
| 1583 | return $values[ $data ]; |
||
| 1584 | } |
||
| 1585 | } |
||
| 1586 | |||
| 1587 | return false; |
||
| 1588 | } |
||
| 1589 | |||
| 1590 | /** |
||
| 1591 | * Retrieve the download URL for a package. |
||
| 1592 | * |
||
| 1593 | * @since 2.5.0 |
||
| 1594 | * |
||
| 1595 | * @param string $slug Plugin slug. |
||
| 1596 | * @return string Plugin download URL or path to local file or empty string if undetermined. |
||
| 1597 | */ |
||
| 1598 | public function get_download_url( $slug ) { |
||
| 1599 | $dl_source = ''; |
||
| 1600 | |||
| 1601 | switch ( $this->plugins[ $slug ]['source_type'] ) { |
||
| 1602 | case 'repo': |
||
| 1603 | return $this->get_wp_repo_download_url( $slug ); |
||
| 1604 | case 'external': |
||
| 1605 | return $this->plugins[ $slug ]['source']; |
||
| 1606 | case 'bundled': |
||
| 1607 | return $this->default_path . $this->plugins[ $slug ]['source']; |
||
| 1608 | } |
||
| 1609 | |||
| 1610 | return $dl_source; // Should never happen. |
||
| 1611 | } |
||
| 1612 | |||
| 1613 | /** |
||
| 1614 | * Retrieve the download URL for a WP repo package. |
||
| 1615 | * |
||
| 1616 | * @since 2.5.0 |
||
| 1617 | * |
||
| 1618 | * @param string $slug Plugin slug. |
||
| 1619 | * @return string Plugin download URL. |
||
| 1620 | */ |
||
| 1621 | protected function get_wp_repo_download_url( $slug ) { |
||
| 1622 | $source = ''; |
||
| 1623 | $api = $this->get_plugins_api( $slug ); |
||
| 1624 | |||
| 1625 | if ( false !== $api && isset( $api->download_link ) ) { |
||
| 1626 | $source = $api->download_link; |
||
| 1627 | } |
||
| 1628 | |||
| 1629 | return $source; |
||
| 1630 | } |
||
| 1631 | |||
| 1632 | /** |
||
| 1633 | * Try to grab information from WordPress API. |
||
| 1634 | * |
||
| 1635 | * @since 2.5.0 |
||
| 1636 | * |
||
| 1637 | * @param string $slug Plugin slug. |
||
| 1638 | * @return object Plugins_api response object on success, WP_Error on failure. |
||
| 1639 | */ |
||
| 1640 | protected function get_plugins_api( $slug ) { |
||
| 1661 | |||
| 1662 | /** |
||
| 1663 | * Retrieve a link to a plugin information page. |
||
| 1664 | * |
||
| 1665 | * @since 2.5.0 |
||
| 1666 | * |
||
| 1667 | * @param string $slug Plugin slug. |
||
| 1668 | * @return string Fully formed html link to a plugin information page if available |
||
| 1669 | * or the plugin name if not. |
||
| 1670 | */ |
||
| 1671 | public function get_info_link( $slug ) { |
||
| 1672 | if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) { |
||
| 1673 | $link = sprintf( |
||
| 1674 | '<a href="%1$s" target="_blank">%2$s</a>', |
||
| 1675 | esc_url( $this->plugins[ $slug ]['external_url'] ), |
||
| 1676 | esc_html( $this->plugins[ $slug ]['name'] ) |
||
| 1677 | ); |
||
| 1678 | } elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) { |
||
| 1679 | $url = add_query_arg( |
||
| 1680 | array( |
||
| 1681 | 'tab' => 'plugin-information', |
||
| 1682 | 'plugin' => urlencode( $slug ), |
||
| 1683 | 'TB_iframe' => 'true', |
||
| 1684 | 'width' => '640', |
||
| 1685 | 'height' => '500', |
||
| 1686 | ), |
||
| 1687 | self_admin_url( 'plugin-install.php' ) |
||
| 1688 | ); |
||
| 1689 | |||
| 1690 | $link = sprintf( |
||
| 1691 | '<a href="%1$s" class="thickbox">%2$s</a>', |
||
| 1692 | esc_url( $url ), |
||
| 1693 | esc_html( $this->plugins[ $slug ]['name'] ) |
||
| 1694 | ); |
||
| 1695 | } else { |
||
| 1696 | $link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink. |
||
| 1697 | } |
||
| 1698 | |||
| 1699 | return $link; |
||
| 1700 | } |
||
| 1701 | |||
| 1702 | /** |
||
| 1703 | * Determine if we're on the TGMPA Install page. |
||
| 1704 | * |
||
| 1705 | * @since 2.1.0 |
||
| 1706 | * |
||
| 1707 | * @return boolean True when on the TGMPA page, false otherwise. |
||
| 1708 | */ |
||
| 1709 | protected function is_tgmpa_page() { |
||
| 1712 | |||
| 1713 | /** |
||
| 1714 | * Determine if we're on a WP Core installation/upgrade page. |
||
| 1715 | * |
||
| 1716 | * @since 2.x.x |
||
| 1717 | * |
||
| 1718 | * @return boolean True when on a WP Core installation/upgrade page, false otherwise. |
||
| 1719 | */ |
||
| 1720 | protected function is_core_update_page() { |
||
| 1741 | |||
| 1742 | /** |
||
| 1743 | * Retrieve the URL to the TGMPA Install page. |
||
| 1744 | * |
||
| 1745 | * I.e. depending on the config settings passed something along the lines of: |
||
| 1746 | * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins |
||
| 1747 | * |
||
| 1748 | * @since 2.5.0 |
||
| 1749 | * |
||
| 1750 | * @return string Properly encoded URL (not escaped). |
||
| 1751 | */ |
||
| 1752 | public function get_tgmpa_url() { |
||
| 1770 | |||
| 1771 | /** |
||
| 1772 | * Retrieve the URL to the TGMPA Install page for a specific plugin status (view). |
||
| 1773 | * |
||
| 1774 | * I.e. depending on the config settings passed something along the lines of: |
||
| 1775 | * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install |
||
| 1776 | * |
||
| 1777 | * @since 2.5.0 |
||
| 1778 | * |
||
| 1779 | * @param string $status Plugin status - either 'install', 'update' or 'activate'. |
||
| 1780 | * @return string Properly encoded URL (not escaped). |
||
| 1781 | */ |
||
| 1782 | public function get_tgmpa_status_url( $status ) { |
||
| 1790 | |||
| 1791 | /** |
||
| 1792 | * Determine whether there are open actions for plugins registered with TGMPA. |
||
| 1793 | * |
||
| 1794 | * @since 2.5.0 |
||
| 1795 | * |
||
| 1796 | * @return bool True if complete, i.e. no outstanding actions. False otherwise. |
||
| 1797 | */ |
||
| 1798 | public function is_tgmpa_complete() { |
||
| 1809 | |||
| 1810 | /** |
||
| 1811 | * Check if a plugin is installed. Does not take must-use plugins into account. |
||
| 1812 | * |
||
| 1813 | * @since 2.5.0 |
||
| 1814 | * |
||
| 1815 | * @param string $slug Plugin slug. |
||
| 1816 | * @return bool True if installed, false otherwise. |
||
| 1817 | */ |
||
| 1818 | public function is_plugin_installed( $slug ) { |
||
| 1823 | |||
| 1824 | /** |
||
| 1825 | * Check if a plugin is active. |
||
| 1826 | * |
||
| 1827 | * @since 2.5.0 |
||
| 1828 | * |
||
| 1829 | * @param string $slug Plugin slug. |
||
| 1830 | * @return bool True if active, false otherwise. |
||
| 1831 | */ |
||
| 1832 | public function is_plugin_active( $slug ) { |
||
| 1835 | |||
| 1836 | /** |
||
| 1837 | * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required |
||
| 1838 | * available, check whether the current install meets them. |
||
| 1839 | * |
||
| 1840 | * @since 2.5.0 |
||
| 1841 | * |
||
| 1842 | * @param string $slug Plugin slug. |
||
| 1843 | * @return bool True if OK to update, false otherwise. |
||
| 1844 | */ |
||
| 1845 | public function can_plugin_update( $slug ) { |
||
| 1860 | |||
| 1861 | /** |
||
| 1862 | * Check to see if the plugin is 'updatetable', i.e. installed, with an update available |
||
| 1863 | * and no WP version requirements blocking it. |
||
| 1864 | * |
||
| 1865 | * @since 2.x.x |
||
| 1866 | * |
||
| 1867 | * @param string $slug Plugin slug. |
||
| 1868 | * @return bool True if OK to proceed with update, false otherwise. |
||
| 1869 | */ |
||
| 1870 | public function is_plugin_updatetable( $slug ) { |
||
| 1877 | |||
| 1878 | /** |
||
| 1879 | * Check if a plugin can be activated, i.e. is not currently active and meets the minimum |
||
| 1880 | * plugin version requirements set in TGMPA (if any). |
||
| 1881 | * |
||
| 1882 | * @since 2.5.0 |
||
| 1883 | * |
||
| 1884 | * @param string $slug Plugin slug. |
||
| 1885 | * @return bool True if OK to activate, false otherwise. |
||
| 1886 | */ |
||
| 1887 | public function can_plugin_activate( $slug ) { |
||
| 1890 | |||
| 1891 | /** |
||
| 1892 | * Retrieve the version number of an installed plugin. |
||
| 1893 | * |
||
| 1894 | * @since 2.5.0 |
||
| 1895 | * |
||
| 1896 | * @param string $slug Plugin slug. |
||
| 1897 | * @return string Version number as string or an empty string if the plugin is not installed |
||
| 1898 | * or version unknown (plugins which don't comply with the plugin header standard). |
||
| 1899 | */ |
||
| 1900 | public function get_installed_version( $slug ) { |
||
| 1909 | |||
| 1910 | /** |
||
| 1911 | * Check whether a plugin complies with the minimum version requirements. |
||
| 1912 | * |
||
| 1913 | * @since 2.5.0 |
||
| 1914 | * |
||
| 1915 | * @param string $slug Plugin slug. |
||
| 1916 | * @return bool True when a plugin needs to be updated, otherwise false. |
||
| 1917 | */ |
||
| 1918 | public function does_plugin_require_update( $slug ) { |
||
| 1924 | |||
| 1925 | /** |
||
| 1926 | * Check whether there is an update available for a plugin. |
||
| 1927 | * |
||
| 1928 | * @since 2.5.0 |
||
| 1929 | * |
||
| 1930 | * @param string $slug Plugin slug. |
||
| 1931 | * @return false|string Version number string of the available update or false if no update available. |
||
| 1932 | */ |
||
| 1933 | public function does_plugin_have_update( $slug ) { |
||
| 1951 | |||
| 1952 | /** |
||
| 1953 | * Retrieve potential upgrade notice for a plugin. |
||
| 1954 | * |
||
| 1955 | * @since 2.5.0 |
||
| 1956 | * |
||
| 1957 | * @param string $slug Plugin slug. |
||
| 1958 | * @return string The upgrade notice or an empty string if no message was available or provided. |
||
| 1959 | */ |
||
| 1960 | public function get_upgrade_notice( $slug ) { |
||
| 1974 | |||
| 1975 | /** |
||
| 1976 | * Wrapper around the core WP get_plugins function, making sure it's actually available. |
||
| 1977 | * |
||
| 1978 | * @since 2.5.0 |
||
| 1979 | * |
||
| 1980 | * @param string $plugin_folder Optional. Relative path to single plugin folder. |
||
| 1981 | * @return array Array of installed plugins with plugin information. |
||
| 1982 | */ |
||
| 1983 | public function get_plugins( $plugin_folder = '' ) { |
||
| 1990 | |||
| 1991 | /** |
||
| 1992 | * Delete dismissable nag option when theme is switched. |
||
| 1993 | * |
||
| 1994 | * This ensures that the user(s) is/are again reminded via nag of required |
||
| 1995 | * and/or recommended plugins if they re-activate the theme. |
||
| 1996 | * |
||
| 1997 | * @since 2.1.1 |
||
| 1998 | */ |
||
| 1999 | public function update_dismiss() { |
||
| 2002 | |||
| 2003 | /** |
||
| 2004 | * Forces plugin activation if the parameter 'force_activation' is |
||
| 2005 | * set to true. |
||
| 2006 | * |
||
| 2007 | * This allows theme authors to specify certain plugins that must be |
||
| 2008 | * active at all times while using the current theme. |
||
| 2009 | * |
||
| 2010 | * Please take special care when using this parameter as it has the |
||
| 2011 | * potential to be harmful if not used correctly. Setting this parameter |
||
| 2012 | * to true will not allow the specified plugin to be deactivated unless |
||
| 2013 | * the user switches themes. |
||
| 2014 | * |
||
| 2015 | * @since 2.2.0 |
||
| 2016 | */ |
||
| 2017 | public function force_activation() { |
||
| 2030 | |||
| 2031 | /** |
||
| 2032 | * Forces plugin deactivation if the parameter 'force_deactivation' |
||
| 2033 | * is set to true and adds the plugin to the 'recently active' plugins list. |
||
| 2034 | * |
||
| 2035 | * This allows theme authors to specify certain plugins that must be |
||
| 2036 | * deactivated upon switching from the current theme to another. |
||
| 2037 | * |
||
| 2038 | * Please take special care when using this parameter as it has the |
||
| 2039 | * potential to be harmful if not used correctly. |
||
| 2040 | * |
||
| 2041 | * @since 2.2.0 |
||
| 2042 | */ |
||
| 2043 | public function force_deactivation() { |
||
| 2061 | |||
| 2062 | /** |
||
| 2063 | * Echo the current TGMPA version number to the page. |
||
| 2064 | */ |
||
| 2065 | public function show_tgmpa_version() { |
||
| 2076 | |||
| 2077 | /** |
||
| 2078 | * Returns the singleton instance of the class. |
||
| 2079 | * |
||
| 2080 | * @since 2.4.0 |
||
| 2081 | * |
||
| 2082 | * @return \TGM_Plugin_Activation The TGM_Plugin_Activation object. |
||
| 2083 | */ |
||
| 2084 | public static function get_instance() { |
||
| 2091 | } |
||
| 2092 | |||
| 2093 | if ( ! function_exists( 'load_tgm_plugin_activation' ) ) { |
||
| 2094 | /** |
||
| 2095 | * Ensure only one instance of the class is ever invoked. |
||
| 2096 | */ |
||
| 2097 | function load_tgm_plugin_activation() { |
||
| 2098 | $GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance(); |
||
| 2099 | } |
||
| 2100 | } |
||
| 2101 | |||
| 3837 |
Instead of relying on
globalstate, we recommend one of these alternatives:1. Pass all data via parameters
2. Create a class that maintains your state