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