| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * These functions are needed to load WordPress. 4 * 5 * @package WordPress 6 */ 7 8 /** 9 * Returns the HTTP protocol sent by the server. 10 * 11 * @since 4.4.0 12 * 13 * @return string The HTTP protocol. Default: HTTP/1.0. 14 */ 15 function wp_get_server_protocol() { 16 $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : ''; 17 18 if ( ! in_array( $protocol, array( 'HTTP/1.1', 'HTTP/2', 'HTTP/2.0', 'HTTP/3' ), true ) ) { 19 $protocol = 'HTTP/1.0'; 20 } 21 22 return $protocol; 23 } 24 25 /** 26 * Fixes `$_SERVER` variables for various setups. 27 * 28 * @since 3.0.0 29 * @access private 30 * 31 * @global string $PHP_SELF The filename of the currently executing script, 32 * relative to the document root. 33 */ 34 function wp_fix_server_vars() { 35 global $PHP_SELF; 36 37 $default_server_values = array( 38 'SERVER_SOFTWARE' => '', 39 'REQUEST_URI' => '', 40 ); 41 42 $_SERVER = array_merge( $default_server_values, $_SERVER ); 43 44 // Fix for IIS when running with PHP ISAPI. 45 if ( empty( $_SERVER['REQUEST_URI'] ) 46 || ( 'cgi-fcgi' !== PHP_SAPI && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) 47 ) { 48 49 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) { 50 // IIS Mod-Rewrite. 51 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL']; 52 } elseif ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) { 53 // IIS Isapi_Rewrite. 54 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL']; 55 } else { 56 // Use ORIG_PATH_INFO if there is no PATH_INFO. 57 if ( ! isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) ) { 58 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO']; 59 } 60 61 // Some IIS + PHP configurations put the script-name in the path-info (no need to append it twice). 62 if ( isset( $_SERVER['PATH_INFO'] ) ) { 63 if ( $_SERVER['PATH_INFO'] === $_SERVER['SCRIPT_NAME'] ) { 64 $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO']; 65 } else { 66 $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO']; 67 } 68 } 69 70 // Append the query string if it exists and isn't null. 71 if ( ! empty( $_SERVER['QUERY_STRING'] ) ) { 72 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING']; 73 } 74 } 75 } 76 77 // Fix for PHP as CGI hosts that set SCRIPT_FILENAME to something ending in php.cgi for all requests. 78 if ( isset( $_SERVER['SCRIPT_FILENAME'] ) && str_ends_with( $_SERVER['SCRIPT_FILENAME'], 'php.cgi' ) ) { 79 $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED']; 80 } 81 82 // Fix for Dreamhost and other PHP as CGI hosts. 83 if ( isset( $_SERVER['SCRIPT_NAME'] ) && str_contains( $_SERVER['SCRIPT_NAME'], 'php.cgi' ) ) { 84 unset( $_SERVER['PATH_INFO'] ); 85 } 86 87 // Fix empty PHP_SELF. 88 $PHP_SELF = $_SERVER['PHP_SELF']; 89 if ( empty( $PHP_SELF ) ) { 90 $_SERVER['PHP_SELF'] = preg_replace( '/(\?.*)?$/', '', $_SERVER['REQUEST_URI'] ); 91 $PHP_SELF = $_SERVER['PHP_SELF']; 92 } 93 94 wp_populate_basic_auth_from_authorization_header(); 95 } 96 97 /** 98 * Populates the Basic Auth server details from the Authorization header. 99 * 100 * Some servers running in CGI or FastCGI mode don't pass the Authorization 101 * header on to WordPress. If it's been rewritten to the `HTTP_AUTHORIZATION` header, 102 * fill in the proper $_SERVER variables instead. 103 * 104 * @since 5.6.0 105 */ 106 function wp_populate_basic_auth_from_authorization_header() { 107 // If we don't have anything to pull from, return early. 108 if ( ! isset( $_SERVER['HTTP_AUTHORIZATION'] ) && ! isset( $_SERVER['REDIRECT_HTTP_AUTHORIZATION'] ) ) { 109 return; 110 } 111 112 // If either PHP_AUTH key is already set, do nothing. 113 if ( isset( $_SERVER['PHP_AUTH_USER'] ) || isset( $_SERVER['PHP_AUTH_PW'] ) ) { 114 return; 115 } 116 117 // From our prior conditional, one of these must be set. 118 $header = isset( $_SERVER['HTTP_AUTHORIZATION'] ) ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['REDIRECT_HTTP_AUTHORIZATION']; 119 120 // Test to make sure the pattern matches expected. 121 if ( ! preg_match( '%^Basic [a-z\d/+]*={0,2}$%i', $header ) ) { 122 return; 123 } 124 125 // Removing `Basic ` the token would start six characters in. 126 $token = substr( $header, 6 ); 127 $userpass = base64_decode( $token ); 128 129 // There must be at least one colon in the string. 130 if ( ! str_contains( $userpass, ':' ) ) { 131 return; 132 } 133 134 list( $user, $pass ) = explode( ':', $userpass, 2 ); 135 136 // Now shove them in the proper keys where we're expecting later on. 137 $_SERVER['PHP_AUTH_USER'] = $user; 138 $_SERVER['PHP_AUTH_PW'] = $pass; 139 } 140 141 /** 142 * Checks the server requirements. 143 * 144 * - PHP version 145 * - PHP extensions 146 * - MySQL or MariaDB version (unless a database drop-in is present) 147 * 148 * Dies if requirements are not met. 149 * 150 * @since 3.0.0 151 * @access private 152 * 153 * @global string $required_php_version The minimum required PHP version string. 154 * @global string[] $required_php_extensions The names of required PHP extensions. 155 * @global string $wp_version The WordPress version string. 156 */ 157 function wp_check_php_mysql_versions() { 158 global $required_php_version, $required_php_extensions, $wp_version; 159 160 $php_version = PHP_VERSION; 161 162 if ( version_compare( $required_php_version, $php_version, '>' ) ) { 163 $protocol = wp_get_server_protocol(); 164 header( sprintf( '%s 500 Internal Server Error', $protocol ), true, 500 ); 165 header( 'Content-Type: text/html; charset=utf-8' ); 166 printf( 167 'Your server is running PHP version %1$s but WordPress %2$s requires at least %3$s.', 168 $php_version, 169 $wp_version, 170 $required_php_version 171 ); 172 exit( 1 ); 173 } 174 175 $missing_extensions = array(); 176 177 if ( isset( $required_php_extensions ) && is_array( $required_php_extensions ) ) { 178 foreach ( $required_php_extensions as $extension ) { 179 if ( extension_loaded( $extension ) ) { 180 continue; 181 } 182 183 $missing_extensions[] = sprintf( 184 'WordPress %1$s requires the <code>%2$s</code> PHP extension.', 185 $wp_version, 186 $extension 187 ); 188 } 189 } 190 191 if ( count( $missing_extensions ) > 0 ) { 192 $protocol = wp_get_server_protocol(); 193 header( sprintf( '%s 500 Internal Server Error', $protocol ), true, 500 ); 194 header( 'Content-Type: text/html; charset=utf-8' ); 195 echo implode( '<br>', $missing_extensions ); 196 exit( 1 ); 197 } 198 199 // This runs before default constants are defined, so we can't assume WP_CONTENT_DIR is set yet. 200 $wp_content_dir = defined( 'WP_CONTENT_DIR' ) ? WP_CONTENT_DIR : ABSPATH . 'wp-content'; 201 202 if ( ! function_exists( 'mysqli_connect' ) 203 && ! file_exists( $wp_content_dir . '/db.php' ) 204 ) { 205 require_once ABSPATH . WPINC . '/functions.php'; 206 wp_load_translations_early(); 207 208 $message = '<p>' . __( 'Your PHP installation appears to be missing the MySQL extension which is required by WordPress.' ) . "</p>\n"; 209 210 $message .= '<p>' . sprintf( 211 /* translators: %s: mysqli. */ 212 __( 'Please check that the %s PHP extension is installed and enabled.' ), 213 '<code>mysqli</code>' 214 ) . "</p>\n"; 215 216 $message .= '<p>' . sprintf( 217 /* translators: %s: Support forums URL. */ 218 __( 'If you are unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress support forums</a>.' ), 219 __( 'https://wordpress.org/support/forums/' ) 220 ) . "</p>\n"; 221 222 $args = array( 223 'exit' => false, 224 'code' => 'mysql_not_found', 225 ); 226 wp_die( 227 $message, 228 __( 'Requirements Not Met' ), 229 $args 230 ); 231 exit( 1 ); 232 } 233 } 234 235 /** 236 * Retrieves the current environment type. 237 * 238 * The type can be set via the `WP_ENVIRONMENT_TYPE` global system variable, 239 * or a constant of the same name. 240 * 241 * Possible values are 'local', 'development', 'staging', and 'production'. 242 * If not set, the type defaults to 'production'. 243 * 244 * @since 5.5.0 245 * @since 5.5.1 Added the 'local' type. 246 * @since 5.5.1 Removed the ability to alter the list of types. 247 * 248 * @return string The current environment type. 249 */ 250 function wp_get_environment_type() { 251 static $current_env = ''; 252 253 if ( ! defined( 'WP_RUN_CORE_TESTS' ) && $current_env ) { 254 return $current_env; 255 } 256 257 $wp_environments = array( 258 'local', 259 'development', 260 'staging', 261 'production', 262 ); 263 264 // Add a note about the deprecated WP_ENVIRONMENT_TYPES constant. 265 if ( defined( 'WP_ENVIRONMENT_TYPES' ) && function_exists( '_deprecated_argument' ) ) { 266 if ( function_exists( '__' ) ) { 267 /* translators: %s: WP_ENVIRONMENT_TYPES */ 268 $message = sprintf( __( 'The %s constant is no longer supported.' ), 'WP_ENVIRONMENT_TYPES' ); 269 } else { 270 $message = sprintf( 'The %s constant is no longer supported.', 'WP_ENVIRONMENT_TYPES' ); 271 } 272 273 _deprecated_argument( 274 'define()', 275 '5.5.1', 276 $message 277 ); 278 } 279 280 // Check if the environment variable has been set, if `getenv` is available on the system. 281 if ( function_exists( 'getenv' ) ) { 282 $has_env = getenv( 'WP_ENVIRONMENT_TYPE' ); 283 if ( false !== $has_env ) { 284 $current_env = $has_env; 285 } 286 } 287 288 // Fetch the environment from a constant, this overrides the global system variable. 289 if ( defined( 'WP_ENVIRONMENT_TYPE' ) && WP_ENVIRONMENT_TYPE ) { 290 $current_env = WP_ENVIRONMENT_TYPE; 291 } 292 293 // Make sure the environment is an allowed one, and not accidentally set to an invalid value. 294 if ( ! in_array( $current_env, $wp_environments, true ) ) { 295 $current_env = 'production'; 296 } 297 298 return $current_env; 299 } 300 301 /** 302 * Retrieves the current development mode. 303 * 304 * The development mode affects how certain parts of the WordPress application behave, 305 * which is relevant when developing for WordPress. 306 * 307 * Development mode can be set via the `WP_DEVELOPMENT_MODE` constant in `wp-config.php`. 308 * Possible values are 'core', 'plugin', 'theme', 'all', or an empty string to disable 309 * development mode. 'all' is a special value to signify that all three development modes 310 * ('core', 'plugin', and 'theme') are enabled. 311 * 312 * Development mode is considered separately from `WP_DEBUG` and wp_get_environment_type(). 313 * It does not affect debugging output, but rather functional nuances in WordPress. 314 * 315 * This function retrieves the currently set development mode value. To check whether 316 * a specific development mode is enabled, use wp_is_development_mode(). 317 * 318 * @since 6.3.0 319 * 320 * @return string The current development mode. 321 */ 322 function wp_get_development_mode() { 323 static $current_mode = null; 324 325 if ( ! defined( 'WP_RUN_CORE_TESTS' ) && null !== $current_mode ) { 326 return $current_mode; 327 } 328 329 $development_mode = WP_DEVELOPMENT_MODE; 330 331 // Exclusively for core tests, rely on the `$_wp_tests_development_mode` global. 332 if ( defined( 'WP_RUN_CORE_TESTS' ) && isset( $GLOBALS['_wp_tests_development_mode'] ) ) { 333 $development_mode = $GLOBALS['_wp_tests_development_mode']; 334 } 335 336 $valid_modes = array( 337 'core', 338 'plugin', 339 'theme', 340 'all', 341 '', 342 ); 343 344 if ( ! in_array( $development_mode, $valid_modes, true ) ) { 345 $development_mode = ''; 346 } 347 348 $current_mode = $development_mode; 349 350 return $current_mode; 351 } 352 353 /** 354 * Checks whether the site is in the given development mode. 355 * 356 * @since 6.3.0 357 * 358 * @param string $mode Development mode to check for. Either 'core', 'plugin', 'theme', or 'all'. 359 * @return bool True if the given mode is covered by the current development mode, false otherwise. 360 */ 361 function wp_is_development_mode( $mode ) { 362 $current_mode = wp_get_development_mode(); 363 if ( empty( $current_mode ) ) { 364 return false; 365 } 366 367 // Return true if the current mode encompasses all modes. 368 if ( 'all' === $current_mode ) { 369 return true; 370 } 371 372 // Return true if the current mode is the given mode. 373 return $mode === $current_mode; 374 } 375 376 /** 377 * Ensures all of WordPress is not loaded when handling a favicon.ico request. 378 * 379 * Instead, send the headers for a zero-length favicon and bail. 380 * 381 * @since 3.0.0 382 * @deprecated 5.4.0 Deprecated in favor of do_favicon(). 383 */ 384 function wp_favicon_request() { 385 if ( '/favicon.ico' === $_SERVER['REQUEST_URI'] ) { 386 header( 'Content-Type: image/vnd.microsoft.icon' ); 387 exit; 388 } 389 } 390 391 /** 392 * Dies with a maintenance message when conditions are met. 393 * 394 * The default message can be replaced by using a drop-in (maintenance.php in 395 * the wp-content directory). 396 * 397 * @since 3.0.0 398 * @access private 399 */ 400 function wp_maintenance() { 401 // Return if maintenance mode is disabled. 402 if ( ! wp_is_maintenance_mode() ) { 403 return; 404 } 405 406 if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) { 407 require_once WP_CONTENT_DIR . '/maintenance.php'; 408 die(); 409 } 410 411 require_once ABSPATH . WPINC . '/functions.php'; 412 wp_load_translations_early(); 413 414 header( 'Retry-After: 600' ); 415 416 wp_die( 417 __( 'Briefly unavailable for scheduled maintenance. Check back in a minute.' ), 418 __( 'Maintenance' ), 419 503 420 ); 421 } 422 423 /** 424 * Checks if maintenance mode is enabled. 425 * 426 * Checks for a file in the WordPress root directory named ".maintenance". 427 * This file will contain the variable $upgrading, set to the time the file 428 * was created. If the file was created less than 10 minutes ago, WordPress 429 * is in maintenance mode. 430 * 431 * @since 5.5.0 432 * 433 * @global int $upgrading The Unix timestamp marking when upgrading WordPress began. 434 * 435 * @return bool True if maintenance mode is enabled, false otherwise. 436 */ 437 function wp_is_maintenance_mode() { 438 global $upgrading; 439 440 if ( ! file_exists( ABSPATH . '.maintenance' ) || wp_installing() ) { 441 return false; 442 } 443 444 require ABSPATH . '.maintenance'; 445 446 // If the $upgrading timestamp is older than 10 minutes, consider maintenance over. 447 if ( ( time() - $upgrading ) >= 10 * MINUTE_IN_SECONDS ) { 448 return false; 449 } 450 451 // Don't enable maintenance mode while scraping for fatal errors. 452 if ( is_int( $upgrading ) && isset( $_REQUEST['wp_scrape_key'], $_REQUEST['wp_scrape_nonce'] ) ) { 453 $key = stripslashes( $_REQUEST['wp_scrape_key'] ); 454 $nonce = stripslashes( $_REQUEST['wp_scrape_nonce'] ); 455 456 if ( md5( $upgrading ) === $key && (int) $nonce === $upgrading ) { 457 return false; 458 } 459 } 460 461 /** 462 * Filters whether to enable maintenance mode. 463 * 464 * This filter runs before it can be used by plugins. It is designed for 465 * non-web runtimes. If this filter returns true, maintenance mode will be 466 * active and the request will end. If false, the request will be allowed to 467 * continue processing even if maintenance mode should be active. 468 * 469 * @since 4.6.0 470 * 471 * @param bool $enable_checks Whether to enable maintenance mode. Default true. 472 * @param int $upgrading The timestamp set in the .maintenance file. 473 */ 474 if ( ! apply_filters( 'enable_maintenance_mode', true, $upgrading ) ) { 475 return false; 476 } 477 478 return true; 479 } 480 481 /** 482 * Gets the time elapsed so far during this PHP script. 483 * 484 * @since 5.8.0 485 * 486 * @return float Seconds since the PHP script started. 487 */ 488 function timer_float() { 489 return microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']; 490 } 491 492 /** 493 * Starts the WordPress micro-timer. 494 * 495 * @since 0.71 496 * @access private 497 * 498 * @global float $timestart Unix timestamp set at the beginning of the page load. 499 * @see timer_stop() 500 * 501 * @return bool Always returns true. 502 */ 503 function timer_start() { 504 global $timestart; 505 506 $timestart = microtime( true ); 507 508 return true; 509 } 510 511 /** 512 * Retrieves or displays the time from the page start to when function is called. 513 * 514 * @since 0.71 515 * 516 * @global float $timestart Seconds from when timer_start() is called. 517 * @global float $timeend Seconds from when function is called. 518 * 519 * @param int|bool $display Whether to echo or return the results. Accepts 0|false for return, 520 * 1|true for echo. Default 0|false. 521 * @param int $precision The number of digits from the right of the decimal to display. 522 * Default 3. 523 * @return string The "second.microsecond" finished time calculation. The number is formatted 524 * for human consumption, both localized and rounded. 525 */ 526 function timer_stop( $display = 0, $precision = 3 ) { 527 global $timestart, $timeend; 528 529 $timeend = microtime( true ); 530 $timetotal = $timeend - $timestart; 531 532 if ( function_exists( 'number_format_i18n' ) ) { 533 $r = number_format_i18n( $timetotal, $precision ); 534 } else { 535 $r = number_format( $timetotal, $precision ); 536 } 537 538 if ( $display ) { 539 echo $r; 540 } 541 542 return $r; 543 } 544 545 /** 546 * Sets PHP error reporting based on WordPress debug settings. 547 * 548 * Uses three constants: `WP_DEBUG`, `WP_DEBUG_DISPLAY`, and `WP_DEBUG_LOG`. 549 * All three can be defined in wp-config.php. By default, `WP_DEBUG` and 550 * `WP_DEBUG_LOG` are set to false, and `WP_DEBUG_DISPLAY` is set to true. 551 * 552 * When `WP_DEBUG` is true, all PHP notices are reported. WordPress will also 553 * display internal notices: when a deprecated WordPress function, function 554 * argument, or file is used. Deprecated code may be removed from a later 555 * version. 556 * 557 * It is strongly recommended that plugin and theme developers use `WP_DEBUG` 558 * in their development environments. 559 * 560 * `WP_DEBUG_DISPLAY` and `WP_DEBUG_LOG` perform no function unless `WP_DEBUG` 561 * is true. 562 * 563 * When `WP_DEBUG_DISPLAY` is true, WordPress will force errors to be displayed. 564 * `WP_DEBUG_DISPLAY` defaults to true. Defining it as null prevents WordPress 565 * from changing the global configuration setting. Defining `WP_DEBUG_DISPLAY` 566 * as false will force errors to be hidden. 567 * 568 * When `WP_DEBUG_LOG` is true, errors will be logged to `wp-content/debug.log`. 569 * When `WP_DEBUG_LOG` is a valid path, errors will be logged to the specified file. 570 * 571 * Errors are never displayed for XML-RPC, REST, `ms-files.php`, and Ajax requests. 572 * 573 * @since 3.0.0 574 * @since 5.1.0 `WP_DEBUG_LOG` can be a file path. 575 * @access private 576 */ 577 function wp_debug_mode() { 578 /** 579 * Filters whether to allow the debug mode check to occur. 580 * 581 * This filter runs before it can be used by plugins. It is designed for 582 * non-web runtimes. Returning false causes the `WP_DEBUG` and related 583 * constants to not be checked and the default PHP values for errors 584 * will be used unless you take care to update them yourself. 585 * 586 * To use this filter you must define a `$wp_filter` global before 587 * WordPress loads, usually in `wp-config.php`. 588 * 589 * Example: 590 * 591 * $GLOBALS['wp_filter'] = array( 592 * 'enable_wp_debug_mode_checks' => array( 593 * 10 => array( 594 * array( 595 * 'accepted_args' => 0, 596 * 'function' => function() { 597 * return false; 598 * }, 599 * ), 600 * ), 601 * ), 602 * ); 603 * 604 * @since 4.6.0 605 * 606 * @param bool $enable_debug_mode Whether to enable debug mode checks to occur. Default true. 607 */ 608 if ( ! apply_filters( 'enable_wp_debug_mode_checks', true ) ) { 609 return; 610 } 611 612 if ( WP_DEBUG ) { 613 error_reporting( E_ALL ); 614 615 if ( WP_DEBUG_DISPLAY ) { 616 ini_set( 'display_errors', 1 ); 617 } elseif ( null !== WP_DEBUG_DISPLAY ) { 618 ini_set( 'display_errors', 0 ); 619 } 620 621 if ( in_array( strtolower( (string) WP_DEBUG_LOG ), array( 'true', '1' ), true ) ) { 622 $log_path = WP_CONTENT_DIR . '/debug.log'; 623 } elseif ( is_string( WP_DEBUG_LOG ) ) { 624 $log_path = WP_DEBUG_LOG; 625 } else { 626 $log_path = false; 627 } 628 629 if ( $log_path ) { 630 ini_set( 'log_errors', 1 ); 631 ini_set( 'error_log', $log_path ); 632 } 633 } else { 634 error_reporting( E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR ); 635 } 636 637 /* 638 * The 'REST_REQUEST' check here is optimistic as the constant is most 639 * likely not set at this point even if it is in fact a REST request. 640 */ 641 if ( defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || defined( 'MS_FILES_REQUEST' ) 642 || ( defined( 'WP_INSTALLING' ) && WP_INSTALLING ) 643 || wp_doing_ajax() || wp_is_json_request() 644 ) { 645 ini_set( 'display_errors', 0 ); 646 } 647 } 648 649 /** 650 * Sets the location of the language directory. 651 * 652 * To set directory manually, define the `WP_LANG_DIR` constant 653 * in wp-config.php. 654 * 655 * If the language directory exists within `WP_CONTENT_DIR`, it 656 * is used. Otherwise the language directory is assumed to live 657 * in `WPINC`. 658 * 659 * @since 3.0.0 660 * @access private 661 */ 662 function wp_set_lang_dir() { 663 if ( ! defined( 'WP_LANG_DIR' ) ) { 664 if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) 665 || ! @is_dir( ABSPATH . WPINC . '/languages' ) 666 ) { 667 /** 668 * Server path of the language directory. 669 * 670 * No leading slash, no trailing slash, full path, not relative to ABSPATH 671 * 672 * @since 2.1.0 673 */ 674 define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' ); 675 676 if ( ! defined( 'LANGDIR' ) ) { 677 // Old static relative path maintained for limited backward compatibility - won't work in some cases. 678 define( 'LANGDIR', 'wp-content/languages' ); 679 } 680 } else { 681 /** 682 * Server path of the language directory. 683 * 684 * No leading slash, no trailing slash, full path, not relative to `ABSPATH`. 685 * 686 * @since 2.1.0 687 */ 688 define( 'WP_LANG_DIR', ABSPATH . WPINC . '/languages' ); 689 690 if ( ! defined( 'LANGDIR' ) ) { 691 // Old relative path maintained for backward compatibility. 692 define( 'LANGDIR', WPINC . '/languages' ); 693 } 694 } 695 } 696 } 697 698 /** 699 * Loads the database class file and instantiates the `$wpdb` global. 700 * 701 * @since 2.5.0 702 * 703 * @global wpdb $wpdb WordPress database abstraction object. 704 */ 705 function require_wp_db() { 706 global $wpdb; 707 708 require_once ABSPATH . WPINC . '/class-wpdb.php'; 709 710 if ( file_exists( WP_CONTENT_DIR . '/db.php' ) ) { 711 require_once WP_CONTENT_DIR . '/db.php'; 712 } 713 714 if ( isset( $wpdb ) ) { 715 return; 716 } 717 718 $dbuser = defined( 'DB_USER' ) ? DB_USER : ''; 719 $dbpassword = defined( 'DB_PASSWORD' ) ? DB_PASSWORD : ''; 720 $dbname = defined( 'DB_NAME' ) ? DB_NAME : ''; 721 $dbhost = defined( 'DB_HOST' ) ? DB_HOST : ''; 722 723 $wpdb = new wpdb( $dbuser, $dbpassword, $dbname, $dbhost ); 724 } 725 726 /** 727 * Sets the database table prefix and the format specifiers for database 728 * table columns. 729 * 730 * Columns not listed here default to `%s`. 731 * 732 * @since 3.0.0 733 * @access private 734 * 735 * @global wpdb $wpdb WordPress database abstraction object. 736 * @global string $table_prefix The database table prefix. 737 */ 738 function wp_set_wpdb_vars() { 739 global $wpdb, $table_prefix; 740 741 if ( ! empty( $wpdb->error ) ) { 742 dead_db(); 743 } 744 745 $wpdb->field_types = array( 746 'post_author' => '%d', 747 'post_parent' => '%d', 748 'menu_order' => '%d', 749 'term_id' => '%d', 750 'term_group' => '%d', 751 'term_taxonomy_id' => '%d', 752 'parent' => '%d', 753 'count' => '%d', 754 'object_id' => '%d', 755 'term_order' => '%d', 756 'ID' => '%d', 757 'comment_ID' => '%d', 758 'comment_post_ID' => '%d', 759 'comment_parent' => '%d', 760 'user_id' => '%d', 761 'link_id' => '%d', 762 'link_owner' => '%d', 763 'link_rating' => '%d', 764 'option_id' => '%d', 765 'blog_id' => '%d', 766 'meta_id' => '%d', 767 'post_id' => '%d', 768 'user_status' => '%d', 769 'umeta_id' => '%d', 770 'comment_karma' => '%d', 771 'comment_count' => '%d', 772 // Multisite: 773 'active' => '%d', 774 'cat_id' => '%d', 775 'deleted' => '%d', 776 'lang_id' => '%d', 777 'mature' => '%d', 778 'public' => '%d', 779 'site_id' => '%d', 780 'spam' => '%d', 781 ); 782 783 $prefix = $wpdb->set_prefix( $table_prefix ); 784 785 if ( is_wp_error( $prefix ) ) { 786 wp_load_translations_early(); 787 wp_die( 788 sprintf( 789 /* translators: 1: $table_prefix, 2: wp-config.php */ 790 __( '<strong>Error:</strong> %1$s in %2$s can only contain numbers, letters, and underscores.' ), 791 '<code>$table_prefix</code>', 792 '<code>wp-config.php</code>' 793 ) 794 ); 795 } 796 } 797 798 /** 799 * Toggles `$_wp_using_ext_object_cache` on and off without directly 800 * touching global. 801 * 802 * @since 3.7.0 803 * 804 * @global bool $_wp_using_ext_object_cache 805 * 806 * @param bool $using Whether external object cache is being used. 807 * @return bool The current 'using' setting. 808 */ 809 function wp_using_ext_object_cache( $using = null ) { 810 global $_wp_using_ext_object_cache; 811 812 $current_using = $_wp_using_ext_object_cache; 813 814 if ( null !== $using ) { 815 $_wp_using_ext_object_cache = $using; 816 } 817 818 return $current_using; 819 } 820 821 /** 822 * Starts the WordPress object cache. 823 * 824 * If an object-cache.php file exists in the wp-content directory, 825 * it uses that drop-in as an external object cache. 826 * 827 * @since 3.0.0 828 * @access private 829 * 830 * @global array $wp_filter Stores all of the filters. 831 */ 832 function wp_start_object_cache() { 833 global $wp_filter; 834 static $first_init = true; 835 836 // Only perform the following checks once. 837 838 /** 839 * Filters whether to enable loading of the object-cache.php drop-in. 840 * 841 * This filter runs before it can be used by plugins. It is designed for non-web 842 * runtimes. If false is returned, object-cache.php will never be loaded. 843 * 844 * @since 5.8.0 845 * 846 * @param bool $enable_object_cache Whether to enable loading object-cache.php (if present). 847 * Default true. 848 */ 849 if ( $first_init && apply_filters( 'enable_loading_object_cache_dropin', true ) ) { 850 if ( ! function_exists( 'wp_cache_init' ) ) { 851 /* 852 * This is the normal situation. First-run of this function. No 853 * caching backend has been loaded. 854 * 855 * We try to load a custom caching backend, and then, if it 856 * results in a wp_cache_init() function existing, we note 857 * that an external object cache is being used. 858 */ 859 if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { 860 require_once WP_CONTENT_DIR . '/object-cache.php'; 861 862 if ( function_exists( 'wp_cache_init' ) ) { 863 wp_using_ext_object_cache( true ); 864 } 865 866 // Re-initialize any hooks added manually by object-cache.php. 867 if ( $wp_filter ) { 868 $wp_filter = WP_Hook::build_preinitialized_hooks( $wp_filter ); 869 } 870 } 871 } elseif ( ! wp_using_ext_object_cache() && file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { 872 /* 873 * Sometimes advanced-cache.php can load object-cache.php before 874 * this function is run. This breaks the function_exists() check 875 * above and can result in wp_using_ext_object_cache() returning 876 * false when actually an external cache is in use. 877 */ 878 wp_using_ext_object_cache( true ); 879 } 880 } 881 882 if ( ! wp_using_ext_object_cache() ) { 883 require_once ABSPATH . WPINC . '/cache.php'; 884 } 885 886 require_once ABSPATH . WPINC . '/cache-compat.php'; 887 888 /* 889 * If cache supports reset, reset instead of init if already 890 * initialized. Reset signals to the cache that global IDs 891 * have changed and it may need to update keys and cleanup caches. 892 */ 893 if ( ! $first_init && function_exists( 'wp_cache_switch_to_blog' ) ) { 894 wp_cache_switch_to_blog( get_current_blog_id() ); 895 } elseif ( function_exists( 'wp_cache_init' ) ) { 896 wp_cache_init(); 897 } 898 899 if ( function_exists( 'wp_cache_add_global_groups' ) ) { 900 wp_cache_add_global_groups( 901 array( 902 'blog-details', 903 'blog-id-cache', 904 'blog-lookup', 905 'blog_meta', 906 'global-posts', 907 'image_editor', 908 'networks', 909 'network-queries', 910 'sites', 911 'site-details', 912 'site-options', 913 'site-queries', 914 'site-transient', 915 'theme_files', 916 'translation_files', 917 'rss', 918 'users', 919 'user-queries', 920 'user_meta', 921 'useremail', 922 'userlogins', 923 'userslugs', 924 ) 925 ); 926 927 wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) ); 928 } 929 930 $first_init = false; 931 } 932 933 /** 934 * Redirects to the installer if WordPress is not installed. 935 * 936 * Dies with an error message when Multisite is enabled. 937 * 938 * @since 3.0.0 939 * @access private 940 */ 941 function wp_not_installed() { 942 if ( is_blog_installed() || wp_installing() ) { 943 return; 944 } 945 946 nocache_headers(); 947 948 if ( is_multisite() ) { 949 wp_die( __( 'The site you have requested is not installed properly. Please contact the system administrator.' ) ); 950 } 951 952 require ABSPATH . WPINC . '/kses.php'; 953 require ABSPATH . WPINC . '/pluggable.php'; 954 955 $link = wp_guess_url() . '/wp-admin/install.php'; 956 957 wp_redirect( $link ); 958 die(); 959 } 960 961 /** 962 * Retrieves an array of must-use plugin files. 963 * 964 * The default directory is wp-content/mu-plugins. To change the default 965 * directory manually, define `WPMU_PLUGIN_DIR` and `WPMU_PLUGIN_URL` 966 * in wp-config.php. 967 * 968 * @since 3.0.0 969 * @access private 970 * 971 * @return string[] Array of absolute paths of files to include. 972 */ 973 function wp_get_mu_plugins() { 974 $mu_plugins = array(); 975 976 if ( ! is_dir( WPMU_PLUGIN_DIR ) ) { 977 return $mu_plugins; 978 } 979 980 $dh = opendir( WPMU_PLUGIN_DIR ); 981 if ( ! $dh ) { 982 return $mu_plugins; 983 } 984 985 while ( ( $plugin = readdir( $dh ) ) !== false ) { 986 if ( str_ends_with( $plugin, '.php' ) ) { 987 $mu_plugins[] = WPMU_PLUGIN_DIR . '/' . $plugin; 988 } 989 } 990 991 closedir( $dh ); 992 993 sort( $mu_plugins ); 994 995 return $mu_plugins; 996 } 997 998 /** 999 * Retrieves an array of active and valid plugin files. 1000 * 1001 * While upgrading or installing WordPress, no plugins are returned. 1002 * 1003 * The default directory is `wp-content/plugins`. To change the default 1004 * directory manually, define `WP_PLUGIN_DIR` and `WP_PLUGIN_URL` 1005 * in `wp-config.php`. 1006 * 1007 * @since 3.0.0 1008 * @access private 1009 * 1010 * @return string[] Array of paths to plugin files relative to the plugins directory. 1011 */ 1012 function wp_get_active_and_valid_plugins() { 1013 $plugins = array(); 1014 $active_plugins = (array) get_option( 'active_plugins', array() ); 1015 1016 // Check for hacks file if the option is enabled. 1017 if ( get_option( 'hack_file' ) && file_exists( ABSPATH . 'my-hacks.php' ) ) { 1018 _deprecated_file( 'my-hacks.php', '1.5.0' ); 1019 array_unshift( $plugins, ABSPATH . 'my-hacks.php' ); 1020 } 1021 1022 if ( empty( $active_plugins ) || wp_installing() ) { 1023 return $plugins; 1024 } 1025 1026 $network_plugins = is_multisite() ? wp_get_active_network_plugins() : false; 1027 1028 foreach ( $active_plugins as $plugin ) { 1029 if ( ! validate_file( $plugin ) // $plugin must validate as file. 1030 && str_ends_with( $plugin, '.php' ) // $plugin must end with '.php'. 1031 && file_exists( WP_PLUGIN_DIR . '/' . $plugin ) // $plugin must exist. 1032 // Not already included as a network plugin. 1033 && ( ! $network_plugins || ! in_array( WP_PLUGIN_DIR . '/' . $plugin, $network_plugins, true ) ) 1034 ) { 1035 $plugins[] = WP_PLUGIN_DIR . '/' . $plugin; 1036 } 1037 } 1038 1039 /* 1040 * Remove plugins from the list of active plugins when we're on an endpoint 1041 * that should be protected against WSODs and the plugin is paused. 1042 */ 1043 if ( wp_is_recovery_mode() ) { 1044 $plugins = wp_skip_paused_plugins( $plugins ); 1045 } 1046 1047 return $plugins; 1048 } 1049 1050 /** 1051 * Filters a given list of plugins, removing any paused plugins from it. 1052 * 1053 * @since 5.2.0 1054 * 1055 * @global WP_Paused_Extensions_Storage $_paused_plugins 1056 * 1057 * @param string[] $plugins Array of absolute plugin main file paths. 1058 * @return string[] Filtered array of plugins, without any paused plugins. 1059 */ 1060 function wp_skip_paused_plugins( array $plugins ) { 1061 $paused_plugins = wp_paused_plugins()->get_all(); 1062 1063 if ( empty( $paused_plugins ) ) { 1064 return $plugins; 1065 } 1066 1067 foreach ( $plugins as $index => $plugin ) { 1068 list( $plugin ) = explode( '/', plugin_basename( $plugin ) ); 1069 1070 if ( array_key_exists( $plugin, $paused_plugins ) ) { 1071 unset( $plugins[ $index ] ); 1072 1073 // Store list of paused plugins for displaying an admin notice. 1074 $GLOBALS['_paused_plugins'][ $plugin ] = $paused_plugins[ $plugin ]; 1075 } 1076 } 1077 1078 return $plugins; 1079 } 1080 1081 /** 1082 * Retrieves an array of active and valid themes. 1083 * 1084 * While upgrading or installing WordPress, no themes are returned. 1085 * 1086 * @since 5.1.0 1087 * @access private 1088 * 1089 * @global string $pagenow The filename of the current screen. 1090 * @global string $wp_stylesheet_path Path to current theme's stylesheet directory. 1091 * @global string $wp_template_path Path to current theme's template directory. 1092 * 1093 * @return string[] Array of absolute paths to theme directories. 1094 */ 1095 function wp_get_active_and_valid_themes() { 1096 global $pagenow, $wp_stylesheet_path, $wp_template_path; 1097 1098 $themes = array(); 1099 1100 if ( wp_installing() && 'wp-activate.php' !== $pagenow ) { 1101 return $themes; 1102 } 1103 1104 if ( is_child_theme() ) { 1105 $themes[] = $wp_stylesheet_path; 1106 } 1107 1108 $themes[] = $wp_template_path; 1109 1110 /* 1111 * Remove themes from the list of active themes when we're on an endpoint 1112 * that should be protected against WSODs and the theme is paused. 1113 */ 1114 if ( wp_is_recovery_mode() ) { 1115 $themes = wp_skip_paused_themes( $themes ); 1116 1117 // If no active and valid themes exist, skip loading themes. 1118 if ( empty( $themes ) ) { 1119 add_filter( 'wp_using_themes', '__return_false' ); 1120 } 1121 } 1122 1123 return $themes; 1124 } 1125 1126 /** 1127 * Filters a given list of themes, removing any paused themes from it. 1128 * 1129 * @since 5.2.0 1130 * 1131 * @global WP_Paused_Extensions_Storage $_paused_themes 1132 * 1133 * @param string[] $themes Array of absolute theme directory paths. 1134 * @return string[] Filtered array of absolute paths to themes, without any paused themes. 1135 */ 1136 function wp_skip_paused_themes( array $themes ) { 1137 $paused_themes = wp_paused_themes()->get_all(); 1138 1139 if ( empty( $paused_themes ) ) { 1140 return $themes; 1141 } 1142 1143 foreach ( $themes as $index => $theme ) { 1144 $theme = basename( $theme ); 1145 1146 if ( array_key_exists( $theme, $paused_themes ) ) { 1147 unset( $themes[ $index ] ); 1148 1149 // Store list of paused themes for displaying an admin notice. 1150 $GLOBALS['_paused_themes'][ $theme ] = $paused_themes[ $theme ]; 1151 } 1152 } 1153 1154 return $themes; 1155 } 1156 1157 /** 1158 * Determines whether WordPress is in Recovery Mode. 1159 * 1160 * In this mode, plugins or themes that cause WSODs will be paused. 1161 * 1162 * @since 5.2.0 1163 * 1164 * @return bool 1165 */ 1166 function wp_is_recovery_mode() { 1167 return wp_recovery_mode()->is_active(); 1168 } 1169 1170 /** 1171 * Determines whether we are currently on an endpoint that should be protected against WSODs. 1172 * 1173 * @since 5.2.0 1174 * 1175 * @global string $pagenow The filename of the current screen. 1176 * 1177 * @return bool True if the current endpoint should be protected. 1178 */ 1179 function is_protected_endpoint() { 1180 // Protect login pages. 1181 if ( isset( $GLOBALS['pagenow'] ) && 'wp-login.php' === $GLOBALS['pagenow'] ) { 1182 return true; 1183 } 1184 1185 // Protect the admin backend. 1186 if ( is_admin() && ! wp_doing_ajax() ) { 1187 return true; 1188 } 1189 1190 // Protect Ajax actions that could help resolve a fatal error should be available. 1191 if ( is_protected_ajax_action() ) { 1192 return true; 1193 } 1194 1195 /** 1196 * Filters whether the current request is against a protected endpoint. 1197 * 1198 * This filter is only fired when an endpoint is requested which is not already protected by 1199 * WordPress core. As such, it exclusively allows providing further protected endpoints in 1200 * addition to the admin backend, login pages and protected Ajax actions. 1201 * 1202 * @since 5.2.0 1203 * 1204 * @param bool $is_protected_endpoint Whether the currently requested endpoint is protected. 1205 * Default false. 1206 */ 1207 return (bool) apply_filters( 'is_protected_endpoint', false ); 1208 } 1209 1210 /** 1211 * Determines whether we are currently handling an Ajax action that should be protected against WSODs. 1212 * 1213 * @since 5.2.0 1214 * 1215 * @return bool True if the current Ajax action should be protected. 1216 */ 1217 function is_protected_ajax_action() { 1218 if ( ! wp_doing_ajax() ) { 1219 return false; 1220 } 1221 1222 if ( ! isset( $_REQUEST['action'] ) ) { 1223 return false; 1224 } 1225 1226 $actions_to_protect = array( 1227 'edit-theme-plugin-file', // Saving changes in the core code editor. 1228 'heartbeat', // Keep the heart beating. 1229 'install-plugin', // Installing a new plugin. 1230 'install-theme', // Installing a new theme. 1231 'search-plugins', // Searching in the list of plugins. 1232 'search-install-plugins', // Searching for a plugin in the plugin install screen. 1233 'update-plugin', // Update an existing plugin. 1234 'update-theme', // Update an existing theme. 1235 'activate-plugin', // Activating an existing plugin. 1236 ); 1237 1238 /** 1239 * Filters the array of protected Ajax actions. 1240 * 1241 * This filter is only fired when doing Ajax and the Ajax request has an 'action' property. 1242 * 1243 * @since 5.2.0 1244 * 1245 * @param string[] $actions_to_protect Array of strings with Ajax actions to protect. 1246 */ 1247 $actions_to_protect = (array) apply_filters( 'wp_protected_ajax_actions', $actions_to_protect ); 1248 1249 if ( ! in_array( $_REQUEST['action'], $actions_to_protect, true ) ) { 1250 return false; 1251 } 1252 1253 return true; 1254 } 1255 1256 /** 1257 * Sets internal encoding. 1258 * 1259 * In most cases the default internal encoding is latin1, which is 1260 * of no use, since we want to use the `mb_` functions for `utf-8` strings. 1261 * 1262 * @since 3.0.0 1263 * @access private 1264 */ 1265 function wp_set_internal_encoding() { 1266 if ( function_exists( 'mb_internal_encoding' ) ) { 1267 $charset = get_option( 'blog_charset' ); 1268 // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged 1269 if ( ! $charset || ! @mb_internal_encoding( $charset ) ) { 1270 mb_internal_encoding( 'UTF-8' ); 1271 } 1272 } 1273 } 1274 1275 /** 1276 * Adds magic quotes to `$_GET`, `$_POST`, `$_COOKIE`, and `$_SERVER`. 1277 * 1278 * Also forces `$_REQUEST` to be `$_GET + $_POST`. If `$_SERVER`, 1279 * `$_COOKIE`, or `$_ENV` are needed, use those superglobals directly. 1280 * 1281 * @since 3.0.0 1282 * @access private 1283 */ 1284 function wp_magic_quotes() { 1285 // Escape with wpdb. 1286 $_GET = add_magic_quotes( $_GET ); 1287 $_POST = add_magic_quotes( $_POST ); 1288 $_COOKIE = add_magic_quotes( $_COOKIE ); 1289 $_SERVER = add_magic_quotes( $_SERVER ); 1290 1291 // Force REQUEST to be GET + POST. 1292 $_REQUEST = array_merge( $_GET, $_POST ); 1293 } 1294 1295 /** 1296 * Runs just before PHP shuts down execution. 1297 * 1298 * @since 1.2.0 1299 * @access private 1300 */ 1301 function shutdown_action_hook() { 1302 /** 1303 * Fires just before PHP shuts down execution. 1304 * 1305 * @since 1.2.0 1306 */ 1307 do_action( 'shutdown' ); 1308 1309 wp_cache_close(); 1310 } 1311 1312 /** 1313 * Clones an object. 1314 * 1315 * @since 2.7.0 1316 * @deprecated 3.2.0 1317 * 1318 * @param object $input_object The object to clone. 1319 * @return object The cloned object. 1320 */ 1321 function wp_clone( $input_object ) { 1322 // Use parens for clone to accommodate PHP 4. See #17880. 1323 return clone( $input_object ); 1324 } 1325 1326 /** 1327 * Determines whether the current request is for the login screen. 1328 * 1329 * @since 6.1.0 1330 * 1331 * @see wp_login_url() 1332 * 1333 * @return bool True if inside WordPress login screen, false otherwise. 1334 */ 1335 function is_login() { 1336 return false !== stripos( wp_login_url(), $_SERVER['SCRIPT_NAME'] ); 1337 } 1338 1339 /** 1340 * Determines whether the current request is for an administrative interface page. 1341 * 1342 * Does not check if the user is an administrator; use current_user_can() 1343 * for checking roles and capabilities. 1344 * 1345 * For more information on this and similar theme functions, check out 1346 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1347 * Conditional Tags} article in the Theme Developer Handbook. 1348 * 1349 * @since 1.5.1 1350 * 1351 * @global WP_Screen $current_screen WordPress current screen object. 1352 * 1353 * @return bool True if inside WordPress administration interface, false otherwise. 1354 */ 1355 function is_admin() { 1356 if ( isset( $GLOBALS['current_screen'] ) ) { 1357 return $GLOBALS['current_screen']->in_admin(); 1358 } elseif ( defined( 'WP_ADMIN' ) ) { 1359 return WP_ADMIN; 1360 } 1361 1362 return false; 1363 } 1364 1365 /** 1366 * Determines whether the current request is for a site's administrative interface. 1367 * 1368 * e.g. `/wp-admin/` 1369 * 1370 * Does not check if the user is an administrator; use current_user_can() 1371 * for checking roles and capabilities. 1372 * 1373 * @since 3.1.0 1374 * 1375 * @global WP_Screen $current_screen WordPress current screen object. 1376 * 1377 * @return bool True if inside WordPress site administration pages. 1378 */ 1379 function is_blog_admin() { 1380 if ( isset( $GLOBALS['current_screen'] ) ) { 1381 return $GLOBALS['current_screen']->in_admin( 'site' ); 1382 } elseif ( defined( 'WP_BLOG_ADMIN' ) ) { 1383 return WP_BLOG_ADMIN; 1384 } 1385 1386 return false; 1387 } 1388 1389 /** 1390 * Determines whether the current request is for the network administrative interface. 1391 * 1392 * e.g. `/wp-admin/network/` 1393 * 1394 * Does not check if the user is an administrator; use current_user_can() 1395 * for checking roles and capabilities. 1396 * 1397 * Does not check if the site is a Multisite network; use is_multisite() 1398 * for checking if Multisite is enabled. 1399 * 1400 * @since 3.1.0 1401 * 1402 * @global WP_Screen $current_screen WordPress current screen object. 1403 * 1404 * @return bool True if inside WordPress network administration pages. 1405 */ 1406 function is_network_admin() { 1407 if ( isset( $GLOBALS['current_screen'] ) ) { 1408 return $GLOBALS['current_screen']->in_admin( 'network' ); 1409 } elseif ( defined( 'WP_NETWORK_ADMIN' ) ) { 1410 return WP_NETWORK_ADMIN; 1411 } 1412 1413 return false; 1414 } 1415 1416 /** 1417 * Determines whether the current request is for a user admin screen. 1418 * 1419 * e.g. `/wp-admin/user/` 1420 * 1421 * Does not check if the user is an administrator; use current_user_can() 1422 * for checking roles and capabilities. 1423 * 1424 * @since 3.1.0 1425 * 1426 * @global WP_Screen $current_screen WordPress current screen object. 1427 * 1428 * @return bool True if inside WordPress user administration pages. 1429 */ 1430 function is_user_admin() { 1431 if ( isset( $GLOBALS['current_screen'] ) ) { 1432 return $GLOBALS['current_screen']->in_admin( 'user' ); 1433 } elseif ( defined( 'WP_USER_ADMIN' ) ) { 1434 return WP_USER_ADMIN; 1435 } 1436 1437 return false; 1438 } 1439 1440 /** 1441 * Determines whether Multisite is enabled. 1442 * 1443 * @since 3.0.0 1444 * 1445 * @return bool True if Multisite is enabled, false otherwise. 1446 */ 1447 function is_multisite() { 1448 if ( defined( 'MULTISITE' ) ) { 1449 return MULTISITE; 1450 } 1451 1452 if ( defined( 'SUBDOMAIN_INSTALL' ) || defined( 'VHOST' ) || defined( 'SUNRISE' ) ) { 1453 return true; 1454 } 1455 1456 return false; 1457 } 1458 1459 /** 1460 * Converts a value to non-negative integer. 1461 * 1462 * @since 2.5.0 1463 * 1464 * @param mixed $maybeint Data you wish to have converted to a non-negative integer. 1465 * @return int A non-negative integer. 1466 */ 1467 function absint( $maybeint ) { 1468 return abs( (int) $maybeint ); 1469 } 1470 1471 /** 1472 * Retrieves the current site ID. 1473 * 1474 * @since 3.1.0 1475 * 1476 * @global int $blog_id 1477 * 1478 * @return int Site ID. 1479 */ 1480 function get_current_blog_id() { 1481 global $blog_id; 1482 1483 return absint( $blog_id ); 1484 } 1485 1486 /** 1487 * Retrieves the current network ID. 1488 * 1489 * @since 4.6.0 1490 * 1491 * @return int The ID of the current network. 1492 */ 1493 function get_current_network_id() { 1494 if ( ! is_multisite() ) { 1495 return 1; 1496 } 1497 1498 $current_network = get_network(); 1499 1500 if ( ! isset( $current_network->id ) ) { 1501 return get_main_network_id(); 1502 } 1503 1504 return absint( $current_network->id ); 1505 } 1506 1507 /** 1508 * Attempts an early load of translations. 1509 * 1510 * Used for errors encountered during the initial loading process, before 1511 * the locale has been properly detected and loaded. 1512 * 1513 * Designed for unusual load sequences (like setup-config.php) or for when 1514 * the script will then terminate with an error, otherwise there is a risk 1515 * that a file can be double-included. 1516 * 1517 * @since 3.4.0 1518 * @access private 1519 * 1520 * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry. 1521 * @global WP_Locale $wp_locale WordPress date and time locale object. 1522 */ 1523 function wp_load_translations_early() { 1524 global $wp_textdomain_registry, $wp_locale; 1525 static $loaded = false; 1526 1527 if ( $loaded ) { 1528 return; 1529 } 1530 1531 $loaded = true; 1532 1533 if ( function_exists( 'did_action' ) && did_action( 'init' ) ) { 1534 return; 1535 } 1536 1537 // We need $wp_local_package. 1538 require ABSPATH . WPINC . '/version.php'; 1539 1540 // Translation and localization. 1541 require_once ABSPATH . WPINC . '/pomo/mo.php'; 1542 require_once ABSPATH . WPINC . '/l10n/class-wp-translation-controller.php'; 1543 require_once ABSPATH . WPINC . '/l10n/class-wp-translations.php'; 1544 require_once ABSPATH . WPINC . '/l10n/class-wp-translation-file.php'; 1545 require_once ABSPATH . WPINC . '/l10n/class-wp-translation-file-mo.php'; 1546 require_once ABSPATH . WPINC . '/l10n/class-wp-translation-file-php.php'; 1547 require_once ABSPATH . WPINC . '/l10n.php'; 1548 require_once ABSPATH . WPINC . '/class-wp-textdomain-registry.php'; 1549 require_once ABSPATH . WPINC . '/class-wp-locale.php'; 1550 require_once ABSPATH . WPINC . '/class-wp-locale-switcher.php'; 1551 1552 // General libraries. 1553 require_once ABSPATH . WPINC . '/plugin.php'; 1554 1555 $locales = array(); 1556 $locations = array(); 1557 1558 if ( ! $wp_textdomain_registry instanceof WP_Textdomain_Registry ) { 1559 $wp_textdomain_registry = new WP_Textdomain_Registry(); 1560 } 1561 1562 while ( true ) { 1563 if ( defined( 'WPLANG' ) ) { 1564 if ( '' === WPLANG ) { 1565 break; 1566 } 1567 $locales[] = WPLANG; 1568 } 1569 1570 if ( isset( $wp_local_package ) ) { 1571 $locales[] = $wp_local_package; 1572 } 1573 1574 if ( ! $locales ) { 1575 break; 1576 } 1577 1578 if ( defined( 'WP_LANG_DIR' ) && @is_dir( WP_LANG_DIR ) ) { 1579 $locations[] = WP_LANG_DIR; 1580 } 1581 1582 if ( defined( 'WP_CONTENT_DIR' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) ) { 1583 $locations[] = WP_CONTENT_DIR . '/languages'; 1584 } 1585 1586 if ( @is_dir( ABSPATH . 'wp-content/languages' ) ) { 1587 $locations[] = ABSPATH . 'wp-content/languages'; 1588 } 1589 1590 if ( @is_dir( ABSPATH . WPINC . '/languages' ) ) { 1591 $locations[] = ABSPATH . WPINC . '/languages'; 1592 } 1593 1594 if ( ! $locations ) { 1595 break; 1596 } 1597 1598 $locations = array_unique( $locations ); 1599 1600 foreach ( $locales as $locale ) { 1601 foreach ( $locations as $location ) { 1602 if ( file_exists( $location . '/' . $locale . '.mo' ) ) { 1603 load_textdomain( 'default', $location . '/' . $locale . '.mo', $locale ); 1604 1605 if ( defined( 'WP_SETUP_CONFIG' ) && file_exists( $location . '/admin-' . $locale . '.mo' ) ) { 1606 load_textdomain( 'default', $location . '/admin-' . $locale . '.mo', $locale ); 1607 } 1608 1609 break 2; 1610 } 1611 } 1612 } 1613 1614 break; 1615 } 1616 1617 $wp_locale = new WP_Locale(); 1618 } 1619 1620 /** 1621 * Checks or sets whether WordPress is in "installation" mode. 1622 * 1623 * If the `WP_INSTALLING` constant is defined during the bootstrap, `wp_installing()` will default to `true`. 1624 * 1625 * @since 4.4.0 1626 * 1627 * @param bool $is_installing Optional. True to set WP into Installing mode, false to turn Installing mode off. 1628 * Omit this parameter if you only want to fetch the current status. 1629 * @return bool True if WP is installing, otherwise false. When a `$is_installing` is passed, the function will 1630 * report whether WP was in installing mode prior to the change to `$is_installing`. 1631 */ 1632 function wp_installing( $is_installing = null ) { 1633 static $installing = null; 1634 1635 // Support for the `WP_INSTALLING` constant, defined before WP is loaded. 1636 if ( is_null( $installing ) ) { 1637 $installing = defined( 'WP_INSTALLING' ) && WP_INSTALLING; 1638 } 1639 1640 if ( ! is_null( $is_installing ) ) { 1641 $old_installing = $installing; 1642 $installing = $is_installing; 1643 1644 return (bool) $old_installing; 1645 } 1646 1647 return (bool) $installing; 1648 } 1649 1650 /** 1651 * Determines if SSL is used. 1652 * 1653 * @since 2.6.0 1654 * @since 4.6.0 Moved from functions.php to load.php. 1655 * 1656 * @return bool True if SSL, otherwise false. 1657 */ 1658 function is_ssl() { 1659 if ( isset( $_SERVER['HTTPS'] ) ) { 1660 if ( 'on' === strtolower( $_SERVER['HTTPS'] ) ) { 1661 return true; 1662 } 1663 1664 if ( '1' === (string) $_SERVER['HTTPS'] ) { 1665 return true; 1666 } 1667 } elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' === (string) $_SERVER['SERVER_PORT'] ) ) { 1668 return true; 1669 } 1670 1671 return false; 1672 } 1673 1674 /** 1675 * Converts a shorthand byte value to an integer byte value. 1676 * 1677 * @since 2.3.0 1678 * @since 4.6.0 Moved from media.php to load.php. 1679 * 1680 * @link https://www.php.net/manual/en/function.ini-get.php 1681 * @link https://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes 1682 * 1683 * @param string $value A (PHP ini) byte value, either shorthand or ordinary. 1684 * @return int An integer byte value. 1685 */ 1686 function wp_convert_hr_to_bytes( $value ) { 1687 $value = strtolower( trim( $value ) ); 1688 $bytes = (int) $value; 1689 1690 if ( str_contains( $value, 'g' ) ) { 1691 $bytes *= GB_IN_BYTES; 1692 } elseif ( str_contains( $value, 'm' ) ) { 1693 $bytes *= MB_IN_BYTES; 1694 } elseif ( str_contains( $value, 'k' ) ) { 1695 $bytes *= KB_IN_BYTES; 1696 } 1697 1698 // Deal with large (float) values which run into the maximum integer size. 1699 return min( $bytes, PHP_INT_MAX ); 1700 } 1701 1702 /** 1703 * Determines whether a PHP ini value is changeable at runtime. 1704 * 1705 * @since 4.6.0 1706 * 1707 * @link https://www.php.net/manual/en/function.ini-get-all.php 1708 * 1709 * @param string $setting The name of the ini setting to check. 1710 * @return bool True if the value is changeable at runtime. False otherwise. 1711 */ 1712 function wp_is_ini_value_changeable( $setting ) { 1713 static $ini_all; 1714 1715 if ( ! isset( $ini_all ) ) { 1716 $ini_all = false; 1717 // Sometimes `ini_get_all()` is disabled via the `disable_functions` option for "security purposes". 1718 if ( function_exists( 'ini_get_all' ) ) { 1719 $ini_all = ini_get_all(); 1720 } 1721 } 1722 1723 if ( isset( $ini_all[ $setting ]['access'] ) 1724 && ( INI_ALL === $ini_all[ $setting ]['access'] || INI_USER === $ini_all[ $setting ]['access'] ) 1725 ) { 1726 return true; 1727 } 1728 1729 // If we were unable to retrieve the details, fail gracefully to assume it's changeable. 1730 if ( ! is_array( $ini_all ) ) { 1731 return true; 1732 } 1733 1734 return false; 1735 } 1736 1737 /** 1738 * Determines whether the current request is a WordPress Ajax request. 1739 * 1740 * @since 4.7.0 1741 * 1742 * @return bool True if it's a WordPress Ajax request, false otherwise. 1743 */ 1744 function wp_doing_ajax() { 1745 /** 1746 * Filters whether the current request is a WordPress Ajax request. 1747 * 1748 * @since 4.7.0 1749 * 1750 * @param bool $wp_doing_ajax Whether the current request is a WordPress Ajax request. 1751 */ 1752 return apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ); 1753 } 1754 1755 /** 1756 * Determines whether the current request should use themes. 1757 * 1758 * @since 5.1.0 1759 * 1760 * @return bool True if themes should be used, false otherwise. 1761 */ 1762 function wp_using_themes() { 1763 /** 1764 * Filters whether the current request should use themes. 1765 * 1766 * @since 5.1.0 1767 * 1768 * @param bool $wp_using_themes Whether the current request should use themes. 1769 */ 1770 return apply_filters( 'wp_using_themes', defined( 'WP_USE_THEMES' ) && WP_USE_THEMES ); 1771 } 1772 1773 /** 1774 * Determines whether the current request is a WordPress cron request. 1775 * 1776 * @since 4.8.0 1777 * 1778 * @return bool True if it's a WordPress cron request, false otherwise. 1779 */ 1780 function wp_doing_cron() { 1781 /** 1782 * Filters whether the current request is a WordPress cron request. 1783 * 1784 * @since 4.8.0 1785 * 1786 * @param bool $wp_doing_cron Whether the current request is a WordPress cron request. 1787 */ 1788 return apply_filters( 'wp_doing_cron', defined( 'DOING_CRON' ) && DOING_CRON ); 1789 } 1790 1791 /** 1792 * Checks whether the given variable is a WordPress Error. 1793 * 1794 * Returns whether `$thing` is an instance of the `WP_Error` class. 1795 * 1796 * @since 2.1.0 1797 * 1798 * @param mixed $thing The variable to check. 1799 * @return bool Whether the variable is an instance of WP_Error. 1800 */ 1801 function is_wp_error( $thing ) { 1802 $is_wp_error = ( $thing instanceof WP_Error ); 1803 1804 if ( $is_wp_error ) { 1805 /** 1806 * Fires when `is_wp_error()` is called and its parameter is an instance of `WP_Error`. 1807 * 1808 * @since 5.6.0 1809 * 1810 * @param WP_Error $thing The error object passed to `is_wp_error()`. 1811 */ 1812 do_action( 'is_wp_error_instance', $thing ); 1813 } 1814 1815 return $is_wp_error; 1816 } 1817 1818 /** 1819 * Determines whether file modifications are allowed. 1820 * 1821 * @since 4.8.0 1822 * 1823 * @param string $context The usage context. 1824 * @return bool True if file modification is allowed, false otherwise. 1825 */ 1826 function wp_is_file_mod_allowed( $context ) { 1827 /** 1828 * Filters whether file modifications are allowed. 1829 * 1830 * @since 4.8.0 1831 * 1832 * @param bool $file_mod_allowed Whether file modifications are allowed. 1833 * @param string $context The usage context. 1834 */ 1835 return apply_filters( 'file_mod_allowed', ! defined( 'DISALLOW_FILE_MODS' ) || ! DISALLOW_FILE_MODS, $context ); 1836 } 1837 1838 /** 1839 * Starts scraping edited file errors. 1840 * 1841 * @since 4.9.0 1842 */ 1843 function wp_start_scraping_edited_file_errors() { 1844 if ( ! isset( $_REQUEST['wp_scrape_key'] ) || ! isset( $_REQUEST['wp_scrape_nonce'] ) ) { 1845 return; 1846 } 1847 1848 $key = substr( sanitize_key( wp_unslash( $_REQUEST['wp_scrape_key'] ) ), 0, 32 ); 1849 $nonce = wp_unslash( $_REQUEST['wp_scrape_nonce'] ); 1850 if ( empty( $key ) || empty( $nonce ) ) { 1851 return; 1852 } 1853 1854 $transient = get_transient( 'scrape_key_' . $key ); 1855 if ( false === $transient ) { 1856 return; 1857 } 1858 1859 if ( $transient !== $nonce ) { 1860 if ( ! headers_sent() ) { 1861 header( 'X-Robots-Tag: noindex' ); 1862 nocache_headers(); 1863 } 1864 echo "###### wp_scraping_result_start:$key ######"; 1865 echo wp_json_encode( 1866 array( 1867 'code' => 'scrape_nonce_failure', 1868 'message' => __( 'Scrape key check failed. Please try again.' ), 1869 ) 1870 ); 1871 echo "###### wp_scraping_result_end:$key ######"; 1872 die(); 1873 } 1874 1875 if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) { 1876 define( 'WP_SANDBOX_SCRAPING', true ); 1877 } 1878 1879 register_shutdown_function( 'wp_finalize_scraping_edited_file_errors', $key ); 1880 } 1881 1882 /** 1883 * Finalizes scraping for edited file errors. 1884 * 1885 * @since 4.9.0 1886 * 1887 * @param string $scrape_key Scrape key. 1888 */ 1889 function wp_finalize_scraping_edited_file_errors( $scrape_key ) { 1890 $error = error_get_last(); 1891 1892 echo "\n###### wp_scraping_result_start:$scrape_key ######\n"; 1893 1894 if ( ! empty( $error ) 1895 && in_array( $error['type'], array( E_CORE_ERROR, E_COMPILE_ERROR, E_ERROR, E_PARSE, E_USER_ERROR, E_RECOVERABLE_ERROR ), true ) 1896 ) { 1897 $error = str_replace( ABSPATH, '', $error ); 1898 echo wp_json_encode( $error ); 1899 } else { 1900 echo wp_json_encode( true ); 1901 } 1902 1903 echo "\n###### wp_scraping_result_end:$scrape_key ######\n"; 1904 } 1905 1906 /** 1907 * Checks whether current request is a JSON request, or is expecting a JSON response. 1908 * 1909 * @since 5.0.0 1910 * 1911 * @return bool True if `Accepts` or `Content-Type` headers contain `application/json`. 1912 * False otherwise. 1913 */ 1914 function wp_is_json_request() { 1915 if ( isset( $_SERVER['HTTP_ACCEPT'] ) && wp_is_json_media_type( $_SERVER['HTTP_ACCEPT'] ) ) { 1916 return true; 1917 } 1918 1919 if ( isset( $_SERVER['CONTENT_TYPE'] ) && wp_is_json_media_type( $_SERVER['CONTENT_TYPE'] ) ) { 1920 return true; 1921 } 1922 1923 return false; 1924 } 1925 1926 /** 1927 * Checks whether current request is a JSONP request, or is expecting a JSONP response. 1928 * 1929 * @since 5.2.0 1930 * 1931 * @return bool True if JSONP request, false otherwise. 1932 */ 1933 function wp_is_jsonp_request() { 1934 if ( ! isset( $_GET['_jsonp'] ) ) { 1935 return false; 1936 } 1937 1938 if ( ! function_exists( 'wp_check_jsonp_callback' ) ) { 1939 require_once ABSPATH . WPINC . '/functions.php'; 1940 } 1941 1942 $jsonp_callback = $_GET['_jsonp']; 1943 if ( ! wp_check_jsonp_callback( $jsonp_callback ) ) { 1944 return false; 1945 } 1946 1947 /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */ 1948 $jsonp_enabled = apply_filters( 'rest_jsonp_enabled', true ); 1949 1950 return $jsonp_enabled; 1951 } 1952 1953 /** 1954 * Checks whether a string is a valid JSON Media Type. 1955 * 1956 * @since 5.6.0 1957 * 1958 * @param string $media_type A Media Type string to check. 1959 * @return bool True if string is a valid JSON Media Type. 1960 */ 1961 function wp_is_json_media_type( $media_type ) { 1962 static $cache = array(); 1963 1964 if ( ! isset( $cache[ $media_type ] ) ) { 1965 $cache[ $media_type ] = (bool) preg_match( '/(^|\s|,)application\/([\w!#\$&-\^\.\+]+\+)?json(\+oembed)?($|\s|;|,)/i', $media_type ); 1966 } 1967 1968 return $cache[ $media_type ]; 1969 } 1970 1971 /** 1972 * Checks whether current request is an XML request, or is expecting an XML response. 1973 * 1974 * @since 5.2.0 1975 * 1976 * @return bool True if `Accepts` or `Content-Type` headers contain `text/xml` 1977 * or one of the related MIME types. False otherwise. 1978 */ 1979 function wp_is_xml_request() { 1980 $accepted = array( 1981 'text/xml', 1982 'application/rss+xml', 1983 'application/atom+xml', 1984 'application/rdf+xml', 1985 'text/xml+oembed', 1986 'application/xml+oembed', 1987 ); 1988 1989 if ( isset( $_SERVER['HTTP_ACCEPT'] ) ) { 1990 foreach ( $accepted as $type ) { 1991 if ( str_contains( $_SERVER['HTTP_ACCEPT'], $type ) ) { 1992 return true; 1993 } 1994 } 1995 } 1996 1997 if ( isset( $_SERVER['CONTENT_TYPE'] ) && in_array( $_SERVER['CONTENT_TYPE'], $accepted, true ) ) { 1998 return true; 1999 } 2000 2001 return false; 2002 } 2003 2004 /** 2005 * Checks if this site is protected by HTTP Basic Auth. 2006 * 2007 * At the moment, this merely checks for the present of Basic Auth credentials. Therefore, calling 2008 * this function with a context different from the current context may give inaccurate results. 2009 * In a future release, this evaluation may be made more robust. 2010 * 2011 * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes 2012 * Basic Auth. 2013 * 2014 * @since 5.6.1 2015 * 2016 * @global string $pagenow The filename of the current screen. 2017 * 2018 * @param string $context The context to check for protection. Accepts 'login', 'admin', and 'front'. 2019 * Defaults to the current context. 2020 * @return bool Whether the site is protected by Basic Auth. 2021 */ 2022 function wp_is_site_protected_by_basic_auth( $context = '' ) { 2023 global $pagenow; 2024 2025 if ( ! $context ) { 2026 if ( 'wp-login.php' === $pagenow ) { 2027 $context = 'login'; 2028 } elseif ( is_admin() ) { 2029 $context = 'admin'; 2030 } else { 2031 $context = 'front'; 2032 } 2033 } 2034 2035 $is_protected = ! empty( $_SERVER['PHP_AUTH_USER'] ) || ! empty( $_SERVER['PHP_AUTH_PW'] ); 2036 2037 /** 2038 * Filters whether a site is protected by HTTP Basic Auth. 2039 * 2040 * @since 5.6.1 2041 * 2042 * @param bool $is_protected Whether the site is protected by Basic Auth. 2043 * @param string $context The context to check for protection. One of 'login', 'admin', or 'front'. 2044 */ 2045 return apply_filters( 'wp_is_site_protected_by_basic_auth', $is_protected, $context ); 2046 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Fri Jul 25 08:20:01 2025 | Cross-referenced by PHPXref |