| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Main WordPress API 4 * 5 * @package WordPress 6 */ 7 8 require ABSPATH . WPINC . '/option.php'; 9 10 /** 11 * Converts given MySQL date string into a different format. 12 * 13 * - `$format` should be a PHP date format string. 14 * - 'U' and 'G' formats will return an integer sum of timestamp with timezone offset. 15 * - `$date` is expected to be local time in MySQL format (`Y-m-d H:i:s`). 16 * 17 * Historically UTC time could be passed to the function to produce Unix timestamp. 18 * 19 * If `$translate` is true then the given date and format string will 20 * be passed to `wp_date()` for translation. 21 * 22 * @since 0.71 23 * 24 * @param string $format Format of the date to return. 25 * @param string $date Date string to convert. 26 * @param bool $translate Whether the return date should be translated. Default true. 27 * @return string|int|false Integer if `$format` is 'U' or 'G', string otherwise. 28 * False on failure. 29 */ 30 function mysql2date( $format, $date, $translate = true ) { 31 if ( empty( $date ) ) { 32 return false; 33 } 34 35 $timezone = wp_timezone(); 36 $datetime = date_create( $date, $timezone ); 37 38 if ( false === $datetime ) { 39 return false; 40 } 41 42 // Returns a sum of timestamp with timezone offset. Ideally should never be used. 43 if ( 'G' === $format || 'U' === $format ) { 44 return $datetime->getTimestamp() + $datetime->getOffset(); 45 } 46 47 if ( $translate ) { 48 return wp_date( $format, $datetime->getTimestamp(), $timezone ); 49 } 50 51 return $datetime->format( $format ); 52 } 53 54 /** 55 * Retrieves the current time based on specified type. 56 * 57 * - The 'mysql' type will return the time in the format for MySQL DATETIME field. 58 * - The 'timestamp' or 'U' types will return the current timestamp or a sum of timestamp 59 * and timezone offset, depending on `$gmt`. 60 * - Other strings will be interpreted as PHP date formats (e.g. 'Y-m-d'). 61 * 62 * If `$gmt` is a truthy value then both types will use GMT time, otherwise the 63 * output is adjusted with the GMT offset for the site. 64 * 65 * @since 1.0.0 66 * @since 5.3.0 Now returns an integer if `$type` is 'U'. Previously a string was returned. 67 * 68 * @param string $type Type of time to retrieve. Accepts 'mysql', 'timestamp', 'U', 69 * or PHP date format string (e.g. 'Y-m-d'). 70 * @param int|bool $gmt Optional. Whether to use GMT timezone. Default false. 71 * @return int|string Integer if `$type` is 'timestamp' or 'U', string otherwise. 72 */ 73 function current_time( $type, $gmt = 0 ) { 74 // Don't use non-GMT timestamp, unless you know the difference and really need to. 75 if ( 'timestamp' === $type || 'U' === $type ) { 76 return $gmt ? time() : time() + (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ); 77 } 78 79 if ( 'mysql' === $type ) { 80 $type = 'Y-m-d H:i:s'; 81 } 82 83 $timezone = $gmt ? new DateTimeZone( 'UTC' ) : wp_timezone(); 84 $datetime = new DateTime( 'now', $timezone ); 85 86 return $datetime->format( $type ); 87 } 88 89 /** 90 * Retrieves the current time as an object using the site's timezone. 91 * 92 * @since 5.3.0 93 * 94 * @return DateTimeImmutable Date and time object. 95 */ 96 function current_datetime() { 97 return new DateTimeImmutable( 'now', wp_timezone() ); 98 } 99 100 /** 101 * Retrieves the timezone of the site as a string. 102 * 103 * Uses the `timezone_string` option to get a proper timezone name if available, 104 * otherwise falls back to a manual UTC ± offset. 105 * 106 * Example return values: 107 * 108 * - 'Europe/Rome' 109 * - 'America/North_Dakota/New_Salem' 110 * - 'UTC' 111 * - '-06:30' 112 * - '+00:00' 113 * - '+08:45' 114 * 115 * @since 5.3.0 116 * 117 * @return string PHP timezone name or a ±HH:MM offset. 118 */ 119 function wp_timezone_string() { 120 $timezone_string = get_option( 'timezone_string' ); 121 122 if ( $timezone_string ) { 123 return $timezone_string; 124 } 125 126 $offset = (float) get_option( 'gmt_offset' ); 127 $hours = (int) $offset; 128 $minutes = ( $offset - $hours ); 129 130 $sign = ( $offset < 0 ) ? '-' : '+'; 131 $abs_hour = abs( $hours ); 132 $abs_mins = abs( $minutes * 60 ); 133 $tz_offset = sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins ); 134 135 return $tz_offset; 136 } 137 138 /** 139 * Retrieves the timezone of the site as a `DateTimeZone` object. 140 * 141 * Timezone can be based on a PHP timezone string or a ±HH:MM offset. 142 * 143 * @since 5.3.0 144 * 145 * @return DateTimeZone Timezone object. 146 */ 147 function wp_timezone() { 148 return new DateTimeZone( wp_timezone_string() ); 149 } 150 151 /** 152 * Retrieves the date in localized format, based on a sum of Unix timestamp and 153 * timezone offset in seconds. 154 * 155 * If the locale specifies the locale month and weekday, then the locale will 156 * take over the format for the date. If it isn't, then the date format string 157 * will be used instead. 158 * 159 * Note that due to the way WP typically generates a sum of timestamp and offset 160 * with `strtotime()`, it implies offset added at a _current_ time, not at the time 161 * the timestamp represents. Storing such timestamps or calculating them differently 162 * will lead to invalid output. 163 * 164 * @since 0.71 165 * @since 5.3.0 Converted into a wrapper for wp_date(). 166 * 167 * @param string $format Format to display the date. 168 * @param int|bool $timestamp_with_offset Optional. A sum of Unix timestamp and timezone offset 169 * in seconds. Default false. 170 * @param bool $gmt Optional. Whether to use GMT timezone. Only applies 171 * if timestamp is not provided. Default false. 172 * @return string The date, translated if locale specifies it. 173 */ 174 function date_i18n( $format, $timestamp_with_offset = false, $gmt = false ) { 175 $timestamp = $timestamp_with_offset; 176 177 // If timestamp is omitted it should be current time (summed with offset, unless `$gmt` is true). 178 if ( ! is_numeric( $timestamp ) ) { 179 // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested 180 $timestamp = current_time( 'timestamp', $gmt ); 181 } 182 183 /* 184 * This is a legacy implementation quirk that the returned timestamp is also with offset. 185 * Ideally this function should never be used to produce a timestamp. 186 */ 187 if ( 'U' === $format ) { 188 $date = $timestamp; 189 } elseif ( $gmt && false === $timestamp_with_offset ) { // Current time in UTC. 190 $date = wp_date( $format, null, new DateTimeZone( 'UTC' ) ); 191 } elseif ( false === $timestamp_with_offset ) { // Current time in site's timezone. 192 $date = wp_date( $format ); 193 } else { 194 /* 195 * Timestamp with offset is typically produced by a UTC `strtotime()` call on an input without timezone. 196 * This is the best attempt to reverse that operation into a local time to use. 197 */ 198 $local_time = gmdate( 'Y-m-d H:i:s', $timestamp ); 199 $timezone = wp_timezone(); 200 $datetime = date_create( $local_time, $timezone ); 201 $date = wp_date( $format, $datetime->getTimestamp(), $timezone ); 202 } 203 204 /** 205 * Filters the date formatted based on the locale. 206 * 207 * @since 2.8.0 208 * 209 * @param string $date Formatted date string. 210 * @param string $format Format to display the date. 211 * @param int $timestamp A sum of Unix timestamp and timezone offset in seconds. 212 * Might be without offset if input omitted timestamp but requested GMT. 213 * @param bool $gmt Whether to use GMT timezone. Only applies if timestamp was not provided. 214 * Default false. 215 */ 216 $date = apply_filters( 'date_i18n', $date, $format, $timestamp, $gmt ); 217 218 return $date; 219 } 220 221 /** 222 * Retrieves the date, in localized format. 223 * 224 * This is a newer function, intended to replace `date_i18n()` without legacy quirks in it. 225 * 226 * Note that, unlike `date_i18n()`, this function accepts a true Unix timestamp, not summed 227 * with timezone offset. 228 * 229 * @since 5.3.0 230 * 231 * @global WP_Locale $wp_locale WordPress date and time locale object. 232 * 233 * @param string $format PHP date format. 234 * @param int $timestamp Optional. Unix timestamp. Defaults to current time. 235 * @param DateTimeZone $timezone Optional. Timezone to output result in. Defaults to timezone 236 * from site settings. 237 * @return string|false The date, translated if locale specifies it. False on invalid timestamp input. 238 */ 239 function wp_date( $format, $timestamp = null, $timezone = null ) { 240 global $wp_locale; 241 242 if ( null === $timestamp ) { 243 $timestamp = time(); 244 } elseif ( ! is_numeric( $timestamp ) ) { 245 return false; 246 } 247 248 if ( ! $timezone ) { 249 $timezone = wp_timezone(); 250 } 251 252 $datetime = date_create( '@' . $timestamp ); 253 $datetime->setTimezone( $timezone ); 254 255 if ( empty( $wp_locale->month ) || empty( $wp_locale->weekday ) ) { 256 $date = $datetime->format( $format ); 257 } else { 258 // We need to unpack shorthand `r` format because it has parts that might be localized. 259 $format = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $format ); 260 261 $new_format = ''; 262 $format_length = strlen( $format ); 263 $month = $wp_locale->get_month( $datetime->format( 'm' ) ); 264 $weekday = $wp_locale->get_weekday( $datetime->format( 'w' ) ); 265 266 for ( $i = 0; $i < $format_length; $i++ ) { 267 switch ( $format[ $i ] ) { 268 case 'D': 269 $new_format .= addcslashes( $wp_locale->get_weekday_abbrev( $weekday ), '\\A..Za..z' ); 270 break; 271 case 'F': 272 $new_format .= addcslashes( $month, '\\A..Za..z' ); 273 break; 274 case 'l': 275 $new_format .= addcslashes( $weekday, '\\A..Za..z' ); 276 break; 277 case 'M': 278 $new_format .= addcslashes( $wp_locale->get_month_abbrev( $month ), '\\A..Za..z' ); 279 break; 280 case 'a': 281 $new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'a' ) ), '\\A..Za..z' ); 282 break; 283 case 'A': 284 $new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'A' ) ), '\\A..Za..z' ); 285 break; 286 case '\\': 287 $new_format .= $format[ $i ]; 288 289 // If character follows a slash, we add it without translating. 290 if ( $i < $format_length ) { 291 $new_format .= $format[ ++$i ]; 292 } 293 break; 294 default: 295 $new_format .= $format[ $i ]; 296 break; 297 } 298 } 299 300 $date = $datetime->format( $new_format ); 301 $date = wp_maybe_decline_date( $date, $format ); 302 } 303 304 /** 305 * Filters the date formatted based on the locale. 306 * 307 * @since 5.3.0 308 * 309 * @param string $date Formatted date string. 310 * @param string $format Format to display the date. 311 * @param int $timestamp Unix timestamp. 312 * @param DateTimeZone $timezone Timezone. 313 */ 314 $date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone ); 315 316 return $date; 317 } 318 319 /** 320 * Determines if the date should be declined. 321 * 322 * If the locale specifies that month names require a genitive case in certain 323 * formats (like 'j F Y'), the month name will be replaced with a correct form. 324 * 325 * @since 4.4.0 326 * @since 5.4.0 The `$format` parameter was added. 327 * 328 * @global WP_Locale $wp_locale WordPress date and time locale object. 329 * 330 * @param string $date Formatted date string. 331 * @param string $format Optional. Date format to check. Default empty string. 332 * @return string The date, declined if locale specifies it. 333 */ 334 function wp_maybe_decline_date( $date, $format = '' ) { 335 global $wp_locale; 336 337 // i18n functions are not available in SHORTINIT mode. 338 if ( ! function_exists( '_x' ) ) { 339 return $date; 340 } 341 342 /* 343 * translators: If months in your language require a genitive case, 344 * translate this to 'on'. Do not translate into your own language. 345 */ 346 if ( 'on' === _x( 'off', 'decline months names: on or off' ) ) { 347 348 $months = $wp_locale->month; 349 $months_genitive = $wp_locale->month_genitive; 350 351 /* 352 * Match a format like 'j F Y' or 'j. F' (day of the month, followed by month name) 353 * and decline the month. 354 */ 355 if ( $format ) { 356 $decline = preg_match( '#[dj]\.? F#', $format ); 357 } else { 358 // If the format is not passed, try to guess it from the date string. 359 $decline = preg_match( '#\b\d{1,2}\.? [^\d ]+\b#u', $date ); 360 } 361 362 if ( $decline ) { 363 foreach ( $months as $key => $month ) { 364 $months[ $key ] = '# ' . preg_quote( $month, '#' ) . '\b#u'; 365 } 366 367 foreach ( $months_genitive as $key => $month ) { 368 $months_genitive[ $key ] = ' ' . $month; 369 } 370 371 $date = preg_replace( $months, $months_genitive, $date ); 372 } 373 374 /* 375 * Match a format like 'F jS' or 'F j' (month name, followed by day with an optional ordinal suffix) 376 * and change it to declined 'j F'. 377 */ 378 if ( $format ) { 379 $decline = preg_match( '#F [dj]#', $format ); 380 } else { 381 // If the format is not passed, try to guess it from the date string. 382 $decline = preg_match( '#\b[^\d ]+ \d{1,2}(st|nd|rd|th)?\b#u', trim( $date ) ); 383 } 384 385 if ( $decline ) { 386 foreach ( $months as $key => $month ) { 387 $months[ $key ] = '#\b' . preg_quote( $month, '#' ) . ' (\d{1,2})(st|nd|rd|th)?([-–]\d{1,2})?(st|nd|rd|th)?\b#u'; 388 } 389 390 foreach ( $months_genitive as $key => $month ) { 391 $months_genitive[ $key ] = '$1$3 ' . $month; 392 } 393 394 $date = preg_replace( $months, $months_genitive, $date ); 395 } 396 } 397 398 // Used for locale-specific rules. 399 $locale = get_locale(); 400 401 if ( 'ca' === $locale ) { 402 // " de abril| de agost| de octubre..." -> " d'abril| d'agost| d'octubre..." 403 $date = preg_replace( '# de ([ao])#i', " d'\\1", $date ); 404 } 405 406 return $date; 407 } 408 409 /** 410 * Converts float number to format based on the locale. 411 * 412 * @since 2.3.0 413 * 414 * @global WP_Locale $wp_locale WordPress date and time locale object. 415 * 416 * @param float $number The number to convert based on locale. 417 * @param int $decimals Optional. Precision of the number of decimal places. Default 0. 418 * @return string Converted number in string format. 419 */ 420 function number_format_i18n( $number, $decimals = 0 ) { 421 global $wp_locale; 422 423 if ( isset( $wp_locale ) ) { 424 $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] ); 425 } else { 426 $formatted = number_format( $number, absint( $decimals ) ); 427 } 428 429 /** 430 * Filters the number formatted based on the locale. 431 * 432 * @since 2.8.0 433 * @since 4.9.0 The `$number` and `$decimals` parameters were added. 434 * 435 * @param string $formatted Converted number in string format. 436 * @param float $number The number to convert based on locale. 437 * @param int $decimals Precision of the number of decimal places. 438 */ 439 return apply_filters( 'number_format_i18n', $formatted, $number, $decimals ); 440 } 441 442 /** 443 * Converts a number of bytes to the largest unit the bytes will fit into. 444 * 445 * It is easier to read 1 KB than 1024 bytes and 1 MB than 1048576 bytes. Converts 446 * number of bytes to human readable number by taking the number of that unit 447 * that the bytes will go into it. Supports YB value. 448 * 449 * Please note that integers in PHP are limited to 32 bits, unless they are on 450 * 64 bit architecture, then they have 64 bit size. If you need to place the 451 * larger size then what PHP integer type will hold, then use a string. It will 452 * be converted to a double, which should always have 64 bit length. 453 * 454 * Technically the correct unit names for powers of 1024 are KiB, MiB etc. 455 * 456 * @since 2.3.0 457 * @since 6.0.0 Support for PB, EB, ZB, and YB was added. 458 * 459 * @param int|string $bytes Number of bytes. Note max integer size for integers. 460 * @param int $decimals Optional. Precision of number of decimal places. Default 0. 461 * @return string|false Number string on success, false on failure. 462 */ 463 function size_format( $bytes, $decimals = 0 ) { 464 $quant = array( 465 /* translators: Unit symbol for yottabyte. */ 466 _x( 'YB', 'unit symbol' ) => YB_IN_BYTES, 467 /* translators: Unit symbol for zettabyte. */ 468 _x( 'ZB', 'unit symbol' ) => ZB_IN_BYTES, 469 /* translators: Unit symbol for exabyte. */ 470 _x( 'EB', 'unit symbol' ) => EB_IN_BYTES, 471 /* translators: Unit symbol for petabyte. */ 472 _x( 'PB', 'unit symbol' ) => PB_IN_BYTES, 473 /* translators: Unit symbol for terabyte. */ 474 _x( 'TB', 'unit symbol' ) => TB_IN_BYTES, 475 /* translators: Unit symbol for gigabyte. */ 476 _x( 'GB', 'unit symbol' ) => GB_IN_BYTES, 477 /* translators: Unit symbol for megabyte. */ 478 _x( 'MB', 'unit symbol' ) => MB_IN_BYTES, 479 /* translators: Unit symbol for kilobyte. */ 480 _x( 'KB', 'unit symbol' ) => KB_IN_BYTES, 481 /* translators: Unit symbol for byte. */ 482 _x( 'B', 'unit symbol' ) => 1, 483 ); 484 485 if ( 0 === $bytes ) { 486 /* translators: Unit symbol for byte. */ 487 return number_format_i18n( 0, $decimals ) . ' ' . _x( 'B', 'unit symbol' ); 488 } 489 490 foreach ( $quant as $unit => $mag ) { 491 if ( (float) $bytes >= $mag ) { 492 return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit; 493 } 494 } 495 496 return false; 497 } 498 499 /** 500 * Converts a duration to human readable format. 501 * 502 * @since 5.1.0 503 * 504 * @param string $duration Duration will be in string format (HH:ii:ss) OR (ii:ss), 505 * with a possible prepended negative sign (-). 506 * @return string|false A human readable duration string, false on failure. 507 */ 508 function human_readable_duration( $duration = '' ) { 509 if ( ( empty( $duration ) || ! is_string( $duration ) ) ) { 510 return false; 511 } 512 513 $duration = trim( $duration ); 514 515 // Remove prepended negative sign. 516 if ( str_starts_with( $duration, '-' ) ) { 517 $duration = substr( $duration, 1 ); 518 } 519 520 // Extract duration parts. 521 $duration_parts = array_reverse( explode( ':', $duration ) ); 522 $duration_count = count( $duration_parts ); 523 524 $hour = null; 525 $minute = null; 526 $second = null; 527 528 if ( 3 === $duration_count ) { 529 // Validate HH:ii:ss duration format. 530 if ( ! ( (bool) preg_match( '/^([0-9]+):([0-5]?[0-9]):([0-5]?[0-9])$/', $duration ) ) ) { 531 return false; 532 } 533 // Three parts: hours, minutes & seconds. 534 list( $second, $minute, $hour ) = $duration_parts; 535 } elseif ( 2 === $duration_count ) { 536 // Validate ii:ss duration format. 537 if ( ! ( (bool) preg_match( '/^([0-5]?[0-9]):([0-5]?[0-9])$/', $duration ) ) ) { 538 return false; 539 } 540 // Two parts: minutes & seconds. 541 list( $second, $minute ) = $duration_parts; 542 } else { 543 return false; 544 } 545 546 $human_readable_duration = array(); 547 548 // Add the hour part to the string. 549 if ( is_numeric( $hour ) ) { 550 /* translators: %s: Time duration in hour or hours. */ 551 $human_readable_duration[] = sprintf( _n( '%s hour', '%s hours', $hour ), (int) $hour ); 552 } 553 554 // Add the minute part to the string. 555 if ( is_numeric( $minute ) ) { 556 /* translators: %s: Time duration in minute or minutes. */ 557 $human_readable_duration[] = sprintf( _n( '%s minute', '%s minutes', $minute ), (int) $minute ); 558 } 559 560 // Add the second part to the string. 561 if ( is_numeric( $second ) ) { 562 /* translators: %s: Time duration in second or seconds. */ 563 $human_readable_duration[] = sprintf( _n( '%s second', '%s seconds', $second ), (int) $second ); 564 } 565 566 return implode( ', ', $human_readable_duration ); 567 } 568 569 /** 570 * Gets the week start and end from the datetime or date string from MySQL. 571 * 572 * @since 0.71 573 * 574 * @param string $mysqlstring Date or datetime field type from MySQL. 575 * @param int|string $start_of_week Optional. Start of the week as an integer. Default empty string. 576 * @return int[] { 577 * Week start and end dates as Unix timestamps. 578 * 579 * @type int $start The week start date as a Unix timestamp. 580 * @type int $end The week end date as a Unix timestamp. 581 * } 582 */ 583 function get_weekstartend( $mysqlstring, $start_of_week = '' ) { 584 // MySQL string year. 585 $my = substr( $mysqlstring, 0, 4 ); 586 587 // MySQL string month. 588 $mm = substr( $mysqlstring, 8, 2 ); 589 590 // MySQL string day. 591 $md = substr( $mysqlstring, 5, 2 ); 592 593 // The timestamp for MySQL string day. 594 $day = mktime( 0, 0, 0, $md, $mm, $my ); 595 596 // The day of the week from the timestamp. 597 $weekday = gmdate( 'w', $day ); 598 599 if ( ! is_numeric( $start_of_week ) ) { 600 $start_of_week = get_option( 'start_of_week' ); 601 } 602 603 if ( $weekday < $start_of_week ) { 604 $weekday += 7; 605 } 606 607 // The most recent week start day on or before $day. 608 $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week ); 609 610 // $start + 1 week - 1 second. 611 $end = $start + WEEK_IN_SECONDS - 1; 612 return compact( 'start', 'end' ); 613 } 614 615 /** 616 * Serializes data, if needed. 617 * 618 * @since 2.0.5 619 * 620 * @param string|array|object $data Data that might be serialized. 621 * @return mixed A scalar data. 622 */ 623 function maybe_serialize( $data ) { 624 if ( is_array( $data ) || is_object( $data ) ) { 625 return serialize( $data ); 626 } 627 628 /* 629 * Double serialization is required for backward compatibility. 630 * See https://core.trac.wordpress.org/ticket/12930 631 * Also the world will end. See WP 3.6.1. 632 */ 633 if ( is_serialized( $data, false ) ) { 634 return serialize( $data ); 635 } 636 637 return $data; 638 } 639 640 /** 641 * Unserializes data only if it was serialized. 642 * 643 * @since 2.0.0 644 * 645 * @param string $data Data that might be unserialized. 646 * @return mixed Unserialized data can be any type. 647 */ 648 function maybe_unserialize( $data ) { 649 if ( is_serialized( $data ) ) { // Don't attempt to unserialize data that wasn't serialized going in. 650 return @unserialize( trim( $data ) ); 651 } 652 653 return $data; 654 } 655 656 /** 657 * Checks value to find if it was serialized. 658 * 659 * If $data is not a string, then returned value will always be false. 660 * Serialized data is always a string. 661 * 662 * @since 2.0.5 663 * @since 6.1.0 Added Enum support. 664 * 665 * @param string $data Value to check to see if was serialized. 666 * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. 667 * @return bool False if not serialized and true if it was. 668 */ 669 function is_serialized( $data, $strict = true ) { 670 // If it isn't a string, it isn't serialized. 671 if ( ! is_string( $data ) ) { 672 return false; 673 } 674 $data = trim( $data ); 675 if ( 'N;' === $data ) { 676 return true; 677 } 678 if ( strlen( $data ) < 4 ) { 679 return false; 680 } 681 if ( ':' !== $data[1] ) { 682 return false; 683 } 684 if ( $strict ) { 685 $lastc = substr( $data, -1 ); 686 if ( ';' !== $lastc && '}' !== $lastc ) { 687 return false; 688 } 689 } else { 690 $semicolon = strpos( $data, ';' ); 691 $brace = strpos( $data, '}' ); 692 // Either ; or } must exist. 693 if ( false === $semicolon && false === $brace ) { 694 return false; 695 } 696 // But neither must be in the first X characters. 697 if ( false !== $semicolon && $semicolon < 3 ) { 698 return false; 699 } 700 if ( false !== $brace && $brace < 4 ) { 701 return false; 702 } 703 } 704 $token = $data[0]; 705 switch ( $token ) { 706 case 's': 707 if ( $strict ) { 708 if ( '"' !== substr( $data, -2, 1 ) ) { 709 return false; 710 } 711 } elseif ( ! str_contains( $data, '"' ) ) { 712 return false; 713 } 714 // Or else fall through. 715 case 'a': 716 case 'O': 717 case 'E': 718 return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); 719 case 'b': 720 case 'i': 721 case 'd': 722 $end = $strict ? '$' : ''; 723 return (bool) preg_match( "/^{$token}:[0-9.E+-]+;$end/", $data ); 724 } 725 return false; 726 } 727 728 /** 729 * Checks whether serialized data is of string type. 730 * 731 * @since 2.0.5 732 * 733 * @param string $data Serialized data. 734 * @return bool False if not a serialized string, true if it is. 735 */ 736 function is_serialized_string( $data ) { 737 // if it isn't a string, it isn't a serialized string. 738 if ( ! is_string( $data ) ) { 739 return false; 740 } 741 $data = trim( $data ); 742 if ( strlen( $data ) < 4 ) { 743 return false; 744 } elseif ( ':' !== $data[1] ) { 745 return false; 746 } elseif ( ! str_ends_with( $data, ';' ) ) { 747 return false; 748 } elseif ( 's' !== $data[0] ) { 749 return false; 750 } elseif ( '"' !== substr( $data, -2, 1 ) ) { 751 return false; 752 } else { 753 return true; 754 } 755 } 756 757 /** 758 * Retrieves post title from XMLRPC XML. 759 * 760 * If the title element is not part of the XML, then the default post title from 761 * the $post_default_title will be used instead. 762 * 763 * @since 0.71 764 * 765 * @global string $post_default_title Default XML-RPC post title. 766 * 767 * @param string $content XMLRPC XML Request content 768 * @return string Post title 769 */ 770 function xmlrpc_getposttitle( $content ) { 771 global $post_default_title; 772 if ( preg_match( '/<title>(.+?)<\/title>/is', $content, $matchtitle ) ) { 773 $post_title = $matchtitle[1]; 774 } else { 775 $post_title = $post_default_title; 776 } 777 return $post_title; 778 } 779 780 /** 781 * Retrieves the post category or categories from XMLRPC XML. 782 * 783 * If the category element is not found, then the default post category will be 784 * used. The return type then would be what $post_default_category. If the 785 * category is found, then it will always be an array. 786 * 787 * @since 0.71 788 * 789 * @global string $post_default_category Default XML-RPC post category. 790 * 791 * @param string $content XMLRPC XML Request content 792 * @return string|array List of categories or category name. 793 */ 794 function xmlrpc_getpostcategory( $content ) { 795 global $post_default_category; 796 if ( preg_match( '/<category>(.+?)<\/category>/is', $content, $matchcat ) ) { 797 $post_category = trim( $matchcat[1], ',' ); 798 $post_category = explode( ',', $post_category ); 799 } else { 800 $post_category = $post_default_category; 801 } 802 return $post_category; 803 } 804 805 /** 806 * XMLRPC XML content without title and category elements. 807 * 808 * @since 0.71 809 * 810 * @param string $content XML-RPC XML Request content. 811 * @return string XMLRPC XML Request content without title and category elements. 812 */ 813 function xmlrpc_removepostdata( $content ) { 814 $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content ); 815 $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content ); 816 $content = trim( $content ); 817 return $content; 818 } 819 820 /** 821 * Uses RegEx to extract URLs from arbitrary content. 822 * 823 * @since 3.7.0 824 * @since 6.0.0 Fixes support for HTML entities (Trac 30580). 825 * 826 * @param string $content Content to extract URLs from. 827 * @return string[] Array of URLs found in passed string. 828 */ 829 function wp_extract_urls( $content ) { 830 preg_match_all( 831 "#([\"']?)(" 832 . '(?:([\w-]+:)?//?)' 833 . '[^\s()<>]+' 834 . '[.]' 835 . '(?:' 836 . '\([\w\d]+\)|' 837 . '(?:' 838 . "[^`!()\[\]{}:'\".,<>«»“”‘’\s]|" 839 . '(?:[:]\d+)?/?' 840 . ')+' 841 . ')' 842 . ")\\1#", 843 $content, 844 $post_links 845 ); 846 847 $post_links = array_unique( 848 array_map( 849 static function ( $link ) { 850 // Decode to replace valid entities, like &. 851 $link = html_entity_decode( $link ); 852 // Maintain backward compatibility by removing extraneous semi-colons (`;`). 853 return str_replace( ';', '', $link ); 854 }, 855 $post_links[2] 856 ) 857 ); 858 859 return array_values( $post_links ); 860 } 861 862 /** 863 * Checks content for video and audio links to add as enclosures. 864 * 865 * Will not add enclosures that have already been added and will 866 * remove enclosures that are no longer in the post. This is called as 867 * pingbacks and trackbacks. 868 * 869 * @since 1.5.0 870 * @since 5.3.0 The `$content` parameter was made optional, and the `$post` parameter was 871 * updated to accept a post ID or a WP_Post object. 872 * @since 5.6.0 The `$content` parameter is no longer optional, but passing `null` to skip it 873 * is still supported. 874 * 875 * @global wpdb $wpdb WordPress database abstraction object. 876 * 877 * @param string|null $content Post content. If `null`, the `post_content` field from `$post` is used. 878 * @param int|WP_Post $post Post ID or post object. 879 * @return void|false Void on success, false if the post is not found. 880 */ 881 function do_enclose( $content, $post ) { 882 global $wpdb; 883 884 // @todo Tidy this code and make the debug code optional. 885 require_once ABSPATH . WPINC . '/class-IXR.php'; 886 887 $post = get_post( $post ); 888 if ( ! $post ) { 889 return false; 890 } 891 892 if ( null === $content ) { 893 $content = $post->post_content; 894 } 895 896 $post_links = array(); 897 898 $pung = get_enclosed( $post->ID ); 899 900 $post_links_temp = wp_extract_urls( $content ); 901 902 foreach ( $pung as $link_test ) { 903 // Link is no longer in post. 904 if ( ! in_array( $link_test, $post_links_temp, true ) ) { 905 $mids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post->ID, $wpdb->esc_like( $link_test ) . '%' ) ); 906 foreach ( $mids as $mid ) { 907 delete_metadata_by_mid( 'post', $mid ); 908 } 909 } 910 } 911 912 foreach ( (array) $post_links_temp as $link_test ) { 913 // If we haven't pung it already. 914 if ( ! in_array( $link_test, $pung, true ) ) { 915 $test = parse_url( $link_test ); 916 if ( false === $test ) { 917 continue; 918 } 919 if ( isset( $test['query'] ) ) { 920 $post_links[] = $link_test; 921 } elseif ( isset( $test['path'] ) && ( '/' !== $test['path'] ) && ( '' !== $test['path'] ) ) { 922 $post_links[] = $link_test; 923 } 924 } 925 } 926 927 /** 928 * Filters the list of enclosure links before querying the database. 929 * 930 * Allows for the addition and/or removal of potential enclosures to save 931 * to postmeta before checking the database for existing enclosures. 932 * 933 * @since 4.4.0 934 * 935 * @param string[] $post_links An array of enclosure links. 936 * @param int $post_id Post ID. 937 */ 938 $post_links = apply_filters( 'enclosure_links', $post_links, $post->ID ); 939 940 foreach ( (array) $post_links as $url ) { 941 $url = strip_fragment_from_url( $url ); 942 943 if ( '' !== $url && ! $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post->ID, $wpdb->esc_like( $url ) . '%' ) ) ) { 944 945 $headers = wp_get_http_headers( $url ); 946 if ( $headers ) { 947 $len = isset( $headers['Content-Length'] ) ? (int) $headers['Content-Length'] : 0; 948 $type = isset( $headers['Content-Type'] ) ? $headers['Content-Type'] : ''; 949 $allowed_types = array( 'video', 'audio' ); 950 951 // Check to see if we can figure out the mime type from the extension. 952 $url_parts = parse_url( $url ); 953 if ( false !== $url_parts && ! empty( $url_parts['path'] ) ) { 954 $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION ); 955 if ( ! empty( $extension ) ) { 956 foreach ( wp_get_mime_types() as $exts => $mime ) { 957 if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) { 958 $type = $mime; 959 break; 960 } 961 } 962 } 963 } 964 965 if ( in_array( substr( $type, 0, strpos( $type, '/' ) ), $allowed_types, true ) ) { 966 add_post_meta( $post->ID, 'enclosure', "$url\n$len\n$mime\n" ); 967 } 968 } 969 } 970 } 971 } 972 973 /** 974 * Retrieves HTTP Headers from URL. 975 * 976 * @since 1.5.1 977 * 978 * @param string $url URL to retrieve HTTP headers from. 979 * @param bool $deprecated Not Used. 980 * @return \WpOrg\Requests\Utility\CaseInsensitiveDictionary|false Headers on success, false on failure. 981 */ 982 function wp_get_http_headers( $url, $deprecated = false ) { 983 if ( ! empty( $deprecated ) ) { 984 _deprecated_argument( __FUNCTION__, '2.7.0' ); 985 } 986 987 $response = wp_safe_remote_head( $url ); 988 989 if ( is_wp_error( $response ) ) { 990 return false; 991 } 992 993 return wp_remote_retrieve_headers( $response ); 994 } 995 996 /** 997 * Determines whether the publish date of the current post in the loop is different 998 * from the publish date of the previous post in the loop. 999 * 1000 * For more information on this and similar theme functions, check out 1001 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1002 * Conditional Tags} article in the Theme Developer Handbook. 1003 * 1004 * @since 0.71 1005 * 1006 * @global string $currentday The day of the current post in the loop. 1007 * @global string $previousday The day of the previous post in the loop. 1008 * 1009 * @return int 1 when new day, 0 if not a new day. 1010 */ 1011 function is_new_day() { 1012 global $currentday, $previousday; 1013 1014 if ( $currentday !== $previousday ) { 1015 return 1; 1016 } else { 1017 return 0; 1018 } 1019 } 1020 1021 /** 1022 * Builds URL query based on an associative and, or indexed array. 1023 * 1024 * This is a convenient function for easily building url queries. It sets the 1025 * separator to '&' and uses _http_build_query() function. 1026 * 1027 * @since 2.3.0 1028 * 1029 * @see _http_build_query() Used to build the query 1030 * @link https://www.php.net/manual/en/function.http-build-query.php for more on what 1031 * http_build_query() does. 1032 * 1033 * @param array $data URL-encode key/value pairs. 1034 * @return string URL-encoded string. 1035 */ 1036 function build_query( $data ) { 1037 return _http_build_query( $data, null, '&', '', false ); 1038 } 1039 1040 /** 1041 * From php.net (modified by Mark Jaquith to behave like the native PHP5 function). 1042 * 1043 * @since 3.2.0 1044 * @access private 1045 * 1046 * @see https://www.php.net/manual/en/function.http-build-query.php 1047 * 1048 * @param array|object $data An array or object of data. Converted to array. 1049 * @param string $prefix Optional. Numeric index. If set, start parameter numbering with it. 1050 * Default null. 1051 * @param string $sep Optional. Argument separator; defaults to 'arg_separator.output'. 1052 * Default null. 1053 * @param string $key Optional. Used to prefix key name. Default empty string. 1054 * @param bool $urlencode Optional. Whether to use urlencode() in the result. Default true. 1055 * @return string The query string. 1056 */ 1057 function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urlencode = true ) { 1058 $ret = array(); 1059 1060 foreach ( (array) $data as $k => $v ) { 1061 if ( $urlencode ) { 1062 $k = urlencode( $k ); 1063 } 1064 1065 if ( is_int( $k ) && null !== $prefix ) { 1066 $k = $prefix . $k; 1067 } 1068 1069 if ( ! empty( $key ) ) { 1070 $k = $key . '%5B' . $k . '%5D'; 1071 } 1072 1073 if ( null === $v ) { 1074 continue; 1075 } elseif ( false === $v ) { 1076 $v = '0'; 1077 } 1078 1079 if ( is_array( $v ) || is_object( $v ) ) { 1080 array_push( $ret, _http_build_query( $v, '', $sep, $k, $urlencode ) ); 1081 } elseif ( $urlencode ) { 1082 array_push( $ret, $k . '=' . urlencode( $v ) ); 1083 } else { 1084 array_push( $ret, $k . '=' . $v ); 1085 } 1086 } 1087 1088 if ( null === $sep ) { 1089 $sep = ini_get( 'arg_separator.output' ); 1090 } 1091 1092 return implode( $sep, $ret ); 1093 } 1094 1095 /** 1096 * Retrieves a modified URL query string. 1097 * 1098 * You can rebuild the URL and append query variables to the URL query by using this function. 1099 * There are two ways to use this function; either a single key and value, or an associative array. 1100 * 1101 * Using a single key and value: 1102 * 1103 * add_query_arg( 'key', 'value', 'http://example.com' ); 1104 * 1105 * Using an associative array: 1106 * 1107 * add_query_arg( array( 1108 * 'key1' => 'value1', 1109 * 'key2' => 'value2', 1110 * ), 'http://example.com' ); 1111 * 1112 * Omitting the URL from either use results in the current URL being used 1113 * (the value of `$_SERVER['REQUEST_URI']`). 1114 * 1115 * Values are expected to be encoded appropriately with urlencode() or rawurlencode(). 1116 * 1117 * Setting any query variable's value to boolean false removes the key (see remove_query_arg()). 1118 * 1119 * Important: The return value of add_query_arg() is not escaped by default. Output should be 1120 * late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting 1121 * (XSS) attacks. 1122 * 1123 * @since 1.5.0 1124 * @since 5.3.0 Formalized the existing and already documented parameters 1125 * by adding `...$args` to the function signature. 1126 * 1127 * @param string|array $key Either a query variable key, or an associative array of query variables. 1128 * @param string $value Optional. Either a query variable value, or a URL to act upon. 1129 * @param string $url Optional. A URL to act upon. 1130 * @return string New URL query string (unescaped). 1131 */ 1132 function add_query_arg( ...$args ) { 1133 if ( is_array( $args[0] ) ) { 1134 if ( count( $args ) < 2 || false === $args[1] ) { 1135 $uri = $_SERVER['REQUEST_URI']; 1136 } else { 1137 $uri = $args[1]; 1138 } 1139 } else { 1140 if ( count( $args ) < 3 || false === $args[2] ) { 1141 $uri = $_SERVER['REQUEST_URI']; 1142 } else { 1143 $uri = $args[2]; 1144 } 1145 } 1146 1147 $frag = strstr( $uri, '#' ); 1148 if ( $frag ) { 1149 $uri = substr( $uri, 0, -strlen( $frag ) ); 1150 } else { 1151 $frag = ''; 1152 } 1153 1154 if ( 0 === stripos( $uri, 'http://' ) ) { 1155 $protocol = 'http://'; 1156 $uri = substr( $uri, 7 ); 1157 } elseif ( 0 === stripos( $uri, 'https://' ) ) { 1158 $protocol = 'https://'; 1159 $uri = substr( $uri, 8 ); 1160 } else { 1161 $protocol = ''; 1162 } 1163 1164 if ( str_contains( $uri, '?' ) ) { 1165 list( $base, $query ) = explode( '?', $uri, 2 ); 1166 $base .= '?'; 1167 } elseif ( $protocol || ! str_contains( $uri, '=' ) ) { 1168 $base = $uri . '?'; 1169 $query = ''; 1170 } else { 1171 $base = ''; 1172 $query = $uri; 1173 } 1174 1175 wp_parse_str( $query, $qs ); 1176 $qs = urlencode_deep( $qs ); // This re-URL-encodes things that were already in the query string. 1177 if ( is_array( $args[0] ) ) { 1178 foreach ( $args[0] as $k => $v ) { 1179 $qs[ $k ] = $v; 1180 } 1181 } else { 1182 $qs[ $args[0] ] = $args[1]; 1183 } 1184 1185 foreach ( $qs as $k => $v ) { 1186 if ( false === $v ) { 1187 unset( $qs[ $k ] ); 1188 } 1189 } 1190 1191 $ret = build_query( $qs ); 1192 $ret = trim( $ret, '?' ); 1193 $ret = preg_replace( '#=(&|$)#', '$1', $ret ); 1194 $ret = $protocol . $base . $ret . $frag; 1195 $ret = rtrim( $ret, '?' ); 1196 $ret = str_replace( '?#', '#', $ret ); 1197 return $ret; 1198 } 1199 1200 /** 1201 * Removes an item or items from a query string. 1202 * 1203 * Important: The return value of remove_query_arg() is not escaped by default. Output should be 1204 * late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting 1205 * (XSS) attacks. 1206 * 1207 * @since 1.5.0 1208 * 1209 * @param string|string[] $key Query key or keys to remove. 1210 * @param false|string $query Optional. When false uses the current URL. Default false. 1211 * @return string New URL query string. 1212 */ 1213 function remove_query_arg( $key, $query = false ) { 1214 if ( is_array( $key ) ) { // Removing multiple keys. 1215 foreach ( $key as $k ) { 1216 $query = add_query_arg( $k, false, $query ); 1217 } 1218 return $query; 1219 } 1220 return add_query_arg( $key, false, $query ); 1221 } 1222 1223 /** 1224 * Returns an array of single-use query variable names that can be removed from a URL. 1225 * 1226 * @since 4.4.0 1227 * 1228 * @return string[] An array of query variable names to remove from the URL. 1229 */ 1230 function wp_removable_query_args() { 1231 $removable_query_args = array( 1232 'activate', 1233 'activated', 1234 'admin_email_remind_later', 1235 'approved', 1236 'core-major-auto-updates-saved', 1237 'deactivate', 1238 'delete_count', 1239 'deleted', 1240 'disabled', 1241 'doing_wp_cron', 1242 'enabled', 1243 'error', 1244 'hotkeys_highlight_first', 1245 'hotkeys_highlight_last', 1246 'ids', 1247 'locked', 1248 'message', 1249 'same', 1250 'saved', 1251 'settings-updated', 1252 'skipped', 1253 'spammed', 1254 'trashed', 1255 'unspammed', 1256 'untrashed', 1257 'update', 1258 'updated', 1259 'wp-post-new-reload', 1260 ); 1261 1262 /** 1263 * Filters the list of query variable names to remove. 1264 * 1265 * @since 4.2.0 1266 * 1267 * @param string[] $removable_query_args An array of query variable names to remove from a URL. 1268 */ 1269 return apply_filters( 'removable_query_args', $removable_query_args ); 1270 } 1271 1272 /** 1273 * Walks the array while sanitizing the contents. 1274 * 1275 * @since 0.71 1276 * @since 5.5.0 Non-string values are left untouched. 1277 * 1278 * @param array $input_array Array to walk while sanitizing contents. 1279 * @return array Sanitized $input_array. 1280 */ 1281 function add_magic_quotes( $input_array ) { 1282 foreach ( (array) $input_array as $k => $v ) { 1283 if ( is_array( $v ) ) { 1284 $input_array[ $k ] = add_magic_quotes( $v ); 1285 } elseif ( is_string( $v ) ) { 1286 $input_array[ $k ] = addslashes( $v ); 1287 } 1288 } 1289 1290 return $input_array; 1291 } 1292 1293 /** 1294 * HTTP request for URI to retrieve content. 1295 * 1296 * @since 1.5.1 1297 * 1298 * @see wp_safe_remote_get() 1299 * 1300 * @param string $uri URI/URL of web page to retrieve. 1301 * @return string|false HTTP content. False on failure. 1302 */ 1303 function wp_remote_fopen( $uri ) { 1304 $parsed_url = parse_url( $uri ); 1305 1306 if ( ! $parsed_url || ! is_array( $parsed_url ) ) { 1307 return false; 1308 } 1309 1310 $options = array(); 1311 $options['timeout'] = 10; 1312 1313 $response = wp_safe_remote_get( $uri, $options ); 1314 1315 if ( is_wp_error( $response ) ) { 1316 return false; 1317 } 1318 1319 return wp_remote_retrieve_body( $response ); 1320 } 1321 1322 /** 1323 * Sets up the WordPress query. 1324 * 1325 * @since 2.0.0 1326 * 1327 * @global WP $wp Current WordPress environment instance. 1328 * @global WP_Query $wp_query WordPress Query object. 1329 * @global WP_Query $wp_the_query Copy of the WordPress Query object. 1330 * 1331 * @param string|array $query_vars Default WP_Query arguments. 1332 */ 1333 function wp( $query_vars = '' ) { 1334 global $wp, $wp_query, $wp_the_query; 1335 1336 $wp->main( $query_vars ); 1337 1338 if ( ! isset( $wp_the_query ) ) { 1339 $wp_the_query = $wp_query; 1340 } 1341 } 1342 1343 /** 1344 * Retrieves the description for the HTTP status. 1345 * 1346 * @since 2.3.0 1347 * @since 3.9.0 Added status codes 418, 428, 429, 431, and 511. 1348 * @since 4.5.0 Added status codes 308, 421, and 451. 1349 * @since 5.1.0 Added status code 103. 1350 * @since 6.6.0 Added status code 425. 1351 * 1352 * @global array $wp_header_to_desc 1353 * 1354 * @param int $code HTTP status code. 1355 * @return string Status description if found, an empty string otherwise. 1356 */ 1357 function get_status_header_desc( $code ) { 1358 global $wp_header_to_desc; 1359 1360 $code = absint( $code ); 1361 1362 if ( ! isset( $wp_header_to_desc ) ) { 1363 $wp_header_to_desc = array( 1364 100 => 'Continue', 1365 101 => 'Switching Protocols', 1366 102 => 'Processing', 1367 103 => 'Early Hints', 1368 1369 200 => 'OK', 1370 201 => 'Created', 1371 202 => 'Accepted', 1372 203 => 'Non-Authoritative Information', 1373 204 => 'No Content', 1374 205 => 'Reset Content', 1375 206 => 'Partial Content', 1376 207 => 'Multi-Status', 1377 226 => 'IM Used', 1378 1379 300 => 'Multiple Choices', 1380 301 => 'Moved Permanently', 1381 302 => 'Found', 1382 303 => 'See Other', 1383 304 => 'Not Modified', 1384 305 => 'Use Proxy', 1385 306 => 'Reserved', 1386 307 => 'Temporary Redirect', 1387 308 => 'Permanent Redirect', 1388 1389 400 => 'Bad Request', 1390 401 => 'Unauthorized', 1391 402 => 'Payment Required', 1392 403 => 'Forbidden', 1393 404 => 'Not Found', 1394 405 => 'Method Not Allowed', 1395 406 => 'Not Acceptable', 1396 407 => 'Proxy Authentication Required', 1397 408 => 'Request Timeout', 1398 409 => 'Conflict', 1399 410 => 'Gone', 1400 411 => 'Length Required', 1401 412 => 'Precondition Failed', 1402 413 => 'Request Entity Too Large', 1403 414 => 'Request-URI Too Long', 1404 415 => 'Unsupported Media Type', 1405 416 => 'Requested Range Not Satisfiable', 1406 417 => 'Expectation Failed', 1407 418 => 'I\'m a teapot', 1408 421 => 'Misdirected Request', 1409 422 => 'Unprocessable Entity', 1410 423 => 'Locked', 1411 424 => 'Failed Dependency', 1412 425 => 'Too Early', 1413 426 => 'Upgrade Required', 1414 428 => 'Precondition Required', 1415 429 => 'Too Many Requests', 1416 431 => 'Request Header Fields Too Large', 1417 451 => 'Unavailable For Legal Reasons', 1418 1419 500 => 'Internal Server Error', 1420 501 => 'Not Implemented', 1421 502 => 'Bad Gateway', 1422 503 => 'Service Unavailable', 1423 504 => 'Gateway Timeout', 1424 505 => 'HTTP Version Not Supported', 1425 506 => 'Variant Also Negotiates', 1426 507 => 'Insufficient Storage', 1427 510 => 'Not Extended', 1428 511 => 'Network Authentication Required', 1429 ); 1430 } 1431 1432 if ( isset( $wp_header_to_desc[ $code ] ) ) { 1433 return $wp_header_to_desc[ $code ]; 1434 } else { 1435 return ''; 1436 } 1437 } 1438 1439 /** 1440 * Sets HTTP status header. 1441 * 1442 * @since 2.0.0 1443 * @since 4.4.0 Added the `$description` parameter. 1444 * 1445 * @see get_status_header_desc() 1446 * 1447 * @param int $code HTTP status code. 1448 * @param string $description Optional. A custom description for the HTTP status. 1449 * Defaults to the result of get_status_header_desc() for the given code. 1450 */ 1451 function status_header( $code, $description = '' ) { 1452 if ( ! $description ) { 1453 $description = get_status_header_desc( $code ); 1454 } 1455 1456 if ( empty( $description ) ) { 1457 return; 1458 } 1459 1460 $protocol = wp_get_server_protocol(); 1461 $status_header = "$protocol $code $description"; 1462 if ( function_exists( 'apply_filters' ) ) { 1463 1464 /** 1465 * Filters an HTTP status header. 1466 * 1467 * @since 2.2.0 1468 * 1469 * @param string $status_header HTTP status header. 1470 * @param int $code HTTP status code. 1471 * @param string $description Description for the status code. 1472 * @param string $protocol Server protocol. 1473 */ 1474 $status_header = apply_filters( 'status_header', $status_header, $code, $description, $protocol ); 1475 } 1476 1477 if ( ! headers_sent() ) { 1478 header( $status_header, true, $code ); 1479 } 1480 } 1481 1482 /** 1483 * Gets the HTTP header information to prevent caching. 1484 * 1485 * The several different headers cover the different ways cache prevention 1486 * is handled by different browsers. 1487 * 1488 * @since 2.8.0 1489 * @since 6.3.0 The `Cache-Control` header for logged in users now includes the 1490 * `no-store` and `private` directives. 1491 * 1492 * @return array The associative array of header names and field values. 1493 */ 1494 function wp_get_nocache_headers() { 1495 $cache_control = ( function_exists( 'is_user_logged_in' ) && is_user_logged_in() ) 1496 ? 'no-cache, must-revalidate, max-age=0, no-store, private' 1497 : 'no-cache, must-revalidate, max-age=0'; 1498 1499 $headers = array( 1500 'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT', 1501 'Cache-Control' => $cache_control, 1502 ); 1503 1504 if ( function_exists( 'apply_filters' ) ) { 1505 /** 1506 * Filters the cache-controlling HTTP headers that are used to prevent caching. 1507 * 1508 * @since 2.8.0 1509 * 1510 * @see wp_get_nocache_headers() 1511 * 1512 * @param array $headers Header names and field values. 1513 */ 1514 $headers = (array) apply_filters( 'nocache_headers', $headers ); 1515 } 1516 $headers['Last-Modified'] = false; 1517 return $headers; 1518 } 1519 1520 /** 1521 * Sets the HTTP headers to prevent caching for the different browsers. 1522 * 1523 * Different browsers support different nocache headers, so several 1524 * headers must be sent so that all of them get the point that no 1525 * caching should occur. 1526 * 1527 * @since 2.0.0 1528 * 1529 * @see wp_get_nocache_headers() 1530 */ 1531 function nocache_headers() { 1532 if ( headers_sent() ) { 1533 return; 1534 } 1535 1536 $headers = wp_get_nocache_headers(); 1537 1538 unset( $headers['Last-Modified'] ); 1539 1540 header_remove( 'Last-Modified' ); 1541 1542 foreach ( $headers as $name => $field_value ) { 1543 header( "{$name}: {$field_value}" ); 1544 } 1545 } 1546 1547 /** 1548 * Sets the HTTP headers for caching for 10 days with JavaScript content type. 1549 * 1550 * @since 2.1.0 1551 */ 1552 function cache_javascript_headers() { 1553 $expires_offset = 10 * DAY_IN_SECONDS; 1554 1555 header( 'Content-Type: text/javascript; charset=' . get_bloginfo( 'charset' ) ); 1556 header( 'Vary: Accept-Encoding' ); // Handle proxies. 1557 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', time() + $expires_offset ) . ' GMT' ); 1558 } 1559 1560 /** 1561 * Retrieves the number of database queries during the WordPress execution. 1562 * 1563 * @since 2.0.0 1564 * 1565 * @global wpdb $wpdb WordPress database abstraction object. 1566 * 1567 * @return int Number of database queries. 1568 */ 1569 function get_num_queries() { 1570 global $wpdb; 1571 return $wpdb->num_queries; 1572 } 1573 1574 /** 1575 * Determines whether input is yes or no. 1576 * 1577 * Must be 'y' to be true. 1578 * 1579 * @since 1.0.0 1580 * 1581 * @param string $yn Character string containing either 'y' (yes) or 'n' (no). 1582 * @return bool True if 'y', false on anything else. 1583 */ 1584 function bool_from_yn( $yn ) { 1585 return ( 'y' === strtolower( $yn ) ); 1586 } 1587 1588 /** 1589 * Loads the feed template from the use of an action hook. 1590 * 1591 * If the feed action does not have a hook, then the function will die with a 1592 * message telling the visitor that the feed is not valid. 1593 * 1594 * It is better to only have one hook for each feed. 1595 * 1596 * @since 2.1.0 1597 * 1598 * @global WP_Query $wp_query WordPress Query object. 1599 */ 1600 function do_feed() { 1601 global $wp_query; 1602 1603 $feed = get_query_var( 'feed' ); 1604 1605 // Remove the pad, if present. 1606 $feed = preg_replace( '/^_+/', '', $feed ); 1607 1608 if ( '' === $feed || 'feed' === $feed ) { 1609 $feed = get_default_feed(); 1610 } 1611 1612 if ( ! has_action( "do_feed_{$feed}" ) ) { 1613 wp_die( __( '<strong>Error:</strong> This is not a valid feed template.' ), '', array( 'response' => 404 ) ); 1614 } 1615 1616 /** 1617 * Fires once the given feed is loaded. 1618 * 1619 * The dynamic portion of the hook name, `$feed`, refers to the feed template name. 1620 * 1621 * Possible hook names include: 1622 * 1623 * - `do_feed_atom` 1624 * - `do_feed_rdf` 1625 * - `do_feed_rss` 1626 * - `do_feed_rss2` 1627 * 1628 * @since 2.1.0 1629 * @since 4.4.0 The `$feed` parameter was added. 1630 * 1631 * @param bool $is_comment_feed Whether the feed is a comment feed. 1632 * @param string $feed The feed name. 1633 */ 1634 do_action( "do_feed_{$feed}", $wp_query->is_comment_feed, $feed ); 1635 } 1636 1637 /** 1638 * Loads the RDF RSS 0.91 Feed template. 1639 * 1640 * @since 2.1.0 1641 * 1642 * @see load_template() 1643 */ 1644 function do_feed_rdf() { 1645 load_template( ABSPATH . WPINC . '/feed-rdf.php' ); 1646 } 1647 1648 /** 1649 * Loads the RSS 1.0 Feed Template. 1650 * 1651 * @since 2.1.0 1652 * 1653 * @see load_template() 1654 */ 1655 function do_feed_rss() { 1656 load_template( ABSPATH . WPINC . '/feed-rss.php' ); 1657 } 1658 1659 /** 1660 * Loads either the RSS2 comment feed or the RSS2 posts feed. 1661 * 1662 * @since 2.1.0 1663 * 1664 * @see load_template() 1665 * 1666 * @param bool $for_comments True for the comment feed, false for normal feed. 1667 */ 1668 function do_feed_rss2( $for_comments ) { 1669 if ( $for_comments ) { 1670 load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' ); 1671 } else { 1672 load_template( ABSPATH . WPINC . '/feed-rss2.php' ); 1673 } 1674 } 1675 1676 /** 1677 * Loads either Atom comment feed or Atom posts feed. 1678 * 1679 * @since 2.1.0 1680 * 1681 * @see load_template() 1682 * 1683 * @param bool $for_comments True for the comment feed, false for normal feed. 1684 */ 1685 function do_feed_atom( $for_comments ) { 1686 if ( $for_comments ) { 1687 load_template( ABSPATH . WPINC . '/feed-atom-comments.php' ); 1688 } else { 1689 load_template( ABSPATH . WPINC . '/feed-atom.php' ); 1690 } 1691 } 1692 1693 /** 1694 * Displays the default robots.txt file content. 1695 * 1696 * @since 2.1.0 1697 * @since 5.3.0 Remove the "Disallow: /" output if search engine visibility is 1698 * discouraged in favor of robots meta HTML tag via wp_robots_no_robots() 1699 * filter callback. 1700 */ 1701 function do_robots() { 1702 header( 'Content-Type: text/plain; charset=utf-8' ); 1703 1704 /** 1705 * Fires when displaying the robots.txt file. 1706 * 1707 * @since 2.1.0 1708 */ 1709 do_action( 'do_robotstxt' ); 1710 1711 $output = "User-agent: *\n"; 1712 $public = get_option( 'blog_public' ); 1713 1714 $site_url = parse_url( site_url() ); 1715 $path = ( ! empty( $site_url['path'] ) ) ? $site_url['path'] : ''; 1716 $output .= "Disallow: $path/wp-admin/\n"; 1717 $output .= "Allow: $path/wp-admin/admin-ajax.php\n"; 1718 1719 /** 1720 * Filters the robots.txt output. 1721 * 1722 * @since 3.0.0 1723 * 1724 * @param string $output The robots.txt output. 1725 * @param bool $public Whether the site is considered "public". 1726 */ 1727 echo apply_filters( 'robots_txt', $output, $public ); 1728 } 1729 1730 /** 1731 * Displays the favicon.ico file content. 1732 * 1733 * @since 5.4.0 1734 */ 1735 function do_favicon() { 1736 /** 1737 * Fires when serving the favicon.ico file. 1738 * 1739 * @since 5.4.0 1740 */ 1741 do_action( 'do_faviconico' ); 1742 1743 wp_redirect( get_site_icon_url( 32, includes_url( 'images/w-logo-blue-white-bg.png' ) ) ); 1744 exit; 1745 } 1746 1747 /** 1748 * Determines whether WordPress is already installed. 1749 * 1750 * The cache will be checked first. If you have a cache plugin, which saves 1751 * the cache values, then this will work. If you use the default WordPress 1752 * cache, and the database goes away, then you might have problems. 1753 * 1754 * Checks for the 'siteurl' option for whether WordPress is installed. 1755 * 1756 * For more information on this and similar theme functions, check out 1757 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1758 * Conditional Tags} article in the Theme Developer Handbook. 1759 * 1760 * @since 2.1.0 1761 * 1762 * @global wpdb $wpdb WordPress database abstraction object. 1763 * 1764 * @return bool Whether the site is already installed. 1765 */ 1766 function is_blog_installed() { 1767 global $wpdb; 1768 1769 /* 1770 * Check cache first. If options table goes away and we have true 1771 * cached, oh well. 1772 */ 1773 if ( wp_cache_get( 'is_blog_installed' ) ) { 1774 return true; 1775 } 1776 1777 $suppress = $wpdb->suppress_errors(); 1778 1779 if ( ! wp_installing() ) { 1780 $alloptions = wp_load_alloptions(); 1781 } 1782 1783 // If siteurl is not set to autoload, check it specifically. 1784 if ( ! isset( $alloptions['siteurl'] ) ) { 1785 $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" ); 1786 } else { 1787 $installed = $alloptions['siteurl']; 1788 } 1789 1790 $wpdb->suppress_errors( $suppress ); 1791 1792 $installed = ! empty( $installed ); 1793 wp_cache_set( 'is_blog_installed', $installed ); 1794 1795 if ( $installed ) { 1796 return true; 1797 } 1798 1799 // If visiting repair.php, return true and let it take over. 1800 if ( defined( 'WP_REPAIRING' ) ) { 1801 return true; 1802 } 1803 1804 $suppress = $wpdb->suppress_errors(); 1805 1806 /* 1807 * Loop over the WP tables. If none exist, then scratch installation is allowed. 1808 * If one or more exist, suggest table repair since we got here because the 1809 * options table could not be accessed. 1810 */ 1811 $wp_tables = $wpdb->tables(); 1812 foreach ( $wp_tables as $table ) { 1813 // The existence of custom user tables shouldn't suggest an unwise state or prevent a clean installation. 1814 if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE === $table ) { 1815 continue; 1816 } 1817 1818 if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE === $table ) { 1819 continue; 1820 } 1821 1822 $described_table = $wpdb->get_results( "DESCRIBE $table;" ); 1823 if ( 1824 ( ! $described_table && empty( $wpdb->last_error ) ) || 1825 ( is_array( $described_table ) && 0 === count( $described_table ) ) 1826 ) { 1827 continue; 1828 } 1829 1830 // One or more tables exist. This is not good. 1831 1832 wp_load_translations_early(); 1833 1834 // Die with a DB error. 1835 $wpdb->error = sprintf( 1836 /* translators: %s: Database repair URL. */ 1837 __( 'One or more database tables are unavailable. The database may need to be <a href="%s">repaired</a>.' ), 1838 'maint/repair.php?referrer=is_blog_installed' 1839 ); 1840 1841 dead_db(); 1842 } 1843 1844 $wpdb->suppress_errors( $suppress ); 1845 1846 wp_cache_set( 'is_blog_installed', false ); 1847 1848 return false; 1849 } 1850 1851 /** 1852 * Retrieves URL with nonce added to URL query. 1853 * 1854 * @since 2.0.4 1855 * 1856 * @param string $actionurl URL to add nonce action. 1857 * @param int|string $action Optional. Nonce action name. Default -1. 1858 * @param string $name Optional. Nonce name. Default '_wpnonce'. 1859 * @return string Escaped URL with nonce action added. 1860 */ 1861 function wp_nonce_url( $actionurl, $action = -1, $name = '_wpnonce' ) { 1862 $actionurl = str_replace( '&', '&', $actionurl ); 1863 return esc_html( add_query_arg( $name, wp_create_nonce( $action ), $actionurl ) ); 1864 } 1865 1866 /** 1867 * Retrieves or display nonce hidden field for forms. 1868 * 1869 * The nonce field is used to validate that the contents of the form came from 1870 * the location on the current site and not somewhere else. The nonce does not 1871 * offer absolute protection, but should protect against most cases. It is very 1872 * important to use nonce field in forms. 1873 * 1874 * The $action and $name are optional, but if you want to have better security, 1875 * it is strongly suggested to set those two parameters. It is easier to just 1876 * call the function without any parameters, because validation of the nonce 1877 * doesn't require any parameters, but since crackers know what the default is 1878 * it won't be difficult for them to find a way around your nonce and cause 1879 * damage. 1880 * 1881 * The input name will be whatever $name value you gave. The input value will be 1882 * the nonce creation value. 1883 * 1884 * @since 2.0.4 1885 * 1886 * @param int|string $action Optional. Action name. Default -1. 1887 * @param string $name Optional. Nonce name. Default '_wpnonce'. 1888 * @param bool $referer Optional. Whether to set the referer field for validation. Default true. 1889 * @param bool $display Optional. Whether to display or return hidden form field. Default true. 1890 * @return string Nonce field HTML markup. 1891 */ 1892 function wp_nonce_field( $action = -1, $name = '_wpnonce', $referer = true, $display = true ) { 1893 $name = esc_attr( $name ); 1894 $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />'; 1895 1896 if ( $referer ) { 1897 $nonce_field .= wp_referer_field( false ); 1898 } 1899 1900 if ( $display ) { 1901 echo $nonce_field; 1902 } 1903 1904 return $nonce_field; 1905 } 1906 1907 /** 1908 * Retrieves or displays referer hidden field for forms. 1909 * 1910 * The referer link is the current Request URI from the server super global. The 1911 * input name is '_wp_http_referer', in case you wanted to check manually. 1912 * 1913 * @since 2.0.4 1914 * 1915 * @param bool $display Optional. Whether to echo or return the referer field. Default true. 1916 * @return string Referer field HTML markup. 1917 */ 1918 function wp_referer_field( $display = true ) { 1919 $request_url = remove_query_arg( '_wp_http_referer' ); 1920 $referer_field = '<input type="hidden" name="_wp_http_referer" value="' . esc_url( $request_url ) . '" />'; 1921 1922 if ( $display ) { 1923 echo $referer_field; 1924 } 1925 1926 return $referer_field; 1927 } 1928 1929 /** 1930 * Retrieves or displays original referer hidden field for forms. 1931 * 1932 * The input name is '_wp_original_http_referer' and will be either the same 1933 * value of wp_referer_field(), if that was posted already or it will be the 1934 * current page, if it doesn't exist. 1935 * 1936 * @since 2.0.4 1937 * 1938 * @param bool $display Optional. Whether to echo the original http referer. Default true. 1939 * @param string $jump_back_to Optional. Can be 'previous' or page you want to jump back to. 1940 * Default 'current'. 1941 * @return string Original referer field. 1942 */ 1943 function wp_original_referer_field( $display = true, $jump_back_to = 'current' ) { 1944 $ref = wp_get_original_referer(); 1945 1946 if ( ! $ref ) { 1947 $ref = ( 'previous' === $jump_back_to ) ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] ); 1948 } 1949 1950 $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( $ref ) . '" />'; 1951 1952 if ( $display ) { 1953 echo $orig_referer_field; 1954 } 1955 1956 return $orig_referer_field; 1957 } 1958 1959 /** 1960 * Retrieves referer from '_wp_http_referer' or HTTP referer. 1961 * 1962 * If it's the same as the current request URL, will return false. 1963 * 1964 * @since 2.0.4 1965 * 1966 * @return string|false Referer URL on success, false on failure. 1967 */ 1968 function wp_get_referer() { 1969 // Return early if called before wp_validate_redirect() is defined. 1970 if ( ! function_exists( 'wp_validate_redirect' ) ) { 1971 return false; 1972 } 1973 1974 $ref = wp_get_raw_referer(); 1975 1976 if ( $ref && wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref 1977 && home_url() . wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref 1978 ) { 1979 return wp_validate_redirect( $ref, false ); 1980 } 1981 1982 return false; 1983 } 1984 1985 /** 1986 * Retrieves unvalidated referer from the '_wp_http_referer' URL query variable or the HTTP referer. 1987 * 1988 * If the value of the '_wp_http_referer' URL query variable is not a string then it will be ignored. 1989 * 1990 * Do not use for redirects, use wp_get_referer() instead. 1991 * 1992 * @since 4.5.0 1993 * 1994 * @return string|false Referer URL on success, false on failure. 1995 */ 1996 function wp_get_raw_referer() { 1997 if ( ! empty( $_REQUEST['_wp_http_referer'] ) && is_string( $_REQUEST['_wp_http_referer'] ) ) { 1998 return wp_unslash( $_REQUEST['_wp_http_referer'] ); 1999 } elseif ( ! empty( $_SERVER['HTTP_REFERER'] ) ) { 2000 return wp_unslash( $_SERVER['HTTP_REFERER'] ); 2001 } 2002 2003 return false; 2004 } 2005 2006 /** 2007 * Retrieves original referer that was posted, if it exists. 2008 * 2009 * @since 2.0.4 2010 * 2011 * @return string|false Original referer URL on success, false on failure. 2012 */ 2013 function wp_get_original_referer() { 2014 // Return early if called before wp_validate_redirect() is defined. 2015 if ( ! function_exists( 'wp_validate_redirect' ) ) { 2016 return false; 2017 } 2018 2019 if ( ! empty( $_REQUEST['_wp_original_http_referer'] ) ) { 2020 return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false ); 2021 } 2022 2023 return false; 2024 } 2025 2026 /** 2027 * Recursive directory creation based on full path. 2028 * 2029 * Will attempt to set permissions on folders. 2030 * 2031 * @since 2.0.1 2032 * 2033 * @param string $target Full path to attempt to create. 2034 * @return bool Whether the path was created. True if path already exists. 2035 */ 2036 function wp_mkdir_p( $target ) { 2037 $wrapper = null; 2038 2039 // Strip the protocol. 2040 if ( wp_is_stream( $target ) ) { 2041 list( $wrapper, $target ) = explode( '://', $target, 2 ); 2042 } 2043 2044 // From php.net/mkdir user contributed notes. 2045 $target = str_replace( '//', '/', $target ); 2046 2047 // Put the wrapper back on the target. 2048 if ( null !== $wrapper ) { 2049 $target = $wrapper . '://' . $target; 2050 } 2051 2052 /* 2053 * Safe mode fails with a trailing slash under certain PHP versions. 2054 * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency. 2055 */ 2056 $target = rtrim( $target, '/' ); 2057 if ( empty( $target ) ) { 2058 $target = '/'; 2059 } 2060 2061 if ( file_exists( $target ) ) { 2062 return @is_dir( $target ); 2063 } 2064 2065 // Do not allow path traversals. 2066 if ( str_contains( $target, '../' ) || str_contains( $target, '..' . DIRECTORY_SEPARATOR ) ) { 2067 return false; 2068 } 2069 2070 // We need to find the permissions of the parent folder that exists and inherit that. 2071 $target_parent = dirname( $target ); 2072 while ( '.' !== $target_parent && ! is_dir( $target_parent ) && dirname( $target_parent ) !== $target_parent ) { 2073 $target_parent = dirname( $target_parent ); 2074 } 2075 2076 // Get the permission bits. 2077 $stat = @stat( $target_parent ); 2078 if ( $stat ) { 2079 $dir_perms = $stat['mode'] & 0007777; 2080 } else { 2081 $dir_perms = 0777; 2082 } 2083 2084 if ( @mkdir( $target, $dir_perms, true ) ) { 2085 2086 /* 2087 * If a umask is set that modifies $dir_perms, we'll have to re-set 2088 * the $dir_perms correctly with chmod() 2089 */ 2090 if ( ( $dir_perms & ~umask() ) !== $dir_perms ) { 2091 $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) ); 2092 for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) { 2093 chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms ); 2094 } 2095 } 2096 2097 return true; 2098 } 2099 2100 return false; 2101 } 2102 2103 /** 2104 * Tests if a given filesystem path is absolute. 2105 * 2106 * For example, '/foo/bar', or 'c:\windows'. 2107 * 2108 * @since 2.5.0 2109 * 2110 * @param string $path File path. 2111 * @return bool True if path is absolute, false is not absolute. 2112 */ 2113 function path_is_absolute( $path ) { 2114 /* 2115 * Check to see if the path is a stream and check to see if its an actual 2116 * path or file as realpath() does not support stream wrappers. 2117 */ 2118 if ( wp_is_stream( $path ) && ( is_dir( $path ) || is_file( $path ) ) ) { 2119 return true; 2120 } 2121 2122 /* 2123 * This is definitive if true but fails if $path does not exist or contains 2124 * a symbolic link. 2125 */ 2126 if ( realpath( $path ) === $path ) { 2127 return true; 2128 } 2129 2130 if ( strlen( $path ) === 0 || '.' === $path[0] ) { 2131 return false; 2132 } 2133 2134 // Windows allows absolute paths like this. 2135 if ( preg_match( '#^[a-zA-Z]:\\\\#', $path ) ) { 2136 return true; 2137 } 2138 2139 // A path starting with / or \ is absolute; anything else is relative. 2140 return ( '/' === $path[0] || '\\' === $path[0] ); 2141 } 2142 2143 /** 2144 * Joins two filesystem paths together. 2145 * 2146 * For example, 'give me $path relative to $base'. If the $path is absolute, 2147 * then it the full path is returned. 2148 * 2149 * @since 2.5.0 2150 * 2151 * @param string $base Base path. 2152 * @param string $path Path relative to $base. 2153 * @return string The path with the base or absolute path. 2154 */ 2155 function path_join( $base, $path ) { 2156 if ( path_is_absolute( $path ) ) { 2157 return $path; 2158 } 2159 2160 return rtrim( $base, '/' ) . '/' . $path; 2161 } 2162 2163 /** 2164 * Normalizes a filesystem path. 2165 * 2166 * On windows systems, replaces backslashes with forward slashes 2167 * and forces upper-case drive letters. 2168 * Allows for two leading slashes for Windows network shares, but 2169 * ensures that all other duplicate slashes are reduced to a single. 2170 * 2171 * @since 3.9.0 2172 * @since 4.4.0 Ensures upper-case drive letters on Windows systems. 2173 * @since 4.5.0 Allows for Windows network shares. 2174 * @since 4.9.7 Allows for PHP file wrappers. 2175 * 2176 * @param string $path Path to normalize. 2177 * @return string Normalized path. 2178 */ 2179 function wp_normalize_path( $path ) { 2180 $wrapper = ''; 2181 2182 if ( wp_is_stream( $path ) ) { 2183 list( $wrapper, $path ) = explode( '://', $path, 2 ); 2184 2185 $wrapper .= '://'; 2186 } 2187 2188 // Standardize all paths to use '/'. 2189 $path = str_replace( '\\', '/', $path ); 2190 2191 // Replace multiple slashes down to a singular, allowing for network shares having two slashes. 2192 $path = preg_replace( '|(?<=.)/+|', '/', $path ); 2193 2194 // Windows paths should uppercase the drive letter. 2195 if ( ':' === substr( $path, 1, 1 ) ) { 2196 $path = ucfirst( $path ); 2197 } 2198 2199 return $wrapper . $path; 2200 } 2201 2202 /** 2203 * Determines a writable directory for temporary files. 2204 * 2205 * Function's preference is the return value of sys_get_temp_dir(), 2206 * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR, 2207 * before finally defaulting to /tmp/ 2208 * 2209 * In the event that this function does not find a writable location, 2210 * It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file. 2211 * 2212 * @since 2.5.0 2213 * 2214 * @return string Writable temporary directory. 2215 */ 2216 function get_temp_dir() { 2217 static $temp = ''; 2218 if ( defined( 'WP_TEMP_DIR' ) ) { 2219 return trailingslashit( WP_TEMP_DIR ); 2220 } 2221 2222 if ( $temp ) { 2223 return trailingslashit( $temp ); 2224 } 2225 2226 if ( function_exists( 'sys_get_temp_dir' ) ) { 2227 $temp = sys_get_temp_dir(); 2228 if ( @is_dir( $temp ) && wp_is_writable( $temp ) ) { 2229 return trailingslashit( $temp ); 2230 } 2231 } 2232 2233 $temp = ini_get( 'upload_tmp_dir' ); 2234 if ( @is_dir( $temp ) && wp_is_writable( $temp ) ) { 2235 return trailingslashit( $temp ); 2236 } 2237 2238 $temp = WP_CONTENT_DIR . '/'; 2239 if ( is_dir( $temp ) && wp_is_writable( $temp ) ) { 2240 return $temp; 2241 } 2242 2243 return '/tmp/'; 2244 } 2245 2246 /** 2247 * Determines if a directory is writable. 2248 * 2249 * This function is used to work around certain ACL issues in PHP primarily 2250 * affecting Windows Servers. 2251 * 2252 * @since 3.6.0 2253 * 2254 * @see win_is_writable() 2255 * 2256 * @param string $path Path to check for write-ability. 2257 * @return bool Whether the path is writable. 2258 */ 2259 function wp_is_writable( $path ) { 2260 if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) { 2261 return win_is_writable( $path ); 2262 } else { 2263 return @is_writable( $path ); 2264 } 2265 } 2266 2267 /** 2268 * Workaround for Windows bug in is_writable() function 2269 * 2270 * PHP has issues with Windows ACL's for determine if a 2271 * directory is writable or not, this works around them by 2272 * checking the ability to open files rather than relying 2273 * upon PHP to interpret the OS ACL. 2274 * 2275 * @since 2.8.0 2276 * 2277 * @see https://bugs.php.net/bug.php?id=27609 2278 * @see https://bugs.php.net/bug.php?id=30931 2279 * 2280 * @param string $path Windows path to check for write-ability. 2281 * @return bool Whether the path is writable. 2282 */ 2283 function win_is_writable( $path ) { 2284 if ( '/' === $path[ strlen( $path ) - 1 ] ) { 2285 // If it looks like a directory, check a random file within the directory. 2286 return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp' ); 2287 } elseif ( is_dir( $path ) ) { 2288 // If it's a directory (and not a file), check a random file within the directory. 2289 return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' ); 2290 } 2291 2292 // Check tmp file for read/write capabilities. 2293 $should_delete_tmp_file = ! file_exists( $path ); 2294 2295 $f = @fopen( $path, 'a' ); 2296 if ( false === $f ) { 2297 return false; 2298 } 2299 fclose( $f ); 2300 2301 if ( $should_delete_tmp_file ) { 2302 unlink( $path ); 2303 } 2304 2305 return true; 2306 } 2307 2308 /** 2309 * Retrieves uploads directory information. 2310 * 2311 * Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory. 2312 * Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases 2313 * when not uploading files. 2314 * 2315 * @since 4.5.0 2316 * 2317 * @see wp_upload_dir() 2318 * 2319 * @return array See wp_upload_dir() for description. 2320 */ 2321 function wp_get_upload_dir() { 2322 return wp_upload_dir( null, false ); 2323 } 2324 2325 /** 2326 * Returns an array containing the current upload directory's path and URL. 2327 * 2328 * Checks the 'upload_path' option, which should be from the web root folder, 2329 * and if it isn't empty it will be used. If it is empty, then the path will be 2330 * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will 2331 * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path. 2332 * 2333 * The upload URL path is set either by the 'upload_url_path' option or by using 2334 * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path. 2335 * 2336 * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in 2337 * the administration settings panel), then the time will be used. The format 2338 * will be year first and then month. 2339 * 2340 * If the path couldn't be created, then an error will be returned with the key 2341 * 'error' containing the error message. The error suggests that the parent 2342 * directory is not writable by the server. 2343 * 2344 * @since 2.0.0 2345 * @uses _wp_upload_dir() 2346 * 2347 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. 2348 * @param bool $create_dir Optional. Whether to check and create the uploads directory. 2349 * Default true for backward compatibility. 2350 * @param bool $refresh_cache Optional. Whether to refresh the cache. Default false. 2351 * @return array { 2352 * Array of information about the upload directory. 2353 * 2354 * @type string $path Base directory and subdirectory or full path to upload directory. 2355 * @type string $url Base URL and subdirectory or absolute URL to upload directory. 2356 * @type string $subdir Subdirectory if uploads use year/month folders option is on. 2357 * @type string $basedir Path without subdir. 2358 * @type string $baseurl URL path without subdir. 2359 * @type string|false $error False or error message. 2360 * } 2361 */ 2362 function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) { 2363 static $cache = array(), $tested_paths = array(); 2364 2365 $key = sprintf( '%d-%s', get_current_blog_id(), (string) $time ); 2366 2367 if ( $refresh_cache || empty( $cache[ $key ] ) ) { 2368 $cache[ $key ] = _wp_upload_dir( $time ); 2369 } 2370 2371 /** 2372 * Filters the uploads directory data. 2373 * 2374 * @since 2.0.0 2375 * 2376 * @param array $uploads { 2377 * Array of information about the upload directory. 2378 * 2379 * @type string $path Base directory and subdirectory or full path to upload directory. 2380 * @type string $url Base URL and subdirectory or absolute URL to upload directory. 2381 * @type string $subdir Subdirectory if uploads use year/month folders option is on. 2382 * @type string $basedir Path without subdir. 2383 * @type string $baseurl URL path without subdir. 2384 * @type string|false $error False or error message. 2385 * } 2386 */ 2387 $uploads = apply_filters( 'upload_dir', $cache[ $key ] ); 2388 2389 if ( $create_dir ) { 2390 $path = $uploads['path']; 2391 2392 if ( array_key_exists( $path, $tested_paths ) ) { 2393 $uploads['error'] = $tested_paths[ $path ]; 2394 } else { 2395 if ( ! wp_mkdir_p( $path ) ) { 2396 if ( str_starts_with( $uploads['basedir'], ABSPATH ) ) { 2397 $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir']; 2398 } else { 2399 $error_path = wp_basename( $uploads['basedir'] ) . $uploads['subdir']; 2400 } 2401 2402 $uploads['error'] = sprintf( 2403 /* translators: %s: Directory path. */ 2404 __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), 2405 esc_html( $error_path ) 2406 ); 2407 } 2408 2409 $tested_paths[ $path ] = $uploads['error']; 2410 } 2411 } 2412 2413 return $uploads; 2414 } 2415 2416 /** 2417 * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path. 2418 * 2419 * @since 4.5.0 2420 * @access private 2421 * 2422 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. 2423 * @return array See wp_upload_dir() 2424 */ 2425 function _wp_upload_dir( $time = null ) { 2426 $siteurl = get_option( 'siteurl' ); 2427 $upload_path = trim( get_option( 'upload_path' ) ); 2428 2429 if ( empty( $upload_path ) || 'wp-content/uploads' === $upload_path ) { 2430 $dir = WP_CONTENT_DIR . '/uploads'; 2431 } elseif ( ! str_starts_with( $upload_path, ABSPATH ) ) { 2432 // $dir is absolute, $upload_path is (maybe) relative to ABSPATH. 2433 $dir = path_join( ABSPATH, $upload_path ); 2434 } else { 2435 $dir = $upload_path; 2436 } 2437 2438 $url = get_option( 'upload_url_path' ); 2439 if ( ! $url ) { 2440 if ( empty( $upload_path ) || ( 'wp-content/uploads' === $upload_path ) || ( $upload_path === $dir ) ) { 2441 $url = WP_CONTENT_URL . '/uploads'; 2442 } else { 2443 $url = trailingslashit( $siteurl ) . $upload_path; 2444 } 2445 } 2446 2447 /* 2448 * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled. 2449 * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block. 2450 */ 2451 if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) { 2452 $dir = ABSPATH . UPLOADS; 2453 $url = trailingslashit( $siteurl ) . UPLOADS; 2454 } 2455 2456 // If multisite (and if not the main site in a post-MU network). 2457 if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) { 2458 2459 if ( ! get_site_option( 'ms_files_rewriting' ) ) { 2460 /* 2461 * If ms-files rewriting is disabled (networks created post-3.5), it is fairly 2462 * straightforward: Append sites/%d if we're not on the main site (for post-MU 2463 * networks). (The extra directory prevents a four-digit ID from conflicting with 2464 * a year-based directory for the main site. But if a MU-era network has disabled 2465 * ms-files rewriting manually, they don't need the extra directory, as they never 2466 * had wp-content/uploads for the main site.) 2467 */ 2468 2469 if ( defined( 'MULTISITE' ) ) { 2470 $ms_dir = '/sites/' . get_current_blog_id(); 2471 } else { 2472 $ms_dir = '/' . get_current_blog_id(); 2473 } 2474 2475 $dir .= $ms_dir; 2476 $url .= $ms_dir; 2477 2478 } elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) { 2479 /* 2480 * Handle the old-form ms-files.php rewriting if the network still has that enabled. 2481 * When ms-files rewriting is enabled, then we only listen to UPLOADS when: 2482 * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used 2483 * there, and 2484 * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect 2485 * the original blog ID. 2486 * 2487 * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute. 2488 * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as 2489 * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files 2490 * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.) 2491 */ 2492 2493 if ( defined( 'BLOGUPLOADDIR' ) ) { 2494 $dir = untrailingslashit( BLOGUPLOADDIR ); 2495 } else { 2496 $dir = ABSPATH . UPLOADS; 2497 } 2498 $url = trailingslashit( $siteurl ) . 'files'; 2499 } 2500 } 2501 2502 $basedir = $dir; 2503 $baseurl = $url; 2504 2505 $subdir = ''; 2506 if ( get_option( 'uploads_use_yearmonth_folders' ) ) { 2507 // Generate the yearly and monthly directories. 2508 if ( ! $time ) { 2509 $time = current_time( 'mysql' ); 2510 } 2511 $y = substr( $time, 0, 4 ); 2512 $m = substr( $time, 5, 2 ); 2513 $subdir = "/$y/$m"; 2514 } 2515 2516 $dir .= $subdir; 2517 $url .= $subdir; 2518 2519 return array( 2520 'path' => $dir, 2521 'url' => $url, 2522 'subdir' => $subdir, 2523 'basedir' => $basedir, 2524 'baseurl' => $baseurl, 2525 'error' => false, 2526 ); 2527 } 2528 2529 /** 2530 * Gets a filename that is sanitized and unique for the given directory. 2531 * 2532 * If the filename is not unique, then a number will be added to the filename 2533 * before the extension, and will continue adding numbers until the filename 2534 * is unique. 2535 * 2536 * The callback function allows the caller to use their own method to create 2537 * unique file names. If defined, the callback should take three arguments: 2538 * - directory, base filename, and extension - and return a unique filename. 2539 * 2540 * @since 2.5.0 2541 * 2542 * @param string $dir Directory. 2543 * @param string $filename File name. 2544 * @param callable $unique_filename_callback Callback. Default null. 2545 * @return string New filename, if given wasn't unique. 2546 */ 2547 function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) { 2548 // Sanitize the file name before we begin processing. 2549 $filename = sanitize_file_name( $filename ); 2550 $ext2 = null; 2551 2552 // Initialize vars used in the wp_unique_filename filter. 2553 $number = ''; 2554 $alt_filenames = array(); 2555 2556 // Separate the filename into a name and extension. 2557 $ext = pathinfo( $filename, PATHINFO_EXTENSION ); 2558 $name = pathinfo( $filename, PATHINFO_BASENAME ); 2559 2560 if ( $ext ) { 2561 $ext = '.' . $ext; 2562 } 2563 2564 // Edge case: if file is named '.ext', treat as an empty name. 2565 if ( $name === $ext ) { 2566 $name = ''; 2567 } 2568 2569 /* 2570 * Increment the file number until we have a unique file to save in $dir. 2571 * Use callback if supplied. 2572 */ 2573 if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) { 2574 $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext ); 2575 } else { 2576 $fname = pathinfo( $filename, PATHINFO_FILENAME ); 2577 2578 // Always append a number to file names that can potentially match image sub-size file names. 2579 if ( $fname && preg_match( '/-(?:\d+x\d+|scaled|rotated)$/', $fname ) ) { 2580 $number = 1; 2581 2582 // At this point the file name may not be unique. This is tested below and the $number is incremented. 2583 $filename = str_replace( "{$fname}{$ext}", "{$fname}-{$number}{$ext}", $filename ); 2584 } 2585 2586 /* 2587 * Get the mime type. Uploaded files were already checked with wp_check_filetype_and_ext() 2588 * in _wp_handle_upload(). Using wp_check_filetype() would be sufficient here. 2589 */ 2590 $file_type = wp_check_filetype( $filename ); 2591 $mime_type = $file_type['type']; 2592 2593 $is_image = ( ! empty( $mime_type ) && str_starts_with( $mime_type, 'image/' ) ); 2594 $upload_dir = wp_get_upload_dir(); 2595 $lc_filename = null; 2596 2597 $lc_ext = strtolower( $ext ); 2598 $_dir = trailingslashit( $dir ); 2599 2600 /* 2601 * If the extension is uppercase add an alternate file name with lowercase extension. 2602 * Both need to be tested for uniqueness as the extension will be changed to lowercase 2603 * for better compatibility with different filesystems. Fixes an inconsistency in WP < 2.9 2604 * where uppercase extensions were allowed but image sub-sizes were created with 2605 * lowercase extensions. 2606 */ 2607 if ( $ext && $lc_ext !== $ext ) { 2608 $lc_filename = preg_replace( '|' . preg_quote( $ext ) . '$|', $lc_ext, $filename ); 2609 } 2610 2611 /* 2612 * Increment the number added to the file name if there are any files in $dir 2613 * whose names match one of the possible name variations. 2614 */ 2615 while ( file_exists( $_dir . $filename ) || ( $lc_filename && file_exists( $_dir . $lc_filename ) ) ) { 2616 $new_number = (int) $number + 1; 2617 2618 if ( $lc_filename ) { 2619 $lc_filename = str_replace( 2620 array( "-{$number}{$lc_ext}", "{$number}{$lc_ext}" ), 2621 "-{$new_number}{$lc_ext}", 2622 $lc_filename 2623 ); 2624 } 2625 2626 if ( '' === "{$number}{$ext}" ) { 2627 $filename = "{$filename}-{$new_number}"; 2628 } else { 2629 $filename = str_replace( 2630 array( "-{$number}{$ext}", "{$number}{$ext}" ), 2631 "-{$new_number}{$ext}", 2632 $filename 2633 ); 2634 } 2635 2636 $number = $new_number; 2637 } 2638 2639 // Change the extension to lowercase if needed. 2640 if ( $lc_filename ) { 2641 $filename = $lc_filename; 2642 } 2643 2644 /* 2645 * Prevent collisions with existing file names that contain dimension-like strings 2646 * (whether they are subsizes or originals uploaded prior to #42437). 2647 */ 2648 2649 $files = array(); 2650 $count = 10000; 2651 2652 // The (resized) image files would have name and extension, and will be in the uploads dir. 2653 if ( $name && $ext && @is_dir( $dir ) && str_contains( $dir, $upload_dir['basedir'] ) ) { 2654 /** 2655 * Filters the file list used for calculating a unique filename for a newly added file. 2656 * 2657 * Returning an array from the filter will effectively short-circuit retrieval 2658 * from the filesystem and return the passed value instead. 2659 * 2660 * @since 5.5.0 2661 * 2662 * @param array|null $files The list of files to use for filename comparisons. 2663 * Default null (to retrieve the list from the filesystem). 2664 * @param string $dir The directory for the new file. 2665 * @param string $filename The proposed filename for the new file. 2666 */ 2667 $files = apply_filters( 'pre_wp_unique_filename_file_list', null, $dir, $filename ); 2668 2669 if ( null === $files ) { 2670 // List of all files and directories contained in $dir. 2671 $files = @scandir( $dir ); 2672 } 2673 2674 if ( ! empty( $files ) ) { 2675 // Remove "dot" dirs. 2676 $files = array_diff( $files, array( '.', '..' ) ); 2677 } 2678 2679 if ( ! empty( $files ) ) { 2680 $count = count( $files ); 2681 2682 /* 2683 * Ensure this never goes into infinite loop as it uses pathinfo() and regex in the check, 2684 * but string replacement for the changes. 2685 */ 2686 $i = 0; 2687 2688 while ( $i <= $count && _wp_check_existing_file_names( $filename, $files ) ) { 2689 $new_number = (int) $number + 1; 2690 2691 // If $ext is uppercase it was replaced with the lowercase version after the previous loop. 2692 $filename = str_replace( 2693 array( "-{$number}{$lc_ext}", "{$number}{$lc_ext}" ), 2694 "-{$new_number}{$lc_ext}", 2695 $filename 2696 ); 2697 2698 $number = $new_number; 2699 ++$i; 2700 } 2701 } 2702 } 2703 2704 /* 2705 * Check if an image will be converted after uploading or some existing image sub-size file names may conflict 2706 * when regenerated. If yes, ensure the new file name will be unique and will produce unique sub-sizes. 2707 */ 2708 if ( $is_image ) { 2709 /** This filter is documented in wp-includes/class-wp-image-editor.php */ 2710 $output_formats = apply_filters( 'image_editor_output_format', array(), $_dir . $filename, $mime_type ); 2711 $alt_types = array(); 2712 2713 if ( ! empty( $output_formats[ $mime_type ] ) ) { 2714 // The image will be converted to this format/mime type. 2715 $alt_mime_type = $output_formats[ $mime_type ]; 2716 2717 // Other types of images whose names may conflict if their sub-sizes are regenerated. 2718 $alt_types = array_keys( array_intersect( $output_formats, array( $mime_type, $alt_mime_type ) ) ); 2719 $alt_types[] = $alt_mime_type; 2720 } elseif ( ! empty( $output_formats ) ) { 2721 $alt_types = array_keys( array_intersect( $output_formats, array( $mime_type ) ) ); 2722 } 2723 2724 // Remove duplicates and the original mime type. It will be added later if needed. 2725 $alt_types = array_unique( array_diff( $alt_types, array( $mime_type ) ) ); 2726 2727 foreach ( $alt_types as $alt_type ) { 2728 $alt_ext = wp_get_default_extension_for_mime_type( $alt_type ); 2729 2730 if ( ! $alt_ext ) { 2731 continue; 2732 } 2733 2734 $alt_ext = ".{$alt_ext}"; 2735 $alt_filename = preg_replace( '|' . preg_quote( $lc_ext ) . '$|', $alt_ext, $filename ); 2736 2737 $alt_filenames[ $alt_ext ] = $alt_filename; 2738 } 2739 2740 if ( ! empty( $alt_filenames ) ) { 2741 /* 2742 * Add the original filename. It needs to be checked again 2743 * together with the alternate filenames when $number is incremented. 2744 */ 2745 $alt_filenames[ $lc_ext ] = $filename; 2746 2747 // Ensure no infinite loop. 2748 $i = 0; 2749 2750 while ( $i <= $count && _wp_check_alternate_file_names( $alt_filenames, $_dir, $files ) ) { 2751 $new_number = (int) $number + 1; 2752 2753 foreach ( $alt_filenames as $alt_ext => $alt_filename ) { 2754 $alt_filenames[ $alt_ext ] = str_replace( 2755 array( "-{$number}{$alt_ext}", "{$number}{$alt_ext}" ), 2756 "-{$new_number}{$alt_ext}", 2757 $alt_filename 2758 ); 2759 } 2760 2761 /* 2762 * Also update the $number in (the output) $filename. 2763 * If the extension was uppercase it was already replaced with the lowercase version. 2764 */ 2765 $filename = str_replace( 2766 array( "-{$number}{$lc_ext}", "{$number}{$lc_ext}" ), 2767 "-{$new_number}{$lc_ext}", 2768 $filename 2769 ); 2770 2771 $number = $new_number; 2772 ++$i; 2773 } 2774 } 2775 } 2776 } 2777 2778 /** 2779 * Filters the result when generating a unique file name. 2780 * 2781 * @since 4.5.0 2782 * @since 5.8.1 The `$alt_filenames` and `$number` parameters were added. 2783 * 2784 * @param string $filename Unique file name. 2785 * @param string $ext File extension. Example: ".png". 2786 * @param string $dir Directory path. 2787 * @param callable|null $unique_filename_callback Callback function that generates the unique file name. 2788 * @param string[] $alt_filenames Array of alternate file names that were checked for collisions. 2789 * @param int|string $number The highest number that was used to make the file name unique 2790 * or an empty string if unused. 2791 */ 2792 return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback, $alt_filenames, $number ); 2793 } 2794 2795 /** 2796 * Helper function to test if each of an array of file names could conflict with existing files. 2797 * 2798 * @since 5.8.1 2799 * @access private 2800 * 2801 * @param string[] $filenames Array of file names to check. 2802 * @param string $dir The directory containing the files. 2803 * @param array $files An array of existing files in the directory. May be empty. 2804 * @return bool True if the tested file name could match an existing file, false otherwise. 2805 */ 2806 function _wp_check_alternate_file_names( $filenames, $dir, $files ) { 2807 foreach ( $filenames as $filename ) { 2808 if ( file_exists( $dir . $filename ) ) { 2809 return true; 2810 } 2811 2812 if ( ! empty( $files ) && _wp_check_existing_file_names( $filename, $files ) ) { 2813 return true; 2814 } 2815 } 2816 2817 return false; 2818 } 2819 2820 /** 2821 * Helper function to check if a file name could match an existing image sub-size file name. 2822 * 2823 * @since 5.3.1 2824 * @access private 2825 * 2826 * @param string $filename The file name to check. 2827 * @param array $files An array of existing files in the directory. 2828 * @return bool True if the tested file name could match an existing file, false otherwise. 2829 */ 2830 function _wp_check_existing_file_names( $filename, $files ) { 2831 $fname = pathinfo( $filename, PATHINFO_FILENAME ); 2832 $ext = pathinfo( $filename, PATHINFO_EXTENSION ); 2833 2834 // Edge case, file names like `.ext`. 2835 if ( empty( $fname ) ) { 2836 return false; 2837 } 2838 2839 if ( $ext ) { 2840 $ext = ".$ext"; 2841 } 2842 2843 $regex = '/^' . preg_quote( $fname ) . '-(?:\d+x\d+|scaled|rotated)' . preg_quote( $ext ) . '$/i'; 2844 2845 foreach ( $files as $file ) { 2846 if ( preg_match( $regex, $file ) ) { 2847 return true; 2848 } 2849 } 2850 2851 return false; 2852 } 2853 2854 /** 2855 * Creates a file in the upload folder with given content. 2856 * 2857 * If there is an error, then the key 'error' will exist with the error message. 2858 * If success, then the key 'file' will have the unique file path, the 'url' key 2859 * will have the link to the new file. and the 'error' key will be set to false. 2860 * 2861 * This function will not move an uploaded file to the upload folder. It will 2862 * create a new file with the content in $bits parameter. If you move the upload 2863 * file, read the content of the uploaded file, and then you can give the 2864 * filename and content to this function, which will add it to the upload 2865 * folder. 2866 * 2867 * The permissions will be set on the new file automatically by this function. 2868 * 2869 * @since 2.0.0 2870 * 2871 * @param string $name Filename. 2872 * @param null|string $deprecated Never used. Set to null. 2873 * @param string $bits File content 2874 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. 2875 * @return array { 2876 * Information about the newly-uploaded file. 2877 * 2878 * @type string $file Filename of the newly-uploaded file. 2879 * @type string $url URL of the uploaded file. 2880 * @type string $type File type. 2881 * @type string|false $error Error message, if there has been an error. 2882 * } 2883 */ 2884 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) { 2885 if ( ! empty( $deprecated ) ) { 2886 _deprecated_argument( __FUNCTION__, '2.0.0' ); 2887 } 2888 2889 if ( empty( $name ) ) { 2890 return array( 'error' => __( 'Empty filename' ) ); 2891 } 2892 2893 $wp_filetype = wp_check_filetype( $name ); 2894 if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) ) { 2895 return array( 'error' => __( 'Sorry, you are not allowed to upload this file type.' ) ); 2896 } 2897 2898 $upload = wp_upload_dir( $time ); 2899 2900 if ( false !== $upload['error'] ) { 2901 return $upload; 2902 } 2903 2904 /** 2905 * Filters whether to treat the upload bits as an error. 2906 * 2907 * Returning a non-array from the filter will effectively short-circuit preparing the upload bits 2908 * and return that value instead. An error message should be returned as a string. 2909 * 2910 * @since 3.0.0 2911 * 2912 * @param array|string $upload_bits_error An array of upload bits data, or error message to return. 2913 */ 2914 $upload_bits_error = apply_filters( 2915 'wp_upload_bits', 2916 array( 2917 'name' => $name, 2918 'bits' => $bits, 2919 'time' => $time, 2920 ) 2921 ); 2922 if ( ! is_array( $upload_bits_error ) ) { 2923 $upload['error'] = $upload_bits_error; 2924 return $upload; 2925 } 2926 2927 $filename = wp_unique_filename( $upload['path'], $name ); 2928 2929 $new_file = $upload['path'] . "/$filename"; 2930 if ( ! wp_mkdir_p( dirname( $new_file ) ) ) { 2931 if ( str_starts_with( $upload['basedir'], ABSPATH ) ) { 2932 $error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir']; 2933 } else { 2934 $error_path = wp_basename( $upload['basedir'] ) . $upload['subdir']; 2935 } 2936 2937 $message = sprintf( 2938 /* translators: %s: Directory path. */ 2939 __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), 2940 $error_path 2941 ); 2942 return array( 'error' => $message ); 2943 } 2944 2945 $ifp = @fopen( $new_file, 'wb' ); 2946 if ( ! $ifp ) { 2947 return array( 2948 /* translators: %s: File name. */ 2949 'error' => sprintf( __( 'Could not write file %s' ), $new_file ), 2950 ); 2951 } 2952 2953 fwrite( $ifp, $bits ); 2954 fclose( $ifp ); 2955 clearstatcache(); 2956 2957 // Set correct file permissions. 2958 $stat = @ stat( dirname( $new_file ) ); 2959 $perms = $stat['mode'] & 0007777; 2960 $perms = $perms & 0000666; 2961 chmod( $new_file, $perms ); 2962 clearstatcache(); 2963 2964 // Compute the URL. 2965 $url = $upload['url'] . "/$filename"; 2966 2967 if ( is_multisite() ) { 2968 clean_dirsize_cache( $new_file ); 2969 } 2970 2971 /** This filter is documented in wp-admin/includes/file.php */ 2972 return apply_filters( 2973 'wp_handle_upload', 2974 array( 2975 'file' => $new_file, 2976 'url' => $url, 2977 'type' => $wp_filetype['type'], 2978 'error' => false, 2979 ), 2980 'sideload' 2981 ); 2982 } 2983 2984 /** 2985 * Retrieves the file type based on the extension name. 2986 * 2987 * @since 2.5.0 2988 * 2989 * @param string $ext The extension to search. 2990 * @return string|void The file type, example: audio, video, document, spreadsheet, etc. 2991 */ 2992 function wp_ext2type( $ext ) { 2993 $ext = strtolower( $ext ); 2994 2995 $ext2type = wp_get_ext_types(); 2996 foreach ( $ext2type as $type => $exts ) { 2997 if ( in_array( $ext, $exts, true ) ) { 2998 return $type; 2999 } 3000 } 3001 } 3002 3003 /** 3004 * Returns first matched extension for the mime-type, 3005 * as mapped from wp_get_mime_types(). 3006 * 3007 * @since 5.8.1 3008 * 3009 * @param string $mime_type 3010 * 3011 * @return string|false 3012 */ 3013 function wp_get_default_extension_for_mime_type( $mime_type ) { 3014 $extensions = explode( '|', array_search( $mime_type, wp_get_mime_types(), true ) ); 3015 3016 if ( empty( $extensions[0] ) ) { 3017 return false; 3018 } 3019 3020 return $extensions[0]; 3021 } 3022 3023 /** 3024 * Retrieves the file type from the file name. 3025 * 3026 * You can optionally define the mime array, if needed. 3027 * 3028 * @since 2.0.4 3029 * 3030 * @param string $filename File name or path. 3031 * @param string[]|null $mimes Optional. Array of allowed mime types keyed by their file extension regex. 3032 * Defaults to the result of get_allowed_mime_types(). 3033 * @return array { 3034 * Values for the extension and mime type. 3035 * 3036 * @type string|false $ext File extension, or false if the file doesn't match a mime type. 3037 * @type string|false $type File mime type, or false if the file doesn't match a mime type. 3038 * } 3039 */ 3040 function wp_check_filetype( $filename, $mimes = null ) { 3041 if ( empty( $mimes ) ) { 3042 $mimes = get_allowed_mime_types(); 3043 } 3044 $type = false; 3045 $ext = false; 3046 3047 foreach ( $mimes as $ext_preg => $mime_match ) { 3048 $ext_preg = '!\.(' . $ext_preg . ')$!i'; 3049 if ( preg_match( $ext_preg, $filename, $ext_matches ) ) { 3050 $type = $mime_match; 3051 $ext = $ext_matches[1]; 3052 break; 3053 } 3054 } 3055 3056 return compact( 'ext', 'type' ); 3057 } 3058 3059 /** 3060 * Attempts to determine the real file type of a file. 3061 * 3062 * If unable to, the file name extension will be used to determine type. 3063 * 3064 * If it's determined that the extension does not match the file's real type, 3065 * then the "proper_filename" value will be set with a proper filename and extension. 3066 * 3067 * Currently this function only supports renaming images validated via wp_get_image_mime(). 3068 * 3069 * @since 3.0.0 3070 * 3071 * @param string $file Full path to the file. 3072 * @param string $filename The name of the file (may differ from $file due to $file being 3073 * in a tmp directory). 3074 * @param string[]|null $mimes Optional. Array of allowed mime types keyed by their file extension regex. 3075 * Defaults to the result of get_allowed_mime_types(). 3076 * @return array { 3077 * Values for the extension, mime type, and corrected filename. 3078 * 3079 * @type string|false $ext File extension, or false if the file doesn't match a mime type. 3080 * @type string|false $type File mime type, or false if the file doesn't match a mime type. 3081 * @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined. 3082 * } 3083 */ 3084 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) { 3085 $proper_filename = false; 3086 3087 // Do basic extension validation and MIME mapping. 3088 $wp_filetype = wp_check_filetype( $filename, $mimes ); 3089 $ext = $wp_filetype['ext']; 3090 $type = $wp_filetype['type']; 3091 3092 // We can't do any further validation without a file to work with. 3093 if ( ! file_exists( $file ) ) { 3094 return compact( 'ext', 'type', 'proper_filename' ); 3095 } 3096 3097 $real_mime = false; 3098 3099 // Validate image types. 3100 if ( $type && str_starts_with( $type, 'image/' ) ) { 3101 3102 // Attempt to figure out what type of image it actually is. 3103 $real_mime = wp_get_image_mime( $file ); 3104 3105 if ( $real_mime && $real_mime !== $type ) { 3106 /** 3107 * Filters the list mapping image mime types to their respective extensions. 3108 * 3109 * @since 3.0.0 3110 * 3111 * @param array $mime_to_ext Array of image mime types and their matching extensions. 3112 */ 3113 $mime_to_ext = apply_filters( 3114 'getimagesize_mimes_to_exts', 3115 array( 3116 'image/jpeg' => 'jpg', 3117 'image/png' => 'png', 3118 'image/gif' => 'gif', 3119 'image/bmp' => 'bmp', 3120 'image/tiff' => 'tif', 3121 'image/webp' => 'webp', 3122 'image/avif' => 'avif', 3123 ) 3124 ); 3125 3126 // Replace whatever is after the last period in the filename with the correct extension. 3127 if ( ! empty( $mime_to_ext[ $real_mime ] ) ) { 3128 $filename_parts = explode( '.', $filename ); 3129 array_pop( $filename_parts ); 3130 $filename_parts[] = $mime_to_ext[ $real_mime ]; 3131 $new_filename = implode( '.', $filename_parts ); 3132 3133 if ( $new_filename !== $filename ) { 3134 $proper_filename = $new_filename; // Mark that it changed. 3135 } 3136 3137 // Redefine the extension / MIME. 3138 $wp_filetype = wp_check_filetype( $new_filename, $mimes ); 3139 $ext = $wp_filetype['ext']; 3140 $type = $wp_filetype['type']; 3141 } else { 3142 // Reset $real_mime and try validating again. 3143 $real_mime = false; 3144 } 3145 } 3146 } 3147 3148 // Validate files that didn't get validated during previous checks. 3149 if ( $type && ! $real_mime && extension_loaded( 'fileinfo' ) ) { 3150 $finfo = finfo_open( FILEINFO_MIME_TYPE ); 3151 $real_mime = finfo_file( $finfo, $file ); 3152 finfo_close( $finfo ); 3153 3154 $google_docs_types = array( 3155 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 3156 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 3157 ); 3158 3159 foreach ( $google_docs_types as $google_docs_type ) { 3160 /* 3161 * finfo_file() can return duplicate mime type for Google docs, 3162 * this conditional reduces it to a single instance. 3163 * 3164 * @see https://bugs.php.net/bug.php?id=77784 3165 * @see https://core.trac.wordpress.org/ticket/57898 3166 */ 3167 if ( 2 === substr_count( $real_mime, $google_docs_type ) ) { 3168 $real_mime = $google_docs_type; 3169 } 3170 } 3171 3172 // fileinfo often misidentifies obscure files as one of these types. 3173 $nonspecific_types = array( 3174 'application/octet-stream', 3175 'application/encrypted', 3176 'application/CDFV2-encrypted', 3177 'application/zip', 3178 ); 3179 3180 /* 3181 * If $real_mime doesn't match the content type we're expecting from the file's extension, 3182 * we need to do some additional vetting. Media types and those listed in $nonspecific_types are 3183 * allowed some leeway, but anything else must exactly match the real content type. 3184 */ 3185 if ( in_array( $real_mime, $nonspecific_types, true ) ) { 3186 // File is a non-specific binary type. That's ok if it's a type that generally tends to be binary. 3187 if ( ! in_array( substr( $type, 0, strcspn( $type, '/' ) ), array( 'application', 'video', 'audio' ), true ) ) { 3188 $type = false; 3189 $ext = false; 3190 } 3191 } elseif ( str_starts_with( $real_mime, 'video/' ) || str_starts_with( $real_mime, 'audio/' ) ) { 3192 /* 3193 * For these types, only the major type must match the real value. 3194 * This means that common mismatches are forgiven: application/vnd.apple.numbers is often misidentified as application/zip, 3195 * and some media files are commonly named with the wrong extension (.mov instead of .mp4) 3196 */ 3197 if ( substr( $real_mime, 0, strcspn( $real_mime, '/' ) ) !== substr( $type, 0, strcspn( $type, '/' ) ) ) { 3198 $type = false; 3199 $ext = false; 3200 } 3201 } elseif ( 'text/plain' === $real_mime ) { 3202 // A few common file types are occasionally detected as text/plain; allow those. 3203 if ( ! in_array( 3204 $type, 3205 array( 3206 'text/plain', 3207 'text/csv', 3208 'application/csv', 3209 'text/richtext', 3210 'text/tsv', 3211 'text/vtt', 3212 ), 3213 true 3214 ) 3215 ) { 3216 $type = false; 3217 $ext = false; 3218 } 3219 } elseif ( 'application/csv' === $real_mime ) { 3220 // Special casing for CSV files. 3221 if ( ! in_array( 3222 $type, 3223 array( 3224 'text/csv', 3225 'text/plain', 3226 'application/csv', 3227 ), 3228 true 3229 ) 3230 ) { 3231 $type = false; 3232 $ext = false; 3233 } 3234 } elseif ( 'text/rtf' === $real_mime ) { 3235 // Special casing for RTF files. 3236 if ( ! in_array( 3237 $type, 3238 array( 3239 'text/rtf', 3240 'text/plain', 3241 'application/rtf', 3242 ), 3243 true 3244 ) 3245 ) { 3246 $type = false; 3247 $ext = false; 3248 } 3249 } else { 3250 if ( $type !== $real_mime ) { 3251 /* 3252 * Everything else including image/* and application/*: 3253 * If the real content type doesn't match the file extension, assume it's dangerous. 3254 */ 3255 $type = false; 3256 $ext = false; 3257 } 3258 } 3259 } 3260 3261 // The mime type must be allowed. 3262 if ( $type ) { 3263 $allowed = get_allowed_mime_types(); 3264 3265 if ( ! in_array( $type, $allowed, true ) ) { 3266 $type = false; 3267 $ext = false; 3268 } 3269 } 3270 3271 /** 3272 * Filters the "real" file type of the given file. 3273 * 3274 * @since 3.0.0 3275 * @since 5.1.0 The $real_mime parameter was added. 3276 * 3277 * @param array $wp_check_filetype_and_ext { 3278 * Values for the extension, mime type, and corrected filename. 3279 * 3280 * @type string|false $ext File extension, or false if the file doesn't match a mime type. 3281 * @type string|false $type File mime type, or false if the file doesn't match a mime type. 3282 * @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined. 3283 * } 3284 * @param string $file Full path to the file. 3285 * @param string $filename The name of the file (may differ from $file due to 3286 * $file being in a tmp directory). 3287 * @param string[]|null $mimes Array of mime types keyed by their file extension regex, or null if 3288 * none were provided. 3289 * @param string|false $real_mime The actual mime type or false if the type cannot be determined. 3290 */ 3291 return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes, $real_mime ); 3292 } 3293 3294 /** 3295 * Returns the real mime type of an image file. 3296 * 3297 * This depends on exif_imagetype() or getimagesize() to determine real mime types. 3298 * 3299 * @since 4.7.1 3300 * @since 5.8.0 Added support for WebP images. 3301 * @since 6.5.0 Added support for AVIF images. 3302 * 3303 * @param string $file Full path to the file. 3304 * @return string|false The actual mime type or false if the type cannot be determined. 3305 */ 3306 function wp_get_image_mime( $file ) { 3307 /* 3308 * Use exif_imagetype() to check the mimetype if available or fall back to 3309 * getimagesize() if exif isn't available. If either function throws an Exception 3310 * we assume the file could not be validated. 3311 */ 3312 try { 3313 if ( is_callable( 'exif_imagetype' ) ) { 3314 $imagetype = exif_imagetype( $file ); 3315 $mime = ( $imagetype ) ? image_type_to_mime_type( $imagetype ) : false; 3316 } elseif ( function_exists( 'getimagesize' ) ) { 3317 // Don't silence errors when in debug mode, unless running unit tests. 3318 if ( defined( 'WP_DEBUG' ) && WP_DEBUG 3319 && ! defined( 'WP_RUN_CORE_TESTS' ) 3320 ) { 3321 // Not using wp_getimagesize() here to avoid an infinite loop. 3322 $imagesize = getimagesize( $file ); 3323 } else { 3324 $imagesize = @getimagesize( $file ); 3325 } 3326 3327 $mime = ( isset( $imagesize['mime'] ) ) ? $imagesize['mime'] : false; 3328 } else { 3329 $mime = false; 3330 } 3331 3332 if ( false !== $mime ) { 3333 return $mime; 3334 } 3335 3336 $magic = file_get_contents( $file, false, null, 0, 12 ); 3337 3338 if ( false === $magic ) { 3339 return false; 3340 } 3341 3342 /* 3343 * Add WebP fallback detection when image library doesn't support WebP. 3344 * Note: detection values come from LibWebP, see 3345 * https://github.com/webmproject/libwebp/blob/master/imageio/image_dec.c#L30 3346 */ 3347 $magic = bin2hex( $magic ); 3348 if ( 3349 // RIFF. 3350 ( str_starts_with( $magic, '52494646' ) ) && 3351 // WEBP. 3352 ( 16 === strpos( $magic, '57454250' ) ) 3353 ) { 3354 $mime = 'image/webp'; 3355 } 3356 3357 /** 3358 * Add AVIF fallback detection when image library doesn't support AVIF. 3359 * 3360 * Detection based on section 4.3.1 File-type box definition of the ISO/IEC 14496-12 3361 * specification and the AV1-AVIF spec, see https://aomediacodec.github.io/av1-avif/v1.1.0.html#brands. 3362 */ 3363 3364 // Divide the header string into 4 byte groups. 3365 $magic = str_split( $magic, 8 ); 3366 3367 if ( 3368 isset( $magic[1] ) && 3369 isset( $magic[2] ) && 3370 'ftyp' === hex2bin( $magic[1] ) && 3371 ( 'avif' === hex2bin( $magic[2] ) || 'avis' === hex2bin( $magic[2] ) ) 3372 ) { 3373 $mime = 'image/avif'; 3374 } 3375 } catch ( Exception $e ) { 3376 $mime = false; 3377 } 3378 3379 return $mime; 3380 } 3381 3382 /** 3383 * Retrieves the list of mime types and file extensions. 3384 * 3385 * @since 3.5.0 3386 * @since 4.2.0 Support was added for GIMP (.xcf) files. 3387 * @since 4.9.2 Support was added for Flac (.flac) files. 3388 * @since 4.9.6 Support was added for AAC (.aac) files. 3389 * 3390 * @return string[] Array of mime types keyed by the file extension regex corresponding to those types. 3391 */ 3392 function wp_get_mime_types() { 3393 /** 3394 * Filters the list of mime types and file extensions. 3395 * 3396 * This filter should be used to add, not remove, mime types. To remove 3397 * mime types, use the {@see 'upload_mimes'} filter. 3398 * 3399 * @since 3.5.0 3400 * 3401 * @param string[] $wp_get_mime_types Mime types keyed by the file extension regex 3402 * corresponding to those types. 3403 */ 3404 return apply_filters( 3405 'mime_types', 3406 array( 3407 // Image formats. 3408 'jpg|jpeg|jpe' => 'image/jpeg', 3409 'gif' => 'image/gif', 3410 'png' => 'image/png', 3411 'bmp' => 'image/bmp', 3412 'tiff|tif' => 'image/tiff', 3413 'webp' => 'image/webp', 3414 'avif' => 'image/avif', 3415 'ico' => 'image/x-icon', 3416 'heic' => 'image/heic', 3417 // Video formats. 3418 'asf|asx' => 'video/x-ms-asf', 3419 'wmv' => 'video/x-ms-wmv', 3420 'wmx' => 'video/x-ms-wmx', 3421 'wm' => 'video/x-ms-wm', 3422 'avi' => 'video/avi', 3423 'divx' => 'video/divx', 3424 'flv' => 'video/x-flv', 3425 'mov|qt' => 'video/quicktime', 3426 'mpeg|mpg|mpe' => 'video/mpeg', 3427 'mp4|m4v' => 'video/mp4', 3428 'ogv' => 'video/ogg', 3429 'webm' => 'video/webm', 3430 'mkv' => 'video/x-matroska', 3431 '3gp|3gpp' => 'video/3gpp', // Can also be audio. 3432 '3g2|3gp2' => 'video/3gpp2', // Can also be audio. 3433 // Text formats. 3434 'txt|asc|c|cc|h|srt' => 'text/plain', 3435 'csv' => 'text/csv', 3436 'tsv' => 'text/tab-separated-values', 3437 'ics' => 'text/calendar', 3438 'rtx' => 'text/richtext', 3439 'css' => 'text/css', 3440 'htm|html' => 'text/html', 3441 'vtt' => 'text/vtt', 3442 'dfxp' => 'application/ttaf+xml', 3443 // Audio formats. 3444 'mp3|m4a|m4b' => 'audio/mpeg', 3445 'aac' => 'audio/aac', 3446 'ra|ram' => 'audio/x-realaudio', 3447 'wav' => 'audio/wav', 3448 'ogg|oga' => 'audio/ogg', 3449 'flac' => 'audio/flac', 3450 'mid|midi' => 'audio/midi', 3451 'wma' => 'audio/x-ms-wma', 3452 'wax' => 'audio/x-ms-wax', 3453 'mka' => 'audio/x-matroska', 3454 // Misc application formats. 3455 'rtf' => 'application/rtf', 3456 'js' => 'application/javascript', 3457 'pdf' => 'application/pdf', 3458 'swf' => 'application/x-shockwave-flash', 3459 'class' => 'application/java', 3460 'tar' => 'application/x-tar', 3461 'zip' => 'application/zip', 3462 'gz|gzip' => 'application/x-gzip', 3463 'rar' => 'application/rar', 3464 '7z' => 'application/x-7z-compressed', 3465 'exe' => 'application/x-msdownload', 3466 'psd' => 'application/octet-stream', 3467 'xcf' => 'application/octet-stream', 3468 // MS Office formats. 3469 'doc' => 'application/msword', 3470 'pot|pps|ppt' => 'application/vnd.ms-powerpoint', 3471 'wri' => 'application/vnd.ms-write', 3472 'xla|xls|xlt|xlw' => 'application/vnd.ms-excel', 3473 'mdb' => 'application/vnd.ms-access', 3474 'mpp' => 'application/vnd.ms-project', 3475 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 3476 'docm' => 'application/vnd.ms-word.document.macroEnabled.12', 3477 'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 3478 'dotm' => 'application/vnd.ms-word.template.macroEnabled.12', 3479 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 3480 'xlsm' => 'application/vnd.ms-excel.sheet.macroEnabled.12', 3481 'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 3482 'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 3483 'xltm' => 'application/vnd.ms-excel.template.macroEnabled.12', 3484 'xlam' => 'application/vnd.ms-excel.addin.macroEnabled.12', 3485 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 3486 'pptm' => 'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 3487 'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 3488 'ppsm' => 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 3489 'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template', 3490 'potm' => 'application/vnd.ms-powerpoint.template.macroEnabled.12', 3491 'ppam' => 'application/vnd.ms-powerpoint.addin.macroEnabled.12', 3492 'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide', 3493 'sldm' => 'application/vnd.ms-powerpoint.slide.macroEnabled.12', 3494 'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote', 3495 'oxps' => 'application/oxps', 3496 'xps' => 'application/vnd.ms-xpsdocument', 3497 // OpenOffice formats. 3498 'odt' => 'application/vnd.oasis.opendocument.text', 3499 'odp' => 'application/vnd.oasis.opendocument.presentation', 3500 'ods' => 'application/vnd.oasis.opendocument.spreadsheet', 3501 'odg' => 'application/vnd.oasis.opendocument.graphics', 3502 'odc' => 'application/vnd.oasis.opendocument.chart', 3503 'odb' => 'application/vnd.oasis.opendocument.database', 3504 'odf' => 'application/vnd.oasis.opendocument.formula', 3505 // WordPerfect formats. 3506 'wp|wpd' => 'application/wordperfect', 3507 // iWork formats. 3508 'key' => 'application/vnd.apple.keynote', 3509 'numbers' => 'application/vnd.apple.numbers', 3510 'pages' => 'application/vnd.apple.pages', 3511 ) 3512 ); 3513 } 3514 3515 /** 3516 * Retrieves the list of common file extensions and their types. 3517 * 3518 * @since 4.6.0 3519 * 3520 * @return array[] Multi-dimensional array of file extensions types keyed by the type of file. 3521 */ 3522 function wp_get_ext_types() { 3523 3524 /** 3525 * Filters file type based on the extension name. 3526 * 3527 * @since 2.5.0 3528 * 3529 * @see wp_ext2type() 3530 * 3531 * @param array[] $ext2type Multi-dimensional array of file extensions types keyed by the type of file. 3532 */ 3533 return apply_filters( 3534 'ext2type', 3535 array( 3536 'image' => array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'bmp', 'tif', 'tiff', 'ico', 'heic', 'webp', 'avif' ), 3537 'audio' => array( 'aac', 'ac3', 'aif', 'aiff', 'flac', 'm3a', 'm4a', 'm4b', 'mka', 'mp1', 'mp2', 'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ), 3538 'video' => array( '3g2', '3gp', '3gpp', 'asf', 'avi', 'divx', 'dv', 'flv', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt', 'rm', 'vob', 'wmv' ), 3539 'document' => array( 'doc', 'docx', 'docm', 'dotm', 'odt', 'pages', 'pdf', 'xps', 'oxps', 'rtf', 'wp', 'wpd', 'psd', 'xcf' ), 3540 'spreadsheet' => array( 'numbers', 'ods', 'xls', 'xlsx', 'xlsm', 'xlsb' ), 3541 'interactive' => array( 'swf', 'key', 'ppt', 'pptx', 'pptm', 'pps', 'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ), 3542 'text' => array( 'asc', 'csv', 'tsv', 'txt' ), 3543 'archive' => array( 'bz2', 'cab', 'dmg', 'gz', 'rar', 'sea', 'sit', 'sqx', 'tar', 'tgz', 'zip', '7z' ), 3544 'code' => array( 'css', 'htm', 'html', 'php', 'js' ), 3545 ) 3546 ); 3547 } 3548 3549 /** 3550 * Wrapper for PHP filesize with filters and casting the result as an integer. 3551 * 3552 * @since 6.0.0 3553 * 3554 * @link https://www.php.net/manual/en/function.filesize.php 3555 * 3556 * @param string $path Path to the file. 3557 * @return int The size of the file in bytes, or 0 in the event of an error. 3558 */ 3559 function wp_filesize( $path ) { 3560 /** 3561 * Filters the result of wp_filesize before the PHP function is run. 3562 * 3563 * @since 6.0.0 3564 * 3565 * @param null|int $size The unfiltered value. Returning an int from the callback bypasses the filesize call. 3566 * @param string $path Path to the file. 3567 */ 3568 $size = apply_filters( 'pre_wp_filesize', null, $path ); 3569 3570 if ( is_int( $size ) ) { 3571 return $size; 3572 } 3573 3574 $size = file_exists( $path ) ? (int) filesize( $path ) : 0; 3575 3576 /** 3577 * Filters the size of the file. 3578 * 3579 * @since 6.0.0 3580 * 3581 * @param int $size The result of PHP filesize on the file. 3582 * @param string $path Path to the file. 3583 */ 3584 return (int) apply_filters( 'wp_filesize', $size, $path ); 3585 } 3586 3587 /** 3588 * Retrieves the list of allowed mime types and file extensions. 3589 * 3590 * @since 2.8.6 3591 * 3592 * @param int|WP_User $user Optional. User to check. Defaults to current user. 3593 * @return string[] Array of mime types keyed by the file extension regex corresponding 3594 * to those types. 3595 */ 3596 function get_allowed_mime_types( $user = null ) { 3597 $t = wp_get_mime_types(); 3598 3599 unset( $t['swf'], $t['exe'] ); 3600 if ( function_exists( 'current_user_can' ) ) { 3601 $unfiltered = $user ? user_can( $user, 'unfiltered_html' ) : current_user_can( 'unfiltered_html' ); 3602 } 3603 3604 if ( empty( $unfiltered ) ) { 3605 unset( $t['htm|html'], $t['js'] ); 3606 } 3607 3608 /** 3609 * Filters the list of allowed mime types and file extensions. 3610 * 3611 * @since 2.0.0 3612 * 3613 * @param array $t Mime types keyed by the file extension regex corresponding to those types. 3614 * @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user). 3615 */ 3616 return apply_filters( 'upload_mimes', $t, $user ); 3617 } 3618 3619 /** 3620 * Displays "Are You Sure" message to confirm the action being taken. 3621 * 3622 * If the action has the nonce explain message, then it will be displayed 3623 * along with the "Are you sure?" message. 3624 * 3625 * @since 2.0.4 3626 * 3627 * @param string $action The nonce action. 3628 */ 3629 function wp_nonce_ays( $action ) { 3630 // Default title and response code. 3631 $title = __( 'Something went wrong.' ); 3632 $response_code = 403; 3633 3634 if ( 'log-out' === $action ) { 3635 $title = sprintf( 3636 /* translators: %s: Site title. */ 3637 __( 'You are attempting to log out of %s' ), 3638 get_bloginfo( 'name' ) 3639 ); 3640 3641 $redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : ''; 3642 3643 $html = $title; 3644 $html .= '</p><p>'; 3645 $html .= sprintf( 3646 /* translators: %s: Logout URL. */ 3647 __( 'Do you really want to <a href="%s">log out</a>?' ), 3648 wp_logout_url( $redirect_to ) 3649 ); 3650 } else { 3651 $html = __( 'The link you followed has expired.' ); 3652 3653 if ( wp_get_referer() ) { 3654 $wp_http_referer = remove_query_arg( 'updated', wp_get_referer() ); 3655 $wp_http_referer = wp_validate_redirect( sanitize_url( $wp_http_referer ) ); 3656 3657 $html .= '</p><p>'; 3658 $html .= sprintf( 3659 '<a href="%s">%s</a>', 3660 esc_url( $wp_http_referer ), 3661 __( 'Please try again.' ) 3662 ); 3663 } 3664 } 3665 3666 wp_die( $html, $title, $response_code ); 3667 } 3668 3669 /** 3670 * Kills WordPress execution and displays HTML page with an error message. 3671 * 3672 * This function complements the `die()` PHP function. The difference is that 3673 * HTML will be displayed to the user. It is recommended to use this function 3674 * only when the execution should not continue any further. It is not recommended 3675 * to call this function very often, and try to handle as many errors as possible 3676 * silently or more gracefully. 3677 * 3678 * As a shorthand, the desired HTTP response code may be passed as an integer to 3679 * the `$title` parameter (the default title would apply) or the `$args` parameter. 3680 * 3681 * @since 2.0.4 3682 * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept 3683 * an integer to be used as the response code. 3684 * @since 5.1.0 The `$link_url`, `$link_text`, and `$exit` arguments were added. 3685 * @since 5.3.0 The `$charset` argument was added. 3686 * @since 5.5.0 The `$text_direction` argument has a priority over get_language_attributes() 3687 * in the default handler. 3688 * 3689 * @global WP_Query $wp_query WordPress Query object. 3690 * 3691 * @param string|WP_Error $message Optional. Error message. If this is a WP_Error object, 3692 * and not an Ajax or XML-RPC request, the error's messages are used. 3693 * Default empty string. 3694 * @param string|int $title Optional. Error title. If `$message` is a `WP_Error` object, 3695 * error data with the key 'title' may be used to specify the title. 3696 * If `$title` is an integer, then it is treated as the response code. 3697 * Default empty string. 3698 * @param string|array|int $args { 3699 * Optional. Arguments to control behavior. If `$args` is an integer, then it is treated 3700 * as the response code. Default empty array. 3701 * 3702 * @type int $response The HTTP response code. Default 200 for Ajax requests, 500 otherwise. 3703 * @type string $link_url A URL to include a link to. Only works in combination with $link_text. 3704 * Default empty string. 3705 * @type string $link_text A label for the link to include. Only works in combination with $link_url. 3706 * Default empty string. 3707 * @type bool $back_link Whether to include a link to go back. Default false. 3708 * @type string $text_direction The text direction. This is only useful internally, when WordPress is still 3709 * loading and the site's locale is not set up yet. Accepts 'rtl' and 'ltr'. 3710 * Default is the value of is_rtl(). 3711 * @type string $charset Character set of the HTML output. Default 'utf-8'. 3712 * @type string $code Error code to use. Default is 'wp_die', or the main error code if $message 3713 * is a WP_Error. 3714 * @type bool $exit Whether to exit the process after completion. Default true. 3715 * } 3716 */ 3717 function wp_die( $message = '', $title = '', $args = array() ) { 3718 global $wp_query; 3719 3720 if ( is_int( $args ) ) { 3721 $args = array( 'response' => $args ); 3722 } elseif ( is_int( $title ) ) { 3723 $args = array( 'response' => $title ); 3724 $title = ''; 3725 } 3726 3727 if ( wp_doing_ajax() ) { 3728 /** 3729 * Filters the callback for killing WordPress execution for Ajax requests. 3730 * 3731 * @since 3.4.0 3732 * 3733 * @param callable $callback Callback function name. 3734 */ 3735 $callback = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' ); 3736 } elseif ( wp_is_json_request() ) { 3737 /** 3738 * Filters the callback for killing WordPress execution for JSON requests. 3739 * 3740 * @since 5.1.0 3741 * 3742 * @param callable $callback Callback function name. 3743 */ 3744 $callback = apply_filters( 'wp_die_json_handler', '_json_wp_die_handler' ); 3745 } elseif ( wp_is_serving_rest_request() && wp_is_jsonp_request() ) { 3746 /** 3747 * Filters the callback for killing WordPress execution for JSONP REST requests. 3748 * 3749 * @since 5.2.0 3750 * 3751 * @param callable $callback Callback function name. 3752 */ 3753 $callback = apply_filters( 'wp_die_jsonp_handler', '_jsonp_wp_die_handler' ); 3754 } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) { 3755 /** 3756 * Filters the callback for killing WordPress execution for XML-RPC requests. 3757 * 3758 * @since 3.4.0 3759 * 3760 * @param callable $callback Callback function name. 3761 */ 3762 $callback = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' ); 3763 } elseif ( wp_is_xml_request() 3764 || isset( $wp_query ) && 3765 ( function_exists( 'is_feed' ) && is_feed() 3766 || function_exists( 'is_comment_feed' ) && is_comment_feed() 3767 || function_exists( 'is_trackback' ) && is_trackback() ) ) { 3768 /** 3769 * Filters the callback for killing WordPress execution for XML requests. 3770 * 3771 * @since 5.2.0 3772 * 3773 * @param callable $callback Callback function name. 3774 */ 3775 $callback = apply_filters( 'wp_die_xml_handler', '_xml_wp_die_handler' ); 3776 } else { 3777 /** 3778 * Filters the callback for killing WordPress execution for all non-Ajax, non-JSON, non-XML requests. 3779 * 3780 * @since 3.0.0 3781 * 3782 * @param callable $callback Callback function name. 3783 */ 3784 $callback = apply_filters( 'wp_die_handler', '_default_wp_die_handler' ); 3785 } 3786 3787 call_user_func( $callback, $message, $title, $args ); 3788 } 3789 3790 /** 3791 * Kills WordPress execution and displays HTML page with an error message. 3792 * 3793 * This is the default handler for wp_die(). If you want a custom one, 3794 * you can override this using the {@see 'wp_die_handler'} filter in wp_die(). 3795 * 3796 * @since 3.0.0 3797 * @access private 3798 * 3799 * @param string|WP_Error $message Error message or WP_Error object. 3800 * @param string $title Optional. Error title. Default empty string. 3801 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 3802 */ 3803 function _default_wp_die_handler( $message, $title = '', $args = array() ) { 3804 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 3805 3806 if ( is_string( $message ) ) { 3807 if ( ! empty( $parsed_args['additional_errors'] ) ) { 3808 $message = array_merge( 3809 array( $message ), 3810 wp_list_pluck( $parsed_args['additional_errors'], 'message' ) 3811 ); 3812 $message = "<ul>\n\t\t<li>" . implode( "</li>\n\t\t<li>", $message ) . "</li>\n\t</ul>"; 3813 } 3814 3815 $message = sprintf( 3816 '<div class="wp-die-message">%s</div>', 3817 $message 3818 ); 3819 } 3820 3821 $have_gettext = function_exists( '__' ); 3822 3823 if ( ! empty( $parsed_args['link_url'] ) && ! empty( $parsed_args['link_text'] ) ) { 3824 $link_url = $parsed_args['link_url']; 3825 if ( function_exists( 'esc_url' ) ) { 3826 $link_url = esc_url( $link_url ); 3827 } 3828 $link_text = $parsed_args['link_text']; 3829 $message .= "\n<p><a href='{$link_url}'>{$link_text}</a></p>"; 3830 } 3831 3832 if ( isset( $parsed_args['back_link'] ) && $parsed_args['back_link'] ) { 3833 $back_text = $have_gettext ? __( '« Back' ) : '« Back'; 3834 $message .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>"; 3835 } 3836 3837 if ( ! did_action( 'admin_head' ) ) : 3838 if ( ! headers_sent() ) { 3839 header( "Content-Type: text/html; charset={$parsed_args['charset']}" ); 3840 status_header( $parsed_args['response'] ); 3841 nocache_headers(); 3842 } 3843 3844 $text_direction = $parsed_args['text_direction']; 3845 $dir_attr = "dir='$text_direction'"; 3846 3847 /* 3848 * If `text_direction` was not explicitly passed, 3849 * use get_language_attributes() if available. 3850 */ 3851 if ( empty( $args['text_direction'] ) 3852 && function_exists( 'language_attributes' ) && function_exists( 'is_rtl' ) 3853 ) { 3854 $dir_attr = get_language_attributes(); 3855 } 3856 ?> 3857 <!DOCTYPE html> 3858 <html <?php echo $dir_attr; ?>> 3859 <head> 3860 <meta http-equiv="Content-Type" content="text/html; charset=<?php echo $parsed_args['charset']; ?>" /> 3861 <meta name="viewport" content="width=device-width"> 3862 <?php 3863 if ( function_exists( 'wp_robots' ) && function_exists( 'wp_robots_no_robots' ) && function_exists( 'add_filter' ) ) { 3864 add_filter( 'wp_robots', 'wp_robots_no_robots' ); 3865 wp_robots(); 3866 } 3867 ?> 3868 <title><?php echo $title; ?></title> 3869 <style type="text/css"> 3870 html { 3871 background: #f1f1f1; 3872 } 3873 body { 3874 background: #fff; 3875 border: 1px solid #ccd0d4; 3876 color: #444; 3877 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; 3878 margin: 2em auto; 3879 padding: 1em 2em; 3880 max-width: 700px; 3881 -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, .04); 3882 box-shadow: 0 1px 1px rgba(0, 0, 0, .04); 3883 } 3884 h1 { 3885 border-bottom: 1px solid #dadada; 3886 clear: both; 3887 color: #666; 3888 font-size: 24px; 3889 margin: 30px 0 0 0; 3890 padding: 0; 3891 padding-bottom: 7px; 3892 } 3893 #error-page { 3894 margin-top: 50px; 3895 } 3896 #error-page p, 3897 #error-page .wp-die-message { 3898 font-size: 14px; 3899 line-height: 1.5; 3900 margin: 25px 0 20px; 3901 } 3902 #error-page code { 3903 font-family: Consolas, Monaco, monospace; 3904 } 3905 ul li { 3906 margin-bottom: 10px; 3907 font-size: 14px ; 3908 } 3909 a { 3910 color: #2271b1; 3911 } 3912 a:hover, 3913 a:active { 3914 color: #135e96; 3915 } 3916 a:focus { 3917 color: #043959; 3918 box-shadow: 0 0 0 2px #2271b1; 3919 outline: 2px solid transparent; 3920 } 3921 .button { 3922 background: #f3f5f6; 3923 border: 1px solid #016087; 3924 color: #016087; 3925 display: inline-block; 3926 text-decoration: none; 3927 font-size: 13px; 3928 line-height: 2; 3929 height: 28px; 3930 margin: 0; 3931 padding: 0 10px 1px; 3932 cursor: pointer; 3933 -webkit-border-radius: 3px; 3934 -webkit-appearance: none; 3935 border-radius: 3px; 3936 white-space: nowrap; 3937 -webkit-box-sizing: border-box; 3938 -moz-box-sizing: border-box; 3939 box-sizing: border-box; 3940 3941 vertical-align: top; 3942 } 3943 3944 .button.button-large { 3945 line-height: 2.30769231; 3946 min-height: 32px; 3947 padding: 0 12px; 3948 } 3949 3950 .button:hover, 3951 .button:focus { 3952 background: #f1f1f1; 3953 } 3954 3955 .button:focus { 3956 background: #f3f5f6; 3957 border-color: #007cba; 3958 -webkit-box-shadow: 0 0 0 1px #007cba; 3959 box-shadow: 0 0 0 1px #007cba; 3960 color: #016087; 3961 outline: 2px solid transparent; 3962 outline-offset: 0; 3963 } 3964 3965 .button:active { 3966 background: #f3f5f6; 3967 border-color: #7e8993; 3968 -webkit-box-shadow: none; 3969 box-shadow: none; 3970 } 3971 3972 <?php 3973 if ( 'rtl' === $text_direction ) { 3974 echo 'body { font-family: Tahoma, Arial; }'; 3975 } 3976 ?> 3977 </style> 3978 </head> 3979 <body id="error-page"> 3980 <?php endif; // ! did_action( 'admin_head' ) ?> 3981 <?php echo $message; ?> 3982 </body> 3983 </html> 3984 <?php 3985 if ( $parsed_args['exit'] ) { 3986 die(); 3987 } 3988 } 3989 3990 /** 3991 * Kills WordPress execution and displays Ajax response with an error message. 3992 * 3993 * This is the handler for wp_die() when processing Ajax requests. 3994 * 3995 * @since 3.4.0 3996 * @access private 3997 * 3998 * @param string $message Error message. 3999 * @param string $title Optional. Error title (unused). Default empty string. 4000 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4001 */ 4002 function _ajax_wp_die_handler( $message, $title = '', $args = array() ) { 4003 // Set default 'response' to 200 for Ajax requests. 4004 $args = wp_parse_args( 4005 $args, 4006 array( 'response' => 200 ) 4007 ); 4008 4009 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 4010 4011 if ( ! headers_sent() ) { 4012 // This is intentional. For backward-compatibility, support passing null here. 4013 if ( null !== $args['response'] ) { 4014 status_header( $parsed_args['response'] ); 4015 } 4016 nocache_headers(); 4017 } 4018 4019 if ( is_scalar( $message ) ) { 4020 $message = (string) $message; 4021 } else { 4022 $message = '0'; 4023 } 4024 4025 if ( $parsed_args['exit'] ) { 4026 die( $message ); 4027 } 4028 4029 echo $message; 4030 } 4031 4032 /** 4033 * Kills WordPress execution and displays JSON response with an error message. 4034 * 4035 * This is the handler for wp_die() when processing JSON requests. 4036 * 4037 * @since 5.1.0 4038 * @access private 4039 * 4040 * @param string $message Error message. 4041 * @param string $title Optional. Error title. Default empty string. 4042 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4043 */ 4044 function _json_wp_die_handler( $message, $title = '', $args = array() ) { 4045 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 4046 4047 $data = array( 4048 'code' => $parsed_args['code'], 4049 'message' => $message, 4050 'data' => array( 4051 'status' => $parsed_args['response'], 4052 ), 4053 'additional_errors' => $parsed_args['additional_errors'], 4054 ); 4055 4056 if ( isset( $parsed_args['error_data'] ) ) { 4057 $data['data']['error'] = $parsed_args['error_data']; 4058 } 4059 4060 if ( ! headers_sent() ) { 4061 header( "Content-Type: application/json; charset={$parsed_args['charset']}" ); 4062 if ( null !== $parsed_args['response'] ) { 4063 status_header( $parsed_args['response'] ); 4064 } 4065 nocache_headers(); 4066 } 4067 4068 echo wp_json_encode( $data ); 4069 if ( $parsed_args['exit'] ) { 4070 die(); 4071 } 4072 } 4073 4074 /** 4075 * Kills WordPress execution and displays JSONP response with an error message. 4076 * 4077 * This is the handler for wp_die() when processing JSONP requests. 4078 * 4079 * @since 5.2.0 4080 * @access private 4081 * 4082 * @param string $message Error message. 4083 * @param string $title Optional. Error title. Default empty string. 4084 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4085 */ 4086 function _jsonp_wp_die_handler( $message, $title = '', $args = array() ) { 4087 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 4088 4089 $data = array( 4090 'code' => $parsed_args['code'], 4091 'message' => $message, 4092 'data' => array( 4093 'status' => $parsed_args['response'], 4094 ), 4095 'additional_errors' => $parsed_args['additional_errors'], 4096 ); 4097 4098 if ( isset( $parsed_args['error_data'] ) ) { 4099 $data['data']['error'] = $parsed_args['error_data']; 4100 } 4101 4102 if ( ! headers_sent() ) { 4103 header( "Content-Type: application/javascript; charset={$parsed_args['charset']}" ); 4104 header( 'X-Content-Type-Options: nosniff' ); 4105 header( 'X-Robots-Tag: noindex' ); 4106 if ( null !== $parsed_args['response'] ) { 4107 status_header( $parsed_args['response'] ); 4108 } 4109 nocache_headers(); 4110 } 4111 4112 $result = wp_json_encode( $data ); 4113 $jsonp_callback = $_GET['_jsonp']; 4114 echo '/**/' . $jsonp_callback . '(' . $result . ')'; 4115 if ( $parsed_args['exit'] ) { 4116 die(); 4117 } 4118 } 4119 4120 /** 4121 * Kills WordPress execution and displays XML response with an error message. 4122 * 4123 * This is the handler for wp_die() when processing XMLRPC requests. 4124 * 4125 * @since 3.2.0 4126 * @access private 4127 * 4128 * @global wp_xmlrpc_server $wp_xmlrpc_server 4129 * 4130 * @param string $message Error message. 4131 * @param string $title Optional. Error title. Default empty string. 4132 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4133 */ 4134 function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) { 4135 global $wp_xmlrpc_server; 4136 4137 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 4138 4139 if ( ! headers_sent() ) { 4140 nocache_headers(); 4141 } 4142 4143 if ( $wp_xmlrpc_server ) { 4144 $error = new IXR_Error( $parsed_args['response'], $message ); 4145 $wp_xmlrpc_server->output( $error->getXml() ); 4146 } 4147 if ( $parsed_args['exit'] ) { 4148 die(); 4149 } 4150 } 4151 4152 /** 4153 * Kills WordPress execution and displays XML response with an error message. 4154 * 4155 * This is the handler for wp_die() when processing XML requests. 4156 * 4157 * @since 5.2.0 4158 * @access private 4159 * 4160 * @param string $message Error message. 4161 * @param string $title Optional. Error title. Default empty string. 4162 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4163 */ 4164 function _xml_wp_die_handler( $message, $title = '', $args = array() ) { 4165 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 4166 4167 $message = htmlspecialchars( $message ); 4168 $title = htmlspecialchars( $title ); 4169 4170 $xml = <<<EOD 4171 <error> 4172 <code>{$parsed_args['code']}</code> 4173 <title><![CDATA[{$title}]]></title> 4174 <message><![CDATA[{$message}]]></message> 4175 <data> 4176 <status>{$parsed_args['response']}</status> 4177 </data> 4178 </error> 4179 4180 EOD; 4181 4182 if ( ! headers_sent() ) { 4183 header( "Content-Type: text/xml; charset={$parsed_args['charset']}" ); 4184 if ( null !== $parsed_args['response'] ) { 4185 status_header( $parsed_args['response'] ); 4186 } 4187 nocache_headers(); 4188 } 4189 4190 echo $xml; 4191 if ( $parsed_args['exit'] ) { 4192 die(); 4193 } 4194 } 4195 4196 /** 4197 * Kills WordPress execution and displays an error message. 4198 * 4199 * This is the handler for wp_die() when processing APP requests. 4200 * 4201 * @since 3.4.0 4202 * @since 5.1.0 Added the $title and $args parameters. 4203 * @access private 4204 * 4205 * @param string $message Optional. Response to print. Default empty string. 4206 * @param string $title Optional. Error title (unused). Default empty string. 4207 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4208 */ 4209 function _scalar_wp_die_handler( $message = '', $title = '', $args = array() ) { 4210 list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args ); 4211 4212 if ( $parsed_args['exit'] ) { 4213 if ( is_scalar( $message ) ) { 4214 die( (string) $message ); 4215 } 4216 die(); 4217 } 4218 4219 if ( is_scalar( $message ) ) { 4220 echo (string) $message; 4221 } 4222 } 4223 4224 /** 4225 * Processes arguments passed to wp_die() consistently for its handlers. 4226 * 4227 * @since 5.1.0 4228 * @access private 4229 * 4230 * @param string|WP_Error $message Error message or WP_Error object. 4231 * @param string $title Optional. Error title. Default empty string. 4232 * @param string|array $args Optional. Arguments to control behavior. Default empty array. 4233 * @return array { 4234 * Processed arguments. 4235 * 4236 * @type string $0 Error message. 4237 * @type string $1 Error title. 4238 * @type array $2 Arguments to control behavior. 4239 * } 4240 */ 4241 function _wp_die_process_input( $message, $title = '', $args = array() ) { 4242 $defaults = array( 4243 'response' => 0, 4244 'code' => '', 4245 'exit' => true, 4246 'back_link' => false, 4247 'link_url' => '', 4248 'link_text' => '', 4249 'text_direction' => '', 4250 'charset' => 'utf-8', 4251 'additional_errors' => array(), 4252 ); 4253 4254 $args = wp_parse_args( $args, $defaults ); 4255 4256 if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) { 4257 if ( ! empty( $message->errors ) ) { 4258 $errors = array(); 4259 foreach ( (array) $message->errors as $error_code => $error_messages ) { 4260 foreach ( (array) $error_messages as $error_message ) { 4261 $errors[] = array( 4262 'code' => $error_code, 4263 'message' => $error_message, 4264 'data' => $message->get_error_data( $error_code ), 4265 ); 4266 } 4267 } 4268 4269 $message = $errors[0]['message']; 4270 if ( empty( $args['code'] ) ) { 4271 $args['code'] = $errors[0]['code']; 4272 } 4273 if ( empty( $args['response'] ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['status'] ) ) { 4274 $args['response'] = $errors[0]['data']['status']; 4275 } 4276 if ( empty( $title ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['title'] ) ) { 4277 $title = $errors[0]['data']['title']; 4278 } 4279 if ( WP_DEBUG_DISPLAY && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['error'] ) ) { 4280 $args['error_data'] = $errors[0]['data']['error']; 4281 } 4282 4283 unset( $errors[0] ); 4284 $args['additional_errors'] = array_values( $errors ); 4285 } else { 4286 $message = ''; 4287 } 4288 } 4289 4290 $have_gettext = function_exists( '__' ); 4291 4292 // The $title and these specific $args must always have a non-empty value. 4293 if ( empty( $args['code'] ) ) { 4294 $args['code'] = 'wp_die'; 4295 } 4296 if ( empty( $args['response'] ) ) { 4297 $args['response'] = 500; 4298 } 4299 if ( empty( $title ) ) { 4300 $title = $have_gettext ? __( 'WordPress › Error' ) : 'WordPress › Error'; 4301 } 4302 if ( empty( $args['text_direction'] ) || ! in_array( $args['text_direction'], array( 'ltr', 'rtl' ), true ) ) { 4303 $args['text_direction'] = 'ltr'; 4304 if ( function_exists( 'is_rtl' ) && is_rtl() ) { 4305 $args['text_direction'] = 'rtl'; 4306 } 4307 } 4308 4309 if ( ! empty( $args['charset'] ) ) { 4310 $args['charset'] = _canonical_charset( $args['charset'] ); 4311 } 4312 4313 return array( $message, $title, $args ); 4314 } 4315 4316 /** 4317 * Encodes a variable into JSON, with some confidence checks. 4318 * 4319 * @since 4.1.0 4320 * @since 5.3.0 No longer handles support for PHP < 5.6. 4321 * @since 6.5.0 The `$data` parameter has been renamed to `$value` and 4322 * the `$options` parameter to `$flags` for parity with PHP. 4323 * 4324 * @param mixed $value Variable (usually an array or object) to encode as JSON. 4325 * @param int $flags Optional. Options to be passed to json_encode(). Default 0. 4326 * @param int $depth Optional. Maximum depth to walk through $value. Must be 4327 * greater than 0. Default 512. 4328 * @return string|false The JSON encoded string, or false if it cannot be encoded. 4329 */ 4330 function wp_json_encode( $value, $flags = 0, $depth = 512 ) { 4331 $json = json_encode( $value, $flags, $depth ); 4332 4333 // If json_encode() was successful, no need to do more confidence checking. 4334 if ( false !== $json ) { 4335 return $json; 4336 } 4337 4338 try { 4339 $value = _wp_json_sanity_check( $value, $depth ); 4340 } catch ( Exception $e ) { 4341 return false; 4342 } 4343 4344 return json_encode( $value, $flags, $depth ); 4345 } 4346 4347 /** 4348 * Performs confidence checks on data that shall be encoded to JSON. 4349 * 4350 * @ignore 4351 * @since 4.1.0 4352 * @access private 4353 * 4354 * @see wp_json_encode() 4355 * 4356 * @throws Exception If depth limit is reached. 4357 * 4358 * @param mixed $value Variable (usually an array or object) to encode as JSON. 4359 * @param int $depth Maximum depth to walk through $value. Must be greater than 0. 4360 * @return mixed The sanitized data that shall be encoded to JSON. 4361 */ 4362 function _wp_json_sanity_check( $value, $depth ) { 4363 if ( $depth < 0 ) { 4364 throw new Exception( 'Reached depth limit' ); 4365 } 4366 4367 if ( is_array( $value ) ) { 4368 $output = array(); 4369 foreach ( $value as $id => $el ) { 4370 // Don't forget to sanitize the ID! 4371 if ( is_string( $id ) ) { 4372 $clean_id = _wp_json_convert_string( $id ); 4373 } else { 4374 $clean_id = $id; 4375 } 4376 4377 // Check the element type, so that we're only recursing if we really have to. 4378 if ( is_array( $el ) || is_object( $el ) ) { 4379 $output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 ); 4380 } elseif ( is_string( $el ) ) { 4381 $output[ $clean_id ] = _wp_json_convert_string( $el ); 4382 } else { 4383 $output[ $clean_id ] = $el; 4384 } 4385 } 4386 } elseif ( is_object( $value ) ) { 4387 $output = new stdClass(); 4388 foreach ( $value as $id => $el ) { 4389 if ( is_string( $id ) ) { 4390 $clean_id = _wp_json_convert_string( $id ); 4391 } else { 4392 $clean_id = $id; 4393 } 4394 4395 if ( is_array( $el ) || is_object( $el ) ) { 4396 $output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 ); 4397 } elseif ( is_string( $el ) ) { 4398 $output->$clean_id = _wp_json_convert_string( $el ); 4399 } else { 4400 $output->$clean_id = $el; 4401 } 4402 } 4403 } elseif ( is_string( $value ) ) { 4404 return _wp_json_convert_string( $value ); 4405 } else { 4406 return $value; 4407 } 4408 4409 return $output; 4410 } 4411 4412 /** 4413 * Converts a string to UTF-8, so that it can be safely encoded to JSON. 4414 * 4415 * @ignore 4416 * @since 4.1.0 4417 * @access private 4418 * 4419 * @see _wp_json_sanity_check() 4420 * 4421 * @param string $input_string The string which is to be converted. 4422 * @return string The checked string. 4423 */ 4424 function _wp_json_convert_string( $input_string ) { 4425 static $use_mb = null; 4426 if ( is_null( $use_mb ) ) { 4427 $use_mb = function_exists( 'mb_convert_encoding' ); 4428 } 4429 4430 if ( $use_mb ) { 4431 $encoding = mb_detect_encoding( $input_string, mb_detect_order(), true ); 4432 if ( $encoding ) { 4433 return mb_convert_encoding( $input_string, 'UTF-8', $encoding ); 4434 } else { 4435 return mb_convert_encoding( $input_string, 'UTF-8', 'UTF-8' ); 4436 } 4437 } else { 4438 return wp_check_invalid_utf8( $input_string, true ); 4439 } 4440 } 4441 4442 /** 4443 * Prepares response data to be serialized to JSON. 4444 * 4445 * This supports the JsonSerializable interface for PHP 5.2-5.3 as well. 4446 * 4447 * @ignore 4448 * @since 4.4.0 4449 * @deprecated 5.3.0 This function is no longer needed as support for PHP 5.2-5.3 4450 * has been dropped. 4451 * @access private 4452 * 4453 * @param mixed $value Native representation. 4454 * @return bool|int|float|null|string|array Data ready for `json_encode()`. 4455 */ 4456 function _wp_json_prepare_data( $value ) { 4457 _deprecated_function( __FUNCTION__, '5.3.0' ); 4458 return $value; 4459 } 4460 4461 /** 4462 * Sends a JSON response back to an Ajax request. 4463 * 4464 * @since 3.5.0 4465 * @since 4.7.0 The `$status_code` parameter was added. 4466 * @since 5.6.0 The `$flags` parameter was added. 4467 * 4468 * @param mixed $response Variable (usually an array or object) to encode as JSON, 4469 * then print and die. 4470 * @param int $status_code Optional. The HTTP status code to output. Default null. 4471 * @param int $flags Optional. Options to be passed to json_encode(). Default 0. 4472 */ 4473 function wp_send_json( $response, $status_code = null, $flags = 0 ) { 4474 if ( wp_is_serving_rest_request() ) { 4475 _doing_it_wrong( 4476 __FUNCTION__, 4477 sprintf( 4478 /* translators: 1: WP_REST_Response, 2: WP_Error */ 4479 __( 'Return a %1$s or %2$s object from your callback when using the REST API.' ), 4480 'WP_REST_Response', 4481 'WP_Error' 4482 ), 4483 '5.5.0' 4484 ); 4485 } 4486 4487 if ( ! headers_sent() ) { 4488 header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) ); 4489 if ( null !== $status_code ) { 4490 status_header( $status_code ); 4491 } 4492 } 4493 4494 echo wp_json_encode( $response, $flags ); 4495 4496 if ( wp_doing_ajax() ) { 4497 wp_die( 4498 '', 4499 '', 4500 array( 4501 'response' => null, 4502 ) 4503 ); 4504 } else { 4505 die; 4506 } 4507 } 4508 4509 /** 4510 * Sends a JSON response back to an Ajax request, indicating success. 4511 * 4512 * @since 3.5.0 4513 * @since 4.7.0 The `$status_code` parameter was added. 4514 * @since 5.6.0 The `$flags` parameter was added. 4515 * 4516 * @param mixed $value Optional. Data to encode as JSON, then print and die. Default null. 4517 * @param int $status_code Optional. The HTTP status code to output. Default null. 4518 * @param int $flags Optional. Options to be passed to json_encode(). Default 0. 4519 */ 4520 function wp_send_json_success( $value = null, $status_code = null, $flags = 0 ) { 4521 $response = array( 'success' => true ); 4522 4523 if ( isset( $value ) ) { 4524 $response['data'] = $value; 4525 } 4526 4527 wp_send_json( $response, $status_code, $flags ); 4528 } 4529 4530 /** 4531 * Sends a JSON response back to an Ajax request, indicating failure. 4532 * 4533 * If the `$value` parameter is a WP_Error object, the errors 4534 * within the object are processed and output as an array of error 4535 * codes and corresponding messages. All other types are output 4536 * without further processing. 4537 * 4538 * @since 3.5.0 4539 * @since 4.1.0 The `$value` parameter is now processed if a WP_Error object is passed in. 4540 * @since 4.7.0 The `$status_code` parameter was added. 4541 * @since 5.6.0 The `$flags` parameter was added. 4542 * 4543 * @param mixed $value Optional. Data to encode as JSON, then print and die. Default null. 4544 * @param int $status_code Optional. The HTTP status code to output. Default null. 4545 * @param int $flags Optional. Options to be passed to json_encode(). Default 0. 4546 */ 4547 function wp_send_json_error( $value = null, $status_code = null, $flags = 0 ) { 4548 $response = array( 'success' => false ); 4549 4550 if ( isset( $value ) ) { 4551 if ( is_wp_error( $value ) ) { 4552 $result = array(); 4553 foreach ( $value->errors as $code => $messages ) { 4554 foreach ( $messages as $message ) { 4555 $result[] = array( 4556 'code' => $code, 4557 'message' => $message, 4558 ); 4559 } 4560 } 4561 4562 $response['data'] = $result; 4563 } else { 4564 $response['data'] = $value; 4565 } 4566 } 4567 4568 wp_send_json( $response, $status_code, $flags ); 4569 } 4570 4571 /** 4572 * Checks that a JSONP callback is a valid JavaScript callback name. 4573 * 4574 * Only allows alphanumeric characters and the dot character in callback 4575 * function names. This helps to mitigate XSS attacks caused by directly 4576 * outputting user input. 4577 * 4578 * @since 4.6.0 4579 * 4580 * @param string $callback Supplied JSONP callback function name. 4581 * @return bool Whether the callback function name is valid. 4582 */ 4583 function wp_check_jsonp_callback( $callback ) { 4584 if ( ! is_string( $callback ) ) { 4585 return false; 4586 } 4587 4588 preg_replace( '/[^\w\.]/', '', $callback, -1, $illegal_char_count ); 4589 4590 return 0 === $illegal_char_count; 4591 } 4592 4593 /** 4594 * Reads and decodes a JSON file. 4595 * 4596 * @since 5.9.0 4597 * 4598 * @param string $filename Path to the JSON file. 4599 * @param array $options { 4600 * Optional. Options to be used with `json_decode()`. 4601 * 4602 * @type bool $associative Optional. When `true`, JSON objects will be returned as associative arrays. 4603 * When `false`, JSON objects will be returned as objects. Default false. 4604 * } 4605 * 4606 * @return mixed Returns the value encoded in JSON in appropriate PHP type. 4607 * `null` is returned if the file is not found, or its content can't be decoded. 4608 */ 4609 function wp_json_file_decode( $filename, $options = array() ) { 4610 $result = null; 4611 $filename = wp_normalize_path( realpath( $filename ) ); 4612 4613 if ( ! $filename ) { 4614 trigger_error( 4615 sprintf( 4616 /* translators: %s: Path to the JSON file. */ 4617 __( "File %s doesn't exist!" ), 4618 $filename 4619 ) 4620 ); 4621 return $result; 4622 } 4623 4624 $options = wp_parse_args( $options, array( 'associative' => false ) ); 4625 $decoded_file = json_decode( file_get_contents( $filename ), $options['associative'] ); 4626 4627 if ( JSON_ERROR_NONE !== json_last_error() ) { 4628 trigger_error( 4629 sprintf( 4630 /* translators: 1: Path to the JSON file, 2: Error message. */ 4631 __( 'Error when decoding a JSON file at path %1$s: %2$s' ), 4632 $filename, 4633 json_last_error_msg() 4634 ) 4635 ); 4636 return $result; 4637 } 4638 4639 return $decoded_file; 4640 } 4641 4642 /** 4643 * Retrieves the WordPress home page URL. 4644 * 4645 * If the constant named 'WP_HOME' exists, then it will be used and returned 4646 * by the function. This can be used to counter the redirection on your local 4647 * development environment. 4648 * 4649 * @since 2.2.0 4650 * @access private 4651 * 4652 * @see WP_HOME 4653 * 4654 * @param string $url URL for the home location. 4655 * @return string Homepage location. 4656 */ 4657 function _config_wp_home( $url = '' ) { 4658 if ( defined( 'WP_HOME' ) ) { 4659 return untrailingslashit( WP_HOME ); 4660 } 4661 return $url; 4662 } 4663 4664 /** 4665 * Retrieves the WordPress site URL. 4666 * 4667 * If the constant named 'WP_SITEURL' is defined, then the value in that 4668 * constant will always be returned. This can be used for debugging a site 4669 * on your localhost while not having to change the database to your URL. 4670 * 4671 * @since 2.2.0 4672 * @access private 4673 * 4674 * @see WP_SITEURL 4675 * 4676 * @param string $url URL to set the WordPress site location. 4677 * @return string The WordPress site URL. 4678 */ 4679 function _config_wp_siteurl( $url = '' ) { 4680 if ( defined( 'WP_SITEURL' ) ) { 4681 return untrailingslashit( WP_SITEURL ); 4682 } 4683 return $url; 4684 } 4685 4686 /** 4687 * Deletes the fresh site option. 4688 * 4689 * @since 4.7.0 4690 * @access private 4691 */ 4692 function _delete_option_fresh_site() { 4693 update_option( 'fresh_site', '0' ); 4694 } 4695 4696 /** 4697 * Sets the localized direction for MCE plugin. 4698 * 4699 * Will only set the direction to 'rtl', if the WordPress locale has 4700 * the text direction set to 'rtl'. 4701 * 4702 * Fills in the 'directionality' setting, enables the 'directionality' 4703 * plugin, and adds the 'ltr' button to 'toolbar1', formerly 4704 * 'theme_advanced_buttons1' array keys. These keys are then returned 4705 * in the $mce_init (TinyMCE settings) array. 4706 * 4707 * @since 2.1.0 4708 * @access private 4709 * 4710 * @param array $mce_init MCE settings array. 4711 * @return array Direction set for 'rtl', if needed by locale. 4712 */ 4713 function _mce_set_direction( $mce_init ) { 4714 if ( is_rtl() ) { 4715 $mce_init['directionality'] = 'rtl'; 4716 $mce_init['rtl_ui'] = true; 4717 4718 if ( ! empty( $mce_init['plugins'] ) && ! str_contains( $mce_init['plugins'], 'directionality' ) ) { 4719 $mce_init['plugins'] .= ',directionality'; 4720 } 4721 4722 if ( ! empty( $mce_init['toolbar1'] ) && ! preg_match( '/\bltr\b/', $mce_init['toolbar1'] ) ) { 4723 $mce_init['toolbar1'] .= ',ltr'; 4724 } 4725 } 4726 4727 return $mce_init; 4728 } 4729 4730 /** 4731 * Determines whether WordPress is currently serving a REST API request. 4732 * 4733 * The function relies on the 'REST_REQUEST' global. As such, it only returns true when an actual REST _request_ is 4734 * being made. It does not return true when a REST endpoint is hit as part of another request, e.g. for preloading a 4735 * REST response. See {@see wp_is_rest_endpoint()} for that purpose. 4736 * 4737 * This function should not be called until the {@see 'parse_request'} action, as the constant is only defined then, 4738 * even for an actual REST request. 4739 * 4740 * @since 6.5.0 4741 * 4742 * @return bool True if it's a WordPress REST API request, false otherwise. 4743 */ 4744 function wp_is_serving_rest_request() { 4745 return defined( 'REST_REQUEST' ) && REST_REQUEST; 4746 } 4747 4748 /** 4749 * Converts smiley code to the icon graphic file equivalent. 4750 * 4751 * You can turn off smilies, by going to the write setting screen and unchecking 4752 * the box, or by setting 'use_smilies' option to false or removing the option. 4753 * 4754 * Plugins may override the default smiley list by setting the $wpsmiliestrans 4755 * to an array, with the key the code the blogger types in and the value the 4756 * image file. 4757 * 4758 * The $wp_smiliessearch global is for the regular expression and is set each 4759 * time the function is called. 4760 * 4761 * The full list of smilies can be found in the function and won't be listed in 4762 * the description. Probably should create a Codex page for it, so that it is 4763 * available. 4764 * 4765 * @global array $wpsmiliestrans 4766 * @global array $wp_smiliessearch 4767 * 4768 * @since 2.2.0 4769 */ 4770 function smilies_init() { 4771 global $wpsmiliestrans, $wp_smiliessearch; 4772 4773 // Don't bother setting up smilies if they are disabled. 4774 if ( ! get_option( 'use_smilies' ) ) { 4775 return; 4776 } 4777 4778 if ( ! isset( $wpsmiliestrans ) ) { 4779 $wpsmiliestrans = array( 4780 ':mrgreen:' => 'mrgreen.png', 4781 ':neutral:' => "\xf0\x9f\x98\x90", 4782 ':twisted:' => "\xf0\x9f\x98\x88", 4783 ':arrow:' => "\xe2\x9e\xa1", 4784 ':shock:' => "\xf0\x9f\x98\xaf", 4785 ':smile:' => "\xf0\x9f\x99\x82", 4786 ':???:' => "\xf0\x9f\x98\x95", 4787 ':cool:' => "\xf0\x9f\x98\x8e", 4788 ':evil:' => "\xf0\x9f\x91\xbf", 4789 ':grin:' => "\xf0\x9f\x98\x80", 4790 ':idea:' => "\xf0\x9f\x92\xa1", 4791 ':oops:' => "\xf0\x9f\x98\xb3", 4792 ':razz:' => "\xf0\x9f\x98\x9b", 4793 ':roll:' => "\xf0\x9f\x99\x84", 4794 ':wink:' => "\xf0\x9f\x98\x89", 4795 ':cry:' => "\xf0\x9f\x98\xa5", 4796 ':eek:' => "\xf0\x9f\x98\xae", 4797 ':lol:' => "\xf0\x9f\x98\x86", 4798 ':mad:' => "\xf0\x9f\x98\xa1", 4799 ':sad:' => "\xf0\x9f\x99\x81", 4800 '8-)' => "\xf0\x9f\x98\x8e", 4801 '8-O' => "\xf0\x9f\x98\xaf", 4802 ':-(' => "\xf0\x9f\x99\x81", 4803 ':-)' => "\xf0\x9f\x99\x82", 4804 ':-?' => "\xf0\x9f\x98\x95", 4805 ':-D' => "\xf0\x9f\x98\x80", 4806 ':-P' => "\xf0\x9f\x98\x9b", 4807 ':-o' => "\xf0\x9f\x98\xae", 4808 ':-x' => "\xf0\x9f\x98\xa1", 4809 ':-|' => "\xf0\x9f\x98\x90", 4810 ';-)' => "\xf0\x9f\x98\x89", 4811 // This one transformation breaks regular text with frequency. 4812 // '8)' => "\xf0\x9f\x98\x8e", 4813 '8O' => "\xf0\x9f\x98\xaf", 4814 ':(' => "\xf0\x9f\x99\x81", 4815 ':)' => "\xf0\x9f\x99\x82", 4816 ':?' => "\xf0\x9f\x98\x95", 4817 ':D' => "\xf0\x9f\x98\x80", 4818 ':P' => "\xf0\x9f\x98\x9b", 4819 ':o' => "\xf0\x9f\x98\xae", 4820 ':x' => "\xf0\x9f\x98\xa1", 4821 ':|' => "\xf0\x9f\x98\x90", 4822 ';)' => "\xf0\x9f\x98\x89", 4823 ':!:' => "\xe2\x9d\x97", 4824 ':?:' => "\xe2\x9d\x93", 4825 ); 4826 } 4827 4828 /** 4829 * Filters all the smilies. 4830 * 4831 * This filter must be added before `smilies_init` is run, as 4832 * it is normally only run once to setup the smilies regex. 4833 * 4834 * @since 4.7.0 4835 * 4836 * @param string[] $wpsmiliestrans List of the smilies' hexadecimal representations, keyed by their smily code. 4837 */ 4838 $wpsmiliestrans = apply_filters( 'smilies', $wpsmiliestrans ); 4839 4840 if ( count( $wpsmiliestrans ) === 0 ) { 4841 return; 4842 } 4843 4844 /* 4845 * NOTE: we sort the smilies in reverse key order. This is to make sure 4846 * we match the longest possible smilie (:???: vs :?) as the regular 4847 * expression used below is first-match 4848 */ 4849 krsort( $wpsmiliestrans ); 4850 4851 $spaces = wp_spaces_regexp(); 4852 4853 // Begin first "subpattern". 4854 $wp_smiliessearch = '/(?<=' . $spaces . '|^)'; 4855 4856 $subchar = ''; 4857 foreach ( (array) $wpsmiliestrans as $smiley => $img ) { 4858 $firstchar = substr( $smiley, 0, 1 ); 4859 $rest = substr( $smiley, 1 ); 4860 4861 // New subpattern? 4862 if ( $firstchar !== $subchar ) { 4863 if ( '' !== $subchar ) { 4864 $wp_smiliessearch .= ')(?=' . $spaces . '|$)'; // End previous "subpattern". 4865 $wp_smiliessearch .= '|(?<=' . $spaces . '|^)'; // Begin another "subpattern". 4866 } 4867 4868 $subchar = $firstchar; 4869 $wp_smiliessearch .= preg_quote( $firstchar, '/' ) . '(?:'; 4870 } else { 4871 $wp_smiliessearch .= '|'; 4872 } 4873 4874 $wp_smiliessearch .= preg_quote( $rest, '/' ); 4875 } 4876 4877 $wp_smiliessearch .= ')(?=' . $spaces . '|$)/m'; 4878 } 4879 4880 /** 4881 * Merges user defined arguments into defaults array. 4882 * 4883 * This function is used throughout WordPress to allow for both string or array 4884 * to be merged into another array. 4885 * 4886 * @since 2.2.0 4887 * @since 2.3.0 `$args` can now also be an object. 4888 * 4889 * @param string|array|object $args Value to merge with $defaults. 4890 * @param array $defaults Optional. Array that serves as the defaults. 4891 * Default empty array. 4892 * @return array Merged user defined values with defaults. 4893 */ 4894 function wp_parse_args( $args, $defaults = array() ) { 4895 if ( is_object( $args ) ) { 4896 $parsed_args = get_object_vars( $args ); 4897 } elseif ( is_array( $args ) ) { 4898 $parsed_args =& $args; 4899 } else { 4900 wp_parse_str( $args, $parsed_args ); 4901 } 4902 4903 if ( is_array( $defaults ) && $defaults ) { 4904 return array_merge( $defaults, $parsed_args ); 4905 } 4906 return $parsed_args; 4907 } 4908 4909 /** 4910 * Converts a comma- or space-separated list of scalar values to an array. 4911 * 4912 * @since 5.1.0 4913 * 4914 * @param array|string $input_list List of values. 4915 * @return array Array of values. 4916 */ 4917 function wp_parse_list( $input_list ) { 4918 if ( ! is_array( $input_list ) ) { 4919 return preg_split( '/[\s,]+/', $input_list, -1, PREG_SPLIT_NO_EMPTY ); 4920 } 4921 4922 // Validate all entries of the list are scalar. 4923 $input_list = array_filter( $input_list, 'is_scalar' ); 4924 4925 return $input_list; 4926 } 4927 4928 /** 4929 * Cleans up an array, comma- or space-separated list of IDs. 4930 * 4931 * @since 3.0.0 4932 * @since 5.1.0 Refactored to use wp_parse_list(). 4933 * 4934 * @param array|string $input_list List of IDs. 4935 * @return int[] Sanitized array of IDs. 4936 */ 4937 function wp_parse_id_list( $input_list ) { 4938 $input_list = wp_parse_list( $input_list ); 4939 4940 return array_unique( array_map( 'absint', $input_list ) ); 4941 } 4942 4943 /** 4944 * Cleans up an array, comma- or space-separated list of slugs. 4945 * 4946 * @since 4.7.0 4947 * @since 5.1.0 Refactored to use wp_parse_list(). 4948 * 4949 * @param array|string $input_list List of slugs. 4950 * @return string[] Sanitized array of slugs. 4951 */ 4952 function wp_parse_slug_list( $input_list ) { 4953 $input_list = wp_parse_list( $input_list ); 4954 4955 return array_unique( array_map( 'sanitize_title', $input_list ) ); 4956 } 4957 4958 /** 4959 * Extracts a slice of an array, given a list of keys. 4960 * 4961 * @since 3.1.0 4962 * 4963 * @param array $input_array The original array. 4964 * @param array $keys The list of keys. 4965 * @return array The array slice. 4966 */ 4967 function wp_array_slice_assoc( $input_array, $keys ) { 4968 $slice = array(); 4969 4970 foreach ( $keys as $key ) { 4971 if ( isset( $input_array[ $key ] ) ) { 4972 $slice[ $key ] = $input_array[ $key ]; 4973 } 4974 } 4975 4976 return $slice; 4977 } 4978 4979 /** 4980 * Sorts the keys of an array alphabetically. 4981 * 4982 * The array is passed by reference so it doesn't get returned 4983 * which mimics the behavior of `ksort()`. 4984 * 4985 * @since 6.0.0 4986 * 4987 * @param array $input_array The array to sort, passed by reference. 4988 */ 4989 function wp_recursive_ksort( &$input_array ) { 4990 foreach ( $input_array as &$value ) { 4991 if ( is_array( $value ) ) { 4992 wp_recursive_ksort( $value ); 4993 } 4994 } 4995 4996 ksort( $input_array ); 4997 } 4998 4999 /** 5000 * Accesses an array in depth based on a path of keys. 5001 * 5002 * It is the PHP equivalent of JavaScript's `lodash.get()` and mirroring it may help other components 5003 * retain some symmetry between client and server implementations. 5004 * 5005 * Example usage: 5006 * 5007 * $input_array = array( 5008 * 'a' => array( 5009 * 'b' => array( 5010 * 'c' => 1, 5011 * ), 5012 * ), 5013 * ); 5014 * _wp_array_get( $input_array, array( 'a', 'b', 'c' ) ); 5015 * 5016 * @internal 5017 * 5018 * @since 5.6.0 5019 * @access private 5020 * 5021 * @param array $input_array An array from which we want to retrieve some information. 5022 * @param array $path An array of keys describing the path with which to retrieve information. 5023 * @param mixed $default_value Optional. The return value if the path does not exist within the array, 5024 * or if `$input_array` or `$path` are not arrays. Default null. 5025 * @return mixed The value from the path specified. 5026 */ 5027 function _wp_array_get( $input_array, $path, $default_value = null ) { 5028 // Confirm $path is valid. 5029 if ( ! is_array( $path ) || 0 === count( $path ) ) { 5030 return $default_value; 5031 } 5032 5033 foreach ( $path as $path_element ) { 5034 if ( ! is_array( $input_array ) ) { 5035 return $default_value; 5036 } 5037 5038 if ( is_string( $path_element ) 5039 || is_integer( $path_element ) 5040 || null === $path_element 5041 ) { 5042 /* 5043 * Check if the path element exists in the input array. 5044 * We check with `isset()` first, as it is a lot faster 5045 * than `array_key_exists()`. 5046 */ 5047 if ( isset( $input_array[ $path_element ] ) ) { 5048 $input_array = $input_array[ $path_element ]; 5049 continue; 5050 } 5051 5052 /* 5053 * If `isset()` returns false, we check with `array_key_exists()`, 5054 * which also checks for `null` values. 5055 */ 5056 if ( array_key_exists( $path_element, $input_array ) ) { 5057 $input_array = $input_array[ $path_element ]; 5058 continue; 5059 } 5060 } 5061 5062 return $default_value; 5063 } 5064 5065 return $input_array; 5066 } 5067 5068 /** 5069 * Sets an array in depth based on a path of keys. 5070 * 5071 * It is the PHP equivalent of JavaScript's `lodash.set()` and mirroring it may help other components 5072 * retain some symmetry between client and server implementations. 5073 * 5074 * Example usage: 5075 * 5076 * $input_array = array(); 5077 * _wp_array_set( $input_array, array( 'a', 'b', 'c', 1 ) ); 5078 * 5079 * $input_array becomes: 5080 * array( 5081 * 'a' => array( 5082 * 'b' => array( 5083 * 'c' => 1, 5084 * ), 5085 * ), 5086 * ); 5087 * 5088 * @internal 5089 * 5090 * @since 5.8.0 5091 * @access private 5092 * 5093 * @param array $input_array An array that we want to mutate to include a specific value in a path. 5094 * @param array $path An array of keys describing the path that we want to mutate. 5095 * @param mixed $value The value that will be set. 5096 */ 5097 function _wp_array_set( &$input_array, $path, $value = null ) { 5098 // Confirm $input_array is valid. 5099 if ( ! is_array( $input_array ) ) { 5100 return; 5101 } 5102 5103 // Confirm $path is valid. 5104 if ( ! is_array( $path ) ) { 5105 return; 5106 } 5107 5108 $path_length = count( $path ); 5109 5110 if ( 0 === $path_length ) { 5111 return; 5112 } 5113 5114 foreach ( $path as $path_element ) { 5115 if ( 5116 ! is_string( $path_element ) && ! is_integer( $path_element ) && 5117 ! is_null( $path_element ) 5118 ) { 5119 return; 5120 } 5121 } 5122 5123 for ( $i = 0; $i < $path_length - 1; ++$i ) { 5124 $path_element = $path[ $i ]; 5125 if ( 5126 ! array_key_exists( $path_element, $input_array ) || 5127 ! is_array( $input_array[ $path_element ] ) 5128 ) { 5129 $input_array[ $path_element ] = array(); 5130 } 5131 $input_array = &$input_array[ $path_element ]; 5132 } 5133 5134 $input_array[ $path[ $i ] ] = $value; 5135 } 5136 5137 /** 5138 * This function is trying to replicate what 5139 * lodash's kebabCase (JS library) does in the client. 5140 * 5141 * The reason we need this function is that we do some processing 5142 * in both the client and the server (e.g.: we generate 5143 * preset classes from preset slugs) that needs to 5144 * create the same output. 5145 * 5146 * We can't remove or update the client's library due to backward compatibility 5147 * (some of the output of lodash's kebabCase is saved in the post content). 5148 * We have to make the server behave like the client. 5149 * 5150 * Changes to this function should follow updates in the client 5151 * with the same logic. 5152 * 5153 * @link https://github.com/lodash/lodash/blob/4.17/dist/lodash.js#L14369 5154 * @link https://github.com/lodash/lodash/blob/4.17/dist/lodash.js#L278 5155 * @link https://github.com/lodash-php/lodash-php/blob/master/src/String/kebabCase.php 5156 * @link https://github.com/lodash-php/lodash-php/blob/master/src/internal/unicodeWords.php 5157 * 5158 * @param string $input_string The string to kebab-case. 5159 * 5160 * @return string kebab-cased-string. 5161 */ 5162 function _wp_to_kebab_case( $input_string ) { 5163 // Ignore the camelCase names for variables so the names are the same as lodash so comparing and porting new changes is easier. 5164 // phpcs:disable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase 5165 5166 /* 5167 * Some notable things we've removed compared to the lodash version are: 5168 * 5169 * - non-alphanumeric characters: rsAstralRange, rsEmoji, etc 5170 * - the groups that processed the apostrophe, as it's removed before passing the string to preg_match: rsApos, rsOptContrLower, and rsOptContrUpper 5171 * 5172 */ 5173 5174 /** Used to compose unicode character classes. */ 5175 $rsLowerRange = 'a-z\\xdf-\\xf6\\xf8-\\xff'; 5176 $rsNonCharRange = '\\x00-\\x2f\\x3a-\\x40\\x5b-\\x60\\x7b-\\xbf'; 5177 $rsPunctuationRange = '\\x{2000}-\\x{206f}'; 5178 $rsSpaceRange = ' \\t\\x0b\\f\\xa0\\x{feff}\\n\\r\\x{2028}\\x{2029}\\x{1680}\\x{180e}\\x{2000}\\x{2001}\\x{2002}\\x{2003}\\x{2004}\\x{2005}\\x{2006}\\x{2007}\\x{2008}\\x{2009}\\x{200a}\\x{202f}\\x{205f}\\x{3000}'; 5179 $rsUpperRange = 'A-Z\\xc0-\\xd6\\xd8-\\xde'; 5180 $rsBreakRange = $rsNonCharRange . $rsPunctuationRange . $rsSpaceRange; 5181 5182 /** Used to compose unicode capture groups. */ 5183 $rsBreak = '[' . $rsBreakRange . ']'; 5184 $rsDigits = '\\d+'; // The last lodash version in GitHub uses a single digit here and expands it when in use. 5185 $rsLower = '[' . $rsLowerRange . ']'; 5186 $rsMisc = '[^' . $rsBreakRange . $rsDigits . $rsLowerRange . $rsUpperRange . ']'; 5187 $rsUpper = '[' . $rsUpperRange . ']'; 5188 5189 /** Used to compose unicode regexes. */ 5190 $rsMiscLower = '(?:' . $rsLower . '|' . $rsMisc . ')'; 5191 $rsMiscUpper = '(?:' . $rsUpper . '|' . $rsMisc . ')'; 5192 $rsOrdLower = '\\d*(?:1st|2nd|3rd|(?![123])\\dth)(?=\\b|[A-Z_])'; 5193 $rsOrdUpper = '\\d*(?:1ST|2ND|3RD|(?![123])\\dTH)(?=\\b|[a-z_])'; 5194 5195 $regexp = '/' . implode( 5196 '|', 5197 array( 5198 $rsUpper . '?' . $rsLower . '+' . '(?=' . implode( '|', array( $rsBreak, $rsUpper, '$' ) ) . ')', 5199 $rsMiscUpper . '+' . '(?=' . implode( '|', array( $rsBreak, $rsUpper . $rsMiscLower, '$' ) ) . ')', 5200 $rsUpper . '?' . $rsMiscLower . '+', 5201 $rsUpper . '+', 5202 $rsOrdUpper, 5203 $rsOrdLower, 5204 $rsDigits, 5205 ) 5206 ) . '/u'; 5207 5208 preg_match_all( $regexp, str_replace( "'", '', $input_string ), $matches ); 5209 return strtolower( implode( '-', $matches[0] ) ); 5210 // phpcs:enable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase 5211 } 5212 5213 /** 5214 * Determines if the variable is a numeric-indexed array. 5215 * 5216 * @since 4.4.0 5217 * 5218 * @param mixed $data Variable to check. 5219 * @return bool Whether the variable is a list. 5220 */ 5221 function wp_is_numeric_array( $data ) { 5222 if ( ! is_array( $data ) ) { 5223 return false; 5224 } 5225 5226 $keys = array_keys( $data ); 5227 $string_keys = array_filter( $keys, 'is_string' ); 5228 5229 return count( $string_keys ) === 0; 5230 } 5231 5232 /** 5233 * Filters a list of objects, based on a set of key => value arguments. 5234 * 5235 * Retrieves the objects from the list that match the given arguments. 5236 * Key represents property name, and value represents property value. 5237 * 5238 * If an object has more properties than those specified in arguments, 5239 * that will not disqualify it. When using the 'AND' operator, 5240 * any missing properties will disqualify it. 5241 * 5242 * When using the `$field` argument, this function can also retrieve 5243 * a particular field from all matching objects, whereas wp_list_filter() 5244 * only does the filtering. 5245 * 5246 * @since 3.0.0 5247 * @since 4.7.0 Uses `WP_List_Util` class. 5248 * 5249 * @param array $input_list An array of objects to filter. 5250 * @param array $args Optional. An array of key => value arguments to match 5251 * against each object. Default empty array. 5252 * @param string $operator Optional. The logical operation to perform. 'AND' means 5253 * all elements from the array must match. 'OR' means only 5254 * one element needs to match. 'NOT' means no elements may 5255 * match. Default 'AND'. 5256 * @param bool|string $field Optional. A field from the object to place instead 5257 * of the entire object. Default false. 5258 * @return array A list of objects or object fields. 5259 */ 5260 function wp_filter_object_list( $input_list, $args = array(), $operator = 'and', $field = false ) { 5261 if ( ! is_array( $input_list ) ) { 5262 return array(); 5263 } 5264 5265 $util = new WP_List_Util( $input_list ); 5266 5267 $util->filter( $args, $operator ); 5268 5269 if ( $field ) { 5270 $util->pluck( $field ); 5271 } 5272 5273 return $util->get_output(); 5274 } 5275 5276 /** 5277 * Filters a list of objects, based on a set of key => value arguments. 5278 * 5279 * Retrieves the objects from the list that match the given arguments. 5280 * Key represents property name, and value represents property value. 5281 * 5282 * If an object has more properties than those specified in arguments, 5283 * that will not disqualify it. When using the 'AND' operator, 5284 * any missing properties will disqualify it. 5285 * 5286 * If you want to retrieve a particular field from all matching objects, 5287 * use wp_filter_object_list() instead. 5288 * 5289 * @since 3.1.0 5290 * @since 4.7.0 Uses `WP_List_Util` class. 5291 * @since 5.9.0 Converted into a wrapper for `wp_filter_object_list()`. 5292 * 5293 * @param array $input_list An array of objects to filter. 5294 * @param array $args Optional. An array of key => value arguments to match 5295 * against each object. Default empty array. 5296 * @param string $operator Optional. The logical operation to perform. 'AND' means 5297 * all elements from the array must match. 'OR' means only 5298 * one element needs to match. 'NOT' means no elements may 5299 * match. Default 'AND'. 5300 * @return array Array of found values. 5301 */ 5302 function wp_list_filter( $input_list, $args = array(), $operator = 'AND' ) { 5303 return wp_filter_object_list( $input_list, $args, $operator ); 5304 } 5305 5306 /** 5307 * Plucks a certain field out of each object or array in an array. 5308 * 5309 * This has the same functionality and prototype of 5310 * array_column() (PHP 5.5) but also supports objects. 5311 * 5312 * @since 3.1.0 5313 * @since 4.0.0 $index_key parameter added. 5314 * @since 4.7.0 Uses `WP_List_Util` class. 5315 * 5316 * @param array $input_list List of objects or arrays. 5317 * @param int|string $field Field from the object to place instead of the entire object. 5318 * @param int|string $index_key Optional. Field from the object to use as keys for the new array. 5319 * Default null. 5320 * @return array Array of found values. If `$index_key` is set, an array of found values with keys 5321 * corresponding to `$index_key`. If `$index_key` is null, array keys from the original 5322 * `$input_list` will be preserved in the results. 5323 */ 5324 function wp_list_pluck( $input_list, $field, $index_key = null ) { 5325 if ( ! is_array( $input_list ) ) { 5326 return array(); 5327 } 5328 5329 $util = new WP_List_Util( $input_list ); 5330 5331 return $util->pluck( $field, $index_key ); 5332 } 5333 5334 /** 5335 * Sorts an array of objects or arrays based on one or more orderby arguments. 5336 * 5337 * @since 4.7.0 5338 * 5339 * @param array $input_list An array of objects or arrays to sort. 5340 * @param string|array $orderby Optional. Either the field name to order by or an array 5341 * of multiple orderby fields as `$orderby => $order`. 5342 * Default empty array. 5343 * @param string $order Optional. Either 'ASC' or 'DESC'. Only used if `$orderby` 5344 * is a string. Default 'ASC'. 5345 * @param bool $preserve_keys Optional. Whether to preserve keys. Default false. 5346 * @return array The sorted array. 5347 */ 5348 function wp_list_sort( $input_list, $orderby = array(), $order = 'ASC', $preserve_keys = false ) { 5349 if ( ! is_array( $input_list ) ) { 5350 return array(); 5351 } 5352 5353 $util = new WP_List_Util( $input_list ); 5354 5355 return $util->sort( $orderby, $order, $preserve_keys ); 5356 } 5357 5358 /** 5359 * Determines if Widgets library should be loaded. 5360 * 5361 * Checks to make sure that the widgets library hasn't already been loaded. 5362 * If it hasn't, then it will load the widgets library and run an action hook. 5363 * 5364 * @since 2.2.0 5365 */ 5366 function wp_maybe_load_widgets() { 5367 /** 5368 * Filters whether to load the Widgets library. 5369 * 5370 * Returning a falsey value from the filter will effectively short-circuit 5371 * the Widgets library from loading. 5372 * 5373 * @since 2.8.0 5374 * 5375 * @param bool $wp_maybe_load_widgets Whether to load the Widgets library. 5376 * Default true. 5377 */ 5378 if ( ! apply_filters( 'load_default_widgets', true ) ) { 5379 return; 5380 } 5381 5382 require_once ABSPATH . WPINC . '/default-widgets.php'; 5383 5384 add_action( '_admin_menu', 'wp_widgets_add_menu' ); 5385 } 5386 5387 /** 5388 * Appends the Widgets menu to the themes main menu. 5389 * 5390 * @since 2.2.0 5391 * @since 5.9.3 Don't specify menu order when the active theme is a block theme. 5392 * 5393 * @global array $submenu 5394 */ 5395 function wp_widgets_add_menu() { 5396 global $submenu; 5397 5398 if ( ! current_theme_supports( 'widgets' ) ) { 5399 return; 5400 } 5401 5402 $menu_name = __( 'Widgets' ); 5403 if ( wp_is_block_theme() || current_theme_supports( 'block-template-parts' ) ) { 5404 $submenu['themes.php'][] = array( $menu_name, 'edit_theme_options', 'widgets.php' ); 5405 } else { 5406 $submenu['themes.php'][8] = array( $menu_name, 'edit_theme_options', 'widgets.php' ); 5407 } 5408 5409 ksort( $submenu['themes.php'], SORT_NUMERIC ); 5410 } 5411 5412 /** 5413 * Flushes all output buffers for PHP 5.2. 5414 * 5415 * Make sure all output buffers are flushed before our singletons are destroyed. 5416 * 5417 * @since 2.2.0 5418 */ 5419 function wp_ob_end_flush_all() { 5420 $levels = ob_get_level(); 5421 for ( $i = 0; $i < $levels; $i++ ) { 5422 ob_end_flush(); 5423 } 5424 } 5425 5426 /** 5427 * Loads custom DB error or display WordPress DB error. 5428 * 5429 * If a file exists in the wp-content directory named db-error.php, then it will 5430 * be loaded instead of displaying the WordPress DB error. If it is not found, 5431 * then the WordPress DB error will be displayed instead. 5432 * 5433 * The WordPress DB error sets the HTTP status header to 500 to try to prevent 5434 * search engines from caching the message. Custom DB messages should do the 5435 * same. 5436 * 5437 * This function was backported to WordPress 2.3.2, but originally was added 5438 * in WordPress 2.5.0. 5439 * 5440 * @since 2.3.2 5441 * 5442 * @global wpdb $wpdb WordPress database abstraction object. 5443 */ 5444 function dead_db() { 5445 global $wpdb; 5446 5447 wp_load_translations_early(); 5448 5449 // Load custom DB error template, if present. 5450 if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) { 5451 require_once WP_CONTENT_DIR . '/db-error.php'; 5452 die(); 5453 } 5454 5455 // If installing or in the admin, provide the verbose message. 5456 if ( wp_installing() || defined( 'WP_ADMIN' ) ) { 5457 wp_die( $wpdb->error ); 5458 } 5459 5460 // Otherwise, be terse. 5461 wp_die( '<h1>' . __( 'Error establishing a database connection' ) . '</h1>', __( 'Database Error' ) ); 5462 } 5463 5464 /** 5465 * Converts a value to non-negative integer. 5466 * 5467 * @since 2.5.0 5468 * 5469 * @param mixed $maybeint Data you wish to have converted to a non-negative integer. 5470 * @return int A non-negative integer. 5471 */ 5472 function absint( $maybeint ) { 5473 return abs( (int) $maybeint ); 5474 } 5475 5476 /** 5477 * Marks a function as deprecated and inform when it has been used. 5478 * 5479 * There is a {@see 'deprecated_function_run'} hook that will be called that can be used 5480 * to get the backtrace up to what file and function called the deprecated function. 5481 * 5482 * The current behavior is to trigger a user error if `WP_DEBUG` is true. 5483 * 5484 * This function is to be used in every function that is deprecated. 5485 * 5486 * @since 2.5.0 5487 * @since 5.4.0 This function is no longer marked as "private". 5488 * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE). 5489 * 5490 * @param string $function_name The function that was called. 5491 * @param string $version The version of WordPress that deprecated the function. 5492 * @param string $replacement Optional. The function that should have been called. Default empty string. 5493 */ 5494 function _deprecated_function( $function_name, $version, $replacement = '' ) { 5495 5496 /** 5497 * Fires when a deprecated function is called. 5498 * 5499 * @since 2.5.0 5500 * 5501 * @param string $function_name The function that was called. 5502 * @param string $replacement The function that should have been called. 5503 * @param string $version The version of WordPress that deprecated the function. 5504 */ 5505 do_action( 'deprecated_function_run', $function_name, $replacement, $version ); 5506 5507 /** 5508 * Filters whether to trigger an error for deprecated functions. 5509 * 5510 * @since 2.5.0 5511 * 5512 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true. 5513 */ 5514 if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) { 5515 if ( function_exists( '__' ) ) { 5516 if ( $replacement ) { 5517 $message = sprintf( 5518 /* translators: 1: PHP function name, 2: Version number, 3: Alternative function name. */ 5519 __( 'Function %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), 5520 $function_name, 5521 $version, 5522 $replacement 5523 ); 5524 } else { 5525 $message = sprintf( 5526 /* translators: 1: PHP function name, 2: Version number. */ 5527 __( 'Function %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ), 5528 $function_name, 5529 $version 5530 ); 5531 } 5532 } else { 5533 if ( $replacement ) { 5534 $message = sprintf( 5535 'Function %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', 5536 $function_name, 5537 $version, 5538 $replacement 5539 ); 5540 } else { 5541 $message = sprintf( 5542 'Function %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', 5543 $function_name, 5544 $version 5545 ); 5546 } 5547 } 5548 5549 wp_trigger_error( '', $message, E_USER_DEPRECATED ); 5550 } 5551 } 5552 5553 /** 5554 * Marks a constructor as deprecated and informs when it has been used. 5555 * 5556 * Similar to _deprecated_function(), but with different strings. Used to 5557 * remove PHP4-style constructors. 5558 * 5559 * The current behavior is to trigger a user error if `WP_DEBUG` is true. 5560 * 5561 * This function is to be used in every PHP4-style constructor method that is deprecated. 5562 * 5563 * @since 4.3.0 5564 * @since 4.5.0 Added the `$parent_class` parameter. 5565 * @since 5.4.0 This function is no longer marked as "private". 5566 * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE). 5567 * 5568 * @param string $class_name The class containing the deprecated constructor. 5569 * @param string $version The version of WordPress that deprecated the function. 5570 * @param string $parent_class Optional. The parent class calling the deprecated constructor. 5571 * Default empty string. 5572 */ 5573 function _deprecated_constructor( $class_name, $version, $parent_class = '' ) { 5574 5575 /** 5576 * Fires when a deprecated constructor is called. 5577 * 5578 * @since 4.3.0 5579 * @since 4.5.0 Added the `$parent_class` parameter. 5580 * 5581 * @param string $class_name The class containing the deprecated constructor. 5582 * @param string $version The version of WordPress that deprecated the function. 5583 * @param string $parent_class The parent class calling the deprecated constructor. 5584 */ 5585 do_action( 'deprecated_constructor_run', $class_name, $version, $parent_class ); 5586 5587 /** 5588 * Filters whether to trigger an error for deprecated functions. 5589 * 5590 * `WP_DEBUG` must be true in addition to the filter evaluating to true. 5591 * 5592 * @since 4.3.0 5593 * 5594 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true. 5595 */ 5596 if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) { 5597 if ( function_exists( '__' ) ) { 5598 if ( $parent_class ) { 5599 $message = sprintf( 5600 /* translators: 1: PHP class name, 2: PHP parent class name, 3: Version number, 4: __construct() method. */ 5601 __( 'The called constructor method for %1$s class in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.' ), 5602 $class_name, 5603 $parent_class, 5604 $version, 5605 '<code>__construct()</code>' 5606 ); 5607 } else { 5608 $message = sprintf( 5609 /* translators: 1: PHP class name, 2: Version number, 3: __construct() method. */ 5610 __( 'The called constructor method for %1$s class is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), 5611 $class_name, 5612 $version, 5613 '<code>__construct()</code>' 5614 ); 5615 } 5616 } else { 5617 if ( $parent_class ) { 5618 $message = sprintf( 5619 'The called constructor method for %1$s class in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.', 5620 $class_name, 5621 $parent_class, 5622 $version, 5623 '<code>__construct()</code>' 5624 ); 5625 } else { 5626 $message = sprintf( 5627 'The called constructor method for %1$s class is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', 5628 $class_name, 5629 $version, 5630 '<code>__construct()</code>' 5631 ); 5632 } 5633 } 5634 5635 wp_trigger_error( '', $message, E_USER_DEPRECATED ); 5636 } 5637 } 5638 5639 /** 5640 * Marks a class as deprecated and informs when it has been used. 5641 * 5642 * There is a {@see 'deprecated_class_run'} hook that will be called that can be used 5643 * to get the backtrace up to what file and function called the deprecated class. 5644 * 5645 * The current behavior is to trigger a user error if `WP_DEBUG` is true. 5646 * 5647 * This function is to be used in the class constructor for every deprecated class. 5648 * See {@see _deprecated_constructor()} for deprecating PHP4-style constructors. 5649 * 5650 * @since 6.4.0 5651 * 5652 * @param string $class_name The name of the class being instantiated. 5653 * @param string $version The version of WordPress that deprecated the class. 5654 * @param string $replacement Optional. The class or function that should have been called. 5655 * Default empty string. 5656 */ 5657 function _deprecated_class( $class_name, $version, $replacement = '' ) { 5658 5659 /** 5660 * Fires when a deprecated class is called. 5661 * 5662 * @since 6.4.0 5663 * 5664 * @param string $class_name The name of the class being instantiated. 5665 * @param string $replacement The class or function that should have been called. 5666 * @param string $version The version of WordPress that deprecated the class. 5667 */ 5668 do_action( 'deprecated_class_run', $class_name, $replacement, $version ); 5669 5670 /** 5671 * Filters whether to trigger an error for a deprecated class. 5672 * 5673 * @since 6.4.0 5674 * 5675 * @param bool $trigger Whether to trigger an error for a deprecated class. Default true. 5676 */ 5677 if ( WP_DEBUG && apply_filters( 'deprecated_class_trigger_error', true ) ) { 5678 if ( function_exists( '__' ) ) { 5679 if ( $replacement ) { 5680 $message = sprintf( 5681 /* translators: 1: PHP class name, 2: Version number, 3: Alternative class or function name. */ 5682 __( 'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), 5683 $class_name, 5684 $version, 5685 $replacement 5686 ); 5687 } else { 5688 $message = sprintf( 5689 /* translators: 1: PHP class name, 2: Version number. */ 5690 __( 'Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ), 5691 $class_name, 5692 $version 5693 ); 5694 } 5695 } else { 5696 if ( $replacement ) { 5697 $message = sprintf( 5698 'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', 5699 $class_name, 5700 $version, 5701 $replacement 5702 ); 5703 } else { 5704 $message = sprintf( 5705 'Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', 5706 $class_name, 5707 $version 5708 ); 5709 } 5710 } 5711 5712 wp_trigger_error( '', $message, E_USER_DEPRECATED ); 5713 } 5714 } 5715 5716 /** 5717 * Marks a file as deprecated and inform when it has been used. 5718 * 5719 * There is a {@see 'deprecated_file_included'} hook that will be called that can be used 5720 * to get the backtrace up to what file and function included the deprecated file. 5721 * 5722 * The current behavior is to trigger a user error if `WP_DEBUG` is true. 5723 * 5724 * This function is to be used in every file that is deprecated. 5725 * 5726 * @since 2.5.0 5727 * @since 5.4.0 This function is no longer marked as "private". 5728 * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE). 5729 * 5730 * @param string $file The file that was included. 5731 * @param string $version The version of WordPress that deprecated the file. 5732 * @param string $replacement Optional. The file that should have been included based on ABSPATH. 5733 * Default empty string. 5734 * @param string $message Optional. A message regarding the change. Default empty string. 5735 */ 5736 function _deprecated_file( $file, $version, $replacement = '', $message = '' ) { 5737 5738 /** 5739 * Fires when a deprecated file is called. 5740 * 5741 * @since 2.5.0 5742 * 5743 * @param string $file The file that was called. 5744 * @param string $replacement The file that should have been included based on ABSPATH. 5745 * @param string $version The version of WordPress that deprecated the file. 5746 * @param string $message A message regarding the change. 5747 */ 5748 do_action( 'deprecated_file_included', $file, $replacement, $version, $message ); 5749 5750 /** 5751 * Filters whether to trigger an error for deprecated files. 5752 * 5753 * @since 2.5.0 5754 * 5755 * @param bool $trigger Whether to trigger the error for deprecated files. Default true. 5756 */ 5757 if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) { 5758 $message = empty( $message ) ? '' : ' ' . $message; 5759 5760 if ( function_exists( '__' ) ) { 5761 if ( $replacement ) { 5762 $message = sprintf( 5763 /* translators: 1: PHP file name, 2: Version number, 3: Alternative file name. */ 5764 __( 'File %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), 5765 $file, 5766 $version, 5767 $replacement 5768 ) . $message; 5769 } else { 5770 $message = sprintf( 5771 /* translators: 1: PHP file name, 2: Version number. */ 5772 __( 'File %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ), 5773 $file, 5774 $version 5775 ) . $message; 5776 } 5777 } else { 5778 if ( $replacement ) { 5779 $message = sprintf( 5780 'File %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', 5781 $file, 5782 $version, 5783 $replacement 5784 ); 5785 } else { 5786 $message = sprintf( 5787 'File %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', 5788 $file, 5789 $version 5790 ) . $message; 5791 } 5792 } 5793 5794 wp_trigger_error( '', $message, E_USER_DEPRECATED ); 5795 } 5796 } 5797 /** 5798 * Marks a function argument as deprecated and inform when it has been used. 5799 * 5800 * This function is to be used whenever a deprecated function argument is used. 5801 * Before this function is called, the argument must be checked for whether it was 5802 * used by comparing it to its default value or evaluating whether it is empty. 5803 * 5804 * For example: 5805 * 5806 * if ( ! empty( $deprecated ) ) { 5807 * _deprecated_argument( __FUNCTION__, '3.0.0' ); 5808 * } 5809 * 5810 * There is a {@see 'deprecated_argument_run'} hook that will be called that can be used 5811 * to get the backtrace up to what file and function used the deprecated argument. 5812 * 5813 * The current behavior is to trigger a user error if WP_DEBUG is true. 5814 * 5815 * @since 3.0.0 5816 * @since 5.4.0 This function is no longer marked as "private". 5817 * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE). 5818 * 5819 * @param string $function_name The function that was called. 5820 * @param string $version The version of WordPress that deprecated the argument used. 5821 * @param string $message Optional. A message regarding the change. Default empty string. 5822 */ 5823 function _deprecated_argument( $function_name, $version, $message = '' ) { 5824 5825 /** 5826 * Fires when a deprecated argument is called. 5827 * 5828 * @since 3.0.0 5829 * 5830 * @param string $function_name The function that was called. 5831 * @param string $message A message regarding the change. 5832 * @param string $version The version of WordPress that deprecated the argument used. 5833 */ 5834 do_action( 'deprecated_argument_run', $function_name, $message, $version ); 5835 5836 /** 5837 * Filters whether to trigger an error for deprecated arguments. 5838 * 5839 * @since 3.0.0 5840 * 5841 * @param bool $trigger Whether to trigger the error for deprecated arguments. Default true. 5842 */ 5843 if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) { 5844 if ( function_exists( '__' ) ) { 5845 if ( $message ) { 5846 $message = sprintf( 5847 /* translators: 1: PHP function name, 2: Version number, 3: Optional message regarding the change. */ 5848 __( 'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s' ), 5849 $function_name, 5850 $version, 5851 $message 5852 ); 5853 } else { 5854 $message = sprintf( 5855 /* translators: 1: PHP function name, 2: Version number. */ 5856 __( 'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.' ), 5857 $function_name, 5858 $version 5859 ); 5860 } 5861 } else { 5862 if ( $message ) { 5863 $message = sprintf( 5864 'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s', 5865 $function_name, 5866 $version, 5867 $message 5868 ); 5869 } else { 5870 $message = sprintf( 5871 'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.', 5872 $function_name, 5873 $version 5874 ); 5875 } 5876 } 5877 5878 wp_trigger_error( '', $message, E_USER_DEPRECATED ); 5879 } 5880 } 5881 5882 /** 5883 * Marks a deprecated action or filter hook as deprecated and throws a notice. 5884 * 5885 * Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where 5886 * the deprecated hook was called. 5887 * 5888 * Default behavior is to trigger a user error if `WP_DEBUG` is true. 5889 * 5890 * This function is called by the do_action_deprecated() and apply_filters_deprecated() 5891 * functions, and so generally does not need to be called directly. 5892 * 5893 * @since 4.6.0 5894 * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE). 5895 * @access private 5896 * 5897 * @param string $hook The hook that was used. 5898 * @param string $version The version of WordPress that deprecated the hook. 5899 * @param string $replacement Optional. The hook that should have been used. Default empty string. 5900 * @param string $message Optional. A message regarding the change. Default empty. 5901 */ 5902 function _deprecated_hook( $hook, $version, $replacement = '', $message = '' ) { 5903 /** 5904 * Fires when a deprecated hook is called. 5905 * 5906 * @since 4.6.0 5907 * 5908 * @param string $hook The hook that was called. 5909 * @param string $replacement The hook that should be used as a replacement. 5910 * @param string $version The version of WordPress that deprecated the argument used. 5911 * @param string $message A message regarding the change. 5912 */ 5913 do_action( 'deprecated_hook_run', $hook, $replacement, $version, $message ); 5914 5915 /** 5916 * Filters whether to trigger deprecated hook errors. 5917 * 5918 * @since 4.6.0 5919 * 5920 * @param bool $trigger Whether to trigger deprecated hook errors. Requires 5921 * `WP_DEBUG` to be defined true. 5922 */ 5923 if ( WP_DEBUG && apply_filters( 'deprecated_hook_trigger_error', true ) ) { 5924 $message = empty( $message ) ? '' : ' ' . $message; 5925 5926 if ( $replacement ) { 5927 $message = sprintf( 5928 /* translators: 1: WordPress hook name, 2: Version number, 3: Alternative hook name. */ 5929 __( 'Hook %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), 5930 $hook, 5931 $version, 5932 $replacement 5933 ) . $message; 5934 } else { 5935 $message = sprintf( 5936 /* translators: 1: WordPress hook name, 2: Version number. */ 5937 __( 'Hook %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ), 5938 $hook, 5939 $version 5940 ) . $message; 5941 } 5942 5943 wp_trigger_error( '', $message, E_USER_DEPRECATED ); 5944 } 5945 } 5946 5947 /** 5948 * Marks something as being incorrectly called. 5949 * 5950 * There is a {@see 'doing_it_wrong_run'} hook that will be called that can be used 5951 * to get the backtrace up to what file and function called the deprecated function. 5952 * 5953 * The current behavior is to trigger a user error if `WP_DEBUG` is true. 5954 * 5955 * @since 3.1.0 5956 * @since 5.4.0 This function is no longer marked as "private". 5957 * 5958 * @param string $function_name The function that was called. 5959 * @param string $message A message explaining what has been done incorrectly. 5960 * @param string $version The version of WordPress where the message was added. 5961 */ 5962 function _doing_it_wrong( $function_name, $message, $version ) { 5963 5964 /** 5965 * Fires when the given function is being used incorrectly. 5966 * 5967 * @since 3.1.0 5968 * 5969 * @param string $function_name The function that was called. 5970 * @param string $message A message explaining what has been done incorrectly. 5971 * @param string $version The version of WordPress where the message was added. 5972 */ 5973 do_action( 'doing_it_wrong_run', $function_name, $message, $version ); 5974 5975 /** 5976 * Filters whether to trigger an error for _doing_it_wrong() calls. 5977 * 5978 * @since 3.1.0 5979 * @since 5.1.0 Added the $function_name, $message and $version parameters. 5980 * 5981 * @param bool $trigger Whether to trigger the error for _doing_it_wrong() calls. Default true. 5982 * @param string $function_name The function that was called. 5983 * @param string $message A message explaining what has been done incorrectly. 5984 * @param string $version The version of WordPress where the message was added. 5985 */ 5986 if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true, $function_name, $message, $version ) ) { 5987 if ( function_exists( '__' ) ) { 5988 if ( $version ) { 5989 /* translators: %s: Version number. */ 5990 $version = sprintf( __( '(This message was added in version %s.)' ), $version ); 5991 } 5992 5993 $message .= ' ' . sprintf( 5994 /* translators: %s: Documentation URL. */ 5995 __( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ), 5996 __( 'https://developer.wordpress.org/advanced-administration/debug/debug-wordpress/' ) 5997 ); 5998 5999 $message = sprintf( 6000 /* translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: WordPress version number. */ 6001 __( 'Function %1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), 6002 $function_name, 6003 $message, 6004 $version 6005 ); 6006 } else { 6007 if ( $version ) { 6008 $version = sprintf( '(This message was added in version %s.)', $version ); 6009 } 6010 6011 $message .= sprintf( 6012 ' Please see <a href="%s">Debugging in WordPress</a> for more information.', 6013 'https://developer.wordpress.org/advanced-administration/debug/debug-wordpress/' 6014 ); 6015 6016 $message = sprintf( 6017 'Function %1$s was called <strong>incorrectly</strong>. %2$s %3$s', 6018 $function_name, 6019 $message, 6020 $version 6021 ); 6022 } 6023 6024 wp_trigger_error( '', $message ); 6025 } 6026 } 6027 6028 /** 6029 * Generates a user-level error/warning/notice/deprecation message. 6030 * 6031 * Generates the message when `WP_DEBUG` is true. 6032 * 6033 * @since 6.4.0 6034 * 6035 * @param string $function_name The function that triggered the error. 6036 * @param string $message The message explaining the error. 6037 * The message can contain allowed HTML 'a' (with href), 'code', 6038 * 'br', 'em', and 'strong' tags and http or https protocols. 6039 * If it contains other HTML tags or protocols, the message should be escaped 6040 * before passing to this function to avoid being stripped {@see wp_kses()}. 6041 * @param int $error_level Optional. The designated error type for this error. 6042 * Only works with E_USER family of constants. Default E_USER_NOTICE. 6043 */ 6044 function wp_trigger_error( $function_name, $message, $error_level = E_USER_NOTICE ) { 6045 6046 // Bail out if WP_DEBUG is not turned on. 6047 if ( ! WP_DEBUG ) { 6048 return; 6049 } 6050 6051 /** 6052 * Fires when the given function triggers a user-level error/warning/notice/deprecation message. 6053 * 6054 * Can be used for debug backtracking. 6055 * 6056 * @since 6.4.0 6057 * 6058 * @param string $function_name The function that was called. 6059 * @param string $message A message explaining what has been done incorrectly. 6060 * @param int $error_level The designated error type for this error. 6061 */ 6062 do_action( 'wp_trigger_error_run', $function_name, $message, $error_level ); 6063 6064 if ( ! empty( $function_name ) ) { 6065 $message = sprintf( '%s(): %s', $function_name, $message ); 6066 } 6067 6068 $message = wp_kses( 6069 $message, 6070 array( 6071 'a' => array( 'href' ), 6072 'br', 6073 'code', 6074 'em', 6075 'strong', 6076 ), 6077 array( 'http', 'https' ) 6078 ); 6079 6080 trigger_error( $message, $error_level ); 6081 } 6082 6083 /** 6084 * Determines whether the server is running an earlier than 1.5.0 version of lighttpd. 6085 * 6086 * @since 2.5.0 6087 * 6088 * @return bool Whether the server is running lighttpd < 1.5.0. 6089 */ 6090 function is_lighttpd_before_150() { 6091 $server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : '' ); 6092 $server_parts[1] = isset( $server_parts[1] ) ? $server_parts[1] : ''; 6093 6094 return ( 'lighttpd' === $server_parts[0] && -1 === version_compare( $server_parts[1], '1.5.0' ) ); 6095 } 6096 6097 /** 6098 * Determines whether the specified module exist in the Apache config. 6099 * 6100 * @since 2.5.0 6101 * 6102 * @global bool $is_apache 6103 * 6104 * @param string $mod The module, e.g. mod_rewrite. 6105 * @param bool $default_value Optional. The default return value if the module is not found. Default false. 6106 * @return bool Whether the specified module is loaded. 6107 */ 6108 function apache_mod_loaded( $mod, $default_value = false ) { 6109 global $is_apache; 6110 6111 if ( ! $is_apache ) { 6112 return false; 6113 } 6114 6115 $loaded_mods = array(); 6116 6117 if ( function_exists( 'apache_get_modules' ) ) { 6118 $loaded_mods = apache_get_modules(); 6119 6120 if ( in_array( $mod, $loaded_mods, true ) ) { 6121 return true; 6122 } 6123 } 6124 6125 if ( empty( $loaded_mods ) 6126 && function_exists( 'phpinfo' ) 6127 && ! str_contains( ini_get( 'disable_functions' ), 'phpinfo' ) 6128 ) { 6129 ob_start(); 6130 phpinfo( INFO_MODULES ); 6131 $phpinfo = ob_get_clean(); 6132 6133 if ( str_contains( $phpinfo, $mod ) ) { 6134 return true; 6135 } 6136 } 6137 6138 return $default_value; 6139 } 6140 6141 /** 6142 * Checks if IIS 7+ supports pretty permalinks. 6143 * 6144 * @since 2.8.0 6145 * 6146 * @global bool $is_iis7 6147 * 6148 * @return bool Whether IIS7 supports permalinks. 6149 */ 6150 function iis7_supports_permalinks() { 6151 global $is_iis7; 6152 6153 $supports_permalinks = false; 6154 if ( $is_iis7 ) { 6155 /* First we check if the DOMDocument class exists. If it does not exist, then we cannot 6156 * easily update the xml configuration file, hence we just bail out and tell user that 6157 * pretty permalinks cannot be used. 6158 * 6159 * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the website. When 6160 * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'. 6161 * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs 6162 * via ISAPI then pretty permalinks will not work. 6163 */ 6164 $supports_permalinks = class_exists( 'DOMDocument', false ) && isset( $_SERVER['IIS_UrlRewriteModule'] ) && ( 'cgi-fcgi' === PHP_SAPI ); 6165 } 6166 6167 /** 6168 * Filters whether IIS 7+ supports pretty permalinks. 6169 * 6170 * @since 2.8.0 6171 * 6172 * @param bool $supports_permalinks Whether IIS7 supports permalinks. Default false. 6173 */ 6174 return apply_filters( 'iis7_supports_permalinks', $supports_permalinks ); 6175 } 6176 6177 /** 6178 * Validates a file name and path against an allowed set of rules. 6179 * 6180 * A return value of `1` means the file path contains directory traversal. 6181 * 6182 * A return value of `2` means the file path contains a Windows drive path. 6183 * 6184 * A return value of `3` means the file is not in the allowed files list. 6185 * 6186 * @since 1.2.0 6187 * 6188 * @param string $file File path. 6189 * @param string[] $allowed_files Optional. Array of allowed files. Default empty array. 6190 * @return int 0 means nothing is wrong, greater than 0 means something was wrong. 6191 */ 6192 function validate_file( $file, $allowed_files = array() ) { 6193 if ( ! is_scalar( $file ) || '' === $file ) { 6194 return 0; 6195 } 6196 6197 // `../` on its own is not allowed: 6198 if ( '../' === $file ) { 6199 return 1; 6200 } 6201 6202 // More than one occurrence of `../` is not allowed: 6203 if ( preg_match_all( '#\.\./#', $file, $matches, PREG_SET_ORDER ) && ( count( $matches ) > 1 ) ) { 6204 return 1; 6205 } 6206 6207 // `../` which does not occur at the end of the path is not allowed: 6208 if ( str_contains( $file, '../' ) && '../' !== mb_substr( $file, -3, 3 ) ) { 6209 return 1; 6210 } 6211 6212 // Files not in the allowed file list are not allowed: 6213 if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files, true ) ) { 6214 return 3; 6215 } 6216 6217 // Absolute Windows drive paths are not allowed: 6218 if ( ':' === substr( $file, 1, 1 ) ) { 6219 return 2; 6220 } 6221 6222 return 0; 6223 } 6224 6225 /** 6226 * Determines whether to force SSL used for the Administration Screens. 6227 * 6228 * @since 2.6.0 6229 * 6230 * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null. 6231 * @return bool True if forced, false if not forced. 6232 */ 6233 function force_ssl_admin( $force = null ) { 6234 static $forced = false; 6235 6236 if ( ! is_null( $force ) ) { 6237 $old_forced = $forced; 6238 $forced = $force; 6239 return $old_forced; 6240 } 6241 6242 return $forced; 6243 } 6244 6245 /** 6246 * Guesses the URL for the site. 6247 * 6248 * Will remove wp-admin links to retrieve only return URLs not in the wp-admin 6249 * directory. 6250 * 6251 * @since 2.6.0 6252 * 6253 * @return string The guessed URL. 6254 */ 6255 function wp_guess_url() { 6256 if ( defined( 'WP_SITEURL' ) && '' !== WP_SITEURL ) { 6257 $url = WP_SITEURL; 6258 } else { 6259 $abspath_fix = str_replace( '\\', '/', ABSPATH ); 6260 $script_filename_dir = dirname( $_SERVER['SCRIPT_FILENAME'] ); 6261 6262 // The request is for the admin. 6263 if ( str_contains( $_SERVER['REQUEST_URI'], 'wp-admin' ) || str_contains( $_SERVER['REQUEST_URI'], 'wp-login.php' ) ) { 6264 $path = preg_replace( '#/(wp-admin/?.*|wp-login\.php.*)#i', '', $_SERVER['REQUEST_URI'] ); 6265 6266 // The request is for a file in ABSPATH. 6267 } elseif ( $script_filename_dir . '/' === $abspath_fix ) { 6268 // Strip off any file/query params in the path. 6269 $path = preg_replace( '#/[^/]*$#i', '', $_SERVER['PHP_SELF'] ); 6270 6271 } else { 6272 if ( str_contains( $_SERVER['SCRIPT_FILENAME'], $abspath_fix ) ) { 6273 // Request is hitting a file inside ABSPATH. 6274 $directory = str_replace( ABSPATH, '', $script_filename_dir ); 6275 // Strip off the subdirectory, and any file/query params. 6276 $path = preg_replace( '#/' . preg_quote( $directory, '#' ) . '/[^/]*$#i', '', $_SERVER['REQUEST_URI'] ); 6277 } elseif ( str_contains( $abspath_fix, $script_filename_dir ) ) { 6278 // Request is hitting a file above ABSPATH. 6279 $subdirectory = substr( $abspath_fix, strpos( $abspath_fix, $script_filename_dir ) + strlen( $script_filename_dir ) ); 6280 // Strip off any file/query params from the path, appending the subdirectory to the installation. 6281 $path = preg_replace( '#/[^/]*$#i', '', $_SERVER['REQUEST_URI'] ) . $subdirectory; 6282 } else { 6283 $path = $_SERVER['REQUEST_URI']; 6284 } 6285 } 6286 6287 $schema = is_ssl() ? 'https://' : 'http://'; // set_url_scheme() is not defined yet. 6288 $url = $schema . $_SERVER['HTTP_HOST'] . $path; 6289 } 6290 6291 return rtrim( $url, '/' ); 6292 } 6293 6294 /** 6295 * Temporarily suspends cache additions. 6296 * 6297 * Stops more data being added to the cache, but still allows cache retrieval. 6298 * This is useful for actions, such as imports, when a lot of data would otherwise 6299 * be almost uselessly added to the cache. 6300 * 6301 * Suspension lasts for a single page load at most. Remember to call this 6302 * function again if you wish to re-enable cache adds earlier. 6303 * 6304 * @since 3.3.0 6305 * 6306 * @param bool $suspend Optional. Suspends additions if true, re-enables them if false. 6307 * Defaults to not changing the current setting. 6308 * @return bool The current suspend setting. 6309 */ 6310 function wp_suspend_cache_addition( $suspend = null ) { 6311 static $_suspend = false; 6312 6313 if ( is_bool( $suspend ) ) { 6314 $_suspend = $suspend; 6315 } 6316 6317 return $_suspend; 6318 } 6319 6320 /** 6321 * Suspends cache invalidation. 6322 * 6323 * Turns cache invalidation on and off. Useful during imports where you don't want to do 6324 * invalidations every time a post is inserted. Callers must be sure that what they are 6325 * doing won't lead to an inconsistent cache when invalidation is suspended. 6326 * 6327 * @since 2.7.0 6328 * 6329 * @global bool $_wp_suspend_cache_invalidation 6330 * 6331 * @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true. 6332 * @return bool The current suspend setting. 6333 */ 6334 function wp_suspend_cache_invalidation( $suspend = true ) { 6335 global $_wp_suspend_cache_invalidation; 6336 6337 $current_suspend = $_wp_suspend_cache_invalidation; 6338 $_wp_suspend_cache_invalidation = $suspend; 6339 return $current_suspend; 6340 } 6341 6342 /** 6343 * Determines whether a site is the main site of the current network. 6344 * 6345 * @since 3.0.0 6346 * @since 4.9.0 The `$network_id` parameter was added. 6347 * 6348 * @param int $site_id Optional. Site ID to test. Defaults to current site. 6349 * @param int $network_id Optional. Network ID of the network to check for. 6350 * Defaults to current network. 6351 * @return bool True if $site_id is the main site of the network, or if not 6352 * running Multisite. 6353 */ 6354 function is_main_site( $site_id = null, $network_id = null ) { 6355 if ( ! is_multisite() ) { 6356 return true; 6357 } 6358 6359 if ( ! $site_id ) { 6360 $site_id = get_current_blog_id(); 6361 } 6362 6363 $site_id = (int) $site_id; 6364 6365 return get_main_site_id( $network_id ) === $site_id; 6366 } 6367 6368 /** 6369 * Gets the main site ID. 6370 * 6371 * @since 4.9.0 6372 * 6373 * @param int $network_id Optional. The ID of the network for which to get the main site. 6374 * Defaults to the current network. 6375 * @return int The ID of the main site. 6376 */ 6377 function get_main_site_id( $network_id = null ) { 6378 if ( ! is_multisite() ) { 6379 return get_current_blog_id(); 6380 } 6381 6382 $network = get_network( $network_id ); 6383 if ( ! $network ) { 6384 return 0; 6385 } 6386 6387 return $network->site_id; 6388 } 6389 6390 /** 6391 * Determines whether a network is the main network of the Multisite installation. 6392 * 6393 * @since 3.7.0 6394 * 6395 * @param int $network_id Optional. Network ID to test. Defaults to current network. 6396 * @return bool True if $network_id is the main network, or if not running Multisite. 6397 */ 6398 function is_main_network( $network_id = null ) { 6399 if ( ! is_multisite() ) { 6400 return true; 6401 } 6402 6403 if ( null === $network_id ) { 6404 $network_id = get_current_network_id(); 6405 } 6406 6407 $network_id = (int) $network_id; 6408 6409 return ( get_main_network_id() === $network_id ); 6410 } 6411 6412 /** 6413 * Gets the main network ID. 6414 * 6415 * @since 4.3.0 6416 * 6417 * @return int The ID of the main network. 6418 */ 6419 function get_main_network_id() { 6420 if ( ! is_multisite() ) { 6421 return 1; 6422 } 6423 6424 $current_network = get_network(); 6425 6426 if ( defined( 'PRIMARY_NETWORK_ID' ) ) { 6427 $main_network_id = PRIMARY_NETWORK_ID; 6428 } elseif ( isset( $current_network->id ) && 1 === (int) $current_network->id ) { 6429 // If the current network has an ID of 1, assume it is the main network. 6430 $main_network_id = 1; 6431 } else { 6432 $_networks = get_networks( 6433 array( 6434 'fields' => 'ids', 6435 'number' => 1, 6436 ) 6437 ); 6438 $main_network_id = array_shift( $_networks ); 6439 } 6440 6441 /** 6442 * Filters the main network ID. 6443 * 6444 * @since 4.3.0 6445 * 6446 * @param int $main_network_id The ID of the main network. 6447 */ 6448 return (int) apply_filters( 'get_main_network_id', $main_network_id ); 6449 } 6450 6451 /** 6452 * Determines whether site meta is enabled. 6453 * 6454 * This function checks whether the 'blogmeta' database table exists. The result is saved as 6455 * a setting for the main network, making it essentially a global setting. Subsequent requests 6456 * will refer to this setting instead of running the query. 6457 * 6458 * @since 5.1.0 6459 * 6460 * @global wpdb $wpdb WordPress database abstraction object. 6461 * 6462 * @return bool True if site meta is supported, false otherwise. 6463 */ 6464 function is_site_meta_supported() { 6465 global $wpdb; 6466 6467 if ( ! is_multisite() ) { 6468 return false; 6469 } 6470 6471 $network_id = get_main_network_id(); 6472 6473 $supported = get_network_option( $network_id, 'site_meta_supported', false ); 6474 if ( false === $supported ) { 6475 $supported = $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->blogmeta}'" ) ? 1 : 0; 6476 6477 update_network_option( $network_id, 'site_meta_supported', $supported ); 6478 } 6479 6480 return (bool) $supported; 6481 } 6482 6483 /** 6484 * Modifies gmt_offset for smart timezone handling. 6485 * 6486 * Overrides the gmt_offset option if we have a timezone_string available. 6487 * 6488 * @since 2.8.0 6489 * 6490 * @return float|false Timezone GMT offset, false otherwise. 6491 */ 6492 function wp_timezone_override_offset() { 6493 $timezone_string = get_option( 'timezone_string' ); 6494 if ( ! $timezone_string ) { 6495 return false; 6496 } 6497 6498 $timezone_object = timezone_open( $timezone_string ); 6499 $datetime_object = date_create(); 6500 if ( false === $timezone_object || false === $datetime_object ) { 6501 return false; 6502 } 6503 6504 return round( timezone_offset_get( $timezone_object, $datetime_object ) / HOUR_IN_SECONDS, 2 ); 6505 } 6506 6507 /** 6508 * Sort-helper for timezones. 6509 * 6510 * @since 2.9.0 6511 * @access private 6512 * 6513 * @param array $a 6514 * @param array $b 6515 * @return int 6516 */ 6517 function _wp_timezone_choice_usort_callback( $a, $b ) { 6518 // Don't use translated versions of Etc. 6519 if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) { 6520 // Make the order of these more like the old dropdown. 6521 if ( str_starts_with( $a['city'], 'GMT+' ) && str_starts_with( $b['city'], 'GMT+' ) ) { 6522 return -1 * ( strnatcasecmp( $a['city'], $b['city'] ) ); 6523 } 6524 6525 if ( 'UTC' === $a['city'] ) { 6526 if ( str_starts_with( $b['city'], 'GMT+' ) ) { 6527 return 1; 6528 } 6529 6530 return -1; 6531 } 6532 6533 if ( 'UTC' === $b['city'] ) { 6534 if ( str_starts_with( $a['city'], 'GMT+' ) ) { 6535 return -1; 6536 } 6537 6538 return 1; 6539 } 6540 6541 return strnatcasecmp( $a['city'], $b['city'] ); 6542 } 6543 6544 if ( $a['t_continent'] === $b['t_continent'] ) { 6545 if ( $a['t_city'] === $b['t_city'] ) { 6546 return strnatcasecmp( $a['t_subcity'], $b['t_subcity'] ); 6547 } 6548 6549 return strnatcasecmp( $a['t_city'], $b['t_city'] ); 6550 } else { 6551 // Force Etc to the bottom of the list. 6552 if ( 'Etc' === $a['continent'] ) { 6553 return 1; 6554 } 6555 6556 if ( 'Etc' === $b['continent'] ) { 6557 return -1; 6558 } 6559 6560 return strnatcasecmp( $a['t_continent'], $b['t_continent'] ); 6561 } 6562 } 6563 6564 /** 6565 * Gives a nicely-formatted list of timezone strings. 6566 * 6567 * @since 2.9.0 6568 * @since 4.7.0 Added the `$locale` parameter. 6569 * 6570 * @param string $selected_zone Selected timezone. 6571 * @param string $locale Optional. Locale to load the timezones in. Default current site locale. 6572 * @return string 6573 */ 6574 function wp_timezone_choice( $selected_zone, $locale = null ) { 6575 static $mo_loaded = false, $locale_loaded = null; 6576 6577 $continents = array( 'Africa', 'America', 'Antarctica', 'Arctic', 'Asia', 'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific' ); 6578 6579 // Load translations for continents and cities. 6580 if ( ! $mo_loaded || $locale !== $locale_loaded ) { 6581 $locale_loaded = $locale ? $locale : get_locale(); 6582 $mofile = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo'; 6583 unload_textdomain( 'continents-cities', true ); 6584 load_textdomain( 'continents-cities', $mofile, $locale_loaded ); 6585 $mo_loaded = true; 6586 } 6587 6588 $tz_identifiers = timezone_identifiers_list(); 6589 $zonen = array(); 6590 6591 foreach ( $tz_identifiers as $zone ) { 6592 $zone = explode( '/', $zone ); 6593 if ( ! in_array( $zone[0], $continents, true ) ) { 6594 continue; 6595 } 6596 6597 // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later. 6598 $exists = array( 6599 0 => ( isset( $zone[0] ) && $zone[0] ), 6600 1 => ( isset( $zone[1] ) && $zone[1] ), 6601 2 => ( isset( $zone[2] ) && $zone[2] ), 6602 ); 6603 $exists[3] = ( $exists[0] && 'Etc' !== $zone[0] ); 6604 $exists[4] = ( $exists[1] && $exists[3] ); 6605 $exists[5] = ( $exists[2] && $exists[3] ); 6606 6607 // phpcs:disable WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText 6608 $zonen[] = array( 6609 'continent' => ( $exists[0] ? $zone[0] : '' ), 6610 'city' => ( $exists[1] ? $zone[1] : '' ), 6611 'subcity' => ( $exists[2] ? $zone[2] : '' ), 6612 't_continent' => ( $exists[3] ? translate( str_replace( '_', ' ', $zone[0] ), 'continents-cities' ) : '' ), 6613 't_city' => ( $exists[4] ? translate( str_replace( '_', ' ', $zone[1] ), 'continents-cities' ) : '' ), 6614 't_subcity' => ( $exists[5] ? translate( str_replace( '_', ' ', $zone[2] ), 'continents-cities' ) : '' ), 6615 ); 6616 // phpcs:enable 6617 } 6618 usort( $zonen, '_wp_timezone_choice_usort_callback' ); 6619 6620 $structure = array(); 6621 6622 if ( empty( $selected_zone ) ) { 6623 $structure[] = '<option selected="selected" value="">' . __( 'Select a city' ) . '</option>'; 6624 } 6625 6626 // If this is a deprecated, but valid, timezone string, display it at the top of the list as-is. 6627 if ( in_array( $selected_zone, $tz_identifiers, true ) === false 6628 && in_array( $selected_zone, timezone_identifiers_list( DateTimeZone::ALL_WITH_BC ), true ) 6629 ) { 6630 $structure[] = '<option selected="selected" value="' . esc_attr( $selected_zone ) . '">' . esc_html( $selected_zone ) . '</option>'; 6631 } 6632 6633 foreach ( $zonen as $key => $zone ) { 6634 // Build value in an array to join later. 6635 $value = array( $zone['continent'] ); 6636 6637 if ( empty( $zone['city'] ) ) { 6638 // It's at the continent level (generally won't happen). 6639 $display = $zone['t_continent']; 6640 } else { 6641 // It's inside a continent group. 6642 6643 // Continent optgroup. 6644 if ( ! isset( $zonen[ $key - 1 ] ) || $zonen[ $key - 1 ]['continent'] !== $zone['continent'] ) { 6645 $label = $zone['t_continent']; 6646 $structure[] = '<optgroup label="' . esc_attr( $label ) . '">'; 6647 } 6648 6649 // Add the city to the value. 6650 $value[] = $zone['city']; 6651 6652 $display = $zone['t_city']; 6653 if ( ! empty( $zone['subcity'] ) ) { 6654 // Add the subcity to the value. 6655 $value[] = $zone['subcity']; 6656 $display .= ' - ' . $zone['t_subcity']; 6657 } 6658 } 6659 6660 // Build the value. 6661 $value = implode( '/', $value ); 6662 $selected = ''; 6663 if ( $value === $selected_zone ) { 6664 $selected = 'selected="selected" '; 6665 } 6666 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $value ) . '">' . esc_html( $display ) . '</option>'; 6667 6668 // Close continent optgroup. 6669 if ( ! empty( $zone['city'] ) && ( ! isset( $zonen[ $key + 1 ] ) || ( isset( $zonen[ $key + 1 ] ) && $zonen[ $key + 1 ]['continent'] !== $zone['continent'] ) ) ) { 6670 $structure[] = '</optgroup>'; 6671 } 6672 } 6673 6674 // Do UTC. 6675 $structure[] = '<optgroup label="' . esc_attr__( 'UTC' ) . '">'; 6676 $selected = ''; 6677 if ( 'UTC' === $selected_zone ) { 6678 $selected = 'selected="selected" '; 6679 } 6680 $structure[] = '<option ' . $selected . 'value="' . esc_attr( 'UTC' ) . '">' . __( 'UTC' ) . '</option>'; 6681 $structure[] = '</optgroup>'; 6682 6683 // Do manual UTC offsets. 6684 $structure[] = '<optgroup label="' . esc_attr__( 'Manual Offsets' ) . '">'; 6685 $offset_range = array( 6686 -12, 6687 -11.5, 6688 -11, 6689 -10.5, 6690 -10, 6691 -9.5, 6692 -9, 6693 -8.5, 6694 -8, 6695 -7.5, 6696 -7, 6697 -6.5, 6698 -6, 6699 -5.5, 6700 -5, 6701 -4.5, 6702 -4, 6703 -3.5, 6704 -3, 6705 -2.5, 6706 -2, 6707 -1.5, 6708 -1, 6709 -0.5, 6710 0, 6711 0.5, 6712 1, 6713 1.5, 6714 2, 6715 2.5, 6716 3, 6717 3.5, 6718 4, 6719 4.5, 6720 5, 6721 5.5, 6722 5.75, 6723 6, 6724 6.5, 6725 7, 6726 7.5, 6727 8, 6728 8.5, 6729 8.75, 6730 9, 6731 9.5, 6732 10, 6733 10.5, 6734 11, 6735 11.5, 6736 12, 6737 12.75, 6738 13, 6739 13.75, 6740 14, 6741 ); 6742 foreach ( $offset_range as $offset ) { 6743 if ( 0 <= $offset ) { 6744 $offset_name = '+' . $offset; 6745 } else { 6746 $offset_name = (string) $offset; 6747 } 6748 6749 $offset_value = $offset_name; 6750 $offset_name = str_replace( array( '.25', '.5', '.75' ), array( ':15', ':30', ':45' ), $offset_name ); 6751 $offset_name = 'UTC' . $offset_name; 6752 $offset_value = 'UTC' . $offset_value; 6753 $selected = ''; 6754 if ( $offset_value === $selected_zone ) { 6755 $selected = 'selected="selected" '; 6756 } 6757 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $offset_value ) . '">' . esc_html( $offset_name ) . '</option>'; 6758 6759 } 6760 $structure[] = '</optgroup>'; 6761 6762 return implode( "\n", $structure ); 6763 } 6764 6765 /** 6766 * Strips close comment and close php tags from file headers used by WP. 6767 * 6768 * @since 2.8.0 6769 * @access private 6770 * 6771 * @see https://core.trac.wordpress.org/ticket/8497 6772 * 6773 * @param string $str Header comment to clean up. 6774 * @return string 6775 */ 6776 function _cleanup_header_comment( $str ) { 6777 return trim( preg_replace( '/\s*(?:\*\/|\?>).*/', '', $str ) ); 6778 } 6779 6780 /** 6781 * Permanently deletes comments or posts of any type that have held a status 6782 * of 'trash' for the number of days defined in EMPTY_TRASH_DAYS. 6783 * 6784 * The default value of `EMPTY_TRASH_DAYS` is 30 (days). 6785 * 6786 * @since 2.9.0 6787 * 6788 * @global wpdb $wpdb WordPress database abstraction object. 6789 */ 6790 function wp_scheduled_delete() { 6791 global $wpdb; 6792 6793 $delete_timestamp = time() - ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS ); 6794 6795 $posts_to_delete = $wpdb->get_results( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wp_trash_meta_time' AND meta_value < %d", $delete_timestamp ), ARRAY_A ); 6796 6797 foreach ( (array) $posts_to_delete as $post ) { 6798 $post_id = (int) $post['post_id']; 6799 if ( ! $post_id ) { 6800 continue; 6801 } 6802 6803 $del_post = get_post( $post_id ); 6804 6805 if ( ! $del_post || 'trash' !== $del_post->post_status ) { 6806 delete_post_meta( $post_id, '_wp_trash_meta_status' ); 6807 delete_post_meta( $post_id, '_wp_trash_meta_time' ); 6808 } else { 6809 wp_delete_post( $post_id ); 6810 } 6811 } 6812 6813 $comments_to_delete = $wpdb->get_results( $wpdb->prepare( "SELECT comment_id FROM $wpdb->commentmeta WHERE meta_key = '_wp_trash_meta_time' AND meta_value < %d", $delete_timestamp ), ARRAY_A ); 6814 6815 foreach ( (array) $comments_to_delete as $comment ) { 6816 $comment_id = (int) $comment['comment_id']; 6817 if ( ! $comment_id ) { 6818 continue; 6819 } 6820 6821 $del_comment = get_comment( $comment_id ); 6822 6823 if ( ! $del_comment || 'trash' !== $del_comment->comment_approved ) { 6824 delete_comment_meta( $comment_id, '_wp_trash_meta_time' ); 6825 delete_comment_meta( $comment_id, '_wp_trash_meta_status' ); 6826 } else { 6827 wp_delete_comment( $del_comment ); 6828 } 6829 } 6830 } 6831 6832 /** 6833 * Retrieves metadata from a file. 6834 * 6835 * Searches for metadata in the first 8 KB of a file, such as a plugin or theme. 6836 * Each piece of metadata must be on its own line. Fields can not span multiple 6837 * lines, the value will get cut at the end of the first line. 6838 * 6839 * If the file data is not within that first 8 KB, then the author should correct 6840 * their plugin file and move the data headers to the top. 6841 * 6842 * @link https://codex.wordpress.org/File_Header 6843 * 6844 * @since 2.9.0 6845 * 6846 * @param string $file Absolute path to the file. 6847 * @param array $default_headers List of headers, in the format `array( 'HeaderKey' => 'Header Name' )`. 6848 * @param string $context Optional. If specified adds filter hook {@see 'extra_$context_headers'}. 6849 * Default empty string. 6850 * @return string[] Array of file header values keyed by header name. 6851 */ 6852 function get_file_data( $file, $default_headers, $context = '' ) { 6853 // Pull only the first 8 KB of the file in. 6854 $file_data = file_get_contents( $file, false, null, 0, 8 * KB_IN_BYTES ); 6855 6856 if ( false === $file_data ) { 6857 $file_data = ''; 6858 } 6859 6860 // Make sure we catch CR-only line endings. 6861 $file_data = str_replace( "\r", "\n", $file_data ); 6862 6863 /** 6864 * Filters extra file headers by context. 6865 * 6866 * The dynamic portion of the hook name, `$context`, refers to 6867 * the context where extra headers might be loaded. 6868 * 6869 * @since 2.9.0 6870 * 6871 * @param array $extra_context_headers Empty array by default. 6872 */ 6873 $extra_headers = $context ? apply_filters( "extra_{$context}_headers", array() ) : array(); 6874 if ( $extra_headers ) { 6875 $extra_headers = array_combine( $extra_headers, $extra_headers ); // Keys equal values. 6876 $all_headers = array_merge( $extra_headers, (array) $default_headers ); 6877 } else { 6878 $all_headers = $default_headers; 6879 } 6880 6881 foreach ( $all_headers as $field => $regex ) { 6882 if ( preg_match( '/^(?:[ \t]*<\?php)?[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] ) { 6883 $all_headers[ $field ] = _cleanup_header_comment( $match[1] ); 6884 } else { 6885 $all_headers[ $field ] = ''; 6886 } 6887 } 6888 6889 return $all_headers; 6890 } 6891 6892 /** 6893 * Returns true. 6894 * 6895 * Useful for returning true to filters easily. 6896 * 6897 * @since 3.0.0 6898 * 6899 * @see __return_false() 6900 * 6901 * @return true True. 6902 */ 6903 function __return_true() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 6904 return true; 6905 } 6906 6907 /** 6908 * Returns false. 6909 * 6910 * Useful for returning false to filters easily. 6911 * 6912 * @since 3.0.0 6913 * 6914 * @see __return_true() 6915 * 6916 * @return false False. 6917 */ 6918 function __return_false() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 6919 return false; 6920 } 6921 6922 /** 6923 * Returns 0. 6924 * 6925 * Useful for returning 0 to filters easily. 6926 * 6927 * @since 3.0.0 6928 * 6929 * @return int 0. 6930 */ 6931 function __return_zero() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 6932 return 0; 6933 } 6934 6935 /** 6936 * Returns an empty array. 6937 * 6938 * Useful for returning an empty array to filters easily. 6939 * 6940 * @since 3.0.0 6941 * 6942 * @return array Empty array. 6943 */ 6944 function __return_empty_array() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 6945 return array(); 6946 } 6947 6948 /** 6949 * Returns null. 6950 * 6951 * Useful for returning null to filters easily. 6952 * 6953 * @since 3.4.0 6954 * 6955 * @return null Null value. 6956 */ 6957 function __return_null() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 6958 return null; 6959 } 6960 6961 /** 6962 * Returns an empty string. 6963 * 6964 * Useful for returning an empty string to filters easily. 6965 * 6966 * @since 3.7.0 6967 * 6968 * @see __return_null() 6969 * 6970 * @return string Empty string. 6971 */ 6972 function __return_empty_string() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 6973 return ''; 6974 } 6975 6976 /** 6977 * Sends a HTTP header to disable content type sniffing in browsers which support it. 6978 * 6979 * @since 3.0.0 6980 * 6981 * @see https://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx 6982 * @see https://src.chromium.org/viewvc/chrome?view=rev&revision=6985 6983 */ 6984 function send_nosniff_header() { 6985 header( 'X-Content-Type-Options: nosniff' ); 6986 } 6987 6988 /** 6989 * Returns a MySQL expression for selecting the week number based on the start_of_week option. 6990 * 6991 * @ignore 6992 * @since 3.0.0 6993 * 6994 * @param string $column Database column. 6995 * @return string SQL clause. 6996 */ 6997 function _wp_mysql_week( $column ) { 6998 $start_of_week = (int) get_option( 'start_of_week' ); 6999 switch ( $start_of_week ) { 7000 case 1: 7001 return "WEEK( $column, 1 )"; 7002 case 2: 7003 case 3: 7004 case 4: 7005 case 5: 7006 case 6: 7007 return "WEEK( DATE_SUB( $column, INTERVAL $start_of_week DAY ), 0 )"; 7008 case 0: 7009 default: 7010 return "WEEK( $column, 0 )"; 7011 } 7012 } 7013 7014 /** 7015 * Finds hierarchy loops using a callback function that maps object IDs to parent IDs. 7016 * 7017 * @since 3.1.0 7018 * @access private 7019 * 7020 * @param callable $callback Function that accepts ( ID, $callback_args ) and outputs parent_ID. 7021 * @param int $start The ID to start the loop check at. 7022 * @param int $start_parent The parent_ID of $start to use instead of calling $callback( $start ). 7023 * Use null to always use $callback. 7024 * @param array $callback_args Optional. Additional arguments to send to $callback. Default empty array. 7025 * @return array IDs of all members of loop. 7026 */ 7027 function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) { 7028 $override = is_null( $start_parent ) ? array() : array( $start => $start_parent ); 7029 7030 $arbitrary_loop_member = wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override, $callback_args ); 7031 if ( ! $arbitrary_loop_member ) { 7032 return array(); 7033 } 7034 7035 return wp_find_hierarchy_loop_tortoise_hare( $callback, $arbitrary_loop_member, $override, $callback_args, true ); 7036 } 7037 7038 /** 7039 * Uses the "The Tortoise and the Hare" algorithm to detect loops. 7040 * 7041 * For every step of the algorithm, the hare takes two steps and the tortoise one. 7042 * If the hare ever laps the tortoise, there must be a loop. 7043 * 7044 * @since 3.1.0 7045 * @access private 7046 * 7047 * @param callable $callback Function that accepts ( ID, callback_arg, ... ) and outputs parent_ID. 7048 * @param int $start The ID to start the loop check at. 7049 * @param array $override Optional. An array of ( ID => parent_ID, ... ) to use instead of $callback. 7050 * Default empty array. 7051 * @param array $callback_args Optional. Additional arguments to send to $callback. Default empty array. 7052 * @param bool $_return_loop Optional. Return loop members or just detect presence of loop? Only set 7053 * to true if you already know the given $start is part of a loop (otherwise 7054 * the returned array might include branches). Default false. 7055 * @return mixed Scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if 7056 * $_return_loop 7057 */ 7058 function wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override = array(), $callback_args = array(), $_return_loop = false ) { 7059 $tortoise = $start; 7060 $hare = $start; 7061 $evanescent_hare = $start; 7062 $return = array(); 7063 7064 // Set evanescent_hare to one past hare. Increment hare two steps. 7065 while ( 7066 $tortoise 7067 && 7068 ( $evanescent_hare = isset( $override[ $hare ] ) ? $override[ $hare ] : call_user_func_array( $callback, array_merge( array( $hare ), $callback_args ) ) ) 7069 && 7070 ( $hare = isset( $override[ $evanescent_hare ] ) ? $override[ $evanescent_hare ] : call_user_func_array( $callback, array_merge( array( $evanescent_hare ), $callback_args ) ) ) 7071 ) { 7072 if ( $_return_loop ) { 7073 $return[ $tortoise ] = true; 7074 $return[ $evanescent_hare ] = true; 7075 $return[ $hare ] = true; 7076 } 7077 7078 // Tortoise got lapped - must be a loop. 7079 if ( $tortoise === $evanescent_hare || $tortoise === $hare ) { 7080 return $_return_loop ? $return : $tortoise; 7081 } 7082 7083 // Increment tortoise by one step. 7084 $tortoise = isset( $override[ $tortoise ] ) ? $override[ $tortoise ] : call_user_func_array( $callback, array_merge( array( $tortoise ), $callback_args ) ); 7085 } 7086 7087 return false; 7088 } 7089 7090 /** 7091 * Sends a HTTP header to limit rendering of pages to same origin iframes. 7092 * 7093 * @since 3.1.3 7094 * 7095 * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options 7096 */ 7097 function send_frame_options_header() { 7098 header( 'X-Frame-Options: SAMEORIGIN' ); 7099 } 7100 7101 /** 7102 * Retrieves a list of protocols to allow in HTML attributes. 7103 * 7104 * @since 3.3.0 7105 * @since 4.3.0 Added 'webcal' to the protocols array. 7106 * @since 4.7.0 Added 'urn' to the protocols array. 7107 * @since 5.3.0 Added 'sms' to the protocols array. 7108 * @since 5.6.0 Added 'irc6' and 'ircs' to the protocols array. 7109 * 7110 * @see wp_kses() 7111 * @see esc_url() 7112 * 7113 * @return string[] Array of allowed protocols. Defaults to an array containing 'http', 'https', 7114 * 'ftp', 'ftps', 'mailto', 'news', 'irc', 'irc6', 'ircs', 'gopher', 'nntp', 'feed', 7115 * 'telnet', 'mms', 'rtsp', 'sms', 'svn', 'tel', 'fax', 'xmpp', 'webcal', and 'urn'. 7116 * This covers all common link protocols, except for 'javascript' which should not 7117 * be allowed for untrusted users. 7118 */ 7119 function wp_allowed_protocols() { 7120 static $protocols = array(); 7121 7122 if ( empty( $protocols ) ) { 7123 $protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'irc6', 'ircs', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'sms', 'svn', 'tel', 'fax', 'xmpp', 'webcal', 'urn' ); 7124 } 7125 7126 if ( ! did_action( 'wp_loaded' ) ) { 7127 /** 7128 * Filters the list of protocols allowed in HTML attributes. 7129 * 7130 * @since 3.0.0 7131 * 7132 * @param string[] $protocols Array of allowed protocols e.g. 'http', 'ftp', 'tel', and more. 7133 */ 7134 $protocols = array_unique( (array) apply_filters( 'kses_allowed_protocols', $protocols ) ); 7135 } 7136 7137 return $protocols; 7138 } 7139 7140 /** 7141 * Returns a comma-separated string or array of functions that have been called to get 7142 * to the current point in code. 7143 * 7144 * @since 3.4.0 7145 * 7146 * @see https://core.trac.wordpress.org/ticket/19589 7147 * 7148 * @param string $ignore_class Optional. A class to ignore all function calls within - useful 7149 * when you want to just give info about the callee. Default null. 7150 * @param int $skip_frames Optional. A number of stack frames to skip - useful for unwinding 7151 * back to the source of the issue. Default 0. 7152 * @param bool $pretty Optional. Whether you want a comma separated string instead of 7153 * the raw array returned. Default true. 7154 * @return string|array Either a string containing a reversed comma separated trace or an array 7155 * of individual calls. 7156 */ 7157 function wp_debug_backtrace_summary( $ignore_class = null, $skip_frames = 0, $pretty = true ) { 7158 static $truncate_paths; 7159 7160 $trace = debug_backtrace( false ); 7161 $caller = array(); 7162 $check_class = ! is_null( $ignore_class ); 7163 ++$skip_frames; // Skip this function. 7164 7165 if ( ! isset( $truncate_paths ) ) { 7166 $truncate_paths = array( 7167 wp_normalize_path( WP_CONTENT_DIR ), 7168 wp_normalize_path( ABSPATH ), 7169 ); 7170 } 7171 7172 foreach ( $trace as $call ) { 7173 if ( $skip_frames > 0 ) { 7174 --$skip_frames; 7175 } elseif ( isset( $call['class'] ) ) { 7176 if ( $check_class && $ignore_class === $call['class'] ) { 7177 continue; // Filter out calls. 7178 } 7179 7180 $caller[] = "{$call['class']}{$call['type']}{$call['function']}"; 7181 } else { 7182 if ( in_array( $call['function'], array( 'do_action', 'apply_filters', 'do_action_ref_array', 'apply_filters_ref_array' ), true ) ) { 7183 $caller[] = "{$call['function']}('{$call['args'][0]}')"; 7184 } elseif ( in_array( $call['function'], array( 'include', 'include_once', 'require', 'require_once' ), true ) ) { 7185 $filename = isset( $call['args'][0] ) ? $call['args'][0] : ''; 7186 $caller[] = $call['function'] . "('" . str_replace( $truncate_paths, '', wp_normalize_path( $filename ) ) . "')"; 7187 } else { 7188 $caller[] = $call['function']; 7189 } 7190 } 7191 } 7192 if ( $pretty ) { 7193 return implode( ', ', array_reverse( $caller ) ); 7194 } else { 7195 return $caller; 7196 } 7197 } 7198 7199 /** 7200 * Retrieves IDs that are not already present in the cache. 7201 * 7202 * @since 3.4.0 7203 * @since 6.1.0 This function is no longer marked as "private". 7204 * 7205 * @param int[] $object_ids Array of IDs. 7206 * @param string $cache_group The cache group to check against. 7207 * @return int[] Array of IDs not present in the cache. 7208 */ 7209 function _get_non_cached_ids( $object_ids, $cache_group ) { 7210 $object_ids = array_filter( $object_ids, '_validate_cache_id' ); 7211 $object_ids = array_unique( array_map( 'intval', $object_ids ), SORT_NUMERIC ); 7212 7213 if ( empty( $object_ids ) ) { 7214 return array(); 7215 } 7216 7217 $non_cached_ids = array(); 7218 $cache_values = wp_cache_get_multiple( $object_ids, $cache_group ); 7219 7220 foreach ( $cache_values as $id => $value ) { 7221 if ( false === $value ) { 7222 $non_cached_ids[] = (int) $id; 7223 } 7224 } 7225 7226 return $non_cached_ids; 7227 } 7228 7229 /** 7230 * Checks whether the given cache ID is either an integer or an integer-like string. 7231 * 7232 * Both `16` and `"16"` are considered valid, other numeric types and numeric strings 7233 * (`16.3` and `"16.3"`) are considered invalid. 7234 * 7235 * @since 6.3.0 7236 * 7237 * @param mixed $object_id The cache ID to validate. 7238 * @return bool Whether the given $object_id is a valid cache ID. 7239 */ 7240 function _validate_cache_id( $object_id ) { 7241 /* 7242 * filter_var() could be used here, but the `filter` PHP extension 7243 * is considered optional and may not be available. 7244 */ 7245 if ( is_int( $object_id ) 7246 || ( is_string( $object_id ) && (string) (int) $object_id === $object_id ) ) { 7247 return true; 7248 } 7249 7250 /* translators: %s: The type of the given object ID. */ 7251 $message = sprintf( __( 'Object ID must be an integer, %s given.' ), gettype( $object_id ) ); 7252 _doing_it_wrong( '_get_non_cached_ids', $message, '6.3.0' ); 7253 7254 return false; 7255 } 7256 7257 /** 7258 * Tests if the current device has the capability to upload files. 7259 * 7260 * @since 3.4.0 7261 * @access private 7262 * 7263 * @return bool Whether the device is able to upload files. 7264 */ 7265 function _device_can_upload() { 7266 if ( ! wp_is_mobile() ) { 7267 return true; 7268 } 7269 7270 $ua = $_SERVER['HTTP_USER_AGENT']; 7271 7272 if ( str_contains( $ua, 'iPhone' ) 7273 || str_contains( $ua, 'iPad' ) 7274 || str_contains( $ua, 'iPod' ) ) { 7275 return preg_match( '#OS ([\d_]+) like Mac OS X#', $ua, $version ) && version_compare( $version[1], '6', '>=' ); 7276 } 7277 7278 return true; 7279 } 7280 7281 /** 7282 * Tests if a given path is a stream URL 7283 * 7284 * @since 3.5.0 7285 * 7286 * @param string $path The resource path or URL. 7287 * @return bool True if the path is a stream URL. 7288 */ 7289 function wp_is_stream( $path ) { 7290 $scheme_separator = strpos( $path, '://' ); 7291 7292 if ( false === $scheme_separator ) { 7293 // $path isn't a stream. 7294 return false; 7295 } 7296 7297 $stream = substr( $path, 0, $scheme_separator ); 7298 7299 return in_array( $stream, stream_get_wrappers(), true ); 7300 } 7301 7302 /** 7303 * Tests if the supplied date is valid for the Gregorian calendar. 7304 * 7305 * @since 3.5.0 7306 * 7307 * @link https://www.php.net/manual/en/function.checkdate.php 7308 * 7309 * @param int $month Month number. 7310 * @param int $day Day number. 7311 * @param int $year Year number. 7312 * @param string $source_date The date to filter. 7313 * @return bool True if valid date, false if not valid date. 7314 */ 7315 function wp_checkdate( $month, $day, $year, $source_date ) { 7316 /** 7317 * Filters whether the given date is valid for the Gregorian calendar. 7318 * 7319 * @since 3.5.0 7320 * 7321 * @param bool $checkdate Whether the given date is valid. 7322 * @param string $source_date Date to check. 7323 */ 7324 return apply_filters( 'wp_checkdate', checkdate( $month, $day, $year ), $source_date ); 7325 } 7326 7327 /** 7328 * Loads the auth check for monitoring whether the user is still logged in. 7329 * 7330 * Can be disabled with remove_action( 'admin_enqueue_scripts', 'wp_auth_check_load' ); 7331 * 7332 * This is disabled for certain screens where a login screen could cause an 7333 * inconvenient interruption. A filter called {@see 'wp_auth_check_load'} can be used 7334 * for fine-grained control. 7335 * 7336 * @since 3.6.0 7337 */ 7338 function wp_auth_check_load() { 7339 if ( ! is_admin() && ! is_user_logged_in() ) { 7340 return; 7341 } 7342 7343 if ( defined( 'IFRAME_REQUEST' ) ) { 7344 return; 7345 } 7346 7347 $screen = get_current_screen(); 7348 $hidden = array( 'update', 'update-network', 'update-core', 'update-core-network', 'upgrade', 'upgrade-network', 'network' ); 7349 $show = ! in_array( $screen->id, $hidden, true ); 7350 7351 /** 7352 * Filters whether to load the authentication check. 7353 * 7354 * Returning a falsey value from the filter will effectively short-circuit 7355 * loading the authentication check. 7356 * 7357 * @since 3.6.0 7358 * 7359 * @param bool $show Whether to load the authentication check. 7360 * @param WP_Screen $screen The current screen object. 7361 */ 7362 if ( apply_filters( 'wp_auth_check_load', $show, $screen ) ) { 7363 wp_enqueue_style( 'wp-auth-check' ); 7364 wp_enqueue_script( 'wp-auth-check' ); 7365 7366 add_action( 'admin_print_footer_scripts', 'wp_auth_check_html', 5 ); 7367 add_action( 'wp_print_footer_scripts', 'wp_auth_check_html', 5 ); 7368 } 7369 } 7370 7371 /** 7372 * Outputs the HTML that shows the wp-login dialog when the user is no longer logged in. 7373 * 7374 * @since 3.6.0 7375 */ 7376 function wp_auth_check_html() { 7377 $login_url = wp_login_url(); 7378 $current_domain = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST']; 7379 $same_domain = str_starts_with( $login_url, $current_domain ); 7380 7381 /** 7382 * Filters whether the authentication check originated at the same domain. 7383 * 7384 * @since 3.6.0 7385 * 7386 * @param bool $same_domain Whether the authentication check originated at the same domain. 7387 */ 7388 $same_domain = apply_filters( 'wp_auth_check_same_domain', $same_domain ); 7389 $wrap_class = $same_domain ? 'hidden' : 'hidden fallback'; 7390 7391 ?> 7392 <div id="wp-auth-check-wrap" class="<?php echo $wrap_class; ?>"> 7393 <div id="wp-auth-check-bg"></div> 7394 <div id="wp-auth-check"> 7395 <button type="button" class="wp-auth-check-close button-link"><span class="screen-reader-text"> 7396 <?php 7397 /* translators: Hidden accessibility text. */ 7398 _e( 'Close dialog' ); 7399 ?> 7400 </span></button> 7401 <?php 7402 7403 if ( $same_domain ) { 7404 $login_src = add_query_arg( 7405 array( 7406 'interim-login' => '1', 7407 'wp_lang' => get_user_locale(), 7408 ), 7409 $login_url 7410 ); 7411 ?> 7412 <div id="wp-auth-check-form" class="loading" data-src="<?php echo esc_url( $login_src ); ?>"></div> 7413 <?php 7414 } 7415 7416 ?> 7417 <div class="wp-auth-fallback"> 7418 <p><b class="wp-auth-fallback-expired" tabindex="0"><?php _e( 'Session expired' ); ?></b></p> 7419 <p><a href="<?php echo esc_url( $login_url ); ?>" target="_blank"><?php _e( 'Please log in again.' ); ?></a> 7420 <?php _e( 'The login page will open in a new tab. After logging in you can close it and return to this page.' ); ?></p> 7421 </div> 7422 </div> 7423 </div> 7424 <?php 7425 } 7426 7427 /** 7428 * Checks whether a user is still logged in, for the heartbeat. 7429 * 7430 * Send a result that shows a log-in box if the user is no longer logged in, 7431 * or if their cookie is within the grace period. 7432 * 7433 * @since 3.6.0 7434 * 7435 * @global int $login_grace_period 7436 * 7437 * @param array $response The Heartbeat response. 7438 * @return array The Heartbeat response with 'wp-auth-check' value set. 7439 */ 7440 function wp_auth_check( $response ) { 7441 $response['wp-auth-check'] = is_user_logged_in() && empty( $GLOBALS['login_grace_period'] ); 7442 return $response; 7443 } 7444 7445 /** 7446 * Returns RegEx body to liberally match an opening HTML tag. 7447 * 7448 * Matches an opening HTML tag that: 7449 * 1. Is self-closing or 7450 * 2. Has no body but has a closing tag of the same name or 7451 * 3. Contains a body and a closing tag of the same name 7452 * 7453 * Note: this RegEx does not balance inner tags and does not attempt 7454 * to produce valid HTML 7455 * 7456 * @since 3.6.0 7457 * 7458 * @param string $tag An HTML tag name. Example: 'video'. 7459 * @return string Tag RegEx. 7460 */ 7461 function get_tag_regex( $tag ) { 7462 if ( empty( $tag ) ) { 7463 return ''; 7464 } 7465 return sprintf( '<%1$s[^<]*(?:>[\s\S]*<\/%1$s>|\s*\/>)', tag_escape( $tag ) ); 7466 } 7467 7468 /** 7469 * Retrieves a canonical form of the provided charset appropriate for passing to PHP 7470 * functions such as htmlspecialchars() and charset HTML attributes. 7471 * 7472 * @since 3.6.0 7473 * @access private 7474 * 7475 * @see https://core.trac.wordpress.org/ticket/23688 7476 * 7477 * @param string $charset A charset name. 7478 * @return string The canonical form of the charset. 7479 */ 7480 function _canonical_charset( $charset ) { 7481 if ( 'utf-8' === strtolower( $charset ) || 'utf8' === strtolower( $charset ) ) { 7482 7483 return 'UTF-8'; 7484 } 7485 7486 if ( 'iso-8859-1' === strtolower( $charset ) || 'iso8859-1' === strtolower( $charset ) ) { 7487 7488 return 'ISO-8859-1'; 7489 } 7490 7491 return $charset; 7492 } 7493 7494 /** 7495 * Sets the mbstring internal encoding to a binary safe encoding when func_overload 7496 * is enabled. 7497 * 7498 * When mbstring.func_overload is in use for multi-byte encodings, the results from 7499 * strlen() and similar functions respect the utf8 characters, causing binary data 7500 * to return incorrect lengths. 7501 * 7502 * This function overrides the mbstring encoding to a binary-safe encoding, and 7503 * resets it to the users expected encoding afterwards through the 7504 * `reset_mbstring_encoding` function. 7505 * 7506 * It is safe to recursively call this function, however each 7507 * `mbstring_binary_safe_encoding()` call must be followed up with an equal number 7508 * of `reset_mbstring_encoding()` calls. 7509 * 7510 * @since 3.7.0 7511 * 7512 * @see reset_mbstring_encoding() 7513 * 7514 * @param bool $reset Optional. Whether to reset the encoding back to a previously-set encoding. 7515 * Default false. 7516 */ 7517 function mbstring_binary_safe_encoding( $reset = false ) { 7518 static $encodings = array(); 7519 static $overloaded = null; 7520 7521 if ( is_null( $overloaded ) ) { 7522 if ( function_exists( 'mb_internal_encoding' ) 7523 && ( (int) ini_get( 'mbstring.func_overload' ) & 2 ) // phpcs:ignore PHPCompatibility.IniDirectives.RemovedIniDirectives.mbstring_func_overloadDeprecated 7524 ) { 7525 $overloaded = true; 7526 } else { 7527 $overloaded = false; 7528 } 7529 } 7530 7531 if ( false === $overloaded ) { 7532 return; 7533 } 7534 7535 if ( ! $reset ) { 7536 $encoding = mb_internal_encoding(); 7537 array_push( $encodings, $encoding ); 7538 mb_internal_encoding( 'ISO-8859-1' ); 7539 } 7540 7541 if ( $reset && $encodings ) { 7542 $encoding = array_pop( $encodings ); 7543 mb_internal_encoding( $encoding ); 7544 } 7545 } 7546 7547 /** 7548 * Resets the mbstring internal encoding to a users previously set encoding. 7549 * 7550 * @see mbstring_binary_safe_encoding() 7551 * 7552 * @since 3.7.0 7553 */ 7554 function reset_mbstring_encoding() { 7555 mbstring_binary_safe_encoding( true ); 7556 } 7557 7558 /** 7559 * Filters/validates a variable as a boolean. 7560 * 7561 * Alternative to `filter_var( $value, FILTER_VALIDATE_BOOLEAN )`. 7562 * 7563 * @since 4.0.0 7564 * 7565 * @param mixed $value Boolean value to validate. 7566 * @return bool Whether the value is validated. 7567 */ 7568 function wp_validate_boolean( $value ) { 7569 if ( is_bool( $value ) ) { 7570 return $value; 7571 } 7572 7573 if ( is_string( $value ) && 'false' === strtolower( $value ) ) { 7574 return false; 7575 } 7576 7577 return (bool) $value; 7578 } 7579 7580 /** 7581 * Deletes a file. 7582 * 7583 * @since 4.2.0 7584 * 7585 * @param string $file The path to the file to delete. 7586 */ 7587 function wp_delete_file( $file ) { 7588 /** 7589 * Filters the path of the file to delete. 7590 * 7591 * @since 2.1.0 7592 * 7593 * @param string $file Path to the file to delete. 7594 */ 7595 $delete = apply_filters( 'wp_delete_file', $file ); 7596 if ( ! empty( $delete ) ) { 7597 @unlink( $delete ); 7598 } 7599 } 7600 7601 /** 7602 * Deletes a file if its path is within the given directory. 7603 * 7604 * @since 4.9.7 7605 * 7606 * @param string $file Absolute path to the file to delete. 7607 * @param string $directory Absolute path to a directory. 7608 * @return bool True on success, false on failure. 7609 */ 7610 function wp_delete_file_from_directory( $file, $directory ) { 7611 if ( wp_is_stream( $file ) ) { 7612 $real_file = $file; 7613 $real_directory = $directory; 7614 } else { 7615 $real_file = realpath( wp_normalize_path( $file ) ); 7616 $real_directory = realpath( wp_normalize_path( $directory ) ); 7617 } 7618 7619 if ( false !== $real_file ) { 7620 $real_file = wp_normalize_path( $real_file ); 7621 } 7622 7623 if ( false !== $real_directory ) { 7624 $real_directory = wp_normalize_path( $real_directory ); 7625 } 7626 7627 if ( false === $real_file || false === $real_directory || ! str_starts_with( $real_file, trailingslashit( $real_directory ) ) ) { 7628 return false; 7629 } 7630 7631 wp_delete_file( $file ); 7632 7633 return true; 7634 } 7635 7636 /** 7637 * Outputs a small JS snippet on preview tabs/windows to remove `window.name` when a user is navigating to another page. 7638 * 7639 * This prevents reusing the same tab for a preview when the user has navigated away. 7640 * 7641 * @since 4.3.0 7642 * 7643 * @global WP_Post $post Global post object. 7644 */ 7645 function wp_post_preview_js() { 7646 global $post; 7647 7648 if ( ! is_preview() || empty( $post ) ) { 7649 return; 7650 } 7651 7652 // Has to match the window name used in post_submit_meta_box(). 7653 $name = 'wp-preview-' . (int) $post->ID; 7654 7655 ob_start(); 7656 ?> 7657 <script> 7658 ( function() { 7659 var query = document.location.search; 7660 7661 if ( query && query.indexOf( 'preview=true' ) !== -1 ) { 7662 window.name = '<?php echo $name; ?>'; 7663 } 7664 7665 if ( window.addEventListener ) { 7666 window.addEventListener( 'pagehide', function() { window.name = ''; } ); 7667 } 7668 }()); 7669 </script> 7670 <?php 7671 wp_print_inline_script_tag( wp_remove_surrounding_empty_script_tags( ob_get_clean() ) ); 7672 } 7673 7674 /** 7675 * Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601 (Y-m-d\TH:i:s). 7676 * 7677 * Explicitly strips timezones, as datetimes are not saved with any timezone 7678 * information. Including any information on the offset could be misleading. 7679 * 7680 * Despite historical function name, the output does not conform to RFC3339 format, 7681 * which must contain timezone. 7682 * 7683 * @since 4.4.0 7684 * 7685 * @param string $date_string Date string to parse and format. 7686 * @return string Date formatted for ISO8601 without time zone. 7687 */ 7688 function mysql_to_rfc3339( $date_string ) { 7689 return mysql2date( 'Y-m-d\TH:i:s', $date_string, false ); 7690 } 7691 7692 /** 7693 * Attempts to raise the PHP memory limit for memory intensive processes. 7694 * 7695 * Only allows raising the existing limit and prevents lowering it. 7696 * 7697 * @since 4.6.0 7698 * 7699 * @param string $context Optional. Context in which the function is called. Accepts either 'admin', 7700 * 'image', 'cron', or an arbitrary other context. If an arbitrary context is passed, 7701 * the similarly arbitrary {@see '$context_memory_limit'} filter will be 7702 * invoked. Default 'admin'. 7703 * @return int|string|false The limit that was set or false on failure. 7704 */ 7705 function wp_raise_memory_limit( $context = 'admin' ) { 7706 // Exit early if the limit cannot be changed. 7707 if ( false === wp_is_ini_value_changeable( 'memory_limit' ) ) { 7708 return false; 7709 } 7710 7711 $current_limit = ini_get( 'memory_limit' ); 7712 $current_limit_int = wp_convert_hr_to_bytes( $current_limit ); 7713 7714 if ( -1 === $current_limit_int ) { 7715 return false; 7716 } 7717 7718 $wp_max_limit = WP_MAX_MEMORY_LIMIT; 7719 $wp_max_limit_int = wp_convert_hr_to_bytes( $wp_max_limit ); 7720 $filtered_limit = $wp_max_limit; 7721 7722 switch ( $context ) { 7723 case 'admin': 7724 /** 7725 * Filters the maximum memory limit available for administration screens. 7726 * 7727 * This only applies to administrators, who may require more memory for tasks 7728 * like updates. Memory limits when processing images (uploaded or edited by 7729 * users of any role) are handled separately. 7730 * 7731 * The `WP_MAX_MEMORY_LIMIT` constant specifically defines the maximum memory 7732 * limit available when in the administration back end. The default is 256M 7733 * (256 megabytes of memory) or the original `memory_limit` php.ini value if 7734 * this is higher. 7735 * 7736 * @since 3.0.0 7737 * @since 4.6.0 The default now takes the original `memory_limit` into account. 7738 * 7739 * @param int|string $filtered_limit The maximum WordPress memory limit. Accepts an integer 7740 * (bytes), or a shorthand string notation, such as '256M'. 7741 */ 7742 $filtered_limit = apply_filters( 'admin_memory_limit', $filtered_limit ); 7743 break; 7744 7745 case 'image': 7746 /** 7747 * Filters the memory limit allocated for image manipulation. 7748 * 7749 * @since 3.5.0 7750 * @since 4.6.0 The default now takes the original `memory_limit` into account. 7751 * 7752 * @param int|string $filtered_limit Maximum memory limit to allocate for image processing. 7753 * Default `WP_MAX_MEMORY_LIMIT` or the original 7754 * php.ini `memory_limit`, whichever is higher. 7755 * Accepts an integer (bytes), or a shorthand string 7756 * notation, such as '256M'. 7757 */ 7758 $filtered_limit = apply_filters( 'image_memory_limit', $filtered_limit ); 7759 break; 7760 7761 case 'cron': 7762 /** 7763 * Filters the memory limit allocated for WP-Cron event processing. 7764 * 7765 * @since 6.3.0 7766 * 7767 * @param int|string $filtered_limit Maximum memory limit to allocate for WP-Cron. 7768 * Default `WP_MAX_MEMORY_LIMIT` or the original 7769 * php.ini `memory_limit`, whichever is higher. 7770 * Accepts an integer (bytes), or a shorthand string 7771 * notation, such as '256M'. 7772 */ 7773 $filtered_limit = apply_filters( 'cron_memory_limit', $filtered_limit ); 7774 break; 7775 7776 default: 7777 /** 7778 * Filters the memory limit allocated for an arbitrary context. 7779 * 7780 * The dynamic portion of the hook name, `$context`, refers to an arbitrary 7781 * context passed on calling the function. This allows for plugins to define 7782 * their own contexts for raising the memory limit. 7783 * 7784 * @since 4.6.0 7785 * 7786 * @param int|string $filtered_limit Maximum memory limit to allocate for this context. 7787 * Default WP_MAX_MEMORY_LIMIT` or the original php.ini `memory_limit`, 7788 * whichever is higher. Accepts an integer (bytes), or a 7789 * shorthand string notation, such as '256M'. 7790 */ 7791 $filtered_limit = apply_filters( "{$context}_memory_limit", $filtered_limit ); 7792 break; 7793 } 7794 7795 $filtered_limit_int = wp_convert_hr_to_bytes( $filtered_limit ); 7796 7797 if ( -1 === $filtered_limit_int || ( $filtered_limit_int > $wp_max_limit_int && $filtered_limit_int > $current_limit_int ) ) { 7798 if ( false !== ini_set( 'memory_limit', $filtered_limit ) ) { 7799 return $filtered_limit; 7800 } else { 7801 return false; 7802 } 7803 } elseif ( -1 === $wp_max_limit_int || $wp_max_limit_int > $current_limit_int ) { 7804 if ( false !== ini_set( 'memory_limit', $wp_max_limit ) ) { 7805 return $wp_max_limit; 7806 } else { 7807 return false; 7808 } 7809 } 7810 7811 return false; 7812 } 7813 7814 /** 7815 * Generates a random UUID (version 4). 7816 * 7817 * @since 4.7.0 7818 * 7819 * @return string UUID. 7820 */ 7821 function wp_generate_uuid4() { 7822 return sprintf( 7823 '%04x%04x-%04x-%04x-%04x-%04x%04x%04x', 7824 mt_rand( 0, 0xffff ), 7825 mt_rand( 0, 0xffff ), 7826 mt_rand( 0, 0xffff ), 7827 mt_rand( 0, 0x0fff ) | 0x4000, 7828 mt_rand( 0, 0x3fff ) | 0x8000, 7829 mt_rand( 0, 0xffff ), 7830 mt_rand( 0, 0xffff ), 7831 mt_rand( 0, 0xffff ) 7832 ); 7833 } 7834 7835 /** 7836 * Validates that a UUID is valid. 7837 * 7838 * @since 4.9.0 7839 * 7840 * @param mixed $uuid UUID to check. 7841 * @param int $version Specify which version of UUID to check against. Default is none, 7842 * to accept any UUID version. Otherwise, only version allowed is `4`. 7843 * @return bool The string is a valid UUID or false on failure. 7844 */ 7845 function wp_is_uuid( $uuid, $version = null ) { 7846 7847 if ( ! is_string( $uuid ) ) { 7848 return false; 7849 } 7850 7851 if ( is_numeric( $version ) ) { 7852 if ( 4 !== (int) $version ) { 7853 _doing_it_wrong( __FUNCTION__, __( 'Only UUID V4 is supported at this time.' ), '4.9.0' ); 7854 return false; 7855 } 7856 $regex = '/^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/'; 7857 } else { 7858 $regex = '/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/'; 7859 } 7860 7861 return (bool) preg_match( $regex, $uuid ); 7862 } 7863 7864 /** 7865 * Gets unique ID. 7866 * 7867 * This is a PHP implementation of Underscore's uniqueId method. A static variable 7868 * contains an integer that is incremented with each call. This number is returned 7869 * with the optional prefix. As such the returned value is not universally unique, 7870 * but it is unique across the life of the PHP process. 7871 * 7872 * @since 5.0.3 7873 * 7874 * @param string $prefix Prefix for the returned ID. 7875 * @return string Unique ID. 7876 */ 7877 function wp_unique_id( $prefix = '' ) { 7878 static $id_counter = 0; 7879 return $prefix . (string) ++$id_counter; 7880 } 7881 7882 /** 7883 * Generates an incremental ID that is independent per each different prefix. 7884 * 7885 * It is similar to `wp_unique_id`, but each prefix has its own internal ID 7886 * counter to make each prefix independent from each other. The ID starts at 1 7887 * and increments on each call. The returned value is not universally unique, 7888 * but it is unique across the life of the PHP process and it's stable per 7889 * prefix. 7890 * 7891 * @since 6.4.0 7892 * 7893 * @param string $prefix Optional. Prefix for the returned ID. Default empty string. 7894 * @return string Incremental ID per prefix. 7895 */ 7896 function wp_unique_prefixed_id( $prefix = '' ) { 7897 static $id_counters = array(); 7898 7899 if ( ! is_string( $prefix ) ) { 7900 wp_trigger_error( 7901 __FUNCTION__, 7902 sprintf( 'The prefix must be a string. "%s" data type given.', gettype( $prefix ) ) 7903 ); 7904 $prefix = ''; 7905 } 7906 7907 if ( ! isset( $id_counters[ $prefix ] ) ) { 7908 $id_counters[ $prefix ] = 0; 7909 } 7910 7911 $id = ++$id_counters[ $prefix ]; 7912 7913 return $prefix . (string) $id; 7914 } 7915 7916 /** 7917 * Gets last changed date for the specified cache group. 7918 * 7919 * @since 4.7.0 7920 * 7921 * @param string $group Where the cache contents are grouped. 7922 * @return string UNIX timestamp with microseconds representing when the group was last changed. 7923 */ 7924 function wp_cache_get_last_changed( $group ) { 7925 $last_changed = wp_cache_get( 'last_changed', $group ); 7926 7927 if ( $last_changed ) { 7928 return $last_changed; 7929 } 7930 7931 return wp_cache_set_last_changed( $group ); 7932 } 7933 7934 /** 7935 * Sets last changed date for the specified cache group to now. 7936 * 7937 * @since 6.3.0 7938 * 7939 * @param string $group Where the cache contents are grouped. 7940 * @return string UNIX timestamp when the group was last changed. 7941 */ 7942 function wp_cache_set_last_changed( $group ) { 7943 $previous_time = wp_cache_get( 'last_changed', $group ); 7944 7945 $time = microtime(); 7946 7947 wp_cache_set( 'last_changed', $time, $group ); 7948 7949 /** 7950 * Fires after a cache group `last_changed` time is updated. 7951 * This may occur multiple times per page load and registered 7952 * actions must be performant. 7953 * 7954 * @since 6.3.0 7955 * 7956 * @param string $group The cache group name. 7957 * @param int $time The new last changed time. 7958 * @param int|false $previous_time The previous last changed time. False if not previously set. 7959 */ 7960 do_action( 'wp_cache_set_last_changed', $group, $time, $previous_time ); 7961 7962 return $time; 7963 } 7964 7965 /** 7966 * Sends an email to the old site admin email address when the site admin email address changes. 7967 * 7968 * @since 4.9.0 7969 * 7970 * @param string $old_email The old site admin email address. 7971 * @param string $new_email The new site admin email address. 7972 * @param string $option_name The relevant database option name. 7973 */ 7974 function wp_site_admin_email_change_notification( $old_email, $new_email, $option_name ) { 7975 $send = true; 7976 7977 // Don't send the notification to the default 'admin_email' value. 7978 if ( 'you@example.com' === $old_email ) { 7979 $send = false; 7980 } 7981 7982 /** 7983 * Filters whether to send the site admin email change notification email. 7984 * 7985 * @since 4.9.0 7986 * 7987 * @param bool $send Whether to send the email notification. 7988 * @param string $old_email The old site admin email address. 7989 * @param string $new_email The new site admin email address. 7990 */ 7991 $send = apply_filters( 'send_site_admin_email_change_email', $send, $old_email, $new_email ); 7992 7993 if ( ! $send ) { 7994 return; 7995 } 7996 7997 /* translators: Do not translate OLD_EMAIL, NEW_EMAIL, SITENAME, SITEURL: those are placeholders. */ 7998 $email_change_text = __( 7999 'Hi, 8000 8001 This notice confirms that the admin email address was changed on ###SITENAME###. 8002 8003 The new admin email address is ###NEW_EMAIL###. 8004 8005 This email has been sent to ###OLD_EMAIL### 8006 8007 Regards, 8008 All at ###SITENAME### 8009 ###SITEURL###' 8010 ); 8011 8012 $email_change_email = array( 8013 'to' => $old_email, 8014 /* translators: Site admin email change notification email subject. %s: Site title. */ 8015 'subject' => __( '[%s] Admin Email Changed' ), 8016 'message' => $email_change_text, 8017 'headers' => '', 8018 ); 8019 8020 // Get site name. 8021 $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 8022 8023 /** 8024 * Filters the contents of the email notification sent when the site admin email address is changed. 8025 * 8026 * @since 4.9.0 8027 * 8028 * @param array $email_change_email { 8029 * Used to build wp_mail(). 8030 * 8031 * @type string $to The intended recipient. 8032 * @type string $subject The subject of the email. 8033 * @type string $message The content of the email. 8034 * The following strings have a special meaning and will get replaced dynamically: 8035 * - ###OLD_EMAIL### The old site admin email address. 8036 * - ###NEW_EMAIL### The new site admin email address. 8037 * - ###SITENAME### The name of the site. 8038 * - ###SITEURL### The URL to the site. 8039 * @type string $headers Headers. 8040 * } 8041 * @param string $old_email The old site admin email address. 8042 * @param string $new_email The new site admin email address. 8043 */ 8044 $email_change_email = apply_filters( 'site_admin_email_change_email', $email_change_email, $old_email, $new_email ); 8045 8046 $email_change_email['message'] = str_replace( '###OLD_EMAIL###', $old_email, $email_change_email['message'] ); 8047 $email_change_email['message'] = str_replace( '###NEW_EMAIL###', $new_email, $email_change_email['message'] ); 8048 $email_change_email['message'] = str_replace( '###SITENAME###', $site_name, $email_change_email['message'] ); 8049 $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] ); 8050 8051 wp_mail( 8052 $email_change_email['to'], 8053 sprintf( 8054 $email_change_email['subject'], 8055 $site_name 8056 ), 8057 $email_change_email['message'], 8058 $email_change_email['headers'] 8059 ); 8060 } 8061 8062 /** 8063 * Returns an anonymized IPv4 or IPv6 address. 8064 * 8065 * @since 4.9.6 Abstracted from `WP_Community_Events::get_unsafe_client_ip()`. 8066 * 8067 * @param string $ip_addr The IPv4 or IPv6 address to be anonymized. 8068 * @param bool $ipv6_fallback Optional. Whether to return the original IPv6 address if the needed functions 8069 * to anonymize it are not present. Default false, return `::` (unspecified address). 8070 * @return string The anonymized IP address. 8071 */ 8072 function wp_privacy_anonymize_ip( $ip_addr, $ipv6_fallback = false ) { 8073 if ( empty( $ip_addr ) ) { 8074 return '0.0.0.0'; 8075 } 8076 8077 // Detect what kind of IP address this is. 8078 $ip_prefix = ''; 8079 $is_ipv6 = substr_count( $ip_addr, ':' ) > 1; 8080 $is_ipv4 = ( 3 === substr_count( $ip_addr, '.' ) ); 8081 8082 if ( $is_ipv6 && $is_ipv4 ) { 8083 // IPv6 compatibility mode, temporarily strip the IPv6 part, and treat it like IPv4. 8084 $ip_prefix = '::ffff:'; 8085 $ip_addr = preg_replace( '/^\[?[0-9a-f:]*:/i', '', $ip_addr ); 8086 $ip_addr = str_replace( ']', '', $ip_addr ); 8087 $is_ipv6 = false; 8088 } 8089 8090 if ( $is_ipv6 ) { 8091 // IPv6 addresses will always be enclosed in [] if there's a port. 8092 $left_bracket = strpos( $ip_addr, '[' ); 8093 $right_bracket = strpos( $ip_addr, ']' ); 8094 $percent = strpos( $ip_addr, '%' ); 8095 $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000'; 8096 8097 // Strip the port (and [] from IPv6 addresses), if they exist. 8098 if ( false !== $left_bracket && false !== $right_bracket ) { 8099 $ip_addr = substr( $ip_addr, $left_bracket + 1, $right_bracket - $left_bracket - 1 ); 8100 } elseif ( false !== $left_bracket || false !== $right_bracket ) { 8101 // The IP has one bracket, but not both, so it's malformed. 8102 return '::'; 8103 } 8104 8105 // Strip the reachability scope. 8106 if ( false !== $percent ) { 8107 $ip_addr = substr( $ip_addr, 0, $percent ); 8108 } 8109 8110 // No invalid characters should be left. 8111 if ( preg_match( '/[^0-9a-f:]/i', $ip_addr ) ) { 8112 return '::'; 8113 } 8114 8115 // Partially anonymize the IP by reducing it to the corresponding network ID. 8116 if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) { 8117 $ip_addr = inet_ntop( inet_pton( $ip_addr ) & inet_pton( $netmask ) ); 8118 if ( false === $ip_addr ) { 8119 return '::'; 8120 } 8121 } elseif ( ! $ipv6_fallback ) { 8122 return '::'; 8123 } 8124 } elseif ( $is_ipv4 ) { 8125 // Strip any port and partially anonymize the IP. 8126 $last_octet_position = strrpos( $ip_addr, '.' ); 8127 $ip_addr = substr( $ip_addr, 0, $last_octet_position ) . '.0'; 8128 } else { 8129 return '0.0.0.0'; 8130 } 8131 8132 // Restore the IPv6 prefix to compatibility mode addresses. 8133 return $ip_prefix . $ip_addr; 8134 } 8135 8136 /** 8137 * Returns uniform "anonymous" data by type. 8138 * 8139 * @since 4.9.6 8140 * 8141 * @param string $type The type of data to be anonymized. 8142 * @param string $data Optional. The data to be anonymized. Default empty string. 8143 * @return string The anonymous data for the requested type. 8144 */ 8145 function wp_privacy_anonymize_data( $type, $data = '' ) { 8146 8147 switch ( $type ) { 8148 case 'email': 8149 $anonymous = 'deleted@site.invalid'; 8150 break; 8151 case 'url': 8152 $anonymous = 'https://site.invalid'; 8153 break; 8154 case 'ip': 8155 $anonymous = wp_privacy_anonymize_ip( $data ); 8156 break; 8157 case 'date': 8158 $anonymous = '0000-00-00 00:00:00'; 8159 break; 8160 case 'text': 8161 /* translators: Deleted text. */ 8162 $anonymous = __( '[deleted]' ); 8163 break; 8164 case 'longtext': 8165 /* translators: Deleted long text. */ 8166 $anonymous = __( 'This content was deleted by the author.' ); 8167 break; 8168 default: 8169 $anonymous = ''; 8170 break; 8171 } 8172 8173 /** 8174 * Filters the anonymous data for each type. 8175 * 8176 * @since 4.9.6 8177 * 8178 * @param string $anonymous Anonymized data. 8179 * @param string $type Type of the data. 8180 * @param string $data Original data. 8181 */ 8182 return apply_filters( 'wp_privacy_anonymize_data', $anonymous, $type, $data ); 8183 } 8184 8185 /** 8186 * Returns the directory used to store personal data export files. 8187 * 8188 * @since 4.9.6 8189 * 8190 * @see wp_privacy_exports_url 8191 * 8192 * @return string Exports directory. 8193 */ 8194 function wp_privacy_exports_dir() { 8195 $upload_dir = wp_upload_dir(); 8196 $exports_dir = trailingslashit( $upload_dir['basedir'] ) . 'wp-personal-data-exports/'; 8197 8198 /** 8199 * Filters the directory used to store personal data export files. 8200 * 8201 * @since 4.9.6 8202 * @since 5.5.0 Exports now use relative paths, so changes to the directory 8203 * via this filter should be reflected on the server. 8204 * 8205 * @param string $exports_dir Exports directory. 8206 */ 8207 return apply_filters( 'wp_privacy_exports_dir', $exports_dir ); 8208 } 8209 8210 /** 8211 * Returns the URL of the directory used to store personal data export files. 8212 * 8213 * @since 4.9.6 8214 * 8215 * @see wp_privacy_exports_dir 8216 * 8217 * @return string Exports directory URL. 8218 */ 8219 function wp_privacy_exports_url() { 8220 $upload_dir = wp_upload_dir(); 8221 $exports_url = trailingslashit( $upload_dir['baseurl'] ) . 'wp-personal-data-exports/'; 8222 8223 /** 8224 * Filters the URL of the directory used to store personal data export files. 8225 * 8226 * @since 4.9.6 8227 * @since 5.5.0 Exports now use relative paths, so changes to the directory URL 8228 * via this filter should be reflected on the server. 8229 * 8230 * @param string $exports_url Exports directory URL. 8231 */ 8232 return apply_filters( 'wp_privacy_exports_url', $exports_url ); 8233 } 8234 8235 /** 8236 * Schedules a `WP_Cron` job to delete expired export files. 8237 * 8238 * @since 4.9.6 8239 */ 8240 function wp_schedule_delete_old_privacy_export_files() { 8241 if ( wp_installing() ) { 8242 return; 8243 } 8244 8245 if ( ! wp_next_scheduled( 'wp_privacy_delete_old_export_files' ) ) { 8246 wp_schedule_event( time(), 'hourly', 'wp_privacy_delete_old_export_files' ); 8247 } 8248 } 8249 8250 /** 8251 * Cleans up export files older than three days old. 8252 * 8253 * The export files are stored in `wp-content/uploads`, and are therefore publicly 8254 * accessible. A CSPRN is appended to the filename to mitigate the risk of an 8255 * unauthorized person downloading the file, but it is still possible. Deleting 8256 * the file after the data subject has had a chance to delete it adds an additional 8257 * layer of protection. 8258 * 8259 * @since 4.9.6 8260 */ 8261 function wp_privacy_delete_old_export_files() { 8262 $exports_dir = wp_privacy_exports_dir(); 8263 if ( ! is_dir( $exports_dir ) ) { 8264 return; 8265 } 8266 8267 require_once ABSPATH . 'wp-admin/includes/file.php'; 8268 $export_files = list_files( $exports_dir, 100, array( 'index.php' ) ); 8269 8270 /** 8271 * Filters the lifetime, in seconds, of a personal data export file. 8272 * 8273 * By default, the lifetime is 3 days. Once the file reaches that age, it will automatically 8274 * be deleted by a cron job. 8275 * 8276 * @since 4.9.6 8277 * 8278 * @param int $expiration The expiration age of the export, in seconds. 8279 */ 8280 $expiration = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS ); 8281 8282 foreach ( (array) $export_files as $export_file ) { 8283 $file_age_in_seconds = time() - filemtime( $export_file ); 8284 8285 if ( $expiration < $file_age_in_seconds ) { 8286 unlink( $export_file ); 8287 } 8288 } 8289 } 8290 8291 /** 8292 * Gets the URL to learn more about updating the PHP version the site is running on. 8293 * 8294 * This URL can be overridden by specifying an environment variable `WP_UPDATE_PHP_URL` or by using the 8295 * {@see 'wp_update_php_url'} filter. Providing an empty string is not allowed and will result in the 8296 * default URL being used. Furthermore the page the URL links to should preferably be localized in the 8297 * site language. 8298 * 8299 * @since 5.1.0 8300 * 8301 * @return string URL to learn more about updating PHP. 8302 */ 8303 function wp_get_update_php_url() { 8304 $default_url = wp_get_default_update_php_url(); 8305 8306 $update_url = $default_url; 8307 if ( false !== getenv( 'WP_UPDATE_PHP_URL' ) ) { 8308 $update_url = getenv( 'WP_UPDATE_PHP_URL' ); 8309 } 8310 8311 /** 8312 * Filters the URL to learn more about updating the PHP version the site is running on. 8313 * 8314 * Providing an empty string is not allowed and will result in the default URL being used. Furthermore 8315 * the page the URL links to should preferably be localized in the site language. 8316 * 8317 * @since 5.1.0 8318 * 8319 * @param string $update_url URL to learn more about updating PHP. 8320 */ 8321 $update_url = apply_filters( 'wp_update_php_url', $update_url ); 8322 8323 if ( empty( $update_url ) ) { 8324 $update_url = $default_url; 8325 } 8326 8327 return $update_url; 8328 } 8329 8330 /** 8331 * Gets the default URL to learn more about updating the PHP version the site is running on. 8332 * 8333 * Do not use this function to retrieve this URL. Instead, use {@see wp_get_update_php_url()} when relying on the URL. 8334 * This function does not allow modifying the returned URL, and is only used to compare the actually used URL with the 8335 * default one. 8336 * 8337 * @since 5.1.0 8338 * @access private 8339 * 8340 * @return string Default URL to learn more about updating PHP. 8341 */ 8342 function wp_get_default_update_php_url() { 8343 return _x( 'https://wordpress.org/support/update-php/', 'localized PHP upgrade information page' ); 8344 } 8345 8346 /** 8347 * Prints the default annotation for the web host altering the "Update PHP" page URL. 8348 * 8349 * This function is to be used after {@see wp_get_update_php_url()} to display a consistent 8350 * annotation if the web host has altered the default "Update PHP" page URL. 8351 * 8352 * @since 5.1.0 8353 * @since 5.2.0 Added the `$before` and `$after` parameters. 8354 * @since 6.4.0 Added the `$display` parameter. 8355 * 8356 * @param string $before Markup to output before the annotation. Default `<p class="description">`. 8357 * @param string $after Markup to output after the annotation. Default `</p>`. 8358 * @param bool $display Whether to echo or return the markup. Default `true` for echo. 8359 * 8360 * @return string|void 8361 */ 8362 function wp_update_php_annotation( $before = '<p class="description">', $after = '</p>', $display = true ) { 8363 $annotation = wp_get_update_php_annotation(); 8364 8365 if ( $annotation ) { 8366 if ( $display ) { 8367 echo $before . $annotation . $after; 8368 } else { 8369 return $before . $annotation . $after; 8370 } 8371 } 8372 } 8373 8374 /** 8375 * Returns the default annotation for the web hosting altering the "Update PHP" page URL. 8376 * 8377 * This function is to be used after {@see wp_get_update_php_url()} to return a consistent 8378 * annotation if the web host has altered the default "Update PHP" page URL. 8379 * 8380 * @since 5.2.0 8381 * 8382 * @return string Update PHP page annotation. An empty string if no custom URLs are provided. 8383 */ 8384 function wp_get_update_php_annotation() { 8385 $update_url = wp_get_update_php_url(); 8386 $default_url = wp_get_default_update_php_url(); 8387 8388 if ( $update_url === $default_url ) { 8389 return ''; 8390 } 8391 8392 $annotation = sprintf( 8393 /* translators: %s: Default Update PHP page URL. */ 8394 __( 'This resource is provided by your web host, and is specific to your site. For more information, <a href="%s" target="_blank">see the official WordPress documentation</a>.' ), 8395 esc_url( $default_url ) 8396 ); 8397 8398 return $annotation; 8399 } 8400 8401 /** 8402 * Gets the URL for directly updating the PHP version the site is running on. 8403 * 8404 * A URL will only be returned if the `WP_DIRECT_UPDATE_PHP_URL` environment variable is specified or 8405 * by using the {@see 'wp_direct_php_update_url'} filter. This allows hosts to send users directly to 8406 * the page where they can update PHP to a newer version. 8407 * 8408 * @since 5.1.1 8409 * 8410 * @return string URL for directly updating PHP or empty string. 8411 */ 8412 function wp_get_direct_php_update_url() { 8413 $direct_update_url = ''; 8414 8415 if ( false !== getenv( 'WP_DIRECT_UPDATE_PHP_URL' ) ) { 8416 $direct_update_url = getenv( 'WP_DIRECT_UPDATE_PHP_URL' ); 8417 } 8418 8419 /** 8420 * Filters the URL for directly updating the PHP version the site is running on from the host. 8421 * 8422 * @since 5.1.1 8423 * 8424 * @param string $direct_update_url URL for directly updating PHP. 8425 */ 8426 $direct_update_url = apply_filters( 'wp_direct_php_update_url', $direct_update_url ); 8427 8428 return $direct_update_url; 8429 } 8430 8431 /** 8432 * Displays a button directly linking to a PHP update process. 8433 * 8434 * This provides hosts with a way for users to be sent directly to their PHP update process. 8435 * 8436 * The button is only displayed if a URL is returned by `wp_get_direct_php_update_url()`. 8437 * 8438 * @since 5.1.1 8439 */ 8440 function wp_direct_php_update_button() { 8441 $direct_update_url = wp_get_direct_php_update_url(); 8442 8443 if ( empty( $direct_update_url ) ) { 8444 return; 8445 } 8446 8447 echo '<p class="button-container">'; 8448 printf( 8449 '<a class="button button-primary" href="%1$s" target="_blank" rel="noopener">%2$s<span class="screen-reader-text"> %3$s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a>', 8450 esc_url( $direct_update_url ), 8451 __( 'Update PHP' ), 8452 /* translators: Hidden accessibility text. */ 8453 __( '(opens in a new tab)' ) 8454 ); 8455 echo '</p>'; 8456 } 8457 8458 /** 8459 * Gets the URL to learn more about updating the site to use HTTPS. 8460 * 8461 * This URL can be overridden by specifying an environment variable `WP_UPDATE_HTTPS_URL` or by using the 8462 * {@see 'wp_update_https_url'} filter. Providing an empty string is not allowed and will result in the 8463 * default URL being used. Furthermore the page the URL links to should preferably be localized in the 8464 * site language. 8465 * 8466 * @since 5.7.0 8467 * 8468 * @return string URL to learn more about updating to HTTPS. 8469 */ 8470 function wp_get_update_https_url() { 8471 $default_url = wp_get_default_update_https_url(); 8472 8473 $update_url = $default_url; 8474 if ( false !== getenv( 'WP_UPDATE_HTTPS_URL' ) ) { 8475 $update_url = getenv( 'WP_UPDATE_HTTPS_URL' ); 8476 } 8477 8478 /** 8479 * Filters the URL to learn more about updating the HTTPS version the site is running on. 8480 * 8481 * Providing an empty string is not allowed and will result in the default URL being used. Furthermore 8482 * the page the URL links to should preferably be localized in the site language. 8483 * 8484 * @since 5.7.0 8485 * 8486 * @param string $update_url URL to learn more about updating HTTPS. 8487 */ 8488 $update_url = apply_filters( 'wp_update_https_url', $update_url ); 8489 if ( empty( $update_url ) ) { 8490 $update_url = $default_url; 8491 } 8492 8493 return $update_url; 8494 } 8495 8496 /** 8497 * Gets the default URL to learn more about updating the site to use HTTPS. 8498 * 8499 * Do not use this function to retrieve this URL. Instead, use {@see wp_get_update_https_url()} when relying on the URL. 8500 * This function does not allow modifying the returned URL, and is only used to compare the actually used URL with the 8501 * default one. 8502 * 8503 * @since 5.7.0 8504 * @access private 8505 * 8506 * @return string Default URL to learn more about updating to HTTPS. 8507 */ 8508 function wp_get_default_update_https_url() { 8509 /* translators: Documentation explaining HTTPS and why it should be used. */ 8510 return __( 'https://developer.wordpress.org/advanced-administration/security/https/' ); 8511 } 8512 8513 /** 8514 * Gets the URL for directly updating the site to use HTTPS. 8515 * 8516 * A URL will only be returned if the `WP_DIRECT_UPDATE_HTTPS_URL` environment variable is specified or 8517 * by using the {@see 'wp_direct_update_https_url'} filter. This allows hosts to send users directly to 8518 * the page where they can update their site to use HTTPS. 8519 * 8520 * @since 5.7.0 8521 * 8522 * @return string URL for directly updating to HTTPS or empty string. 8523 */ 8524 function wp_get_direct_update_https_url() { 8525 $direct_update_url = ''; 8526 8527 if ( false !== getenv( 'WP_DIRECT_UPDATE_HTTPS_URL' ) ) { 8528 $direct_update_url = getenv( 'WP_DIRECT_UPDATE_HTTPS_URL' ); 8529 } 8530 8531 /** 8532 * Filters the URL for directly updating the PHP version the site is running on from the host. 8533 * 8534 * @since 5.7.0 8535 * 8536 * @param string $direct_update_url URL for directly updating PHP. 8537 */ 8538 $direct_update_url = apply_filters( 'wp_direct_update_https_url', $direct_update_url ); 8539 8540 return $direct_update_url; 8541 } 8542 8543 /** 8544 * Gets the size of a directory. 8545 * 8546 * A helper function that is used primarily to check whether 8547 * a blog has exceeded its allowed upload space. 8548 * 8549 * @since MU (3.0.0) 8550 * @since 5.2.0 $max_execution_time parameter added. 8551 * 8552 * @param string $directory Full path of a directory. 8553 * @param int $max_execution_time Maximum time to run before giving up. In seconds. 8554 * The timeout is global and is measured from the moment WordPress started to load. 8555 * @return int|false|null Size in bytes if a valid directory. False if not. Null if timeout. 8556 */ 8557 function get_dirsize( $directory, $max_execution_time = null ) { 8558 8559 /* 8560 * Exclude individual site directories from the total when checking the main site of a network, 8561 * as they are subdirectories and should not be counted. 8562 */ 8563 if ( is_multisite() && is_main_site() ) { 8564 $size = recurse_dirsize( $directory, $directory . '/sites', $max_execution_time ); 8565 } else { 8566 $size = recurse_dirsize( $directory, null, $max_execution_time ); 8567 } 8568 8569 return $size; 8570 } 8571 8572 /** 8573 * Gets the size of a directory recursively. 8574 * 8575 * Used by get_dirsize() to get a directory size when it contains other directories. 8576 * 8577 * @since MU (3.0.0) 8578 * @since 4.3.0 The `$exclude` parameter was added. 8579 * @since 5.2.0 The `$max_execution_time` parameter was added. 8580 * @since 5.6.0 The `$directory_cache` parameter was added. 8581 * 8582 * @param string $directory Full path of a directory. 8583 * @param string|string[] $exclude Optional. Full path of a subdirectory to exclude from the total, 8584 * or array of paths. Expected without trailing slash(es). 8585 * Default null. 8586 * @param int $max_execution_time Optional. Maximum time to run before giving up. In seconds. 8587 * The timeout is global and is measured from the moment 8588 * WordPress started to load. Defaults to the value of 8589 * `max_execution_time` PHP setting. 8590 * @param array $directory_cache Optional. Array of cached directory paths. 8591 * Defaults to the value of `dirsize_cache` transient. 8592 * @return int|false|null Size in bytes if a valid directory. False if not. Null if timeout. 8593 */ 8594 function recurse_dirsize( $directory, $exclude = null, $max_execution_time = null, &$directory_cache = null ) { 8595 $directory = untrailingslashit( $directory ); 8596 $save_cache = false; 8597 8598 if ( ! isset( $directory_cache ) ) { 8599 $directory_cache = get_transient( 'dirsize_cache' ); 8600 $save_cache = true; 8601 } 8602 8603 if ( isset( $directory_cache[ $directory ] ) && is_int( $directory_cache[ $directory ] ) ) { 8604 return $directory_cache[ $directory ]; 8605 } 8606 8607 if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) ) { 8608 return false; 8609 } 8610 8611 if ( 8612 ( is_string( $exclude ) && $directory === $exclude ) || 8613 ( is_array( $exclude ) && in_array( $directory, $exclude, true ) ) 8614 ) { 8615 return false; 8616 } 8617 8618 if ( null === $max_execution_time ) { 8619 // Keep the previous behavior but attempt to prevent fatal errors from timeout if possible. 8620 if ( function_exists( 'ini_get' ) ) { 8621 $max_execution_time = ini_get( 'max_execution_time' ); 8622 } else { 8623 // Disable... 8624 $max_execution_time = 0; 8625 } 8626 8627 // Leave 1 second "buffer" for other operations if $max_execution_time has reasonable value. 8628 if ( $max_execution_time > 10 ) { 8629 $max_execution_time -= 1; 8630 } 8631 } 8632 8633 /** 8634 * Filters the amount of storage space used by one directory and all its children, in megabytes. 8635 * 8636 * Return the actual used space to short-circuit the recursive PHP file size calculation 8637 * and use something else, like a CDN API or native operating system tools for better performance. 8638 * 8639 * @since 5.6.0 8640 * 8641 * @param int|false $space_used The amount of used space, in bytes. Default false. 8642 * @param string $directory Full path of a directory. 8643 * @param string|string[]|null $exclude Full path of a subdirectory to exclude from the total, 8644 * or array of paths. 8645 * @param int $max_execution_time Maximum time to run before giving up. In seconds. 8646 * @param array $directory_cache Array of cached directory paths. 8647 */ 8648 $size = apply_filters( 'pre_recurse_dirsize', false, $directory, $exclude, $max_execution_time, $directory_cache ); 8649 8650 if ( false === $size ) { 8651 $size = 0; 8652 8653 $handle = opendir( $directory ); 8654 if ( $handle ) { 8655 while ( ( $file = readdir( $handle ) ) !== false ) { 8656 $path = $directory . '/' . $file; 8657 if ( '.' !== $file && '..' !== $file ) { 8658 if ( is_file( $path ) ) { 8659 $size += filesize( $path ); 8660 } elseif ( is_dir( $path ) ) { 8661 $handlesize = recurse_dirsize( $path, $exclude, $max_execution_time, $directory_cache ); 8662 if ( $handlesize > 0 ) { 8663 $size += $handlesize; 8664 } 8665 } 8666 8667 if ( $max_execution_time > 0 && 8668 ( microtime( true ) - WP_START_TIMESTAMP ) > $max_execution_time 8669 ) { 8670 // Time exceeded. Give up instead of risking a fatal timeout. 8671 $size = null; 8672 break; 8673 } 8674 } 8675 } 8676 closedir( $handle ); 8677 } 8678 } 8679 8680 if ( ! is_array( $directory_cache ) ) { 8681 $directory_cache = array(); 8682 } 8683 8684 $directory_cache[ $directory ] = $size; 8685 8686 // Only write the transient on the top level call and not on recursive calls. 8687 if ( $save_cache ) { 8688 $expiration = ( wp_using_ext_object_cache() ) ? 0 : 10 * YEAR_IN_SECONDS; 8689 set_transient( 'dirsize_cache', $directory_cache, $expiration ); 8690 } 8691 8692 return $size; 8693 } 8694 8695 /** 8696 * Cleans directory size cache used by recurse_dirsize(). 8697 * 8698 * Removes the current directory and all parent directories from the `dirsize_cache` transient. 8699 * 8700 * @since 5.6.0 8701 * @since 5.9.0 Added input validation with a notice for invalid input. 8702 * 8703 * @param string $path Full path of a directory or file. 8704 */ 8705 function clean_dirsize_cache( $path ) { 8706 if ( ! is_string( $path ) || empty( $path ) ) { 8707 trigger_error( 8708 sprintf( 8709 /* translators: 1: Function name, 2: A variable type, like "boolean" or "integer". */ 8710 __( '%1$s only accepts a non-empty path string, received %2$s.' ), 8711 '<code>clean_dirsize_cache()</code>', 8712 '<code>' . gettype( $path ) . '</code>' 8713 ) 8714 ); 8715 return; 8716 } 8717 8718 $directory_cache = get_transient( 'dirsize_cache' ); 8719 8720 if ( empty( $directory_cache ) ) { 8721 return; 8722 } 8723 8724 $expiration = ( wp_using_ext_object_cache() ) ? 0 : 10 * YEAR_IN_SECONDS; 8725 if ( 8726 ! str_contains( $path, '/' ) && 8727 ! str_contains( $path, '\\' ) 8728 ) { 8729 unset( $directory_cache[ $path ] ); 8730 set_transient( 'dirsize_cache', $directory_cache, $expiration ); 8731 return; 8732 } 8733 8734 $last_path = null; 8735 $path = untrailingslashit( $path ); 8736 unset( $directory_cache[ $path ] ); 8737 8738 while ( 8739 $last_path !== $path && 8740 DIRECTORY_SEPARATOR !== $path && 8741 '.' !== $path && 8742 '..' !== $path 8743 ) { 8744 $last_path = $path; 8745 $path = dirname( $path ); 8746 unset( $directory_cache[ $path ] ); 8747 } 8748 8749 set_transient( 'dirsize_cache', $directory_cache, $expiration ); 8750 } 8751 8752 /** 8753 * Checks compatibility with the current WordPress version. 8754 * 8755 * @since 5.2.0 8756 * 8757 * @global string $wp_version The WordPress version string. 8758 * 8759 * @param string $required Minimum required WordPress version. 8760 * @return bool True if required version is compatible or empty, false if not. 8761 */ 8762 function is_wp_version_compatible( $required ) { 8763 global $wp_version; 8764 8765 // Strip off any -alpha, -RC, -beta, -src suffixes. 8766 list( $version ) = explode( '-', $wp_version ); 8767 8768 if ( is_string( $required ) ) { 8769 $trimmed = trim( $required ); 8770 8771 if ( substr_count( $trimmed, '.' ) > 1 && str_ends_with( $trimmed, '.0' ) ) { 8772 $required = substr( $trimmed, 0, -2 ); 8773 } 8774 } 8775 8776 return empty( $required ) || version_compare( $version, $required, '>=' ); 8777 } 8778 8779 /** 8780 * Checks compatibility with the current PHP version. 8781 * 8782 * @since 5.2.0 8783 * 8784 * @param string $required Minimum required PHP version. 8785 * @return bool True if required version is compatible or empty, false if not. 8786 */ 8787 function is_php_version_compatible( $required ) { 8788 return empty( $required ) || version_compare( PHP_VERSION, $required, '>=' ); 8789 } 8790 8791 /** 8792 * Checks if two numbers are nearly the same. 8793 * 8794 * This is similar to using `round()` but the precision is more fine-grained. 8795 * 8796 * @since 5.3.0 8797 * 8798 * @param int|float $expected The expected value. 8799 * @param int|float $actual The actual number. 8800 * @param int|float $precision Optional. The allowed variation. Default 1. 8801 * @return bool Whether the numbers match within the specified precision. 8802 */ 8803 function wp_fuzzy_number_match( $expected, $actual, $precision = 1 ) { 8804 return abs( (float) $expected - (float) $actual ) <= $precision; 8805 } 8806 8807 /** 8808 * Creates and returns the markup for an admin notice. 8809 * 8810 * @since 6.4.0 8811 * 8812 * @param string $message The message. 8813 * @param array $args { 8814 * Optional. An array of arguments for the admin notice. Default empty array. 8815 * 8816 * @type string $type Optional. The type of admin notice. 8817 * For example, 'error', 'success', 'warning', 'info'. 8818 * Default empty string. 8819 * @type bool $dismissible Optional. Whether the admin notice is dismissible. Default false. 8820 * @type string $id Optional. The value of the admin notice's ID attribute. Default empty string. 8821 * @type string[] $additional_classes Optional. A string array of class names. Default empty array. 8822 * @type string[] $attributes Optional. Additional attributes for the notice div. Default empty array. 8823 * @type bool $paragraph_wrap Optional. Whether to wrap the message in paragraph tags. Default true. 8824 * } 8825 * @return string The markup for an admin notice. 8826 */ 8827 function wp_get_admin_notice( $message, $args = array() ) { 8828 $defaults = array( 8829 'type' => '', 8830 'dismissible' => false, 8831 'id' => '', 8832 'additional_classes' => array(), 8833 'attributes' => array(), 8834 'paragraph_wrap' => true, 8835 ); 8836 8837 $args = wp_parse_args( $args, $defaults ); 8838 8839 /** 8840 * Filters the arguments for an admin notice. 8841 * 8842 * @since 6.4.0 8843 * 8844 * @param array $args The arguments for the admin notice. 8845 * @param string $message The message for the admin notice. 8846 */ 8847 $args = apply_filters( 'wp_admin_notice_args', $args, $message ); 8848 $id = ''; 8849 $classes = 'notice'; 8850 $attributes = ''; 8851 8852 if ( is_string( $args['id'] ) ) { 8853 $trimmed_id = trim( $args['id'] ); 8854 8855 if ( '' !== $trimmed_id ) { 8856 $id = 'id="' . $trimmed_id . '" '; 8857 } 8858 } 8859 8860 if ( is_string( $args['type'] ) ) { 8861 $type = trim( $args['type'] ); 8862 8863 if ( str_contains( $type, ' ' ) ) { 8864 _doing_it_wrong( 8865 __FUNCTION__, 8866 sprintf( 8867 /* translators: %s: The "type" key. */ 8868 __( 'The %s key must be a string without spaces.' ), 8869 '<code>type</code>' 8870 ), 8871 '6.4.0' 8872 ); 8873 } 8874 8875 if ( '' !== $type ) { 8876 $classes .= ' notice-' . $type; 8877 } 8878 } 8879 8880 if ( true === $args['dismissible'] ) { 8881 $classes .= ' is-dismissible'; 8882 } 8883 8884 if ( is_array( $args['additional_classes'] ) && ! empty( $args['additional_classes'] ) ) { 8885 $classes .= ' ' . implode( ' ', $args['additional_classes'] ); 8886 } 8887 8888 if ( is_array( $args['attributes'] ) && ! empty( $args['attributes'] ) ) { 8889 $attributes = ''; 8890 foreach ( $args['attributes'] as $attr => $val ) { 8891 if ( is_bool( $val ) ) { 8892 $attributes .= $val ? ' ' . $attr : ''; 8893 } elseif ( is_int( $attr ) ) { 8894 $attributes .= ' ' . esc_attr( trim( $val ) ); 8895 } elseif ( $val ) { 8896 $attributes .= ' ' . $attr . '="' . esc_attr( trim( $val ) ) . '"'; 8897 } 8898 } 8899 } 8900 8901 if ( false !== $args['paragraph_wrap'] ) { 8902 $message = "<p>$message</p>"; 8903 } 8904 8905 $markup = sprintf( '<div %1$sclass="%2$s"%3$s>%4$s</div>', $id, $classes, $attributes, $message ); 8906 8907 /** 8908 * Filters the markup for an admin notice. 8909 * 8910 * @since 6.4.0 8911 * 8912 * @param string $markup The HTML markup for the admin notice. 8913 * @param string $message The message for the admin notice. 8914 * @param array $args The arguments for the admin notice. 8915 */ 8916 return apply_filters( 'wp_admin_notice_markup', $markup, $message, $args ); 8917 } 8918 8919 /** 8920 * Outputs an admin notice. 8921 * 8922 * @since 6.4.0 8923 * 8924 * @param string $message The message to output. 8925 * @param array $args { 8926 * Optional. An array of arguments for the admin notice. Default empty array. 8927 * 8928 * @type string $type Optional. The type of admin notice. 8929 * For example, 'error', 'success', 'warning', 'info'. 8930 * Default empty string. 8931 * @type bool $dismissible Optional. Whether the admin notice is dismissible. Default false. 8932 * @type string $id Optional. The value of the admin notice's ID attribute. Default empty string. 8933 * @type string[] $additional_classes Optional. A string array of class names. Default empty array. 8934 * @type string[] $attributes Optional. Additional attributes for the notice div. Default empty array. 8935 * @type bool $paragraph_wrap Optional. Whether to wrap the message in paragraph tags. Default true. 8936 * } 8937 */ 8938 function wp_admin_notice( $message, $args = array() ) { 8939 /** 8940 * Fires before an admin notice is output. 8941 * 8942 * @since 6.4.0 8943 * 8944 * @param string $message The message for the admin notice. 8945 * @param array $args The arguments for the admin notice. 8946 */ 8947 do_action( 'wp_admin_notice', $message, $args ); 8948 8949 echo wp_kses_post( wp_get_admin_notice( $message, $args ) ); 8950 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sat Apr 27 08:20:02 2024 | Cross-referenced by PHPXref |