| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress Plugin Administration API 4 * 5 * @package WordPress 6 * @subpackage Administration 7 */ 8 9 /** 10 * Parses the plugin contents to retrieve plugin's metadata. 11 * 12 * All plugin headers must be on their own line. Plugin description must not have 13 * any newlines, otherwise only parts of the description will be displayed. 14 * The below is formatted for printing. 15 * 16 * /* 17 * Plugin Name: Name of the plugin. 18 * Plugin URI: The home page of the plugin. 19 * Description: Plugin description. 20 * Author: Plugin author's name. 21 * Author URI: Link to the author's website. 22 * Version: Plugin version. 23 * Text Domain: Optional. Unique identifier, should be same as the one used in 24 * load_plugin_textdomain(). 25 * Domain Path: Optional. Only useful if the translations are located in a 26 * folder above the plugin's base path. For example, if .mo files are 27 * located in the locale folder then Domain Path will be "/locale/" and 28 * must have the first slash. Defaults to the base folder the plugin is 29 * located in. 30 * Network: Optional. Specify "Network: true" to require that a plugin is activated 31 * across all sites in an installation. This will prevent a plugin from being 32 * activated on a single site when Multisite is enabled. 33 * Requires at least: Optional. Specify the minimum required WordPress version. 34 * Requires PHP: Optional. Specify the minimum required PHP version. 35 * * / # Remove the space to close comment. 36 * 37 * The first 8 KB of the file will be pulled in and if the plugin data is not 38 * within that first 8 KB, then the plugin author should correct their plugin 39 * and move the plugin data headers to the top. 40 * 41 * The plugin file is assumed to have permissions to allow for scripts to read 42 * the file. This is not checked however and the file is only opened for 43 * reading. 44 * 45 * @since 1.5.0 46 * @since 5.3.0 Added support for `Requires at least` and `Requires PHP` headers. 47 * @since 5.8.0 Added support for `Update URI` header. 48 * @since 6.5.0 Added support for `Requires Plugins` header. 49 * 50 * @param string $plugin_file Absolute path to the main plugin file. 51 * @param bool $markup Optional. If the returned data should have HTML markup applied. 52 * Default true. 53 * @param bool $translate Optional. If the returned data should be translated. Default true. 54 * @return array { 55 * Plugin data. Values will be empty if not supplied by the plugin. 56 * 57 * @type string $Name Name of the plugin. Should be unique. 58 * @type string $PluginURI Plugin URI. 59 * @type string $Version Plugin version. 60 * @type string $Description Plugin description. 61 * @type string $Author Plugin author's name. 62 * @type string $AuthorURI Plugin author's website address (if set). 63 * @type string $TextDomain Plugin textdomain. 64 * @type string $DomainPath Plugin's relative directory path to .mo files. 65 * @type bool $Network Whether the plugin can only be activated network-wide. 66 * @type string $RequiresWP Minimum required version of WordPress. 67 * @type string $RequiresPHP Minimum required version of PHP. 68 * @type string $UpdateURI ID of the plugin for update purposes, should be a URI. 69 * @type string $RequiresPlugins Comma separated list of dot org plugin slugs. 70 * @type string $Title Title of the plugin and link to the plugin's site (if set). 71 * @type string $AuthorName Plugin author's name. 72 * } 73 */ 74 function get_plugin_data( $plugin_file, $markup = true, $translate = true ) { 75 76 $default_headers = array( 77 'Name' => 'Plugin Name', 78 'PluginURI' => 'Plugin URI', 79 'Version' => 'Version', 80 'Description' => 'Description', 81 'Author' => 'Author', 82 'AuthorURI' => 'Author URI', 83 'TextDomain' => 'Text Domain', 84 'DomainPath' => 'Domain Path', 85 'Network' => 'Network', 86 'RequiresWP' => 'Requires at least', 87 'RequiresPHP' => 'Requires PHP', 88 'UpdateURI' => 'Update URI', 89 'RequiresPlugins' => 'Requires Plugins', 90 // Site Wide Only is deprecated in favor of Network. 91 '_sitewide' => 'Site Wide Only', 92 ); 93 94 $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' ); 95 96 // Site Wide Only is the old header for Network. 97 if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) { 98 /* translators: 1: Site Wide Only: true, 2: Network: true */ 99 _deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), '<code>Site Wide Only: true</code>', '<code>Network: true</code>' ) ); 100 $plugin_data['Network'] = $plugin_data['_sitewide']; 101 } 102 $plugin_data['Network'] = ( 'true' === strtolower( $plugin_data['Network'] ) ); 103 unset( $plugin_data['_sitewide'] ); 104 105 // If no text domain is defined fall back to the plugin slug. 106 if ( ! $plugin_data['TextDomain'] ) { 107 $plugin_slug = dirname( plugin_basename( $plugin_file ) ); 108 if ( '.' !== $plugin_slug && ! str_contains( $plugin_slug, '/' ) ) { 109 $plugin_data['TextDomain'] = $plugin_slug; 110 } 111 } 112 113 if ( $markup || $translate ) { 114 $plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate ); 115 } else { 116 $plugin_data['Title'] = $plugin_data['Name']; 117 $plugin_data['AuthorName'] = $plugin_data['Author']; 118 } 119 120 return $plugin_data; 121 } 122 123 /** 124 * Sanitizes plugin data, optionally adds markup, optionally translates. 125 * 126 * @since 2.7.0 127 * 128 * @see get_plugin_data() 129 * 130 * @access private 131 * 132 * @param string $plugin_file Path to the main plugin file. 133 * @param array $plugin_data An array of plugin data. See get_plugin_data(). 134 * @param bool $markup Optional. If the returned data should have HTML markup applied. 135 * Default true. 136 * @param bool $translate Optional. If the returned data should be translated. Default true. 137 * @return array Plugin data. Values will be empty if not supplied by the plugin. 138 * See get_plugin_data() for the list of possible values. 139 */ 140 function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) { 141 142 // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path. 143 $plugin_file = plugin_basename( $plugin_file ); 144 145 // Translate fields. 146 if ( $translate ) { 147 $textdomain = $plugin_data['TextDomain']; 148 if ( $textdomain ) { 149 if ( ! is_textdomain_loaded( $textdomain ) ) { 150 if ( $plugin_data['DomainPath'] ) { 151 load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] ); 152 } else { 153 load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) ); 154 } 155 } 156 } elseif ( 'hello.php' === basename( $plugin_file ) ) { 157 $textdomain = 'default'; 158 } 159 if ( $textdomain ) { 160 foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field ) { 161 if ( ! empty( $plugin_data[ $field ] ) ) { 162 // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain 163 $plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain ); 164 } 165 } 166 } 167 } 168 169 // Sanitize fields. 170 $allowed_tags_in_links = array( 171 'abbr' => array( 'title' => true ), 172 'acronym' => array( 'title' => true ), 173 'code' => true, 174 'em' => true, 175 'strong' => true, 176 ); 177 178 $allowed_tags = $allowed_tags_in_links; 179 $allowed_tags['a'] = array( 180 'href' => true, 181 'title' => true, 182 ); 183 184 /* 185 * Name is marked up inside <a> tags. Don't allow these. 186 * Author is too, but some plugins have used <a> here (omitting Author URI). 187 */ 188 $plugin_data['Name'] = wp_kses( $plugin_data['Name'], $allowed_tags_in_links ); 189 $plugin_data['Author'] = wp_kses( $plugin_data['Author'], $allowed_tags ); 190 191 $plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags ); 192 $plugin_data['Version'] = wp_kses( $plugin_data['Version'], $allowed_tags ); 193 194 $plugin_data['PluginURI'] = esc_url( $plugin_data['PluginURI'] ); 195 $plugin_data['AuthorURI'] = esc_url( $plugin_data['AuthorURI'] ); 196 197 $plugin_data['Title'] = $plugin_data['Name']; 198 $plugin_data['AuthorName'] = $plugin_data['Author']; 199 200 // Apply markup. 201 if ( $markup ) { 202 if ( $plugin_data['PluginURI'] && $plugin_data['Name'] ) { 203 $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '">' . $plugin_data['Name'] . '</a>'; 204 } 205 206 if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] ) { 207 $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '">' . $plugin_data['Author'] . '</a>'; 208 } 209 210 $plugin_data['Description'] = wptexturize( $plugin_data['Description'] ); 211 212 if ( $plugin_data['Author'] ) { 213 $plugin_data['Description'] .= sprintf( 214 /* translators: %s: Plugin author. */ 215 ' <cite>' . __( 'By %s.' ) . '</cite>', 216 $plugin_data['Author'] 217 ); 218 } 219 } 220 221 return $plugin_data; 222 } 223 224 /** 225 * Gets a list of a plugin's files. 226 * 227 * @since 2.8.0 228 * 229 * @param string $plugin Path to the plugin file relative to the plugins directory. 230 * @return string[] Array of file names relative to the plugin root. 231 */ 232 function get_plugin_files( $plugin ) { 233 $plugin_file = WP_PLUGIN_DIR . '/' . $plugin; 234 $dir = dirname( $plugin_file ); 235 236 $plugin_files = array( plugin_basename( $plugin_file ) ); 237 238 if ( is_dir( $dir ) && WP_PLUGIN_DIR !== $dir ) { 239 240 /** 241 * Filters the array of excluded directories and files while scanning the folder. 242 * 243 * @since 4.9.0 244 * 245 * @param string[] $exclusions Array of excluded directories and files. 246 */ 247 $exclusions = (array) apply_filters( 'plugin_files_exclusions', array( 'CVS', 'node_modules', 'vendor', 'bower_components' ) ); 248 249 $list_files = list_files( $dir, 100, $exclusions ); 250 $list_files = array_map( 'plugin_basename', $list_files ); 251 252 $plugin_files = array_merge( $plugin_files, $list_files ); 253 $plugin_files = array_values( array_unique( $plugin_files ) ); 254 } 255 256 return $plugin_files; 257 } 258 259 /** 260 * Checks the plugins directory and retrieve all plugin files with plugin data. 261 * 262 * WordPress only supports plugin files in the base plugins directory 263 * (wp-content/plugins) and in one directory above the plugins directory 264 * (wp-content/plugins/my-plugin). The file it looks for has the plugin data 265 * and must be found in those two locations. It is recommended to keep your 266 * plugin files in their own directories. 267 * 268 * The file with the plugin data is the file that will be included and therefore 269 * needs to have the main execution for the plugin. This does not mean 270 * everything must be contained in the file and it is recommended that the file 271 * be split for maintainability. Keep everything in one file for extreme 272 * optimization purposes. 273 * 274 * @since 1.5.0 275 * 276 * @param string $plugin_folder Optional. Relative path to single plugin folder. 277 * @return array[] Array of arrays of plugin data, keyed by plugin file name. See get_plugin_data(). 278 */ 279 function get_plugins( $plugin_folder = '' ) { 280 281 $cache_plugins = wp_cache_get( 'plugins', 'plugins' ); 282 if ( ! $cache_plugins ) { 283 $cache_plugins = array(); 284 } 285 286 if ( isset( $cache_plugins[ $plugin_folder ] ) ) { 287 return $cache_plugins[ $plugin_folder ]; 288 } 289 290 $wp_plugins = array(); 291 $plugin_root = WP_PLUGIN_DIR; 292 if ( ! empty( $plugin_folder ) ) { 293 $plugin_root .= $plugin_folder; 294 } 295 296 // Files in wp-content/plugins directory. 297 $plugins_dir = @opendir( $plugin_root ); 298 $plugin_files = array(); 299 300 if ( $plugins_dir ) { 301 while ( ( $file = readdir( $plugins_dir ) ) !== false ) { 302 if ( str_starts_with( $file, '.' ) ) { 303 continue; 304 } 305 306 if ( is_dir( $plugin_root . '/' . $file ) ) { 307 $plugins_subdir = @opendir( $plugin_root . '/' . $file ); 308 309 if ( $plugins_subdir ) { 310 while ( ( $subfile = readdir( $plugins_subdir ) ) !== false ) { 311 if ( str_starts_with( $subfile, '.' ) ) { 312 continue; 313 } 314 315 if ( str_ends_with( $subfile, '.php' ) ) { 316 $plugin_files[] = "$file/$subfile"; 317 } 318 } 319 320 closedir( $plugins_subdir ); 321 } 322 } elseif ( str_ends_with( $file, '.php' ) ) { 323 $plugin_files[] = $file; 324 } 325 } 326 327 closedir( $plugins_dir ); 328 } 329 330 if ( empty( $plugin_files ) ) { 331 return $wp_plugins; 332 } 333 334 foreach ( $plugin_files as $plugin_file ) { 335 if ( ! is_readable( "$plugin_root/$plugin_file" ) ) { 336 continue; 337 } 338 339 // Do not apply markup/translate as it will be cached. 340 $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); 341 342 if ( empty( $plugin_data['Name'] ) ) { 343 continue; 344 } 345 346 $wp_plugins[ plugin_basename( $plugin_file ) ] = $plugin_data; 347 } 348 349 uasort( $wp_plugins, '_sort_uname_callback' ); 350 351 $cache_plugins[ $plugin_folder ] = $wp_plugins; 352 wp_cache_set( 'plugins', $cache_plugins, 'plugins' ); 353 354 return $wp_plugins; 355 } 356 357 /** 358 * Checks the mu-plugins directory and retrieve all mu-plugin files with any plugin data. 359 * 360 * WordPress only includes mu-plugin files in the base mu-plugins directory (wp-content/mu-plugins). 361 * 362 * @since 3.0.0 363 * @return array[] Array of arrays of mu-plugin data, keyed by plugin file name. See get_plugin_data(). 364 */ 365 function get_mu_plugins() { 366 $wp_plugins = array(); 367 $plugin_files = array(); 368 369 if ( ! is_dir( WPMU_PLUGIN_DIR ) ) { 370 return $wp_plugins; 371 } 372 373 // Files in wp-content/mu-plugins directory. 374 $plugins_dir = @opendir( WPMU_PLUGIN_DIR ); 375 if ( $plugins_dir ) { 376 while ( ( $file = readdir( $plugins_dir ) ) !== false ) { 377 if ( str_ends_with( $file, '.php' ) ) { 378 $plugin_files[] = $file; 379 } 380 } 381 } else { 382 return $wp_plugins; 383 } 384 385 closedir( $plugins_dir ); 386 387 if ( empty( $plugin_files ) ) { 388 return $wp_plugins; 389 } 390 391 foreach ( $plugin_files as $plugin_file ) { 392 if ( ! is_readable( WPMU_PLUGIN_DIR . "/$plugin_file" ) ) { 393 continue; 394 } 395 396 // Do not apply markup/translate as it will be cached. 397 $plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); 398 399 if ( empty( $plugin_data['Name'] ) ) { 400 $plugin_data['Name'] = $plugin_file; 401 } 402 403 $wp_plugins[ $plugin_file ] = $plugin_data; 404 } 405 406 if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php' ) <= 30 ) { 407 // Silence is golden. 408 unset( $wp_plugins['index.php'] ); 409 } 410 411 uasort( $wp_plugins, '_sort_uname_callback' ); 412 413 return $wp_plugins; 414 } 415 416 /** 417 * Declares a callback to sort array by a 'Name' key. 418 * 419 * @since 3.1.0 420 * 421 * @access private 422 * 423 * @param array $a array with 'Name' key. 424 * @param array $b array with 'Name' key. 425 * @return int Return 0 or 1 based on two string comparison. 426 */ 427 function _sort_uname_callback( $a, $b ) { 428 return strnatcasecmp( $a['Name'], $b['Name'] ); 429 } 430 431 /** 432 * Checks the wp-content directory and retrieve all drop-ins with any plugin data. 433 * 434 * @since 3.0.0 435 * @return array[] Array of arrays of dropin plugin data, keyed by plugin file name. See get_plugin_data(). 436 */ 437 function get_dropins() { 438 $dropins = array(); 439 $plugin_files = array(); 440 441 $_dropins = _get_dropins(); 442 443 // Files in wp-content directory. 444 $plugins_dir = @opendir( WP_CONTENT_DIR ); 445 if ( $plugins_dir ) { 446 while ( ( $file = readdir( $plugins_dir ) ) !== false ) { 447 if ( isset( $_dropins[ $file ] ) ) { 448 $plugin_files[] = $file; 449 } 450 } 451 } else { 452 return $dropins; 453 } 454 455 closedir( $plugins_dir ); 456 457 if ( empty( $plugin_files ) ) { 458 return $dropins; 459 } 460 461 foreach ( $plugin_files as $plugin_file ) { 462 if ( ! is_readable( WP_CONTENT_DIR . "/$plugin_file" ) ) { 463 continue; 464 } 465 466 // Do not apply markup/translate as it will be cached. 467 $plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); 468 469 if ( empty( $plugin_data['Name'] ) ) { 470 $plugin_data['Name'] = $plugin_file; 471 } 472 473 $dropins[ $plugin_file ] = $plugin_data; 474 } 475 476 uksort( $dropins, 'strnatcasecmp' ); 477 478 return $dropins; 479 } 480 481 /** 482 * Returns drop-in plugins that WordPress uses. 483 * 484 * Includes Multisite drop-ins only when is_multisite() 485 * 486 * @since 3.0.0 487 * 488 * @return array[] { 489 * Key is file name. The value is an array of data about the drop-in. 490 * 491 * @type array ...$0 { 492 * Data about the drop-in. 493 * 494 * @type string $0 The purpose of the drop-in. 495 * @type string|true $1 Name of the constant that must be true for the drop-in 496 * to be used, or true if no constant is required. 497 * } 498 * } 499 */ 500 function _get_dropins() { 501 $dropins = array( 502 'advanced-cache.php' => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE 503 'db.php' => array( __( 'Custom database class.' ), true ), // Auto on load. 504 'db-error.php' => array( __( 'Custom database error message.' ), true ), // Auto on error. 505 'install.php' => array( __( 'Custom installation script.' ), true ), // Auto on installation. 506 'maintenance.php' => array( __( 'Custom maintenance message.' ), true ), // Auto on maintenance. 507 'object-cache.php' => array( __( 'External object cache.' ), true ), // Auto on load. 508 'php-error.php' => array( __( 'Custom PHP error message.' ), true ), // Auto on error. 509 'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // Auto on error. 510 ); 511 512 if ( is_multisite() ) { 513 $dropins['sunrise.php'] = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE 514 $dropins['blog-deleted.php'] = array( __( 'Custom site deleted message.' ), true ); // Auto on deleted blog. 515 $dropins['blog-inactive.php'] = array( __( 'Custom site inactive message.' ), true ); // Auto on inactive blog. 516 $dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // Auto on archived or spammed blog. 517 } 518 519 return $dropins; 520 } 521 522 /** 523 * Determines whether a plugin is active. 524 * 525 * Only plugins installed in the plugins/ folder can be active. 526 * 527 * Plugins in the mu-plugins/ folder can't be "activated," so this function will 528 * return false for those plugins. 529 * 530 * For more information on this and similar theme functions, check out 531 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 532 * Conditional Tags} article in the Theme Developer Handbook. 533 * 534 * @since 2.5.0 535 * 536 * @param string $plugin Path to the plugin file relative to the plugins directory. 537 * @return bool True, if in the active plugins list. False, not in the list. 538 */ 539 function is_plugin_active( $plugin ) { 540 return in_array( $plugin, (array) get_option( 'active_plugins', array() ), true ) || is_plugin_active_for_network( $plugin ); 541 } 542 543 /** 544 * Determines whether the plugin is inactive. 545 * 546 * Reverse of is_plugin_active(). Used as a callback. 547 * 548 * For more information on this and similar theme functions, check out 549 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 550 * Conditional Tags} article in the Theme Developer Handbook. 551 * 552 * @since 3.1.0 553 * 554 * @see is_plugin_active() 555 * 556 * @param string $plugin Path to the plugin file relative to the plugins directory. 557 * @return bool True if inactive. False if active. 558 */ 559 function is_plugin_inactive( $plugin ) { 560 return ! is_plugin_active( $plugin ); 561 } 562 563 /** 564 * Determines whether the plugin is active for the entire network. 565 * 566 * Only plugins installed in the plugins/ folder can be active. 567 * 568 * Plugins in the mu-plugins/ folder can't be "activated," so this function will 569 * return false for those plugins. 570 * 571 * For more information on this and similar theme functions, check out 572 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 573 * Conditional Tags} article in the Theme Developer Handbook. 574 * 575 * @since 3.0.0 576 * 577 * @param string $plugin Path to the plugin file relative to the plugins directory. 578 * @return bool True if active for the network, otherwise false. 579 */ 580 function is_plugin_active_for_network( $plugin ) { 581 if ( ! is_multisite() ) { 582 return false; 583 } 584 585 $plugins = get_site_option( 'active_sitewide_plugins' ); 586 if ( isset( $plugins[ $plugin ] ) ) { 587 return true; 588 } 589 590 return false; 591 } 592 593 /** 594 * Checks for "Network: true" in the plugin header to see if this should 595 * be activated only as a network wide plugin. The plugin would also work 596 * when Multisite is not enabled. 597 * 598 * Checks for "Site Wide Only: true" for backward compatibility. 599 * 600 * @since 3.0.0 601 * @since 7.1.1 The `$plugin` path is normalized with `plugin_basename()` and `trim()`, 602 * matching how `activate_plugin()` resolves it. 603 * 604 * @param string $plugin Path to the plugin file. Accepts a path relative to the plugins 605 * directory, or an absolute path, with or without surrounding whitespace. 606 * @return bool True if plugin is network only, false otherwise. 607 */ 608 function is_network_only_plugin( $plugin ) { 609 // Normalize the path the same way activate_plugin() does, so both agree on the file. 610 $plugin = plugin_basename( trim( $plugin ) ); 611 612 $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin ); 613 if ( $plugin_data ) { 614 return $plugin_data['Network']; 615 } 616 return false; 617 } 618 619 /** 620 * Attempts activation of plugin in a "sandbox" and redirects on success. 621 * 622 * A plugin that is already activated will not attempt to be activated again. 623 * 624 * The way it works is by setting the redirection to the error before trying to 625 * include the plugin file. If the plugin fails, then the redirection will not 626 * be overwritten with the success message. Also, the options will not be 627 * updated and the activation hook will not be called on plugin error. 628 * 629 * It should be noted that in no way the below code will actually prevent errors 630 * within the file. The code should not be used elsewhere to replicate the 631 * "sandbox", which uses redirection to work. 632 * {@source 13 1} 633 * 634 * If any errors are found or text is outputted, then it will be captured to 635 * ensure that the success redirection will update the error redirection. 636 * 637 * @since 2.5.0 638 * @since 5.2.0 Test for WordPress version and PHP version compatibility. 639 * 640 * @param string $plugin Path to the plugin file relative to the plugins directory. 641 * @param string $redirect Optional. URL to redirect to. 642 * @param bool $network_wide Optional. Whether to enable the plugin for all sites in the network 643 * or just the current site. Multisite only. Default false. 644 * @param bool $silent Optional. Whether to prevent calling activation hooks. Default false. 645 * @return null|WP_Error Null on success, WP_Error on invalid file. 646 */ 647 function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) { 648 $plugin = plugin_basename( trim( $plugin ) ); 649 650 if ( is_multisite() && ( $network_wide || is_network_only_plugin( $plugin ) ) ) { 651 $network_wide = true; 652 $current = get_site_option( 'active_sitewide_plugins', array() ); 653 $_GET['networkwide'] = 1; // Back compat for plugins looking for this value. 654 } else { 655 $current = get_option( 'active_plugins', array() ); 656 } 657 658 $valid = validate_plugin( $plugin ); 659 if ( is_wp_error( $valid ) ) { 660 return $valid; 661 } 662 663 $requirements = validate_plugin_requirements( $plugin ); 664 if ( is_wp_error( $requirements ) ) { 665 return $requirements; 666 } 667 668 if ( $network_wide && ! isset( $current[ $plugin ] ) 669 || ! $network_wide && ! in_array( $plugin, $current, true ) 670 ) { 671 if ( ! empty( $redirect ) ) { 672 // We'll override this later if the plugin can be included without fatal error. 673 wp_redirect( add_query_arg( '_error_nonce', wp_create_nonce( 'plugin-activation-error_' . $plugin ), $redirect ) ); 674 } 675 676 ob_start(); 677 678 // Load the plugin to test whether it throws any errors. 679 plugin_sandbox_scrape( $plugin ); 680 681 if ( ! $silent ) { 682 /** 683 * Fires before a plugin is activated. 684 * 685 * If a plugin is silently activated (such as during an update), 686 * this hook does not fire. 687 * 688 * @since 2.9.0 689 * 690 * @param string $plugin Path to the plugin file relative to the plugins directory. 691 * @param bool $network_wide Whether to enable the plugin for all sites in the network 692 * or just the current site. Multisite only. Default false. 693 */ 694 do_action( 'activate_plugin', $plugin, $network_wide ); 695 696 /** 697 * Fires as a specific plugin is being activated. 698 * 699 * This hook is the "activation" hook used internally by register_activation_hook(). 700 * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename. 701 * 702 * If a plugin is silently activated (such as during an update), this hook does not fire. 703 * 704 * @since 2.0.0 705 * 706 * @param bool $network_wide Whether to enable the plugin for all sites in the network 707 * or just the current site. Multisite only. Default false. 708 */ 709 do_action( "activate_{$plugin}", $network_wide ); 710 } 711 712 if ( $network_wide ) { 713 $current = get_site_option( 'active_sitewide_plugins', array() ); 714 $current[ $plugin ] = time(); 715 update_site_option( 'active_sitewide_plugins', $current ); 716 } else { 717 $current = get_option( 'active_plugins', array() ); 718 $current[] = $plugin; 719 sort( $current ); 720 update_option( 'active_plugins', $current ); 721 } 722 723 if ( ! $silent ) { 724 /** 725 * Fires after a plugin has been activated. 726 * 727 * If a plugin is silently activated (such as during an update), 728 * this hook does not fire. 729 * 730 * @since 2.9.0 731 * 732 * @param string $plugin Path to the plugin file relative to the plugins directory. 733 * @param bool $network_wide Whether to enable the plugin for all sites in the network 734 * or just the current site. Multisite only. Default false. 735 */ 736 do_action( 'activated_plugin', $plugin, $network_wide ); 737 } 738 739 if ( ob_get_length() > 0 ) { 740 $output = ob_get_clean(); 741 return new WP_Error( 'unexpected_output', __( 'The plugin generated unexpected output.' ), $output ); 742 } 743 744 ob_end_clean(); 745 } 746 747 return null; 748 } 749 750 /** 751 * Deactivates a single plugin or multiple plugins. 752 * 753 * The deactivation hook is disabled by the plugin upgrader by using the $silent 754 * parameter. 755 * 756 * @since 2.5.0 757 * 758 * @param string|string[] $plugins Single plugin or list of plugins to deactivate. 759 * @param bool $silent Prevent calling deactivation hooks. Default false. 760 * @param bool|null $network_wide Whether to deactivate the plugin for all sites in the network. 761 * A value of null will deactivate plugins for both the network 762 * and the current site. Multisite only. Default null. 763 */ 764 function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) { 765 if ( is_multisite() ) { 766 $network_current = get_site_option( 'active_sitewide_plugins', array() ); 767 } 768 $current = get_option( 'active_plugins', array() ); 769 $do_blog = false; 770 $do_network = false; 771 772 foreach ( (array) $plugins as $plugin ) { 773 $plugin = plugin_basename( trim( $plugin ) ); 774 if ( ! is_plugin_active( $plugin ) ) { 775 continue; 776 } 777 778 $network_deactivating = ( false !== $network_wide ) && is_plugin_active_for_network( $plugin ); 779 780 if ( ! $silent ) { 781 /** 782 * Fires before a plugin is deactivated. 783 * 784 * If a plugin is silently deactivated (such as during an update), 785 * this hook does not fire. 786 * 787 * @since 2.9.0 788 * 789 * @param string $plugin Path to the plugin file relative to the plugins directory. 790 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network 791 * or just the current site. Multisite only. Default false. 792 */ 793 do_action( 'deactivate_plugin', $plugin, $network_deactivating ); 794 } 795 796 if ( false !== $network_wide ) { 797 if ( is_plugin_active_for_network( $plugin ) ) { 798 $do_network = true; 799 unset( $network_current[ $plugin ] ); 800 } elseif ( $network_wide ) { 801 continue; 802 } 803 } 804 805 if ( true !== $network_wide ) { 806 $key = array_search( $plugin, $current, true ); 807 if ( false !== $key ) { 808 $do_blog = true; 809 unset( $current[ $key ] ); 810 } 811 } 812 813 if ( $do_blog && wp_is_recovery_mode() ) { 814 list( $extension ) = explode( '/', $plugin ); 815 wp_paused_plugins()->delete( $extension ); 816 } 817 818 if ( ! $silent ) { 819 /** 820 * Fires as a specific plugin is being deactivated. 821 * 822 * This hook is the "deactivation" hook used internally by register_deactivation_hook(). 823 * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename. 824 * 825 * If a plugin is silently deactivated (such as during an update), this hook does not fire. 826 * 827 * @since 2.0.0 828 * 829 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network 830 * or just the current site. Multisite only. Default false. 831 */ 832 do_action( "deactivate_{$plugin}", $network_deactivating ); 833 834 /** 835 * Fires after a plugin is deactivated. 836 * 837 * If a plugin is silently deactivated (such as during an update), 838 * this hook does not fire. 839 * 840 * @since 2.9.0 841 * 842 * @param string $plugin Path to the plugin file relative to the plugins directory. 843 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network 844 * or just the current site. Multisite only. Default false. 845 */ 846 do_action( 'deactivated_plugin', $plugin, $network_deactivating ); 847 } 848 } 849 850 if ( $do_blog ) { 851 update_option( 'active_plugins', $current ); 852 } 853 if ( $do_network ) { 854 update_site_option( 'active_sitewide_plugins', $network_current ); 855 } 856 } 857 858 /** 859 * Activates multiple plugins. 860 * 861 * When WP_Error is returned, it does not mean that one of the plugins had 862 * errors. It means that one or more of the plugin file paths were invalid. 863 * 864 * The execution will be halted as soon as one of the plugins has an error. 865 * 866 * @since 2.6.0 867 * 868 * @param string|string[] $plugins Single plugin or list of plugins to activate. 869 * @param string $redirect Redirect to page after successful activation. 870 * @param bool $network_wide Whether to enable the plugin for all sites in the network. 871 * Default false. 872 * @param bool $silent Prevent calling activation hooks. Default false. 873 * @return true|WP_Error True when finished or WP_Error if there were errors during a plugin activation. 874 */ 875 function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) { 876 if ( ! is_array( $plugins ) ) { 877 $plugins = array( $plugins ); 878 } 879 880 $errors = array(); 881 foreach ( $plugins as $plugin ) { 882 if ( ! empty( $redirect ) ) { 883 $redirect = add_query_arg( 'plugin', $plugin, $redirect ); 884 } 885 $result = activate_plugin( $plugin, $redirect, $network_wide, $silent ); 886 if ( is_wp_error( $result ) ) { 887 $errors[ $plugin ] = $result; 888 } 889 } 890 891 if ( ! empty( $errors ) ) { 892 return new WP_Error( 'plugins_invalid', __( 'One of the plugins is invalid.' ), $errors ); 893 } 894 895 return true; 896 } 897 898 /** 899 * Removes directory and files of a plugin for a list of plugins. 900 * 901 * @since 2.6.0 902 * 903 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. 904 * 905 * @param string[] $plugins List of plugin paths to delete, relative to the plugins directory. 906 * @param string $deprecated Not used. 907 * @return bool|null|WP_Error True on success, false if `$plugins` is empty, `WP_Error` on failure. 908 * `null` if filesystem credentials are required to proceed. 909 */ 910 function delete_plugins( $plugins, $deprecated = '' ) { 911 global $wp_filesystem; 912 913 if ( empty( $plugins ) ) { 914 return false; 915 } 916 917 $checked = array(); 918 foreach ( $plugins as $plugin ) { 919 $checked[] = 'checked[]=' . $plugin; 920 } 921 922 $url = wp_nonce_url( 'plugins.php?action=delete-selected&verify-delete=1&' . implode( '&', $checked ), 'bulk-plugins' ); 923 924 ob_start(); 925 $credentials = request_filesystem_credentials( $url ); 926 $data = ob_get_clean(); 927 928 if ( false === $credentials ) { 929 if ( ! empty( $data ) ) { 930 require_once ABSPATH . 'wp-admin/admin-header.php'; 931 echo $data; 932 require_once ABSPATH . 'wp-admin/admin-footer.php'; 933 exit; 934 } 935 return null; 936 } 937 938 if ( ! WP_Filesystem( $credentials ) ) { 939 ob_start(); 940 // Failed to connect. Error and request again. 941 request_filesystem_credentials( $url, '', true ); 942 $data = ob_get_clean(); 943 944 if ( ! empty( $data ) ) { 945 require_once ABSPATH . 'wp-admin/admin-header.php'; 946 echo $data; 947 require_once ABSPATH . 'wp-admin/admin-footer.php'; 948 exit; 949 } 950 return null; 951 } 952 953 if ( ! is_object( $wp_filesystem ) ) { 954 return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) ); 955 } 956 957 if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) { 958 return new WP_Error( 'fs_error', __( 'Filesystem error.' ), $wp_filesystem->errors ); 959 } 960 961 // Get the base plugin folder. 962 $plugins_dir = $wp_filesystem->wp_plugins_dir(); 963 if ( empty( $plugins_dir ) ) { 964 return new WP_Error( 'fs_no_plugins_dir', __( 'Unable to locate WordPress plugin directory.' ) ); 965 } 966 967 $plugins_dir = trailingslashit( $plugins_dir ); 968 969 $plugin_translations = wp_get_installed_translations( 'plugins' ); 970 971 $errors = array(); 972 973 foreach ( $plugins as $plugin_file ) { 974 // Run Uninstall hook. 975 if ( is_uninstallable_plugin( $plugin_file ) ) { 976 uninstall_plugin( $plugin_file ); 977 } 978 979 /** 980 * Fires immediately before a plugin deletion attempt. 981 * 982 * @since 4.4.0 983 * 984 * @param string $plugin_file Path to the plugin file relative to the plugins directory. 985 */ 986 do_action( 'delete_plugin', $plugin_file ); 987 988 $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin_file ) ); 989 990 /* 991 * If plugin is in its own directory, recursively delete the directory. 992 * Base check on if plugin includes directory separator AND that it's not the root plugin folder. 993 */ 994 if ( strpos( $plugin_file, '/' ) && $this_plugin_dir !== $plugins_dir ) { 995 $deleted = $wp_filesystem->delete( $this_plugin_dir, true ); 996 } else { 997 $deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file ); 998 } 999 1000 /** 1001 * Fires immediately after a plugin deletion attempt. 1002 * 1003 * @since 4.4.0 1004 * 1005 * @param string $plugin_file Path to the plugin file relative to the plugins directory. 1006 * @param bool $deleted Whether the plugin deletion was successful. 1007 */ 1008 do_action( 'deleted_plugin', $plugin_file, $deleted ); 1009 1010 if ( ! $deleted ) { 1011 $errors[] = $plugin_file; 1012 continue; 1013 } 1014 1015 $plugin_slug = dirname( $plugin_file ); 1016 1017 if ( 'hello.php' === $plugin_file ) { 1018 $plugin_slug = 'hello-dolly'; 1019 } 1020 1021 // Remove language files, silently. 1022 if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) { 1023 $translations = $plugin_translations[ $plugin_slug ]; 1024 1025 foreach ( $translations as $translation => $data ) { 1026 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' ); 1027 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' ); 1028 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.l10n.php' ); 1029 1030 $json_translation_files = glob( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '-*.json' ); 1031 if ( $json_translation_files ) { 1032 array_map( array( $wp_filesystem, 'delete' ), $json_translation_files ); 1033 } 1034 } 1035 } 1036 } 1037 1038 // Remove deleted plugins from the plugin updates list. 1039 $current = get_site_transient( 'update_plugins' ); 1040 if ( $current ) { 1041 // Don't remove the plugins that weren't deleted. 1042 $deleted = array_diff( $plugins, $errors ); 1043 1044 foreach ( $deleted as $plugin_file ) { 1045 unset( $current->response[ $plugin_file ] ); 1046 } 1047 1048 set_site_transient( 'update_plugins', $current ); 1049 } 1050 1051 if ( ! empty( $errors ) ) { 1052 if ( 1 === count( $errors ) ) { 1053 /* translators: %s: Plugin filename. */ 1054 $message = __( 'Could not fully remove the plugin %s.' ); 1055 } else { 1056 /* translators: %s: Comma-separated list of plugin filenames. */ 1057 $message = __( 'Could not fully remove the plugins %s.' ); 1058 } 1059 1060 return new WP_Error( 'could_not_remove_plugin', sprintf( $message, implode( ', ', $errors ) ) ); 1061 } 1062 1063 return true; 1064 } 1065 1066 /** 1067 * Validates active plugins. 1068 * 1069 * Validate all active plugins, deactivates invalid and 1070 * returns an array of deactivated ones. 1071 * 1072 * @since 2.5.0 1073 * @return WP_Error[] Array of plugin errors keyed by plugin file name. 1074 */ 1075 function validate_active_plugins() { 1076 $plugins = get_option( 'active_plugins', array() ); 1077 // Validate vartype: array. 1078 if ( ! is_array( $plugins ) ) { 1079 update_option( 'active_plugins', array() ); 1080 $plugins = array(); 1081 } 1082 1083 if ( is_multisite() && current_user_can( 'manage_network_plugins' ) ) { 1084 $network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() ); 1085 $plugins = array_merge( $plugins, array_keys( $network_plugins ) ); 1086 } 1087 1088 if ( empty( $plugins ) ) { 1089 return array(); 1090 } 1091 1092 $invalid = array(); 1093 1094 // Invalid plugins get deactivated. 1095 foreach ( $plugins as $plugin ) { 1096 $result = validate_plugin( $plugin ); 1097 if ( is_wp_error( $result ) ) { 1098 $invalid[ $plugin ] = $result; 1099 deactivate_plugins( $plugin, true ); 1100 } 1101 } 1102 return $invalid; 1103 } 1104 1105 /** 1106 * Validates the plugin path. 1107 * 1108 * Checks that the main plugin file exists and is a valid plugin. See validate_file(). 1109 * 1110 * @since 2.5.0 1111 * 1112 * @param string $plugin Path to the plugin file relative to the plugins directory. 1113 * @return int|WP_Error 0 on success, WP_Error on failure. 1114 */ 1115 function validate_plugin( $plugin ) { 1116 if ( validate_file( $plugin ) ) { 1117 return new WP_Error( 'plugin_invalid', __( 'Invalid plugin path.' ) ); 1118 } 1119 if ( ! file_exists( WP_PLUGIN_DIR . '/' . $plugin ) ) { 1120 return new WP_Error( 'plugin_not_found', __( 'Plugin file does not exist.' ) ); 1121 } 1122 1123 $installed_plugins = get_plugins(); 1124 if ( ! isset( $installed_plugins[ $plugin ] ) ) { 1125 return new WP_Error( 'no_plugin_header', __( 'The plugin does not have a valid header.' ) ); 1126 } 1127 return 0; 1128 } 1129 1130 /** 1131 * Validates the plugin requirements for WordPress version and PHP version. 1132 * 1133 * Uses the information from `Requires at least`, `Requires PHP` and `Requires Plugins` headers 1134 * defined in the plugin's main PHP file. 1135 * 1136 * @since 5.2.0 1137 * @since 5.3.0 Added support for reading the headers from the plugin's 1138 * main PHP file, with `readme.txt` as a fallback. 1139 * @since 5.8.0 Removed support for using `readme.txt` as a fallback. 1140 * @since 6.5.0 Added support for the 'Requires Plugins' header. 1141 * 1142 * @param string $plugin Path to the plugin file relative to the plugins directory. 1143 * @return true|WP_Error True if requirements are met, WP_Error on failure. 1144 */ 1145 function validate_plugin_requirements( $plugin ) { 1146 $plugin_headers = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin ); 1147 1148 $requirements = array( 1149 'requires' => ! empty( $plugin_headers['RequiresWP'] ) ? $plugin_headers['RequiresWP'] : '', 1150 'requires_php' => ! empty( $plugin_headers['RequiresPHP'] ) ? $plugin_headers['RequiresPHP'] : '', 1151 'requires_plugins' => ! empty( $plugin_headers['RequiresPlugins'] ) ? $plugin_headers['RequiresPlugins'] : '', 1152 ); 1153 1154 $compatible_wp = is_wp_version_compatible( $requirements['requires'] ); 1155 $compatible_php = is_php_version_compatible( $requirements['requires_php'] ); 1156 1157 $php_update_message = '</p><p>' . sprintf( 1158 /* translators: %s: URL to Update PHP page. */ 1159 __( '<a href="%s">Learn more about updating PHP</a>.' ), 1160 esc_url( wp_get_update_php_url() ) 1161 ); 1162 1163 $annotation = wp_get_update_php_annotation(); 1164 1165 if ( $annotation ) { 1166 $php_update_message .= '</p><p><em>' . $annotation . '</em>'; 1167 } 1168 1169 if ( ! $compatible_wp && ! $compatible_php ) { 1170 return new WP_Error( 1171 'plugin_wp_php_incompatible', 1172 '<p>' . sprintf( 1173 /* translators: 1: Current WordPress version, 2: Current PHP version, 3: Plugin name, 4: Required WordPress version, 5: Required PHP version. */ 1174 _x( '<strong>Error:</strong> Current versions of WordPress (%1$s) and PHP (%2$s) do not meet minimum requirements for %3$s. The plugin requires WordPress %4$s and PHP %5$s.', 'plugin' ), 1175 get_bloginfo( 'version' ), 1176 PHP_VERSION, 1177 $plugin_headers['Name'], 1178 $requirements['requires'], 1179 $requirements['requires_php'] 1180 ) . $php_update_message . '</p>' 1181 ); 1182 } elseif ( ! $compatible_php ) { 1183 return new WP_Error( 1184 'plugin_php_incompatible', 1185 '<p>' . sprintf( 1186 /* translators: 1: Current PHP version, 2: Plugin name, 3: Required PHP version. */ 1187 _x( '<strong>Error:</strong> Current PHP version (%1$s) does not meet minimum requirements for %2$s. The plugin requires PHP %3$s.', 'plugin' ), 1188 PHP_VERSION, 1189 $plugin_headers['Name'], 1190 $requirements['requires_php'] 1191 ) . $php_update_message . '</p>' 1192 ); 1193 } elseif ( ! $compatible_wp ) { 1194 return new WP_Error( 1195 'plugin_wp_incompatible', 1196 '<p>' . sprintf( 1197 /* translators: 1: Current WordPress version, 2: Plugin name, 3: Required WordPress version. */ 1198 _x( '<strong>Error:</strong> Current WordPress version (%1$s) does not meet minimum requirements for %2$s. The plugin requires WordPress %3$s.', 'plugin' ), 1199 get_bloginfo( 'version' ), 1200 $plugin_headers['Name'], 1201 $requirements['requires'] 1202 ) . '</p>' 1203 ); 1204 } 1205 1206 WP_Plugin_Dependencies::initialize(); 1207 1208 if ( WP_Plugin_Dependencies::has_unmet_dependencies( $plugin ) ) { 1209 $dependency_names = WP_Plugin_Dependencies::get_dependency_names( $plugin ); 1210 $unmet_dependencies = array(); 1211 $unmet_dependency_names = array(); 1212 1213 foreach ( $dependency_names as $dependency => $dependency_name ) { 1214 $dependency_file = WP_Plugin_Dependencies::get_dependency_filepath( $dependency ); 1215 1216 if ( false === $dependency_file ) { 1217 $unmet_dependencies['not_installed'][ $dependency ] = $dependency_name; 1218 $unmet_dependency_names[] = $dependency_name; 1219 } elseif ( is_plugin_inactive( $dependency_file ) ) { 1220 $unmet_dependencies['inactive'][ $dependency ] = $dependency_name; 1221 $unmet_dependency_names[] = $dependency_name; 1222 } 1223 } 1224 1225 $error_message = sprintf( 1226 /* translators: 1: Plugin name, 2: Number of plugins, 3: A comma-separated list of plugin names. */ 1227 _n( 1228 '<strong>Error:</strong> %1$s requires %2$d plugin to be installed and activated: %3$s.', 1229 '<strong>Error:</strong> %1$s requires %2$d plugins to be installed and activated: %3$s.', 1230 count( $unmet_dependency_names ) 1231 ), 1232 $plugin_headers['Name'], 1233 count( $unmet_dependency_names ), 1234 implode( wp_get_list_item_separator(), $unmet_dependency_names ) 1235 ); 1236 1237 if ( is_multisite() ) { 1238 if ( current_user_can( 'manage_network_plugins' ) ) { 1239 $error_message .= ' ' . sprintf( 1240 /* translators: %s: Link to the plugins page. */ 1241 __( '<a href="%s">Manage plugins</a>.' ), 1242 esc_url( network_admin_url( 'plugins.php' ) ) 1243 ); 1244 } else { 1245 $error_message .= ' ' . __( 'Please contact your network administrator.' ); 1246 } 1247 } else { 1248 $error_message .= ' ' . sprintf( 1249 /* translators: %s: Link to the plugins page. */ 1250 __( '<a href="%s">Manage plugins</a>.' ), 1251 esc_url( admin_url( 'plugins.php' ) ) 1252 ); 1253 } 1254 1255 return new WP_Error( 1256 'plugin_missing_dependencies', 1257 "<p>{$error_message}</p>", 1258 $unmet_dependencies 1259 ); 1260 } 1261 1262 /** 1263 * Filters the plugin requirement validation response. 1264 * 1265 * If a plugin fails due to a Core-provided validation (incompatible WP, PHP versions), this 1266 * filter will not fire. A WP_Error response will already be returned. 1267 * 1268 * This filter is intended to add additional validation steps by site administrators. 1269 * 1270 * @since 6.9.0 1271 * 1272 * @param bool|WP_Error $met_requirements True if the plugin meets requirements, WP_Error if not. 1273 * @param string $plugin Path to the plugin file relative to the plugins directory. 1274 */ 1275 return apply_filters( 'validate_plugin_requirements', true, $plugin ); 1276 } 1277 1278 /** 1279 * Determines whether the plugin can be uninstalled. 1280 * 1281 * @since 2.7.0 1282 * 1283 * @param string $plugin Path to the plugin file relative to the plugins directory. 1284 * @return bool Whether plugin can be uninstalled. 1285 */ 1286 function is_uninstallable_plugin( $plugin ) { 1287 $file = plugin_basename( $plugin ); 1288 1289 $uninstallable_plugins = (array) get_option( 'uninstall_plugins' ); 1290 if ( isset( $uninstallable_plugins[ $file ] ) || file_exists( WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php' ) ) { 1291 return true; 1292 } 1293 1294 return false; 1295 } 1296 1297 /** 1298 * Uninstalls a single plugin. 1299 * 1300 * Calls the uninstall hook, if it is available. 1301 * 1302 * @since 2.7.0 1303 * 1304 * @param string $plugin Path to the plugin file relative to the plugins directory. 1305 * @return true|null True if a plugin's uninstall.php file has been found and included. 1306 * Null otherwise. 1307 */ 1308 function uninstall_plugin( $plugin ) { 1309 $file = plugin_basename( $plugin ); 1310 1311 $uninstallable_plugins = (array) get_option( 'uninstall_plugins' ); 1312 1313 /** 1314 * Fires in uninstall_plugin() immediately before the plugin is uninstalled. 1315 * 1316 * @since 4.5.0 1317 * 1318 * @param string $plugin Path to the plugin file relative to the plugins directory. 1319 * @param array $uninstallable_plugins Uninstallable plugins. 1320 */ 1321 do_action( 'pre_uninstall_plugin', $plugin, $uninstallable_plugins ); 1322 1323 if ( file_exists( WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php' ) ) { 1324 if ( isset( $uninstallable_plugins[ $file ] ) ) { 1325 unset( $uninstallable_plugins[ $file ] ); 1326 update_option( 'uninstall_plugins', $uninstallable_plugins ); 1327 } 1328 unset( $uninstallable_plugins ); 1329 1330 define( 'WP_UNINSTALL_PLUGIN', $file ); 1331 1332 wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file ); 1333 include_once WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php'; 1334 1335 return true; 1336 } 1337 1338 if ( isset( $uninstallable_plugins[ $file ] ) ) { 1339 $callable = $uninstallable_plugins[ $file ]; 1340 unset( $uninstallable_plugins[ $file ] ); 1341 update_option( 'uninstall_plugins', $uninstallable_plugins ); 1342 unset( $uninstallable_plugins ); 1343 1344 wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file ); 1345 include_once WP_PLUGIN_DIR . '/' . $file; 1346 1347 add_action( "uninstall_{$file}", $callable ); 1348 1349 /** 1350 * Fires in uninstall_plugin() once the plugin has been uninstalled. 1351 * 1352 * The action concatenates the 'uninstall_' prefix with the basename of the 1353 * plugin passed to uninstall_plugin() to create a dynamically-named action. 1354 * 1355 * @since 2.7.0 1356 */ 1357 do_action( "uninstall_{$file}" ); 1358 } 1359 return null; 1360 } 1361 1362 // 1363 // Menu. 1364 // 1365 1366 /** 1367 * Adds a top-level menu page. 1368 * 1369 * This function takes a capability which will be used to determine whether 1370 * or not a page is included in the menu. 1371 * 1372 * The function which is hooked in to handle the output of the page must check 1373 * that the user has the required capability as well. 1374 * 1375 * @since 1.5.0 1376 * 1377 * @global array $menu 1378 * @global array $admin_page_hooks 1379 * @global array $_registered_pages 1380 * @global array $_parent_pages 1381 * 1382 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1383 * @param string $menu_title The text to be used for the menu. 1384 * @param string $capability The capability required for this menu to be displayed to the user. 1385 * @param string $menu_slug The slug name to refer to this menu by. Should be unique for this menu page and only 1386 * include lowercase alphanumeric, dashes, and underscores characters to be compatible 1387 * with sanitize_key(). 1388 * @param callable $callback Optional. The function to be called to output the content for this page. 1389 * @param string $icon_url Optional. The URL to the icon to be used for this menu. 1390 * * Pass a base64-encoded SVG using a data URI, which will be colored to match 1391 * the color scheme. This should begin with 'data:image/svg+xml;base64,'. 1392 * * Pass the name of a Dashicons helper class to use a font icon, 1393 * e.g. 'dashicons-chart-pie'. 1394 * * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS. 1395 * @param int|float $position Optional. The position in the menu order this item should appear. 1396 * @return string The resulting page's hook_suffix. 1397 */ 1398 function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '', $position = null ) { 1399 global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages; 1400 1401 $menu_slug = plugin_basename( $menu_slug ); 1402 1403 $admin_page_hooks[ $menu_slug ] = sanitize_title( $menu_title ); 1404 1405 $hookname = get_plugin_page_hookname( $menu_slug, '' ); 1406 1407 if ( ! empty( $callback ) && ! empty( $hookname ) && current_user_can( $capability ) ) { 1408 add_action( $hookname, $callback ); 1409 } 1410 1411 if ( empty( $icon_url ) ) { 1412 $icon_url = 'dashicons-admin-generic'; 1413 $icon_class = 'menu-icon-generic '; 1414 } else { 1415 $icon_url = set_url_scheme( $icon_url ); 1416 $icon_class = ''; 1417 } 1418 1419 $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url ); 1420 1421 if ( null !== $position && ! is_numeric( $position ) ) { 1422 _doing_it_wrong( 1423 __FUNCTION__, 1424 sprintf( 1425 /* translators: %s: add_menu_page() */ 1426 __( 'The seventh parameter passed to %s should be numeric representing menu position.' ), 1427 '<code>add_menu_page()</code>' 1428 ), 1429 '6.0.0' 1430 ); 1431 $position = null; 1432 } 1433 1434 if ( null === $position || ! is_numeric( $position ) ) { 1435 $menu[] = $new_menu; 1436 } elseif ( isset( $menu[ (string) $position ] ) ) { 1437 $collision_avoider = (int) base_convert( substr( md5( $menu_slug . $menu_title ), -4 ), 16, 10 ) * 0.00001; 1438 $position = (string) ( $position + $collision_avoider ); 1439 $menu[ $position ] = $new_menu; 1440 } else { 1441 /* 1442 * Cast menu position to a string. 1443 * 1444 * This allows for floats to be passed as the position. PHP will normally cast a float to an 1445 * integer value, this ensures the float retains its mantissa (positive fractional part). 1446 * 1447 * A string containing an integer value, eg "10", is treated as a numeric index. 1448 */ 1449 $position = (string) $position; 1450 $menu[ $position ] = $new_menu; 1451 } 1452 1453 $_registered_pages[ $hookname ] = true; 1454 1455 // No parent as top level. 1456 $_parent_pages[ $menu_slug ] = false; 1457 1458 return $hookname; 1459 } 1460 1461 /** 1462 * Adds a submenu page. 1463 * 1464 * This function takes a capability which will be used to determine whether 1465 * or not a page is included in the menu. 1466 * 1467 * The function which is hooked in to handle the output of the page must check 1468 * that the user has the required capability as well. 1469 * 1470 * @since 1.5.0 1471 * @since 5.3.0 Added the `$position` parameter. 1472 * 1473 * @global array $submenu 1474 * @global array $menu 1475 * @global array $_wp_real_parent_file 1476 * @global bool $_wp_submenu_nopriv 1477 * @global array $_registered_pages 1478 * @global array $_parent_pages 1479 * 1480 * @param string $parent_slug The slug name for the parent menu (or the file name of a standard 1481 * WordPress admin page). 1482 * @param string $page_title The text to be displayed in the title tags of the page when the menu 1483 * is selected. 1484 * @param string $menu_title The text to be used for the menu. 1485 * @param string $capability The capability required for this menu to be displayed to the user. 1486 * @param string $menu_slug The slug name to refer to this menu by. Should be unique for this menu 1487 * and only include lowercase alphanumeric, dashes, and underscores characters 1488 * to be compatible with sanitize_key(). 1489 * @param callable $callback Optional. The function to be called to output the content for this page. 1490 * @param int|float $position Optional. The position in the menu order this item should appear. 1491 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1492 */ 1493 function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1494 global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv, 1495 $_registered_pages, $_parent_pages; 1496 1497 $menu_slug = plugin_basename( $menu_slug ); 1498 $parent_slug = plugin_basename( $parent_slug ); 1499 1500 if ( isset( $_wp_real_parent_file[ $parent_slug ] ) ) { 1501 $parent_slug = $_wp_real_parent_file[ $parent_slug ]; 1502 } 1503 1504 if ( ! current_user_can( $capability ) ) { 1505 $_wp_submenu_nopriv[ $parent_slug ][ $menu_slug ] = true; 1506 return false; 1507 } 1508 1509 /* 1510 * If the parent doesn't already have a submenu, add a link to the parent 1511 * as the first item in the submenu. If the submenu file is the same as the 1512 * parent file someone is trying to link back to the parent manually. In 1513 * this case, don't automatically add a link back to avoid duplication. 1514 */ 1515 if ( ! isset( $submenu[ $parent_slug ] ) && $menu_slug !== $parent_slug ) { 1516 foreach ( (array) $menu as $parent_menu ) { 1517 if ( $parent_menu[2] === $parent_slug && current_user_can( $parent_menu[1] ) ) { 1518 $submenu[ $parent_slug ][] = array_slice( $parent_menu, 0, 4 ); 1519 } 1520 } 1521 } 1522 1523 $new_sub_menu = array( $menu_title, $capability, $menu_slug, $page_title ); 1524 1525 if ( null !== $position && ! is_numeric( $position ) ) { 1526 _doing_it_wrong( 1527 __FUNCTION__, 1528 sprintf( 1529 /* translators: %s: add_submenu_page() */ 1530 __( 'The seventh parameter passed to %s should be numeric representing menu position.' ), 1531 '<code>add_submenu_page()</code>' 1532 ), 1533 '5.3.0' 1534 ); 1535 $position = null; 1536 } 1537 1538 if ( 1539 null === $position || 1540 ( ! isset( $submenu[ $parent_slug ] ) || $position >= count( $submenu[ $parent_slug ] ) ) 1541 ) { 1542 $submenu[ $parent_slug ][] = $new_sub_menu; 1543 } else { 1544 // Test for a negative position. 1545 $position = max( $position, 0 ); 1546 if ( 0 === $position ) { 1547 // For negative or `0` positions, prepend the submenu. 1548 array_unshift( $submenu[ $parent_slug ], $new_sub_menu ); 1549 } else { 1550 $position = absint( $position ); 1551 // Grab all of the items before the insertion point. 1552 $before_items = array_slice( $submenu[ $parent_slug ], 0, $position, true ); 1553 // Grab all of the items after the insertion point. 1554 $after_items = array_slice( $submenu[ $parent_slug ], $position, null, true ); 1555 // Add the new item. 1556 $before_items[] = $new_sub_menu; 1557 // Merge the items. 1558 $submenu[ $parent_slug ] = array_merge( $before_items, $after_items ); 1559 } 1560 } 1561 1562 // Sort the parent array. 1563 ksort( $submenu[ $parent_slug ] ); 1564 1565 $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug ); 1566 if ( ! empty( $callback ) && ! empty( $hookname ) ) { 1567 add_action( $hookname, $callback ); 1568 } 1569 1570 $_registered_pages[ $hookname ] = true; 1571 1572 /* 1573 * Backward-compatibility for plugins using add_management_page(). 1574 * See wp-admin/admin.php for redirect from edit.php to tools.php. 1575 */ 1576 if ( 'tools.php' === $parent_slug ) { 1577 $_registered_pages[ get_plugin_page_hookname( $menu_slug, 'edit.php' ) ] = true; 1578 } 1579 1580 // No parent as top level. 1581 $_parent_pages[ $menu_slug ] = $parent_slug; 1582 1583 return $hookname; 1584 } 1585 1586 /** 1587 * Adds a submenu page to the Tools main menu. 1588 * 1589 * This function takes a capability which will be used to determine whether 1590 * or not a page is included in the menu. 1591 * 1592 * The function which is hooked in to handle the output of the page must check 1593 * that the user has the required capability as well. 1594 * 1595 * @since 1.5.0 1596 * @since 5.3.0 Added the `$position` parameter. 1597 * 1598 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1599 * @param string $menu_title The text to be used for the menu. 1600 * @param string $capability The capability required for this menu to be displayed to the user. 1601 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1602 * @param callable $callback Optional. The function to be called to output the content for this page. 1603 * @param int $position Optional. The position in the menu order this item should appear. 1604 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1605 */ 1606 function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1607 return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1608 } 1609 1610 /** 1611 * Adds a submenu page to the Settings main menu. 1612 * 1613 * This function takes a capability which will be used to determine whether 1614 * or not a page is included in the menu. 1615 * 1616 * The function which is hooked in to handle the output of the page must check 1617 * that the user has the required capability as well. 1618 * 1619 * @since 1.5.0 1620 * @since 5.3.0 Added the `$position` parameter. 1621 * 1622 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1623 * @param string $menu_title The text to be used for the menu. 1624 * @param string $capability The capability required for this menu to be displayed to the user. 1625 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1626 * @param callable $callback Optional. The function to be called to output the content for this page. 1627 * @param int $position Optional. The position in the menu order this item should appear. 1628 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1629 */ 1630 function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1631 return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1632 } 1633 1634 /** 1635 * Adds a submenu page to the Appearance main menu. 1636 * 1637 * This function takes a capability which will be used to determine whether 1638 * or not a page is included in the menu. 1639 * 1640 * The function which is hooked in to handle the output of the page must check 1641 * that the user has the required capability as well. 1642 * 1643 * @since 2.0.0 1644 * @since 5.3.0 Added the `$position` parameter. 1645 * 1646 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1647 * @param string $menu_title The text to be used for the menu. 1648 * @param string $capability The capability required for this menu to be displayed to the user. 1649 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1650 * @param callable $callback Optional. The function to be called to output the content for this page. 1651 * @param int $position Optional. The position in the menu order this item should appear. 1652 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1653 */ 1654 function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1655 return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1656 } 1657 1658 /** 1659 * Adds a submenu page to the Plugins main menu. 1660 * 1661 * This function takes a capability which will be used to determine whether 1662 * or not a page is included in the menu. 1663 * 1664 * The function which is hooked in to handle the output of the page must check 1665 * that the user has the required capability as well. 1666 * 1667 * @since 3.0.0 1668 * @since 5.3.0 Added the `$position` parameter. 1669 * 1670 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1671 * @param string $menu_title The text to be used for the menu. 1672 * @param string $capability The capability required for this menu to be displayed to the user. 1673 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1674 * @param callable $callback Optional. The function to be called to output the content for this page. 1675 * @param int $position Optional. The position in the menu order this item should appear. 1676 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1677 */ 1678 function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1679 return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1680 } 1681 1682 /** 1683 * Adds a submenu page to the Users/Profile main menu. 1684 * 1685 * This function takes a capability which will be used to determine whether 1686 * or not a page is included in the menu. 1687 * 1688 * The function which is hooked in to handle the output of the page must check 1689 * that the user has the required capability as well. 1690 * 1691 * @since 2.1.3 1692 * @since 5.3.0 Added the `$position` parameter. 1693 * 1694 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1695 * @param string $menu_title The text to be used for the menu. 1696 * @param string $capability The capability required for this menu to be displayed to the user. 1697 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1698 * @param callable $callback Optional. The function to be called to output the content for this page. 1699 * @param int $position Optional. The position in the menu order this item should appear. 1700 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1701 */ 1702 function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1703 if ( current_user_can( 'edit_users' ) ) { 1704 $parent = 'users.php'; 1705 } else { 1706 $parent = 'profile.php'; 1707 } 1708 return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1709 } 1710 1711 /** 1712 * Adds a submenu page to the Dashboard main menu. 1713 * 1714 * This function takes a capability which will be used to determine whether 1715 * or not a page is included in the menu. 1716 * 1717 * The function which is hooked in to handle the output of the page must check 1718 * that the user has the required capability as well. 1719 * 1720 * @since 2.7.0 1721 * @since 5.3.0 Added the `$position` parameter. 1722 * 1723 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1724 * @param string $menu_title The text to be used for the menu. 1725 * @param string $capability The capability required for this menu to be displayed to the user. 1726 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1727 * @param callable $callback Optional. The function to be called to output the content for this page. 1728 * @param int $position Optional. The position in the menu order this item should appear. 1729 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1730 */ 1731 function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1732 return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1733 } 1734 1735 /** 1736 * Adds a submenu page to the Posts main menu. 1737 * 1738 * This function takes a capability which will be used to determine whether 1739 * or not a page is included in the menu. 1740 * 1741 * The function which is hooked in to handle the output of the page must check 1742 * that the user has the required capability as well. 1743 * 1744 * @since 2.7.0 1745 * @since 5.3.0 Added the `$position` parameter. 1746 * 1747 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1748 * @param string $menu_title The text to be used for the menu. 1749 * @param string $capability The capability required for this menu to be displayed to the user. 1750 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1751 * @param callable $callback Optional. The function to be called to output the content for this page. 1752 * @param int $position Optional. The position in the menu order this item should appear. 1753 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1754 */ 1755 function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1756 return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1757 } 1758 1759 /** 1760 * Adds a submenu page to the Media main menu. 1761 * 1762 * This function takes a capability which will be used to determine whether 1763 * or not a page is included in the menu. 1764 * 1765 * The function which is hooked in to handle the output of the page must check 1766 * that the user has the required capability as well. 1767 * 1768 * @since 2.7.0 1769 * @since 5.3.0 Added the `$position` parameter. 1770 * 1771 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1772 * @param string $menu_title The text to be used for the menu. 1773 * @param string $capability The capability required for this menu to be displayed to the user. 1774 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1775 * @param callable $callback Optional. The function to be called to output the content for this page. 1776 * @param int $position Optional. The position in the menu order this item should appear. 1777 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1778 */ 1779 function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1780 return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1781 } 1782 1783 /** 1784 * Adds a submenu page to the Links main menu. 1785 * 1786 * This function takes a capability which will be used to determine whether 1787 * or not a page is included in the menu. 1788 * 1789 * The function which is hooked in to handle the output of the page must check 1790 * that the user has the required capability as well. 1791 * 1792 * @since 2.7.0 1793 * @since 5.3.0 Added the `$position` parameter. 1794 * 1795 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1796 * @param string $menu_title The text to be used for the menu. 1797 * @param string $capability The capability required for this menu to be displayed to the user. 1798 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1799 * @param callable $callback Optional. The function to be called to output the content for this page. 1800 * @param int $position Optional. The position in the menu order this item should appear. 1801 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1802 */ 1803 function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1804 return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1805 } 1806 1807 /** 1808 * Adds a submenu page to the Pages main menu. 1809 * 1810 * This function takes a capability which will be used to determine whether 1811 * or not a page is included in the menu. 1812 * 1813 * The function which is hooked in to handle the output of the page must check 1814 * that the user has the required capability as well. 1815 * 1816 * @since 2.7.0 1817 * @since 5.3.0 Added the `$position` parameter. 1818 * 1819 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1820 * @param string $menu_title The text to be used for the menu. 1821 * @param string $capability The capability required for this menu to be displayed to the user. 1822 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1823 * @param callable $callback Optional. The function to be called to output the content for this page. 1824 * @param int $position Optional. The position in the menu order this item should appear. 1825 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1826 */ 1827 function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1828 return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1829 } 1830 1831 /** 1832 * Adds a submenu page to the Comments main menu. 1833 * 1834 * This function takes a capability which will be used to determine whether 1835 * or not a page is included in the menu. 1836 * 1837 * The function which is hooked in to handle the output of the page must check 1838 * that the user has the required capability as well. 1839 * 1840 * @since 2.7.0 1841 * @since 5.3.0 Added the `$position` parameter. 1842 * 1843 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. 1844 * @param string $menu_title The text to be used for the menu. 1845 * @param string $capability The capability required for this menu to be displayed to the user. 1846 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1847 * @param callable $callback Optional. The function to be called to output the content for this page. 1848 * @param int $position Optional. The position in the menu order this item should appear. 1849 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required. 1850 */ 1851 function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) { 1852 return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position ); 1853 } 1854 1855 /** 1856 * Removes a top-level admin menu. 1857 * 1858 * Example usage: 1859 * 1860 * - `remove_menu_page( 'tools.php' )` 1861 * - `remove_menu_page( 'plugin_menu_slug' )` 1862 * 1863 * @since 3.1.0 1864 * 1865 * @global array $menu 1866 * 1867 * @param string $menu_slug The slug of the menu. 1868 * @return array|false The removed menu on success, false if not found. 1869 */ 1870 function remove_menu_page( $menu_slug ) { 1871 global $menu; 1872 1873 foreach ( $menu as $i => $item ) { 1874 if ( $menu_slug === $item[2] ) { 1875 unset( $menu[ $i ] ); 1876 return $item; 1877 } 1878 } 1879 1880 return false; 1881 } 1882 1883 /** 1884 * Removes an admin submenu. 1885 * 1886 * Example usage: 1887 * 1888 * - `remove_submenu_page( 'themes.php', 'nav-menus.php' )` 1889 * - `remove_submenu_page( 'tools.php', 'plugin_submenu_slug' )` 1890 * - `remove_submenu_page( 'plugin_menu_slug', 'plugin_submenu_slug' )` 1891 * 1892 * @since 3.1.0 1893 * 1894 * @global array $submenu 1895 * 1896 * @param string $menu_slug The slug for the parent menu. 1897 * @param string $submenu_slug The slug of the submenu. 1898 * @return array|false The removed submenu on success, false if not found. 1899 */ 1900 function remove_submenu_page( $menu_slug, $submenu_slug ) { 1901 global $submenu; 1902 1903 if ( ! isset( $submenu[ $menu_slug ] ) ) { 1904 return false; 1905 } 1906 1907 foreach ( $submenu[ $menu_slug ] as $i => $item ) { 1908 if ( $submenu_slug === $item[2] ) { 1909 unset( $submenu[ $menu_slug ][ $i ] ); 1910 return $item; 1911 } 1912 } 1913 1914 return false; 1915 } 1916 1917 /** 1918 * Gets the URL to access a particular menu page based on the slug it was registered with. 1919 * 1920 * If the slug hasn't been registered properly, no URL will be returned. 1921 * 1922 * @since 3.0.0 1923 * 1924 * @global array $_parent_pages 1925 * 1926 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). 1927 * @param bool $display Optional. Whether or not to display the URL. Default true. 1928 * @return string The menu page URL. 1929 */ 1930 function menu_page_url( $menu_slug, $display = true ) { 1931 global $_parent_pages; 1932 1933 if ( isset( $_parent_pages[ $menu_slug ] ) ) { 1934 $parent_slug = $_parent_pages[ $menu_slug ]; 1935 1936 if ( $parent_slug && ! isset( $_parent_pages[ $parent_slug ] ) ) { 1937 $url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) ); 1938 } else { 1939 $url = admin_url( 'admin.php?page=' . $menu_slug ); 1940 } 1941 } else { 1942 $url = ''; 1943 } 1944 1945 $url = esc_url( $url ); 1946 1947 if ( $display ) { 1948 echo $url; 1949 } 1950 1951 return $url; 1952 } 1953 1954 // 1955 // Pluggable Menu Support -- Private. 1956 // 1957 /** 1958 * Gets the parent file of the current admin page. 1959 * 1960 * @since 1.5.0 1961 * 1962 * @global string $parent_file 1963 * @global array $menu 1964 * @global array $submenu 1965 * @global string $pagenow The filename of the current screen. 1966 * @global string $typenow The post type of the current screen. 1967 * @global string $plugin_page 1968 * @global array $_wp_real_parent_file 1969 * @global array $_wp_menu_nopriv 1970 * @global array $_wp_submenu_nopriv 1971 * 1972 * @param string $parent_page Optional. The slug name for the parent menu (or the file name 1973 * of a standard WordPress admin page). Default empty string. 1974 * @return string The parent file of the current admin page. 1975 */ 1976 function get_admin_page_parent( $parent_page = '' ) { 1977 global $parent_file, $menu, $submenu, $pagenow, $typenow, 1978 $plugin_page, $_wp_real_parent_file, $_wp_menu_nopriv, $_wp_submenu_nopriv; 1979 1980 if ( ! empty( $parent_page ) && 'admin.php' !== $parent_page ) { 1981 return $_wp_real_parent_file[ $parent_page ] ?? $parent_page; 1982 } 1983 1984 if ( 'admin.php' === $pagenow && isset( $plugin_page ) ) { 1985 foreach ( (array) $menu as $parent_menu ) { 1986 if ( $parent_menu[2] === $plugin_page ) { 1987 $parent_file = $plugin_page; 1988 return $_wp_real_parent_file[ $parent_file ] ?? $parent_file; 1989 } 1990 } 1991 if ( isset( $_wp_menu_nopriv[ $plugin_page ] ) ) { 1992 $parent_file = $plugin_page; 1993 return $_wp_real_parent_file[ $parent_file ] ?? $parent_file; 1994 } 1995 } 1996 1997 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $pagenow ][ $plugin_page ] ) ) { 1998 $parent_file = $pagenow; 1999 return $_wp_real_parent_file[ $parent_file ] ?? $parent_file; 2000 } 2001 2002 foreach ( array_keys( (array) $submenu ) as $parent_page ) { 2003 foreach ( $submenu[ $parent_page ] as $submenu_array ) { 2004 if ( isset( $_wp_real_parent_file[ $parent_page ] ) ) { 2005 $parent_page = $_wp_real_parent_file[ $parent_page ]; 2006 } 2007 2008 if ( ! empty( $typenow ) && "$pagenow?post_type=$typenow" === $submenu_array[2] ) { 2009 $parent_file = $parent_page; 2010 return $parent_page; 2011 } elseif ( empty( $typenow ) && $pagenow === $submenu_array[2] 2012 && ( empty( $parent_file ) || ! str_contains( $parent_file, '?' ) ) 2013 ) { 2014 $parent_file = $parent_page; 2015 return $parent_page; 2016 } elseif ( isset( $plugin_page ) && $plugin_page === $submenu_array[2] ) { 2017 $parent_file = $parent_page; 2018 return $parent_page; 2019 } 2020 } 2021 } 2022 2023 if ( empty( $parent_file ) ) { 2024 $parent_file = ''; 2025 } 2026 return ''; 2027 } 2028 2029 /** 2030 * Gets the title of the current admin page. 2031 * 2032 * @since 1.5.0 2033 * 2034 * @global string $title The title of the current screen. 2035 * @global array $menu 2036 * @global array $submenu 2037 * @global string $pagenow The filename of the current screen. 2038 * @global string $typenow The post type of the current screen. 2039 * @global string $plugin_page 2040 * 2041 * @return string The title of the current admin page. 2042 */ 2043 function get_admin_page_title() { 2044 global $title, $menu, $submenu, $pagenow, $typenow, $plugin_page; 2045 2046 if ( ! empty( $title ) ) { 2047 return $title; 2048 } 2049 2050 $hook = get_plugin_page_hook( $plugin_page, $pagenow ); 2051 2052 $parent = get_admin_page_parent(); 2053 $parent1 = $parent; 2054 2055 if ( empty( $parent ) ) { 2056 foreach ( (array) $menu as $menu_array ) { 2057 if ( isset( $menu_array[3] ) ) { 2058 if ( $menu_array[2] === $pagenow ) { 2059 $title = $menu_array[3]; 2060 return $menu_array[3]; 2061 } elseif ( isset( $plugin_page ) && $plugin_page === $menu_array[2] && $hook === $menu_array[5] ) { 2062 $title = $menu_array[3]; 2063 return $menu_array[3]; 2064 } 2065 } else { 2066 $title = $menu_array[0]; 2067 return $title; 2068 } 2069 } 2070 } else { 2071 foreach ( array_keys( $submenu ) as $parent ) { 2072 foreach ( $submenu[ $parent ] as $submenu_array ) { 2073 if ( isset( $plugin_page ) 2074 && $plugin_page === $submenu_array[2] 2075 && ( $pagenow === $parent 2076 || $plugin_page === $parent 2077 || $plugin_page === $hook 2078 || 'admin.php' === $pagenow && $parent1 !== $submenu_array[2] 2079 || ! empty( $typenow ) && "$pagenow?post_type=$typenow" === $parent ) 2080 ) { 2081 $title = $submenu_array[3]; 2082 return $submenu_array[3]; 2083 } 2084 2085 if ( $submenu_array[2] !== $pagenow || isset( $_GET['page'] ) ) { // Not the current page. 2086 continue; 2087 } 2088 2089 if ( isset( $submenu_array[3] ) ) { 2090 $title = $submenu_array[3]; 2091 return $submenu_array[3]; 2092 } else { 2093 $title = $submenu_array[0]; 2094 return $title; 2095 } 2096 } 2097 } 2098 if ( empty( $title ) ) { 2099 foreach ( $menu as $menu_array ) { 2100 if ( isset( $plugin_page ) 2101 && $plugin_page === $menu_array[2] 2102 && 'admin.php' === $pagenow 2103 && $parent1 === $menu_array[2] 2104 ) { 2105 $title = $menu_array[3]; 2106 return $menu_array[3]; 2107 } 2108 } 2109 } 2110 } 2111 2112 return $title; 2113 } 2114 2115 /** 2116 * Gets the hook attached to the administrative page of a plugin. 2117 * 2118 * @since 1.5.0 2119 * 2120 * @param string $plugin_page The slug name of the plugin page. 2121 * @param string $parent_page The slug name for the parent menu (or the file name of a standard 2122 * WordPress admin page). 2123 * @return string|null Hook attached to the plugin page, null otherwise. 2124 */ 2125 function get_plugin_page_hook( $plugin_page, $parent_page ) { 2126 $hook = get_plugin_page_hookname( $plugin_page, $parent_page ); 2127 if ( has_action( $hook ) ) { 2128 return $hook; 2129 } else { 2130 return null; 2131 } 2132 } 2133 2134 /** 2135 * Gets the hook name for the administrative page of a plugin. 2136 * 2137 * @since 1.5.0 2138 * 2139 * @global array $admin_page_hooks 2140 * 2141 * @param string $plugin_page The slug name of the plugin page. 2142 * @param string $parent_page The slug name for the parent menu (or the file name of a standard 2143 * WordPress admin page). 2144 * @return string Hook name for the plugin page. 2145 */ 2146 function get_plugin_page_hookname( $plugin_page, $parent_page ) { 2147 global $admin_page_hooks; 2148 2149 $parent = get_admin_page_parent( $parent_page ); 2150 2151 $page_type = 'admin'; 2152 if ( empty( $parent_page ) || 'admin.php' === $parent_page || isset( $admin_page_hooks[ $plugin_page ] ) ) { 2153 if ( isset( $admin_page_hooks[ $plugin_page ] ) ) { 2154 $page_type = 'toplevel'; 2155 } elseif ( isset( $admin_page_hooks[ $parent ] ) ) { 2156 $page_type = $admin_page_hooks[ $parent ]; 2157 } 2158 } elseif ( isset( $admin_page_hooks[ $parent ] ) ) { 2159 $page_type = $admin_page_hooks[ $parent ]; 2160 } 2161 2162 $plugin_name = preg_replace( '!\.php!', '', $plugin_page ); 2163 2164 return $page_type . '_page_' . $plugin_name; 2165 } 2166 2167 /** 2168 * Determines whether the current user can access the current admin page. 2169 * 2170 * @since 1.5.0 2171 * 2172 * @global string $pagenow The filename of the current screen. 2173 * @global array $menu 2174 * @global array $submenu 2175 * @global array $_wp_menu_nopriv 2176 * @global array $_wp_submenu_nopriv 2177 * @global string $plugin_page 2178 * @global array $_registered_pages 2179 * 2180 * @return bool True if the current user can access the admin page, false otherwise. 2181 */ 2182 function user_can_access_admin_page() { 2183 global $pagenow, $menu, $submenu, $_wp_menu_nopriv, $_wp_submenu_nopriv, 2184 $plugin_page, $_registered_pages; 2185 2186 $parent = get_admin_page_parent(); 2187 2188 if ( ! isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $parent ][ $pagenow ] ) ) { 2189 return false; 2190 } 2191 2192 if ( isset( $plugin_page ) ) { 2193 if ( isset( $_wp_submenu_nopriv[ $parent ][ $plugin_page ] ) ) { 2194 return false; 2195 } 2196 2197 $hookname = get_plugin_page_hookname( $plugin_page, $parent ); 2198 2199 if ( ! isset( $_registered_pages[ $hookname ] ) ) { 2200 return false; 2201 } 2202 } 2203 2204 if ( empty( $parent ) ) { 2205 if ( isset( $_wp_menu_nopriv[ $pagenow ] ) ) { 2206 return false; 2207 } 2208 if ( isset( $_wp_submenu_nopriv[ $pagenow ][ $pagenow ] ) ) { 2209 return false; 2210 } 2211 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $pagenow ][ $plugin_page ] ) ) { 2212 return false; 2213 } 2214 if ( isset( $plugin_page ) && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) { 2215 return false; 2216 } 2217 2218 foreach ( array_keys( $_wp_submenu_nopriv ) as $key ) { 2219 if ( isset( $_wp_submenu_nopriv[ $key ][ $pagenow ] ) ) { 2220 return false; 2221 } 2222 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $key ][ $plugin_page ] ) ) { 2223 return false; 2224 } 2225 } 2226 2227 return true; 2228 } 2229 2230 if ( isset( $plugin_page ) && $plugin_page === $parent && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) { 2231 return false; 2232 } 2233 2234 if ( isset( $submenu[ $parent ] ) ) { 2235 foreach ( $submenu[ $parent ] as $submenu_array ) { 2236 if ( isset( $plugin_page ) && $submenu_array[2] === $plugin_page ) { 2237 return current_user_can( $submenu_array[1] ); 2238 } elseif ( $submenu_array[2] === $pagenow ) { 2239 return current_user_can( $submenu_array[1] ); 2240 } 2241 } 2242 } 2243 2244 foreach ( $menu as $menu_array ) { 2245 if ( $menu_array[2] === $parent ) { 2246 return current_user_can( $menu_array[1] ); 2247 } 2248 } 2249 2250 return true; 2251 } 2252 2253 /* Allowed list functions */ 2254 2255 /** 2256 * Refreshes the value of the allowed options list available via the 'allowed_options' hook. 2257 * 2258 * See the {@see 'allowed_options'} filter. 2259 * 2260 * @since 2.7.0 2261 * @since 5.5.0 `$new_whitelist_options` was renamed to `$new_allowed_options`. 2262 * Please consider writing more inclusive code. 2263 * 2264 * @global array $new_allowed_options 2265 * 2266 * @param array $options 2267 * @return array Updated allowed options. 2268 */ 2269 function option_update_filter( $options ) { 2270 global $new_allowed_options; 2271 2272 if ( is_array( $new_allowed_options ) ) { 2273 $options = add_allowed_options( $new_allowed_options, $options ); 2274 } 2275 2276 return $options; 2277 } 2278 2279 /** 2280 * Adds an array of options to the list of allowed options. 2281 * 2282 * @since 5.5.0 2283 * 2284 * @global array $allowed_options 2285 * 2286 * @param array $new_options 2287 * @param string|array $options 2288 * @return array Updated allowed options. 2289 */ 2290 function add_allowed_options( $new_options, $options = '' ) { 2291 if ( '' === $options ) { 2292 global $allowed_options; 2293 } else { 2294 $allowed_options = $options; 2295 } 2296 2297 foreach ( $new_options as $page => $keys ) { 2298 foreach ( $keys as $key ) { 2299 if ( ! isset( $allowed_options[ $page ] ) || ! is_array( $allowed_options[ $page ] ) ) { 2300 $allowed_options[ $page ] = array(); 2301 $allowed_options[ $page ][] = $key; 2302 } else { 2303 $pos = array_search( $key, $allowed_options[ $page ], true ); 2304 if ( false === $pos ) { 2305 $allowed_options[ $page ][] = $key; 2306 } 2307 } 2308 } 2309 } 2310 2311 return $allowed_options; 2312 } 2313 2314 /** 2315 * Removes a list of options from the allowed options list. 2316 * 2317 * @since 5.5.0 2318 * 2319 * @global array $allowed_options 2320 * 2321 * @param array $del_options 2322 * @param string|array $options 2323 * @return array Updated allowed options. 2324 */ 2325 function remove_allowed_options( $del_options, $options = '' ) { 2326 if ( '' === $options ) { 2327 global $allowed_options; 2328 } else { 2329 $allowed_options = $options; 2330 } 2331 2332 foreach ( $del_options as $page => $keys ) { 2333 foreach ( $keys as $key ) { 2334 if ( isset( $allowed_options[ $page ] ) && is_array( $allowed_options[ $page ] ) ) { 2335 $pos = array_search( $key, $allowed_options[ $page ], true ); 2336 if ( false !== $pos ) { 2337 unset( $allowed_options[ $page ][ $pos ] ); 2338 } 2339 } 2340 } 2341 } 2342 2343 return $allowed_options; 2344 } 2345 2346 /** 2347 * Outputs nonce, action, and option_page fields for a settings page. 2348 * 2349 * @since 2.7.0 2350 * 2351 * @param string $option_group A settings group name. This should match the group name 2352 * used in register_setting(). 2353 */ 2354 function settings_fields( $option_group ) { 2355 echo "<input type='hidden' name='option_page' value='" . esc_attr( $option_group ) . "' />"; 2356 echo '<input type="hidden" name="action" value="update" />'; 2357 wp_nonce_field( "$option_group-options" ); 2358 } 2359 2360 /** 2361 * Clears the plugins cache used by get_plugins() and by default, the plugin updates cache. 2362 * 2363 * @since 3.7.0 2364 * 2365 * @param bool $clear_update_cache Whether to clear the plugin updates cache. Default true. 2366 */ 2367 function wp_clean_plugins_cache( $clear_update_cache = true ) { 2368 if ( $clear_update_cache ) { 2369 delete_site_transient( 'update_plugins' ); 2370 } 2371 wp_cache_delete( 'plugins', 'plugins' ); 2372 } 2373 2374 /** 2375 * Loads a given plugin attempt to generate errors. 2376 * 2377 * @since 3.0.0 2378 * @since 4.4.0 Function was moved into the `wp-admin/includes/plugin.php` file. 2379 * 2380 * @param string $plugin Path to the plugin file relative to the plugins directory. 2381 */ 2382 function plugin_sandbox_scrape( $plugin ) { 2383 if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) { 2384 define( 'WP_SANDBOX_SCRAPING', true ); 2385 } 2386 2387 wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin ); 2388 include_once WP_PLUGIN_DIR . '/' . $plugin; 2389 } 2390 2391 /** 2392 * Declares a helper function for adding content to the Privacy Policy Guide. 2393 * 2394 * Plugins and themes should suggest text for inclusion in the site's privacy policy. 2395 * The suggested text should contain information about any functionality that affects user privacy, 2396 * and will be shown on the Privacy Policy Guide screen. 2397 * 2398 * A plugin or theme can use this function multiple times as long as it will help to better present 2399 * the suggested policy content. For example modular plugins such as WooCommerse or Jetpack 2400 * can add or remove suggested content depending on the modules/extensions that are enabled. 2401 * For more information see the Plugin Handbook: 2402 * https://developer.wordpress.org/plugins/privacy/suggesting-text-for-the-site-privacy-policy/. 2403 * 2404 * The HTML contents of the `$policy_text` supports use of a specialized `.privacy-policy-tutorial` 2405 * CSS class which can be used to provide supplemental information. Any content contained within 2406 * HTML elements that have the `.privacy-policy-tutorial` CSS class applied will be omitted 2407 * from the clipboard when the section content is copied. 2408 * 2409 * Intended for use with the `'admin_init'` action. 2410 * 2411 * @since 4.9.6 2412 * 2413 * @param string $plugin_name The name of the plugin or theme that is suggesting content 2414 * for the site's privacy policy. 2415 * @param string $policy_text The suggested content for inclusion in the policy. 2416 */ 2417 function wp_add_privacy_policy_content( $plugin_name, $policy_text ) { 2418 if ( ! is_admin() ) { 2419 _doing_it_wrong( 2420 __FUNCTION__, 2421 sprintf( 2422 /* translators: %s: admin_init */ 2423 __( 'The suggested privacy policy content should be added only in wp-admin by using the %s (or later) action.' ), 2424 '<code>admin_init</code>' 2425 ), 2426 '4.9.7' 2427 ); 2428 return; 2429 } elseif ( ! doing_action( 'admin_init' ) && ! did_action( 'admin_init' ) ) { 2430 _doing_it_wrong( 2431 __FUNCTION__, 2432 sprintf( 2433 /* translators: %s: admin_init */ 2434 __( 'The suggested privacy policy content should be added by using the %s (or later) action. Please see the inline documentation.' ), 2435 '<code>admin_init</code>' 2436 ), 2437 '4.9.7' 2438 ); 2439 return; 2440 } 2441 2442 if ( ! class_exists( 'WP_Privacy_Policy_Content' ) ) { 2443 require_once ABSPATH . 'wp-admin/includes/class-wp-privacy-policy-content.php'; 2444 } 2445 2446 WP_Privacy_Policy_Content::add( $plugin_name, $policy_text ); 2447 } 2448 2449 /** 2450 * Determines whether a plugin is technically active but was paused while 2451 * loading. 2452 * 2453 * For more information on this and similar theme functions, check out 2454 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 2455 * Conditional Tags} article in the Theme Developer Handbook. 2456 * 2457 * @since 5.2.0 2458 * 2459 * @global WP_Paused_Extensions_Storage $_paused_plugins 2460 * 2461 * @param string $plugin Path to the plugin file relative to the plugins directory. 2462 * @return bool True, if in the list of paused plugins. False, if not in the list. 2463 */ 2464 function is_plugin_paused( $plugin ) { 2465 if ( ! isset( $GLOBALS['_paused_plugins'] ) ) { 2466 return false; 2467 } 2468 2469 if ( ! is_plugin_active( $plugin ) ) { 2470 return false; 2471 } 2472 2473 list( $plugin ) = explode( '/', $plugin ); 2474 2475 return array_key_exists( $plugin, $GLOBALS['_paused_plugins'] ); 2476 } 2477 2478 /** 2479 * Gets the error that was recorded for a paused plugin. 2480 * 2481 * @since 5.2.0 2482 * 2483 * @global WP_Paused_Extensions_Storage $_paused_plugins 2484 * 2485 * @param string $plugin Path to the plugin file relative to the plugins directory. 2486 * @return array|false Array of error information as returned by `error_get_last()`, 2487 * or false if none was recorded. 2488 */ 2489 function wp_get_plugin_error( $plugin ) { 2490 if ( ! isset( $GLOBALS['_paused_plugins'] ) ) { 2491 return false; 2492 } 2493 2494 list( $plugin ) = explode( '/', $plugin ); 2495 2496 if ( ! array_key_exists( $plugin, $GLOBALS['_paused_plugins'] ) ) { 2497 return false; 2498 } 2499 2500 return $GLOBALS['_paused_plugins'][ $plugin ]; 2501 } 2502 2503 /** 2504 * Tries to resume a single plugin. 2505 * 2506 * If a redirect was provided, we first ensure the plugin does not throw fatal 2507 * errors anymore. 2508 * 2509 * The way it works is by setting the redirection to the error before trying to 2510 * include the plugin file. If the plugin fails, then the redirection will not 2511 * be overwritten with the success message and the plugin will not be resumed. 2512 * 2513 * @since 5.2.0 2514 * 2515 * @param string $plugin Single plugin to resume. 2516 * @param string $redirect Optional. URL to redirect to. Default empty string. 2517 * @return true|WP_Error True on success, false if `$plugin` was not paused, 2518 * `WP_Error` on failure. 2519 */ 2520 function resume_plugin( $plugin, $redirect = '' ) { 2521 /* 2522 * We'll override this later if the plugin could be resumed without 2523 * creating a fatal error. 2524 */ 2525 if ( ! empty( $redirect ) ) { 2526 wp_redirect( 2527 add_query_arg( 2528 '_error_nonce', 2529 wp_create_nonce( 'plugin-resume-error_' . $plugin ), 2530 $redirect 2531 ) 2532 ); 2533 2534 // Load the plugin to test whether it throws a fatal error. 2535 ob_start(); 2536 plugin_sandbox_scrape( $plugin ); 2537 ob_clean(); 2538 } 2539 2540 list( $extension ) = explode( '/', $plugin ); 2541 2542 $result = wp_paused_plugins()->delete( $extension ); 2543 2544 if ( ! $result ) { 2545 return new WP_Error( 2546 'could_not_resume_plugin', 2547 __( 'Could not resume the plugin.' ) 2548 ); 2549 } 2550 2551 return true; 2552 } 2553 2554 /** 2555 * Renders an admin notice in case some plugins have been paused due to errors. 2556 * 2557 * @since 5.2.0 2558 * 2559 * @global string $pagenow The filename of the current screen. 2560 * @global WP_Paused_Extensions_Storage $_paused_plugins 2561 */ 2562 function paused_plugins_notice() { 2563 if ( 'plugins.php' === $GLOBALS['pagenow'] ) { 2564 return; 2565 } 2566 2567 if ( ! current_user_can( 'resume_plugins' ) ) { 2568 return; 2569 } 2570 2571 if ( ! isset( $GLOBALS['_paused_plugins'] ) || empty( $GLOBALS['_paused_plugins'] ) ) { 2572 return; 2573 } 2574 2575 $message = sprintf( 2576 '<strong>%s</strong><br>%s</p><p><a href="%s">%s</a>', 2577 __( 'One or more plugins failed to load properly.' ), 2578 __( 'You can find more details and make changes on the Plugins screen.' ), 2579 esc_url( admin_url( 'plugins.php?plugin_status=paused' ) ), 2580 __( 'Go to the Plugins screen' ) 2581 ); 2582 wp_admin_notice( 2583 $message, 2584 array( 'type' => 'error' ) 2585 ); 2586 } 2587 2588 /** 2589 * Renders an admin notice when a plugin was deactivated during an update. 2590 * 2591 * Displays an admin notice in case a plugin has been deactivated during an 2592 * upgrade due to incompatibility with the current version of WordPress. 2593 * 2594 * @since 5.8.0 2595 * @access private 2596 * 2597 * @global string $pagenow The filename of the current screen. 2598 * @global string $wp_version The WordPress version string. 2599 */ 2600 function deactivated_plugins_notice() { 2601 if ( 'plugins.php' === $GLOBALS['pagenow'] ) { 2602 return; 2603 } 2604 2605 if ( ! current_user_can( 'activate_plugins' ) ) { 2606 return; 2607 } 2608 2609 $blog_deactivated_plugins = get_option( 'wp_force_deactivated_plugins' ); 2610 $site_deactivated_plugins = array(); 2611 2612 if ( false === $blog_deactivated_plugins ) { 2613 // Option not in database, add an empty array to avoid extra DB queries on subsequent loads. 2614 update_option( 'wp_force_deactivated_plugins', array(), false ); 2615 } 2616 2617 if ( is_multisite() ) { 2618 $site_deactivated_plugins = get_site_option( 'wp_force_deactivated_plugins' ); 2619 if ( false === $site_deactivated_plugins ) { 2620 // Option not in database, add an empty array to avoid extra DB queries on subsequent loads. 2621 update_site_option( 'wp_force_deactivated_plugins', array() ); 2622 } 2623 } 2624 2625 if ( empty( $blog_deactivated_plugins ) && empty( $site_deactivated_plugins ) ) { 2626 // No deactivated plugins. 2627 return; 2628 } 2629 2630 $deactivated_plugins = array_merge( $blog_deactivated_plugins, $site_deactivated_plugins ); 2631 2632 foreach ( $deactivated_plugins as $plugin ) { 2633 if ( ! empty( $plugin['version_compatible'] ) && ! empty( $plugin['version_deactivated'] ) ) { 2634 $explanation = sprintf( 2635 /* translators: 1: Name of deactivated plugin, 2: Plugin version deactivated, 3: Current WP version, 4: Compatible plugin version. */ 2636 __( '%1$s %2$s was deactivated due to incompatibility with WordPress %3$s, please upgrade to %1$s %4$s or later.' ), 2637 $plugin['plugin_name'], 2638 $plugin['version_deactivated'], 2639 $GLOBALS['wp_version'], 2640 $plugin['version_compatible'] 2641 ); 2642 } else { 2643 $explanation = sprintf( 2644 /* translators: 1: Name of deactivated plugin, 2: Plugin version deactivated, 3: Current WP version. */ 2645 __( '%1$s %2$s was deactivated due to incompatibility with WordPress %3$s.' ), 2646 $plugin['plugin_name'], 2647 ! empty( $plugin['version_deactivated'] ) ? $plugin['version_deactivated'] : '', 2648 $GLOBALS['wp_version'], 2649 $plugin['version_compatible'] 2650 ); 2651 } 2652 2653 $message = sprintf( 2654 '<strong>%s</strong><br>%s</p><p><a href="%s">%s</a>', 2655 sprintf( 2656 /* translators: %s: Name of deactivated plugin. */ 2657 __( '%s plugin deactivated during WordPress upgrade.' ), 2658 $plugin['plugin_name'] 2659 ), 2660 $explanation, 2661 esc_url( admin_url( 'plugins.php?plugin_status=inactive' ) ), 2662 __( 'Go to the Plugins screen' ) 2663 ); 2664 wp_admin_notice( $message, array( 'type' => 'warning' ) ); 2665 } 2666 2667 // Empty the options. 2668 update_option( 'wp_force_deactivated_plugins', array(), false ); 2669 if ( is_multisite() ) { 2670 update_site_option( 'wp_force_deactivated_plugins', array() ); 2671 } 2672 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Fri Sep 25 08:20:31 2026 | Cross-referenced by PHPXref |