[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> functions.php (source)

   1  <?php
   2  /**
   3   * Main WordPress API
   4   *
   5   * @package WordPress
   6   */
   7  
   8  require  ABSPATH . WPINC . '/option.php';
   9  
  10  /**
  11   * Convert 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 a 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 Formatted date string or sum of Unix timestamp and timezone offset.
  28   *                          False on failure.
  29   */
  30  function mysql2date( $format, $date, $translate = true ) {
  31      if ( empty( $date ) ) {
  32          return false;
  33      }
  34  
  35      $datetime = date_create( $date, wp_timezone() );
  36  
  37      if ( false === $datetime ) {
  38          return false;
  39      }
  40  
  41      // Returns a sum of timestamp with timezone offset. Ideally should never be used.
  42      if ( 'G' === $format || 'U' === $format ) {
  43          return $datetime->getTimestamp() + $datetime->getOffset();
  44      }
  45  
  46      if ( $translate ) {
  47          return wp_date( $format, $datetime->getTimestamp() );
  48      }
  49  
  50      return $datetime->format( $format );
  51  }
  52  
  53  /**
  54   * Retrieves the current time based on specified type.
  55   *
  56   * The 'mysql' type will return the time in the format for MySQL DATETIME field.
  57   * The 'timestamp' type will return the current timestamp or a sum of timestamp
  58   * and timezone offset, depending on `$gmt`.
  59   * Other strings will be interpreted as PHP date formats (e.g. 'Y-m-d').
  60   *
  61   * If $gmt is set to either '1' or 'true', then both types will use GMT time.
  62   * if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
  63   *
  64   * @since 1.0.0
  65   *
  66   * @param string   $type Type of time to retrieve. Accepts 'mysql', 'timestamp',
  67   *                       or PHP date format string (e.g. 'Y-m-d').
  68   * @param int|bool $gmt  Optional. Whether to use GMT timezone. Default false.
  69   * @return int|string Integer if $type is 'timestamp', string otherwise.
  70   */
  71  function current_time( $type, $gmt = 0 ) {
  72      // Don't use non-GMT timestamp, unless you know the difference and really need to.
  73      if ( 'timestamp' === $type || 'U' === $type ) {
  74          return $gmt ? time() : time() + (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
  75      }
  76  
  77      if ( 'mysql' === $type ) {
  78          $type = 'Y-m-d H:i:s';
  79      }
  80  
  81      $timezone = $gmt ? new DateTimeZone( 'UTC' ) : wp_timezone();
  82      $datetime = new DateTime( 'now', $timezone );
  83  
  84      return $datetime->format( $type );
  85  }
  86  
  87  /**
  88   * Retrieves the current time as an object with the timezone from settings.
  89   *
  90   * @since 5.3.0
  91   *
  92   * @return DateTimeImmutable Date and time object.
  93   */
  94  function current_datetime() {
  95      return new DateTimeImmutable( 'now', wp_timezone() );
  96  }
  97  
  98  /**
  99   * Retrieves the timezone from site settings as a string.
 100   *
 101   * Uses the `timezone_string` option to get a proper timezone if available,
 102   * otherwise falls back to an offset.
 103   *
 104   * @since 5.3.0
 105   *
 106   * @return string PHP timezone string or a ±HH:MM offset.
 107   */
 108  function wp_timezone_string() {
 109      $timezone_string = get_option( 'timezone_string' );
 110  
 111      if ( $timezone_string ) {
 112          return $timezone_string;
 113      }
 114  
 115      $offset  = (float) get_option( 'gmt_offset' );
 116      $hours   = (int) $offset;
 117      $minutes = ( $offset - $hours );
 118  
 119      $sign      = ( $offset < 0 ) ? '-' : '+';
 120      $abs_hour  = abs( $hours );
 121      $abs_mins  = abs( $minutes * 60 );
 122      $tz_offset = sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins );
 123  
 124      return $tz_offset;
 125  }
 126  
 127  /**
 128   * Retrieves the timezone from site settings as a `DateTimeZone` object.
 129   *
 130   * Timezone can be based on a PHP timezone string or a ±HH:MM offset.
 131   *
 132   * @since 5.3.0
 133   *
 134   * @return DateTimeZone Timezone object.
 135   */
 136  function wp_timezone() {
 137      return new DateTimeZone( wp_timezone_string() );
 138  }
 139  
 140  /**
 141   * Retrieves the date in localized format, based on a sum of Unix timestamp and
 142   * timezone offset in seconds.
 143   *
 144   * If the locale specifies the locale month and weekday, then the locale will
 145   * take over the format for the date. If it isn't, then the date format string
 146   * will be used instead.
 147   *
 148   * Note that due to the way WP typically generates a sum of timestamp and offset
 149   * with `strtotime()`, it implies offset added at a _current_ time, not at the time
 150   * the timestamp represents. Storing such timestamps or calculating them differently
 151   * will lead to invalid output.
 152   *
 153   * @since 0.71
 154   * @since 5.3.0 Converted into a wrapper for wp_date().
 155   *
 156   * @global WP_Locale $wp_locale WordPress date and time locale object.
 157   *
 158   * @param string   $format                Format to display the date.
 159   * @param int|bool $timestamp_with_offset Optional. A sum of Unix timestamp and timezone offset
 160   *                                        in seconds. Default false.
 161   * @param bool     $gmt                   Optional. Whether to use GMT timezone. Only applies
 162   *                                        if timestamp is not provided. Default false.
 163   * @return string The date, translated if locale specifies it.
 164   */
 165  function date_i18n( $format, $timestamp_with_offset = false, $gmt = false ) {
 166      $timestamp = $timestamp_with_offset;
 167  
 168      // If timestamp is omitted it should be current time (summed with offset, unless `$gmt` is true).
 169      if ( ! is_numeric( $timestamp ) ) {
 170          $timestamp = current_time( 'timestamp', $gmt );
 171      }
 172  
 173      /*
 174       * This is a legacy implementation quirk that the returned timestamp is also with offset.
 175       * Ideally this function should never be used to produce a timestamp.
 176       */
 177      if ( 'U' === $format ) {
 178          $date = $timestamp;
 179      } elseif ( $gmt && false === $timestamp_with_offset ) { // Current time in UTC.
 180          $date = wp_date( $format, null, new DateTimeZone( 'UTC' ) );
 181      } elseif ( false === $timestamp_with_offset ) { // Current time in site's timezone.
 182          $date = wp_date( $format );
 183      } else {
 184          /*
 185           * Timestamp with offset is typically produced by a UTC `strtotime()` call on an input without timezone.
 186           * This is the best attempt to reverse that operation into a local time to use.
 187           */
 188          $local_time = gmdate( 'Y-m-d H:i:s', $timestamp );
 189          $timezone   = wp_timezone();
 190          $datetime   = date_create( $local_time, $timezone );
 191          $date       = wp_date( $format, $datetime->getTimestamp(), $timezone );
 192      }
 193  
 194      /**
 195       * Filters the date formatted based on the locale.
 196       *
 197       * @since 2.8.0
 198       *
 199       * @param string $date      Formatted date string.
 200       * @param string $format    Format to display the date.
 201       * @param int    $timestamp A sum of Unix timestamp and timezone offset in seconds.
 202       *                          Might be without offset if input omitted timestamp but requested GMT.
 203       * @param bool   $gmt       Whether to use GMT timezone. Only applies if timestamp was not provided.
 204       *                          Default false.
 205       */
 206      $date = apply_filters( 'date_i18n', $date, $format, $timestamp, $gmt );
 207  
 208      return $date;
 209  }
 210  
 211  /**
 212   * Retrieves the date, in localized format.
 213   *
 214   * This is a newer function, intended to replace `date_i18n()` without legacy quirks in it.
 215   *
 216   * Note that, unlike `date_i18n()`, this function accepts a true Unix timestamp, not summed
 217   * with timezone offset.
 218   *
 219   * @since 5.3.0
 220   *
 221   * @param string       $format    PHP date format.
 222   * @param int          $timestamp Optional. Unix timestamp. Defaults to current time.
 223   * @param DateTimeZone $timezone  Optional. Timezone to output result in. Defaults to timezone
 224   *                                from site settings.
 225   * @return string|false The date, translated if locale specifies it. False on invalid timestamp input.
 226   */
 227  function wp_date( $format, $timestamp = null, $timezone = null ) {
 228      global $wp_locale;
 229  
 230      if ( null === $timestamp ) {
 231          $timestamp = time();
 232      } elseif ( ! is_numeric( $timestamp ) ) {
 233          return false;
 234      }
 235  
 236      if ( ! $timezone ) {
 237          $timezone = wp_timezone();
 238      }
 239  
 240      $datetime = date_create( '@' . $timestamp );
 241      $datetime->setTimezone( $timezone );
 242  
 243      if ( empty( $wp_locale->month ) || empty( $wp_locale->weekday ) ) {
 244          $date = $datetime->format( $format );
 245      } else {
 246          // We need to unpack shorthand `r` format because it has parts that might be localized.
 247          $format = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $format );
 248  
 249          $new_format    = '';
 250          $format_length = strlen( $format );
 251          $month         = $wp_locale->get_month( $datetime->format( 'm' ) );
 252          $weekday       = $wp_locale->get_weekday( $datetime->format( 'w' ) );
 253  
 254          for ( $i = 0; $i < $format_length; $i ++ ) {
 255              switch ( $format[ $i ] ) {
 256                  case 'D':
 257                      $new_format .= addcslashes( $wp_locale->get_weekday_abbrev( $weekday ), '\\A..Za..z' );
 258                      break;
 259                  case 'F':
 260                      $new_format .= addcslashes( $month, '\\A..Za..z' );
 261                      break;
 262                  case 'l':
 263                      $new_format .= addcslashes( $weekday, '\\A..Za..z' );
 264                      break;
 265                  case 'M':
 266                      $new_format .= addcslashes( $wp_locale->get_month_abbrev( $month ), '\\A..Za..z' );
 267                      break;
 268                  case 'a':
 269                      $new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'a' ) ), '\\A..Za..z' );
 270                      break;
 271                  case 'A':
 272                      $new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'A' ) ), '\\A..Za..z' );
 273                      break;
 274                  case '\\':
 275                      $new_format .= $format[ $i ];
 276  
 277                      // If character follows a slash, we add it without translating.
 278                      if ( $i < $format_length ) {
 279                          $new_format .= $format[ ++$i ];
 280                      }
 281                      break;
 282                  default:
 283                      $new_format .= $format[ $i ];
 284                      break;
 285              }
 286          }
 287  
 288          $date = $datetime->format( $new_format );
 289          $date = wp_maybe_decline_date( $date, $format );
 290      }
 291  
 292      /**
 293       * Filters the date formatted based on the locale.
 294       *
 295       * @since 5.3.0
 296       *
 297       * @param string       $date      Formatted date string.
 298       * @param string       $format    Format to display the date.
 299       * @param int          $timestamp Unix timestamp.
 300       * @param DateTimeZone $timezone  Timezone.
 301       */
 302      $date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );
 303  
 304      return $date;
 305  }
 306  
 307  /**
 308   * Determines if the date should be declined.
 309   *
 310   * If the locale specifies that month names require a genitive case in certain
 311   * formats (like 'j F Y'), the month name will be replaced with a correct form.
 312   *
 313   * @since 4.4.0
 314   * @since 5.4.0 The `$format` parameter was added.
 315   *
 316   * @global WP_Locale $wp_locale WordPress date and time locale object.
 317   *
 318   * @param string $date   Formatted date string.
 319   * @param string $format Optional. Date format to check. Default empty string.
 320   * @return string The date, declined if locale specifies it.
 321   */
 322  function wp_maybe_decline_date( $date, $format = '' ) {
 323      global $wp_locale;
 324  
 325      // i18n functions are not available in SHORTINIT mode.
 326      if ( ! function_exists( '_x' ) ) {
 327          return $date;
 328      }
 329  
 330      /*
 331       * translators: If months in your language require a genitive case,
 332       * translate this to 'on'. Do not translate into your own language.
 333       */
 334      if ( 'on' === _x( 'off', 'decline months names: on or off' ) ) {
 335  
 336          $months          = $wp_locale->month;
 337          $months_genitive = $wp_locale->month_genitive;
 338  
 339          /*
 340           * Match a format like 'j F Y' or 'j. F' (day of the month, followed by month name)
 341           * and decline the month.
 342           */
 343          if ( $format ) {
 344              $decline = preg_match( '#[dj]\.? F#', $format );
 345          } else {
 346              // If the format is not passed, try to guess it from the date string.
 347              $decline = preg_match( '#\b\d{1,2}\.? [^\d ]+\b#u', $date );
 348          }
 349  
 350          if ( $decline ) {
 351              foreach ( $months as $key => $month ) {
 352                  $months[ $key ] = '# ' . preg_quote( $month, '#' ) . '\b#u';
 353              }
 354  
 355              foreach ( $months_genitive as $key => $month ) {
 356                  $months_genitive[ $key ] = ' ' . $month;
 357              }
 358  
 359              $date = preg_replace( $months, $months_genitive, $date );
 360          }
 361  
 362          /*
 363           * Match a format like 'F jS' or 'F j' (month name, followed by day with an optional ordinal suffix)
 364           * and change it to declined 'j F'.
 365           */
 366          if ( $format ) {
 367              $decline = preg_match( '#F [dj]#', $format );
 368          } else {
 369              // If the format is not passed, try to guess it from the date string.
 370              $decline = preg_match( '#\b[^\d ]+ \d{1,2}(st|nd|rd|th)?\b#u', trim( $date ) );
 371          }
 372  
 373          if ( $decline ) {
 374              foreach ( $months as $key => $month ) {
 375                  $months[ $key ] = '#\b' . preg_quote( $month, '#' ) . ' (\d{1,2})(st|nd|rd|th)?([-–]\d{1,2})?(st|nd|rd|th)?\b#u';
 376              }
 377  
 378              foreach ( $months_genitive as $key => $month ) {
 379                  $months_genitive[ $key ] = '$1$3 ' . $month;
 380              }
 381  
 382              $date = preg_replace( $months, $months_genitive, $date );
 383          }
 384      }
 385  
 386      // Used for locale-specific rules.
 387      $locale = get_locale();
 388  
 389      if ( 'ca' === $locale ) {
 390          // " de abril| de agost| de octubre..." -> " d'abril| d'agost| d'octubre..."
 391          $date = preg_replace( '# de ([ao])#i', " d'\\1", $date );
 392      }
 393  
 394      return $date;
 395  }
 396  
 397  /**
 398   * Convert float number to format based on the locale.
 399   *
 400   * @since 2.3.0
 401   *
 402   * @global WP_Locale $wp_locale WordPress date and time locale object.
 403   *
 404   * @param float $number   The number to convert based on locale.
 405   * @param int   $decimals Optional. Precision of the number of decimal places. Default 0.
 406   * @return string Converted number in string format.
 407   */
 408  function number_format_i18n( $number, $decimals = 0 ) {
 409      global $wp_locale;
 410  
 411      if ( isset( $wp_locale ) ) {
 412          $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
 413      } else {
 414          $formatted = number_format( $number, absint( $decimals ) );
 415      }
 416  
 417      /**
 418       * Filters the number formatted based on the locale.
 419       *
 420       * @since 2.8.0
 421       * @since 4.9.0 The `$number` and `$decimals` parameters were added.
 422       *
 423       * @param string $formatted Converted number in string format.
 424       * @param float  $number    The number to convert based on locale.
 425       * @param int    $decimals  Precision of the number of decimal places.
 426       */
 427      return apply_filters( 'number_format_i18n', $formatted, $number, $decimals );
 428  }
 429  
 430  /**
 431   * Convert number of bytes largest unit bytes will fit into.
 432   *
 433   * It is easier to read 1 KB than 1024 bytes and 1 MB than 1048576 bytes. Converts
 434   * number of bytes to human readable number by taking the number of that unit
 435   * that the bytes will go into it. Supports TB value.
 436   *
 437   * Please note that integers in PHP are limited to 32 bits, unless they are on
 438   * 64 bit architecture, then they have 64 bit size. If you need to place the
 439   * larger size then what PHP integer type will hold, then use a string. It will
 440   * be converted to a double, which should always have 64 bit length.
 441   *
 442   * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
 443   *
 444   * @since 2.3.0
 445   *
 446   * @param int|string $bytes    Number of bytes. Note max integer size for integers.
 447   * @param int        $decimals Optional. Precision of number of decimal places. Default 0.
 448   * @return string|false Number string on success, false on failure.
 449   */
 450  function size_format( $bytes, $decimals = 0 ) {
 451      $quant = array(
 452          /* translators: Unit symbol for terabyte. */
 453          _x( 'TB', 'unit symbol' ) => TB_IN_BYTES,
 454          /* translators: Unit symbol for gigabyte. */
 455          _x( 'GB', 'unit symbol' ) => GB_IN_BYTES,
 456          /* translators: Unit symbol for megabyte. */
 457          _x( 'MB', 'unit symbol' ) => MB_IN_BYTES,
 458          /* translators: Unit symbol for kilobyte. */
 459          _x( 'KB', 'unit symbol' ) => KB_IN_BYTES,
 460          /* translators: Unit symbol for byte. */
 461          _x( 'B', 'unit symbol' )  => 1,
 462      );
 463  
 464      if ( 0 === $bytes ) {
 465          /* translators: Unit symbol for byte. */
 466          return number_format_i18n( 0, $decimals ) . ' ' . _x( 'B', 'unit symbol' );
 467      }
 468  
 469      foreach ( $quant as $unit => $mag ) {
 470          if ( (float) $bytes >= $mag ) {
 471              return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
 472          }
 473      }
 474  
 475      return false;
 476  }
 477  
 478  /**
 479   * Convert a duration to human readable format.
 480   *
 481   * @since 5.1.0
 482   *
 483   * @param string $duration Duration will be in string format (HH:ii:ss) OR (ii:ss),
 484   *                         with a possible prepended negative sign (-).
 485   * @return string|false A human readable duration string, false on failure.
 486   */
 487  function human_readable_duration( $duration = '' ) {
 488      if ( ( empty( $duration ) || ! is_string( $duration ) ) ) {
 489          return false;
 490      }
 491  
 492      $duration = trim( $duration );
 493  
 494      // Remove prepended negative sign.
 495      if ( '-' === substr( $duration, 0, 1 ) ) {
 496          $duration = substr( $duration, 1 );
 497      }
 498  
 499      // Extract duration parts.
 500      $duration_parts = array_reverse( explode( ':', $duration ) );
 501      $duration_count = count( $duration_parts );
 502  
 503      $hour   = null;
 504      $minute = null;
 505      $second = null;
 506  
 507      if ( 3 === $duration_count ) {
 508          // Validate HH:ii:ss duration format.
 509          if ( ! ( (bool) preg_match( '/^([0-9]+):([0-5]?[0-9]):([0-5]?[0-9])$/', $duration ) ) ) {
 510              return false;
 511          }
 512          // Three parts: hours, minutes & seconds.
 513          list( $second, $minute, $hour ) = $duration_parts;
 514      } elseif ( 2 === $duration_count ) {
 515          // Validate ii:ss duration format.
 516          if ( ! ( (bool) preg_match( '/^([0-5]?[0-9]):([0-5]?[0-9])$/', $duration ) ) ) {
 517              return false;
 518          }
 519          // Two parts: minutes & seconds.
 520          list( $second, $minute ) = $duration_parts;
 521      } else {
 522          return false;
 523      }
 524  
 525      $human_readable_duration = array();
 526  
 527      // Add the hour part to the string.
 528      if ( is_numeric( $hour ) ) {
 529          /* translators: %s: Time duration in hour or hours. */
 530          $human_readable_duration[] = sprintf( _n( '%s hour', '%s hours', $hour ), (int) $hour );
 531      }
 532  
 533      // Add the minute part to the string.
 534      if ( is_numeric( $minute ) ) {
 535          /* translators: %s: Time duration in minute or minutes. */
 536          $human_readable_duration[] = sprintf( _n( '%s minute', '%s minutes', $minute ), (int) $minute );
 537      }
 538  
 539      // Add the second part to the string.
 540      if ( is_numeric( $second ) ) {
 541          /* translators: %s: Time duration in second or seconds. */
 542          $human_readable_duration[] = sprintf( _n( '%s second', '%s seconds', $second ), (int) $second );
 543      }
 544  
 545      return implode( ', ', $human_readable_duration );
 546  }
 547  
 548  /**
 549   * Get the week start and end from the datetime or date string from MySQL.
 550   *
 551   * @since 0.71
 552   *
 553   * @param string     $mysqlstring   Date or datetime field type from MySQL.
 554   * @param int|string $start_of_week Optional. Start of the week as an integer. Default empty string.
 555   * @return array Keys are 'start' and 'end'.
 556   */
 557  function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
 558      // MySQL string year.
 559      $my = substr( $mysqlstring, 0, 4 );
 560  
 561      // MySQL string month.
 562      $mm = substr( $mysqlstring, 8, 2 );
 563  
 564      // MySQL string day.
 565      $md = substr( $mysqlstring, 5, 2 );
 566  
 567      // The timestamp for MySQL string day.
 568      $day = mktime( 0, 0, 0, $md, $mm, $my );
 569  
 570      // The day of the week from the timestamp.
 571      $weekday = gmdate( 'w', $day );
 572  
 573      if ( ! is_numeric( $start_of_week ) ) {
 574          $start_of_week = get_option( 'start_of_week' );
 575      }
 576  
 577      if ( $weekday < $start_of_week ) {
 578          $weekday += 7;
 579      }
 580  
 581      // The most recent week start day on or before $day.
 582      $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week );
 583  
 584      // $start + 1 week - 1 second.
 585      $end = $start + WEEK_IN_SECONDS - 1;
 586      return compact( 'start', 'end' );
 587  }
 588  
 589  /**
 590   * Serialize data, if needed.
 591   *
 592   * @since 2.0.5
 593   *
 594   * @param string|array|object $data Data that might be serialized.
 595   * @return mixed A scalar data.
 596   */
 597  function maybe_serialize( $data ) {
 598      if ( is_array( $data ) || is_object( $data ) ) {
 599          return serialize( $data );
 600      }
 601  
 602      /*
 603       * Double serialization is required for backward compatibility.
 604       * See https://core.trac.wordpress.org/ticket/12930
 605       * Also the world will end. See WP 3.6.1.
 606       */
 607      if ( is_serialized( $data, false ) ) {
 608          return serialize( $data );
 609      }
 610  
 611      return $data;
 612  }
 613  
 614  /**
 615   * Unserialize data only if it was serialized.
 616   *
 617   * @since 2.0.0
 618   *
 619   * @param string $data Data that might be unserialized.
 620   * @return mixed Unserialized data can be any type.
 621   */
 622  function maybe_unserialize( $data ) {
 623      if ( is_serialized( $data ) ) { // Don't attempt to unserialize data that wasn't serialized going in.
 624          return @unserialize( trim( $data ) );
 625      }
 626  
 627      return $data;
 628  }
 629  
 630  /**
 631   * Check value to find if it was serialized.
 632   *
 633   * If $data is not an string, then returned value will always be false.
 634   * Serialized data is always a string.
 635   *
 636   * @since 2.0.5
 637   *
 638   * @param string $data   Value to check to see if was serialized.
 639   * @param bool   $strict Optional. Whether to be strict about the end of the string. Default true.
 640   * @return bool False if not serialized and true if it was.
 641   */
 642  function is_serialized( $data, $strict = true ) {
 643      // If it isn't a string, it isn't serialized.
 644      if ( ! is_string( $data ) ) {
 645          return false;
 646      }
 647      $data = trim( $data );
 648      if ( 'N;' === $data ) {
 649          return true;
 650      }
 651      if ( strlen( $data ) < 4 ) {
 652          return false;
 653      }
 654      if ( ':' !== $data[1] ) {
 655          return false;
 656      }
 657      if ( $strict ) {
 658          $lastc = substr( $data, -1 );
 659          if ( ';' !== $lastc && '}' !== $lastc ) {
 660              return false;
 661          }
 662      } else {
 663          $semicolon = strpos( $data, ';' );
 664          $brace     = strpos( $data, '}' );
 665          // Either ; or } must exist.
 666          if ( false === $semicolon && false === $brace ) {
 667              return false;
 668          }
 669          // But neither must be in the first X characters.
 670          if ( false !== $semicolon && $semicolon < 3 ) {
 671              return false;
 672          }
 673          if ( false !== $brace && $brace < 4 ) {
 674              return false;
 675          }
 676      }
 677      $token = $data[0];
 678      switch ( $token ) {
 679          case 's':
 680              if ( $strict ) {
 681                  if ( '"' !== substr( $data, -2, 1 ) ) {
 682                      return false;
 683                  }
 684              } elseif ( false === strpos( $data, '"' ) ) {
 685                  return false;
 686              }
 687              // Or else fall through.
 688          case 'a':
 689          case 'O':
 690              return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
 691          case 'b':
 692          case 'i':
 693          case 'd':
 694              $end = $strict ? '$' : '';
 695              return (bool) preg_match( "/^{$token}:[0-9.E+-]+;$end/", $data );
 696      }
 697      return false;
 698  }
 699  
 700  /**
 701   * Check whether serialized data is of string type.
 702   *
 703   * @since 2.0.5
 704   *
 705   * @param string $data Serialized data.
 706   * @return bool False if not a serialized string, true if it is.
 707   */
 708  function is_serialized_string( $data ) {
 709      // if it isn't a string, it isn't a serialized string.
 710      if ( ! is_string( $data ) ) {
 711          return false;
 712      }
 713      $data = trim( $data );
 714      if ( strlen( $data ) < 4 ) {
 715          return false;
 716      } elseif ( ':' !== $data[1] ) {
 717          return false;
 718      } elseif ( ';' !== substr( $data, -1 ) ) {
 719          return false;
 720      } elseif ( 's' !== $data[0] ) {
 721          return false;
 722      } elseif ( '"' !== substr( $data, -2, 1 ) ) {
 723          return false;
 724      } else {
 725          return true;
 726      }
 727  }
 728  
 729  /**
 730   * Retrieve post title from XMLRPC XML.
 731   *
 732   * If the title element is not part of the XML, then the default post title from
 733   * the $post_default_title will be used instead.
 734   *
 735   * @since 0.71
 736   *
 737   * @global string $post_default_title Default XML-RPC post title.
 738   *
 739   * @param string $content XMLRPC XML Request content
 740   * @return string Post title
 741   */
 742  function xmlrpc_getposttitle( $content ) {
 743      global $post_default_title;
 744      if ( preg_match( '/<title>(.+?)<\/title>/is', $content, $matchtitle ) ) {
 745          $post_title = $matchtitle[1];
 746      } else {
 747          $post_title = $post_default_title;
 748      }
 749      return $post_title;
 750  }
 751  
 752  /**
 753   * Retrieve the post category or categories from XMLRPC XML.
 754   *
 755   * If the category element is not found, then the default post category will be
 756   * used. The return type then would be what $post_default_category. If the
 757   * category is found, then it will always be an array.
 758   *
 759   * @since 0.71
 760   *
 761   * @global string $post_default_category Default XML-RPC post category.
 762   *
 763   * @param string $content XMLRPC XML Request content
 764   * @return string|array List of categories or category name.
 765   */
 766  function xmlrpc_getpostcategory( $content ) {
 767      global $post_default_category;
 768      if ( preg_match( '/<category>(.+?)<\/category>/is', $content, $matchcat ) ) {
 769          $post_category = trim( $matchcat[1], ',' );
 770          $post_category = explode( ',', $post_category );
 771      } else {
 772          $post_category = $post_default_category;
 773      }
 774      return $post_category;
 775  }
 776  
 777  /**
 778   * XMLRPC XML content without title and category elements.
 779   *
 780   * @since 0.71
 781   *
 782   * @param string $content XML-RPC XML Request content.
 783   * @return string XMLRPC XML Request content without title and category elements.
 784   */
 785  function xmlrpc_removepostdata( $content ) {
 786      $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
 787      $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
 788      $content = trim( $content );
 789      return $content;
 790  }
 791  
 792  /**
 793   * Use RegEx to extract URLs from arbitrary content.
 794   *
 795   * @since 3.7.0
 796   *
 797   * @param string $content Content to extract URLs from.
 798   * @return string[] Array of URLs found in passed string.
 799   */
 800  function wp_extract_urls( $content ) {
 801      preg_match_all(
 802          "#([\"']?)("
 803              . '(?:([\w-]+:)?//?)'
 804              . '[^\s()<>]+'
 805              . '[.]'
 806              . '(?:'
 807                  . '\([\w\d]+\)|'
 808                  . '(?:'
 809                      . "[^`!()\[\]{};:'\".,<>«»“”‘’\s]|"
 810                      . '(?:[:]\d+)?/?'
 811                  . ')+'
 812              . ')'
 813          . ")\\1#",
 814          $content,
 815          $post_links
 816      );
 817  
 818      $post_links = array_unique( array_map( 'html_entity_decode', $post_links[2] ) );
 819  
 820      return array_values( $post_links );
 821  }
 822  
 823  /**
 824   * Check content for video and audio links to add as enclosures.
 825   *
 826   * Will not add enclosures that have already been added and will
 827   * remove enclosures that are no longer in the post. This is called as
 828   * pingbacks and trackbacks.
 829   *
 830   * @since 1.5.0
 831   * @since 5.3.0 The `$content` parameter was made optional, and the `$post` parameter was
 832   *              updated to accept a post ID or a WP_Post object.
 833   * @since 5.6.0 The `$content` parameter is no longer optional, but passing `null` to skip it
 834   *              is still supported.
 835   *
 836   * @global wpdb $wpdb WordPress database abstraction object.
 837   *
 838   * @param string|null $content Post content. If `null`, the `post_content` field from `$post` is used.
 839   * @param int|WP_Post $post    Post ID or post object.
 840   * @return void|false Void on success, false if the post is not found.
 841   */
 842  function do_enclose( $content, $post ) {
 843      global $wpdb;
 844  
 845      // @todo Tidy this code and make the debug code optional.
 846      include_once  ABSPATH . WPINC . '/class-IXR.php';
 847  
 848      $post = get_post( $post );
 849      if ( ! $post ) {
 850          return false;
 851      }
 852  
 853      if ( null === $content ) {
 854          $content = $post->post_content;
 855      }
 856  
 857      $post_links = array();
 858  
 859      $pung = get_enclosed( $post->ID );
 860  
 861      $post_links_temp = wp_extract_urls( $content );
 862  
 863      foreach ( $pung as $link_test ) {
 864          // Link is no longer in post.
 865          if ( ! in_array( $link_test, $post_links_temp, true ) ) {
 866              $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 ) . '%' ) );
 867              foreach ( $mids as $mid ) {
 868                  delete_metadata_by_mid( 'post', $mid );
 869              }
 870          }
 871      }
 872  
 873      foreach ( (array) $post_links_temp as $link_test ) {
 874          // If we haven't pung it already.
 875          if ( ! in_array( $link_test, $pung, true ) ) {
 876              $test = parse_url( $link_test );
 877              if ( false === $test ) {
 878                  continue;
 879              }
 880              if ( isset( $test['query'] ) ) {
 881                  $post_links[] = $link_test;
 882              } elseif ( isset( $test['path'] ) && ( '/' !== $test['path'] ) && ( '' !== $test['path'] ) ) {
 883                  $post_links[] = $link_test;
 884              }
 885          }
 886      }
 887  
 888      /**
 889       * Filters the list of enclosure links before querying the database.
 890       *
 891       * Allows for the addition and/or removal of potential enclosures to save
 892       * to postmeta before checking the database for existing enclosures.
 893       *
 894       * @since 4.4.0
 895       *
 896       * @param string[] $post_links An array of enclosure links.
 897       * @param int      $post_ID    Post ID.
 898       */
 899      $post_links = apply_filters( 'enclosure_links', $post_links, $post->ID );
 900  
 901      foreach ( (array) $post_links as $url ) {
 902          $url = strip_fragment_from_url( $url );
 903  
 904          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 ) . '%' ) ) ) {
 905  
 906              $headers = wp_get_http_headers( $url );
 907              if ( $headers ) {
 908                  $len           = isset( $headers['content-length'] ) ? (int) $headers['content-length'] : 0;
 909                  $type          = isset( $headers['content-type'] ) ? $headers['content-type'] : '';
 910                  $allowed_types = array( 'video', 'audio' );
 911  
 912                  // Check to see if we can figure out the mime type from the extension.
 913                  $url_parts = parse_url( $url );
 914                  if ( false !== $url_parts && ! empty( $url_parts['path'] ) ) {
 915                      $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );
 916                      if ( ! empty( $extension ) ) {
 917                          foreach ( wp_get_mime_types() as $exts => $mime ) {
 918                              if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
 919                                  $type = $mime;
 920                                  break;
 921                              }
 922                          }
 923                      }
 924                  }
 925  
 926                  if ( in_array( substr( $type, 0, strpos( $type, '/' ) ), $allowed_types, true ) ) {
 927                      add_post_meta( $post->ID, 'enclosure', "$url\n$len\n$mime\n" );
 928                  }
 929              }
 930          }
 931      }
 932  }
 933  
 934  /**
 935   * Retrieve HTTP Headers from URL.
 936   *
 937   * @since 1.5.1
 938   *
 939   * @param string $url        URL to retrieve HTTP headers from.
 940   * @param bool   $deprecated Not Used.
 941   * @return string|false Headers on success, false on failure.
 942   */
 943  function wp_get_http_headers( $url, $deprecated = false ) {
 944      if ( ! empty( $deprecated ) ) {
 945          _deprecated_argument( __FUNCTION__, '2.7.0' );
 946      }
 947  
 948      $response = wp_safe_remote_head( $url );
 949  
 950      if ( is_wp_error( $response ) ) {
 951          return false;
 952      }
 953  
 954      return wp_remote_retrieve_headers( $response );
 955  }
 956  
 957  /**
 958   * Determines whether the publish date of the current post in the loop is different
 959   * from the publish date of the previous post in the loop.
 960   *
 961   * For more information on this and similar theme functions, check out
 962   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 963   * Conditional Tags} article in the Theme Developer Handbook.
 964   *
 965   * @since 0.71
 966   *
 967   * @global string $currentday  The day of the current post in the loop.
 968   * @global string $previousday The day of the previous post in the loop.
 969   *
 970   * @return int 1 when new day, 0 if not a new day.
 971   */
 972  function is_new_day() {
 973      global $currentday, $previousday;
 974  
 975      if ( $currentday !== $previousday ) {
 976          return 1;
 977      } else {
 978          return 0;
 979      }
 980  }
 981  
 982  /**
 983   * Build URL query based on an associative and, or indexed array.
 984   *
 985   * This is a convenient function for easily building url queries. It sets the
 986   * separator to '&' and uses _http_build_query() function.
 987   *
 988   * @since 2.3.0
 989   *
 990   * @see _http_build_query() Used to build the query
 991   * @link https://www.php.net/manual/en/function.http-build-query.php for more on what
 992   *       http_build_query() does.
 993   *
 994   * @param array $data URL-encode key/value pairs.
 995   * @return string URL-encoded string.
 996   */
 997  function build_query( $data ) {
 998      return _http_build_query( $data, null, '&', '', false );
 999  }
1000  
1001  /**
1002   * From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
1003   *
1004   * @since 3.2.0
1005   * @access private
1006   *
1007   * @see https://www.php.net/manual/en/function.http-build-query.php
1008   *
1009   * @param array|object $data      An array or object of data. Converted to array.
1010   * @param string       $prefix    Optional. Numeric index. If set, start parameter numbering with it.
1011   *                                Default null.
1012   * @param string       $sep       Optional. Argument separator; defaults to 'arg_separator.output'.
1013   *                                Default null.
1014   * @param string       $key       Optional. Used to prefix key name. Default empty.
1015   * @param bool         $urlencode Optional. Whether to use urlencode() in the result. Default true.
1016   * @return string The query string.
1017   */
1018  function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urlencode = true ) {
1019      $ret = array();
1020  
1021      foreach ( (array) $data as $k => $v ) {
1022          if ( $urlencode ) {
1023              $k = urlencode( $k );
1024          }
1025          if ( is_int( $k ) && null != $prefix ) {
1026              $k = $prefix . $k;
1027          }
1028          if ( ! empty( $key ) ) {
1029              $k = $key . '%5B' . $k . '%5D';
1030          }
1031          if ( null === $v ) {
1032              continue;
1033          } elseif ( false === $v ) {
1034              $v = '0';
1035          }
1036  
1037          if ( is_array( $v ) || is_object( $v ) ) {
1038              array_push( $ret, _http_build_query( $v, '', $sep, $k, $urlencode ) );
1039          } elseif ( $urlencode ) {
1040              array_push( $ret, $k . '=' . urlencode( $v ) );
1041          } else {
1042              array_push( $ret, $k . '=' . $v );
1043          }
1044      }
1045  
1046      if ( null === $sep ) {
1047          $sep = ini_get( 'arg_separator.output' );
1048      }
1049  
1050      return implode( $sep, $ret );
1051  }
1052  
1053  /**
1054   * Retrieves a modified URL query string.
1055   *
1056   * You can rebuild the URL and append query variables to the URL query by using this function.
1057   * There are two ways to use this function; either a single key and value, or an associative array.
1058   *
1059   * Using a single key and value:
1060   *
1061   *     add_query_arg( 'key', 'value', 'http://example.com' );
1062   *
1063   * Using an associative array:
1064   *
1065   *     add_query_arg( array(
1066   *         'key1' => 'value1',
1067   *         'key2' => 'value2',
1068   *     ), 'http://example.com' );
1069   *
1070   * Omitting the URL from either use results in the current URL being used
1071   * (the value of `$_SERVER['REQUEST_URI']`).
1072   *
1073   * Values are expected to be encoded appropriately with urlencode() or rawurlencode().
1074   *
1075   * Setting any query variable's value to boolean false removes the key (see remove_query_arg()).
1076   *
1077   * Important: The return value of add_query_arg() is not escaped by default. Output should be
1078   * late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting
1079   * (XSS) attacks.
1080   *
1081   * @since 1.5.0
1082   * @since 5.3.0 Formalized the existing and already documented parameters
1083   *              by adding `...$args` to the function signature.
1084   *
1085   * @param string|array $key   Either a query variable key, or an associative array of query variables.
1086   * @param string       $value Optional. Either a query variable value, or a URL to act upon.
1087   * @param string       $url   Optional. A URL to act upon.
1088   * @return string New URL query string (unescaped).
1089   */
1090  function add_query_arg( ...$args ) {
1091      if ( is_array( $args[0] ) ) {
1092          if ( count( $args ) < 2 || false === $args[1] ) {
1093              $uri = $_SERVER['REQUEST_URI'];
1094          } else {
1095              $uri = $args[1];
1096          }
1097      } else {
1098          if ( count( $args ) < 3 || false === $args[2] ) {
1099              $uri = $_SERVER['REQUEST_URI'];
1100          } else {
1101              $uri = $args[2];
1102          }
1103      }
1104  
1105      $frag = strstr( $uri, '#' );
1106      if ( $frag ) {
1107          $uri = substr( $uri, 0, -strlen( $frag ) );
1108      } else {
1109          $frag = '';
1110      }
1111  
1112      if ( 0 === stripos( $uri, 'http://' ) ) {
1113          $protocol = 'http://';
1114          $uri      = substr( $uri, 7 );
1115      } elseif ( 0 === stripos( $uri, 'https://' ) ) {
1116          $protocol = 'https://';
1117          $uri      = substr( $uri, 8 );
1118      } else {
1119          $protocol = '';
1120      }
1121  
1122      if ( strpos( $uri, '?' ) !== false ) {
1123          list( $base, $query ) = explode( '?', $uri, 2 );
1124          $base                .= '?';
1125      } elseif ( $protocol || strpos( $uri, '=' ) === false ) {
1126          $base  = $uri . '?';
1127          $query = '';
1128      } else {
1129          $base  = '';
1130          $query = $uri;
1131      }
1132  
1133      wp_parse_str( $query, $qs );
1134      $qs = urlencode_deep( $qs ); // This re-URL-encodes things that were already in the query string.
1135      if ( is_array( $args[0] ) ) {
1136          foreach ( $args[0] as $k => $v ) {
1137              $qs[ $k ] = $v;
1138          }
1139      } else {
1140          $qs[ $args[0] ] = $args[1];
1141      }
1142  
1143      foreach ( $qs as $k => $v ) {
1144          if ( false === $v ) {
1145              unset( $qs[ $k ] );
1146          }
1147      }
1148  
1149      $ret = build_query( $qs );
1150      $ret = trim( $ret, '?' );
1151      $ret = preg_replace( '#=(&|$)#', '$1', $ret );
1152      $ret = $protocol . $base . $ret . $frag;
1153      $ret = rtrim( $ret, '?' );
1154      return $ret;
1155  }
1156  
1157  /**
1158   * Removes an item or items from a query string.
1159   *
1160   * @since 1.5.0
1161   *
1162   * @param string|string[] $key   Query key or keys to remove.
1163   * @param false|string    $query Optional. When false uses the current URL. Default false.
1164   * @return string New URL query string.
1165   */
1166  function remove_query_arg( $key, $query = false ) {
1167      if ( is_array( $key ) ) { // Removing multiple keys.
1168          foreach ( $key as $k ) {
1169              $query = add_query_arg( $k, false, $query );
1170          }
1171          return $query;
1172      }
1173      return add_query_arg( $key, false, $query );
1174  }
1175  
1176  /**
1177   * Returns an array of single-use query variable names that can be removed from a URL.
1178   *
1179   * @since 4.4.0
1180   *
1181   * @return string[] An array of query variable names to remove from the URL.
1182   */
1183  function wp_removable_query_args() {
1184      $removable_query_args = array(
1185          'activate',
1186          'activated',
1187          'admin_email_remind_later',
1188          'approved',
1189          'core-major-auto-updates-saved',
1190          'deactivate',
1191          'delete_count',
1192          'deleted',
1193          'disabled',
1194          'doing_wp_cron',
1195          'enabled',
1196          'error',
1197          'hotkeys_highlight_first',
1198          'hotkeys_highlight_last',
1199          'ids',
1200          'locked',
1201          'message',
1202          'same',
1203          'saved',
1204          'settings-updated',
1205          'skipped',
1206          'spammed',
1207          'trashed',
1208          'unspammed',
1209          'untrashed',
1210          'update',
1211          'updated',
1212          'wp-post-new-reload',
1213      );
1214  
1215      /**
1216       * Filters the list of query variable names to remove.
1217       *
1218       * @since 4.2.0
1219       *
1220       * @param string[] $removable_query_args An array of query variable names to remove from a URL.
1221       */
1222      return apply_filters( 'removable_query_args', $removable_query_args );
1223  }
1224  
1225  /**
1226   * Walks the array while sanitizing the contents.
1227   *
1228   * @since 0.71
1229   * @since 5.5.0 Non-string values are left untouched.
1230   *
1231   * @param array $array Array to walk while sanitizing contents.
1232   * @return array Sanitized $array.
1233   */
1234  function add_magic_quotes( $array ) {
1235      foreach ( (array) $array as $k => $v ) {
1236          if ( is_array( $v ) ) {
1237              $array[ $k ] = add_magic_quotes( $v );
1238          } elseif ( is_string( $v ) ) {
1239              $array[ $k ] = addslashes( $v );
1240          } else {
1241              continue;
1242          }
1243      }
1244  
1245      return $array;
1246  }
1247  
1248  /**
1249   * HTTP request for URI to retrieve content.
1250   *
1251   * @since 1.5.1
1252   *
1253   * @see wp_safe_remote_get()
1254   *
1255   * @param string $uri URI/URL of web page to retrieve.
1256   * @return string|false HTTP content. False on failure.
1257   */
1258  function wp_remote_fopen( $uri ) {
1259      $parsed_url = parse_url( $uri );
1260  
1261      if ( ! $parsed_url || ! is_array( $parsed_url ) ) {
1262          return false;
1263      }
1264  
1265      $options            = array();
1266      $options['timeout'] = 10;
1267  
1268      $response = wp_safe_remote_get( $uri, $options );
1269  
1270      if ( is_wp_error( $response ) ) {
1271          return false;
1272      }
1273  
1274      return wp_remote_retrieve_body( $response );
1275  }
1276  
1277  /**
1278   * Set up the WordPress query.
1279   *
1280   * @since 2.0.0
1281   *
1282   * @global WP       $wp           Current WordPress environment instance.
1283   * @global WP_Query $wp_query     WordPress Query object.
1284   * @global WP_Query $wp_the_query Copy of the WordPress Query object.
1285   *
1286   * @param string|array $query_vars Default WP_Query arguments.
1287   */
1288  function wp( $query_vars = '' ) {
1289      global $wp, $wp_query, $wp_the_query;
1290  
1291      $wp->main( $query_vars );
1292  
1293      if ( ! isset( $wp_the_query ) ) {
1294          $wp_the_query = $wp_query;
1295      }
1296  }
1297  
1298  /**
1299   * Retrieve the description for the HTTP status.
1300   *
1301   * @since 2.3.0
1302   * @since 3.9.0 Added status codes 418, 428, 429, 431, and 511.
1303   * @since 4.5.0 Added status codes 308, 421, and 451.
1304   * @since 5.1.0 Added status code 103.
1305   *
1306   * @global array $wp_header_to_desc
1307   *
1308   * @param int $code HTTP status code.
1309   * @return string Status description if found, an empty string otherwise.
1310   */
1311  function get_status_header_desc( $code ) {
1312      global $wp_header_to_desc;
1313  
1314      $code = absint( $code );
1315  
1316      if ( ! isset( $wp_header_to_desc ) ) {
1317          $wp_header_to_desc = array(
1318              100 => 'Continue',
1319              101 => 'Switching Protocols',
1320              102 => 'Processing',
1321              103 => 'Early Hints',
1322  
1323              200 => 'OK',
1324              201 => 'Created',
1325              202 => 'Accepted',
1326              203 => 'Non-Authoritative Information',
1327              204 => 'No Content',
1328              205 => 'Reset Content',
1329              206 => 'Partial Content',
1330              207 => 'Multi-Status',
1331              226 => 'IM Used',
1332  
1333              300 => 'Multiple Choices',
1334              301 => 'Moved Permanently',
1335              302 => 'Found',
1336              303 => 'See Other',
1337              304 => 'Not Modified',
1338              305 => 'Use Proxy',
1339              306 => 'Reserved',
1340              307 => 'Temporary Redirect',
1341              308 => 'Permanent Redirect',
1342  
1343              400 => 'Bad Request',
1344              401 => 'Unauthorized',
1345              402 => 'Payment Required',
1346              403 => 'Forbidden',
1347              404 => 'Not Found',
1348              405 => 'Method Not Allowed',
1349              406 => 'Not Acceptable',
1350              407 => 'Proxy Authentication Required',
1351              408 => 'Request Timeout',
1352              409 => 'Conflict',
1353              410 => 'Gone',
1354              411 => 'Length Required',
1355              412 => 'Precondition Failed',
1356              413 => 'Request Entity Too Large',
1357              414 => 'Request-URI Too Long',
1358              415 => 'Unsupported Media Type',
1359              416 => 'Requested Range Not Satisfiable',
1360              417 => 'Expectation Failed',
1361              418 => 'I\'m a teapot',
1362              421 => 'Misdirected Request',
1363              422 => 'Unprocessable Entity',
1364              423 => 'Locked',
1365              424 => 'Failed Dependency',
1366              426 => 'Upgrade Required',
1367              428 => 'Precondition Required',
1368              429 => 'Too Many Requests',
1369              431 => 'Request Header Fields Too Large',
1370              451 => 'Unavailable For Legal Reasons',
1371  
1372              500 => 'Internal Server Error',
1373              501 => 'Not Implemented',
1374              502 => 'Bad Gateway',
1375              503 => 'Service Unavailable',
1376              504 => 'Gateway Timeout',
1377              505 => 'HTTP Version Not Supported',
1378              506 => 'Variant Also Negotiates',
1379              507 => 'Insufficient Storage',
1380              510 => 'Not Extended',
1381              511 => 'Network Authentication Required',
1382          );
1383      }
1384  
1385      if ( isset( $wp_header_to_desc[ $code ] ) ) {
1386          return $wp_header_to_desc[ $code ];
1387      } else {
1388          return '';
1389      }
1390  }
1391  
1392  /**
1393   * Set HTTP status header.
1394   *
1395   * @since 2.0.0
1396   * @since 4.4.0 Added the `$description` parameter.
1397   *
1398   * @see get_status_header_desc()
1399   *
1400   * @param int    $code        HTTP status code.
1401   * @param string $description Optional. A custom description for the HTTP status.
1402   */
1403  function status_header( $code, $description = '' ) {
1404      if ( ! $description ) {
1405          $description = get_status_header_desc( $code );
1406      }
1407  
1408      if ( empty( $description ) ) {
1409          return;
1410      }
1411  
1412      $protocol      = wp_get_server_protocol();
1413      $status_header = "$protocol $code $description";
1414      if ( function_exists( 'apply_filters' ) ) {
1415  
1416          /**
1417           * Filters an HTTP status header.
1418           *
1419           * @since 2.2.0
1420           *
1421           * @param string $status_header HTTP status header.
1422           * @param int    $code          HTTP status code.
1423           * @param string $description   Description for the status code.
1424           * @param string $protocol      Server protocol.
1425           */
1426          $status_header = apply_filters( 'status_header', $status_header, $code, $description, $protocol );
1427      }
1428  
1429      if ( ! headers_sent() ) {
1430          header( $status_header, true, $code );
1431      }
1432  }
1433  
1434  /**
1435   * Get the header information to prevent caching.
1436   *
1437   * The several different headers cover the different ways cache prevention
1438   * is handled by different browsers
1439   *
1440   * @since 2.8.0
1441   *
1442   * @return array The associative array of header names and field values.
1443   */
1444  function wp_get_nocache_headers() {
1445      $headers = array(
1446          'Expires'       => 'Wed, 11 Jan 1984 05:00:00 GMT',
1447          'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
1448      );
1449  
1450      if ( function_exists( 'apply_filters' ) ) {
1451          /**
1452           * Filters the cache-controlling headers.
1453           *
1454           * @since 2.8.0
1455           *
1456           * @see wp_get_nocache_headers()
1457           *
1458           * @param array $headers {
1459           *     Header names and field values.
1460           *
1461           *     @type string $Expires       Expires header.
1462           *     @type string $Cache-Control Cache-Control header.
1463           * }
1464           */
1465          $headers = (array) apply_filters( 'nocache_headers', $headers );
1466      }
1467      $headers['Last-Modified'] = false;
1468      return $headers;
1469  }
1470  
1471  /**
1472   * Set the headers to prevent caching for the different browsers.
1473   *
1474   * Different browsers support different nocache headers, so several
1475   * headers must be sent so that all of them get the point that no
1476   * caching should occur.
1477   *
1478   * @since 2.0.0
1479   *
1480   * @see wp_get_nocache_headers()
1481   */
1482  function nocache_headers() {
1483      if ( headers_sent() ) {
1484          return;
1485      }
1486  
1487      $headers = wp_get_nocache_headers();
1488  
1489      unset( $headers['Last-Modified'] );
1490  
1491      header_remove( 'Last-Modified' );
1492  
1493      foreach ( $headers as $name => $field_value ) {
1494          header( "{$name}: {$field_value}" );
1495      }
1496  }
1497  
1498  /**
1499   * Set the headers for caching for 10 days with JavaScript content type.
1500   *
1501   * @since 2.1.0
1502   */
1503  function cache_javascript_headers() {
1504      $expiresOffset = 10 * DAY_IN_SECONDS;
1505  
1506      header( 'Content-Type: text/javascript; charset=' . get_bloginfo( 'charset' ) );
1507      header( 'Vary: Accept-Encoding' ); // Handle proxies.
1508      header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', time() + $expiresOffset ) . ' GMT' );
1509  }
1510  
1511  /**
1512   * Retrieve the number of database queries during the WordPress execution.
1513   *
1514   * @since 2.0.0
1515   *
1516   * @global wpdb $wpdb WordPress database abstraction object.
1517   *
1518   * @return int Number of database queries.
1519   */
1520  function get_num_queries() {
1521      global $wpdb;
1522      return $wpdb->num_queries;
1523  }
1524  
1525  /**
1526   * Whether input is yes or no.
1527   *
1528   * Must be 'y' to be true.
1529   *
1530   * @since 1.0.0
1531   *
1532   * @param string $yn Character string containing either 'y' (yes) or 'n' (no).
1533   * @return bool True if yes, false on anything else.
1534   */
1535  function bool_from_yn( $yn ) {
1536      return ( 'y' === strtolower( $yn ) );
1537  }
1538  
1539  /**
1540   * Load the feed template from the use of an action hook.
1541   *
1542   * If the feed action does not have a hook, then the function will die with a
1543   * message telling the visitor that the feed is not valid.
1544   *
1545   * It is better to only have one hook for each feed.
1546   *
1547   * @since 2.1.0
1548   *
1549   * @global WP_Query $wp_query WordPress Query object.
1550   */
1551  function do_feed() {
1552      global $wp_query;
1553  
1554      $feed = get_query_var( 'feed' );
1555  
1556      // Remove the pad, if present.
1557      $feed = preg_replace( '/^_+/', '', $feed );
1558  
1559      if ( '' === $feed || 'feed' === $feed ) {
1560          $feed = get_default_feed();
1561      }
1562  
1563      if ( ! has_action( "do_feed_{$feed}" ) ) {
1564          wp_die( __( 'Error: This is not a valid feed template.' ), '', array( 'response' => 404 ) );
1565      }
1566  
1567      /**
1568       * Fires once the given feed is loaded.
1569       *
1570       * The dynamic portion of the hook name, `$feed`, refers to the feed template name.
1571       * Possible values include: 'rdf', 'rss', 'rss2', and 'atom'.
1572       *
1573       * @since 2.1.0
1574       * @since 4.4.0 The `$feed` parameter was added.
1575       *
1576       * @param bool   $is_comment_feed Whether the feed is a comment feed.
1577       * @param string $feed            The feed name.
1578       */
1579      do_action( "do_feed_{$feed}", $wp_query->is_comment_feed, $feed );
1580  }
1581  
1582  /**
1583   * Load the RDF RSS 0.91 Feed template.
1584   *
1585   * @since 2.1.0
1586   *
1587   * @see load_template()
1588   */
1589  function do_feed_rdf() {
1590      load_template( ABSPATH . WPINC . '/feed-rdf.php' );
1591  }
1592  
1593  /**
1594   * Load the RSS 1.0 Feed Template.
1595   *
1596   * @since 2.1.0
1597   *
1598   * @see load_template()
1599   */
1600  function do_feed_rss() {
1601      load_template( ABSPATH . WPINC . '/feed-rss.php' );
1602  }
1603  
1604  /**
1605   * Load either the RSS2 comment feed or the RSS2 posts feed.
1606   *
1607   * @since 2.1.0
1608   *
1609   * @see load_template()
1610   *
1611   * @param bool $for_comments True for the comment feed, false for normal feed.
1612   */
1613  function do_feed_rss2( $for_comments ) {
1614      if ( $for_comments ) {
1615          load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' );
1616      } else {
1617          load_template( ABSPATH . WPINC . '/feed-rss2.php' );
1618      }
1619  }
1620  
1621  /**
1622   * Load either Atom comment feed or Atom posts feed.
1623   *
1624   * @since 2.1.0
1625   *
1626   * @see load_template()
1627   *
1628   * @param bool $for_comments True for the comment feed, false for normal feed.
1629   */
1630  function do_feed_atom( $for_comments ) {
1631      if ( $for_comments ) {
1632          load_template( ABSPATH . WPINC . '/feed-atom-comments.php' );
1633      } else {
1634          load_template( ABSPATH . WPINC . '/feed-atom.php' );
1635      }
1636  }
1637  
1638  /**
1639   * Displays the default robots.txt file content.
1640   *
1641   * @since 2.1.0
1642   * @since 5.3.0 Remove the "Disallow: /" output if search engine visiblity is
1643   *              discouraged in favor of robots meta HTML tag via wp_robots_no_robots()
1644   *              filter callback.
1645   */
1646  function do_robots() {
1647      header( 'Content-Type: text/plain; charset=utf-8' );
1648  
1649      /**
1650       * Fires when displaying the robots.txt file.
1651       *
1652       * @since 2.1.0
1653       */
1654      do_action( 'do_robotstxt' );
1655  
1656      $output = "User-agent: *\n";
1657      $public = get_option( 'blog_public' );
1658  
1659      $site_url = parse_url( site_url() );
1660      $path     = ( ! empty( $site_url['path'] ) ) ? $site_url['path'] : '';
1661      $output  .= "Disallow: $path/wp-admin/\n";
1662      $output  .= "Allow: $path/wp-admin/admin-ajax.php\n";
1663  
1664      /**
1665       * Filters the robots.txt output.
1666       *
1667       * @since 3.0.0
1668       *
1669       * @param string $output The robots.txt output.
1670       * @param bool   $public Whether the site is considered "public".
1671       */
1672      echo apply_filters( 'robots_txt', $output, $public );
1673  }
1674  
1675  /**
1676   * Display the favicon.ico file content.
1677   *
1678   * @since 5.4.0
1679   */
1680  function do_favicon() {
1681      /**
1682       * Fires when serving the favicon.ico file.
1683       *
1684       * @since 5.4.0
1685       */
1686      do_action( 'do_faviconico' );
1687  
1688      wp_redirect( get_site_icon_url( 32, includes_url( 'images/w-logo-blue-white-bg.png' ) ) );
1689      exit;
1690  }
1691  
1692  /**
1693   * Determines whether WordPress is already installed.
1694   *
1695   * The cache will be checked first. If you have a cache plugin, which saves
1696   * the cache values, then this will work. If you use the default WordPress
1697   * cache, and the database goes away, then you might have problems.
1698   *
1699   * Checks for the 'siteurl' option for whether WordPress is installed.
1700   *
1701   * For more information on this and similar theme functions, check out
1702   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
1703   * Conditional Tags} article in the Theme Developer Handbook.
1704   *
1705   * @since 2.1.0
1706   *
1707   * @global wpdb $wpdb WordPress database abstraction object.
1708   *
1709   * @return bool Whether the site is already installed.
1710   */
1711  function is_blog_installed() {
1712      global $wpdb;
1713  
1714      /*
1715       * Check cache first. If options table goes away and we have true
1716       * cached, oh well.
1717       */
1718      if ( wp_cache_get( 'is_blog_installed' ) ) {
1719          return true;
1720      }
1721  
1722      $suppress = $wpdb->suppress_errors();
1723      if ( ! wp_installing() ) {
1724          $alloptions = wp_load_alloptions();
1725      }
1726      // If siteurl is not set to autoload, check it specifically.
1727      if ( ! isset( $alloptions['siteurl'] ) ) {
1728          $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
1729      } else {
1730          $installed = $alloptions['siteurl'];
1731      }
1732      $wpdb->suppress_errors( $suppress );
1733  
1734      $installed = ! empty( $installed );
1735      wp_cache_set( 'is_blog_installed', $installed );
1736  
1737      if ( $installed ) {
1738          return true;
1739      }
1740  
1741      // If visiting repair.php, return true and let it take over.
1742      if ( defined( 'WP_REPAIRING' ) ) {
1743          return true;
1744      }
1745  
1746      $suppress = $wpdb->suppress_errors();
1747  
1748      /*
1749       * Loop over the WP tables. If none exist, then scratch installation is allowed.
1750       * If one or more exist, suggest table repair since we got here because the
1751       * options table could not be accessed.
1752       */
1753      $wp_tables = $wpdb->tables();
1754      foreach ( $wp_tables as $table ) {
1755          // The existence of custom user tables shouldn't suggest an unwise state or prevent a clean installation.
1756          if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table ) {
1757              continue;
1758          }
1759          if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table ) {
1760              continue;
1761          }
1762  
1763          $described_table = $wpdb->get_results( "DESCRIBE $table;" );
1764          if (
1765              ( ! $described_table && empty( $wpdb->last_error ) ) ||
1766              ( is_array( $described_table ) && 0 === count( $described_table ) )
1767          ) {
1768              continue;
1769          }
1770  
1771          // One or more tables exist. This is not good.
1772  
1773          wp_load_translations_early();
1774  
1775          // Die with a DB error.
1776          $wpdb->error = sprintf(
1777              /* translators: %s: Database repair URL. */
1778              __( 'One or more database tables are unavailable. The database may need to be <a href="%s">repaired</a>.' ),
1779              'maint/repair.php?referrer=is_blog_installed'
1780          );
1781  
1782          dead_db();
1783      }
1784  
1785      $wpdb->suppress_errors( $suppress );
1786  
1787      wp_cache_set( 'is_blog_installed', false );
1788  
1789      return false;
1790  }
1791  
1792  /**
1793   * Retrieve URL with nonce added to URL query.
1794   *
1795   * @since 2.0.4
1796   *
1797   * @param string     $actionurl URL to add nonce action.
1798   * @param int|string $action    Optional. Nonce action name. Default -1.
1799   * @param string     $name      Optional. Nonce name. Default '_wpnonce'.
1800   * @return string Escaped URL with nonce action added.
1801   */
1802  function wp_nonce_url( $actionurl, $action = -1, $name = '_wpnonce' ) {
1803      $actionurl = str_replace( '&amp;', '&', $actionurl );
1804      return esc_html( add_query_arg( $name, wp_create_nonce( $action ), $actionurl ) );
1805  }
1806  
1807  /**
1808   * Retrieve or display nonce hidden field for forms.
1809   *
1810   * The nonce field is used to validate that the contents of the form came from
1811   * the location on the current site and not somewhere else. The nonce does not
1812   * offer absolute protection, but should protect against most cases. It is very
1813   * important to use nonce field in forms.
1814   *
1815   * The $action and $name are optional, but if you want to have better security,
1816   * it is strongly suggested to set those two parameters. It is easier to just
1817   * call the function without any parameters, because validation of the nonce
1818   * doesn't require any parameters, but since crackers know what the default is
1819   * it won't be difficult for them to find a way around your nonce and cause
1820   * damage.
1821   *
1822   * The input name will be whatever $name value you gave. The input value will be
1823   * the nonce creation value.
1824   *
1825   * @since 2.0.4
1826   *
1827   * @param int|string $action  Optional. Action name. Default -1.
1828   * @param string     $name    Optional. Nonce name. Default '_wpnonce'.
1829   * @param bool       $referer Optional. Whether to set the referer field for validation. Default true.
1830   * @param bool       $echo    Optional. Whether to display or return hidden form field. Default true.
1831   * @return string Nonce field HTML markup.
1832   */
1833  function wp_nonce_field( $action = -1, $name = '_wpnonce', $referer = true, $echo = true ) {
1834      $name        = esc_attr( $name );
1835      $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
1836  
1837      if ( $referer ) {
1838          $nonce_field .= wp_referer_field( false );
1839      }
1840  
1841      if ( $echo ) {
1842          echo $nonce_field;
1843      }
1844  
1845      return $nonce_field;
1846  }
1847  
1848  /**
1849   * Retrieve or display referer hidden field for forms.
1850   *
1851   * The referer link is the current Request URI from the server super global. The
1852   * input name is '_wp_http_referer', in case you wanted to check manually.
1853   *
1854   * @since 2.0.4
1855   *
1856   * @param bool $echo Optional. Whether to echo or return the referer field. Default true.
1857   * @return string Referer field HTML markup.
1858   */
1859  function wp_referer_field( $echo = true ) {
1860      $referer_field = '<input type="hidden" name="_wp_http_referer" value="' . esc_attr( wp_unslash( $_SERVER['REQUEST_URI'] ) ) . '" />';
1861  
1862      if ( $echo ) {
1863          echo $referer_field;
1864      }
1865  
1866      return $referer_field;
1867  }
1868  
1869  /**
1870   * Retrieve or display original referer hidden field for forms.
1871   *
1872   * The input name is '_wp_original_http_referer' and will be either the same
1873   * value of wp_referer_field(), if that was posted already or it will be the
1874   * current page, if it doesn't exist.
1875   *
1876   * @since 2.0.4
1877   *
1878   * @param bool   $echo         Optional. Whether to echo the original http referer. Default true.
1879   * @param string $jump_back_to Optional. Can be 'previous' or page you want to jump back to.
1880   *                             Default 'current'.
1881   * @return string Original referer field.
1882   */
1883  function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
1884      $ref = wp_get_original_referer();
1885  
1886      if ( ! $ref ) {
1887          $ref = ( 'previous' === $jump_back_to ) ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] );
1888      }
1889  
1890      $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( $ref ) . '" />';
1891  
1892      if ( $echo ) {
1893          echo $orig_referer_field;
1894      }
1895  
1896      return $orig_referer_field;
1897  }
1898  
1899  /**
1900   * Retrieve referer from '_wp_http_referer' or HTTP referer.
1901   *
1902   * If it's the same as the current request URL, will return false.
1903   *
1904   * @since 2.0.4
1905   *
1906   * @return string|false Referer URL on success, false on failure.
1907   */
1908  function wp_get_referer() {
1909      if ( ! function_exists( 'wp_validate_redirect' ) ) {
1910          return false;
1911      }
1912  
1913      $ref = wp_get_raw_referer();
1914  
1915      if ( $ref && wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref && home_url() . wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref ) {
1916          return wp_validate_redirect( $ref, false );
1917      }
1918  
1919      return false;
1920  }
1921  
1922  /**
1923   * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
1924   *
1925   * Do not use for redirects, use wp_get_referer() instead.
1926   *
1927   * @since 4.5.0
1928   *
1929   * @return string|false Referer URL on success, false on failure.
1930   */
1931  function wp_get_raw_referer() {
1932      if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
1933          return wp_unslash( $_REQUEST['_wp_http_referer'] );
1934      } elseif ( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
1935          return wp_unslash( $_SERVER['HTTP_REFERER'] );
1936      }
1937  
1938      return false;
1939  }
1940  
1941  /**
1942   * Retrieve original referer that was posted, if it exists.
1943   *
1944   * @since 2.0.4
1945   *
1946   * @return string|false Original referer URL on success, false on failure.
1947   */
1948  function wp_get_original_referer() {
1949      if ( ! empty( $_REQUEST['_wp_original_http_referer'] ) && function_exists( 'wp_validate_redirect' ) ) {
1950          return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false );
1951      }
1952  
1953      return false;
1954  }
1955  
1956  /**
1957   * Recursive directory creation based on full path.
1958   *
1959   * Will attempt to set permissions on folders.
1960   *
1961   * @since 2.0.1
1962   *
1963   * @param string $target Full path to attempt to create.
1964   * @return bool Whether the path was created. True if path already exists.
1965   */
1966  function wp_mkdir_p( $target ) {
1967      $wrapper = null;
1968  
1969      // Strip the protocol.
1970      if ( wp_is_stream( $target ) ) {
1971          list( $wrapper, $target ) = explode( '://', $target, 2 );
1972      }
1973  
1974      // From php.net/mkdir user contributed notes.
1975      $target = str_replace( '//', '/', $target );
1976  
1977      // Put the wrapper back on the target.
1978      if ( null !== $wrapper ) {
1979          $target = $wrapper . '://' . $target;
1980      }
1981  
1982      /*
1983       * Safe mode fails with a trailing slash under certain PHP versions.
1984       * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
1985       */
1986      $target = rtrim( $target, '/' );
1987      if ( empty( $target ) ) {
1988          $target = '/';
1989      }
1990  
1991      if ( file_exists( $target ) ) {
1992          return @is_dir( $target );
1993      }
1994  
1995      // Do not allow path traversals.
1996      if ( false !== strpos( $target, '../' ) || false !== strpos( $target, '..' . DIRECTORY_SEPARATOR ) ) {
1997          return false;
1998      }
1999  
2000      // We need to find the permissions of the parent folder that exists and inherit that.
2001      $target_parent = dirname( $target );
2002      while ( '.' !== $target_parent && ! is_dir( $target_parent ) && dirname( $target_parent ) !== $target_parent ) {
2003          $target_parent = dirname( $target_parent );
2004      }
2005  
2006      // Get the permission bits.
2007      $stat = @stat( $target_parent );
2008      if ( $stat ) {
2009          $dir_perms = $stat['mode'] & 0007777;
2010      } else {
2011          $dir_perms = 0777;
2012      }
2013  
2014      if ( @mkdir( $target, $dir_perms, true ) ) {
2015  
2016          /*
2017           * If a umask is set that modifies $dir_perms, we'll have to re-set
2018           * the $dir_perms correctly with chmod()
2019           */
2020          if ( ( $dir_perms & ~umask() ) != $dir_perms ) {
2021              $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) );
2022              for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) {
2023                  chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms );
2024              }
2025          }
2026  
2027          return true;
2028      }
2029  
2030      return false;
2031  }
2032  
2033  /**
2034   * Test if a given filesystem path is absolute.
2035   *
2036   * For example, '/foo/bar', or 'c:\windows'.
2037   *
2038   * @since 2.5.0
2039   *
2040   * @param string $path File path.
2041   * @return bool True if path is absolute, false is not absolute.
2042   */
2043  function path_is_absolute( $path ) {
2044      /*
2045       * Check to see if the path is a stream and check to see if its an actual
2046       * path or file as realpath() does not support stream wrappers.
2047       */
2048      if ( wp_is_stream( $path ) && ( is_dir( $path ) || is_file( $path ) ) ) {
2049          return true;
2050      }
2051  
2052      /*
2053       * This is definitive if true but fails if $path does not exist or contains
2054       * a symbolic link.
2055       */
2056      if ( realpath( $path ) == $path ) {
2057          return true;
2058      }
2059  
2060      if ( strlen( $path ) == 0 || '.' === $path[0] ) {
2061          return false;
2062      }
2063  
2064      // Windows allows absolute paths like this.
2065      if ( preg_match( '#^[a-zA-Z]:\\\\#', $path ) ) {
2066          return true;
2067      }
2068  
2069      // A path starting with / or \ is absolute; anything else is relative.
2070      return ( '/' === $path[0] || '\\' === $path[0] );
2071  }
2072  
2073  /**
2074   * Join two filesystem paths together.
2075   *
2076   * For example, 'give me $path relative to $base'. If the $path is absolute,
2077   * then it the full path is returned.
2078   *
2079   * @since 2.5.0
2080   *
2081   * @param string $base Base path.
2082   * @param string $path Path relative to $base.
2083   * @return string The path with the base or absolute path.
2084   */
2085  function path_join( $base, $path ) {
2086      if ( path_is_absolute( $path ) ) {
2087          return $path;
2088      }
2089  
2090      return rtrim( $base, '/' ) . '/' . ltrim( $path, '/' );
2091  }
2092  
2093  /**
2094   * Normalize a filesystem path.
2095   *
2096   * On windows systems, replaces backslashes with forward slashes
2097   * and forces upper-case drive letters.
2098   * Allows for two leading slashes for Windows network shares, but
2099   * ensures that all other duplicate slashes are reduced to a single.
2100   *
2101   * @since 3.9.0
2102   * @since 4.4.0 Ensures upper-case drive letters on Windows systems.
2103   * @since 4.5.0 Allows for Windows network shares.
2104   * @since 4.9.7 Allows for PHP file wrappers.
2105   *
2106   * @param string $path Path to normalize.
2107   * @return string Normalized path.
2108   */
2109  function wp_normalize_path( $path ) {
2110      $wrapper = '';
2111  
2112      if ( wp_is_stream( $path ) ) {
2113          list( $wrapper, $path ) = explode( '://', $path, 2 );
2114  
2115          $wrapper .= '://';
2116      }
2117  
2118      // Standardise all paths to use '/'.
2119      $path = str_replace( '\\', '/', $path );
2120  
2121      // Replace multiple slashes down to a singular, allowing for network shares having two slashes.
2122      $path = preg_replace( '|(?<=.)/+|', '/', $path );
2123  
2124      // Windows paths should uppercase the drive letter.
2125      if ( ':' === substr( $path, 1, 1 ) ) {
2126          $path = ucfirst( $path );
2127      }
2128  
2129      return $wrapper . $path;
2130  }
2131  
2132  /**
2133   * Determine a writable directory for temporary files.
2134   *
2135   * Function's preference is the return value of sys_get_temp_dir(),
2136   * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR,
2137   * before finally defaulting to /tmp/
2138   *
2139   * In the event that this function does not find a writable location,
2140   * It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file.
2141   *
2142   * @since 2.5.0
2143   *
2144   * @return string Writable temporary directory.
2145   */
2146  function get_temp_dir() {
2147      static $temp = '';
2148      if ( defined( 'WP_TEMP_DIR' ) ) {
2149          return trailingslashit( WP_TEMP_DIR );
2150      }
2151  
2152      if ( $temp ) {
2153          return trailingslashit( $temp );
2154      }
2155  
2156      if ( function_exists( 'sys_get_temp_dir' ) ) {
2157          $temp = sys_get_temp_dir();
2158          if ( @is_dir( $temp ) && wp_is_writable( $temp ) ) {
2159              return trailingslashit( $temp );
2160          }
2161      }
2162  
2163      $temp = ini_get( 'upload_tmp_dir' );
2164      if ( @is_dir( $temp ) && wp_is_writable( $temp ) ) {
2165          return trailingslashit( $temp );
2166      }
2167  
2168      $temp = WP_CONTENT_DIR . '/';
2169      if ( is_dir( $temp ) && wp_is_writable( $temp ) ) {
2170          return $temp;
2171      }
2172  
2173      return '/tmp/';
2174  }
2175  
2176  /**
2177   * Determine if a directory is writable.
2178   *
2179   * This function is used to work around certain ACL issues in PHP primarily
2180   * affecting Windows Servers.
2181   *
2182   * @since 3.6.0
2183   *
2184   * @see win_is_writable()
2185   *
2186   * @param string $path Path to check for write-ability.
2187   * @return bool Whether the path is writable.
2188   */
2189  function wp_is_writable( $path ) {
2190      if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
2191          return win_is_writable( $path );
2192      } else {
2193          return @is_writable( $path );
2194      }
2195  }
2196  
2197  /**
2198   * Workaround for Windows bug in is_writable() function
2199   *
2200   * PHP has issues with Windows ACL's for determine if a
2201   * directory is writable or not, this works around them by
2202   * checking the ability to open files rather than relying
2203   * upon PHP to interprate the OS ACL.
2204   *
2205   * @since 2.8.0
2206   *
2207   * @see https://bugs.php.net/bug.php?id=27609
2208   * @see https://bugs.php.net/bug.php?id=30931
2209   *
2210   * @param string $path Windows path to check for write-ability.
2211   * @return bool Whether the path is writable.
2212   */
2213  function win_is_writable( $path ) {
2214      if ( '/' === $path[ strlen( $path ) - 1 ] ) {
2215          // If it looks like a directory, check a random file within the directory.
2216          return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp' );
2217      } elseif ( is_dir( $path ) ) {
2218          // If it's a directory (and not a file), check a random file within the directory.
2219          return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
2220      }
2221  
2222      // Check tmp file for read/write capabilities.
2223      $should_delete_tmp_file = ! file_exists( $path );
2224  
2225      $f = @fopen( $path, 'a' );
2226      if ( false === $f ) {
2227          return false;
2228      }
2229      fclose( $f );
2230  
2231      if ( $should_delete_tmp_file ) {
2232          unlink( $path );
2233      }
2234  
2235      return true;
2236  }
2237  
2238  /**
2239   * Retrieves uploads directory information.
2240   *
2241   * Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory.
2242   * Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases
2243   * when not uploading files.
2244   *
2245   * @since 4.5.0
2246   *
2247   * @see wp_upload_dir()
2248   *
2249   * @return array See wp_upload_dir() for description.
2250   */
2251  function wp_get_upload_dir() {
2252      return wp_upload_dir( null, false );
2253  }
2254  
2255  /**
2256   * Returns an array containing the current upload directory's path and URL.
2257   *
2258   * Checks the 'upload_path' option, which should be from the web root folder,
2259   * and if it isn't empty it will be used. If it is empty, then the path will be
2260   * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
2261   * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
2262   *
2263   * The upload URL path is set either by the 'upload_url_path' option or by using
2264   * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
2265   *
2266   * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
2267   * the administration settings panel), then the time will be used. The format
2268   * will be year first and then month.
2269   *
2270   * If the path couldn't be created, then an error will be returned with the key
2271   * 'error' containing the error message. The error suggests that the parent
2272   * directory is not writable by the server.
2273   *
2274   * @since 2.0.0
2275   * @uses _wp_upload_dir()
2276   *
2277   * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
2278   * @param bool   $create_dir Optional. Whether to check and create the uploads directory.
2279   *                           Default true for backward compatibility.
2280   * @param bool   $refresh_cache Optional. Whether to refresh the cache. Default false.
2281   * @return array {
2282   *     Array of information about the upload directory.
2283   *
2284   *     @type string       $path    Base directory and subdirectory or full path to upload directory.
2285   *     @type string       $url     Base URL and subdirectory or absolute URL to upload directory.
2286   *     @type string       $subdir  Subdirectory if uploads use year/month folders option is on.
2287   *     @type string       $basedir Path without subdir.
2288   *     @type string       $baseurl URL path without subdir.
2289   *     @type string|false $error   False or error message.
2290   * }
2291   */
2292  function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
2293      static $cache = array(), $tested_paths = array();
2294  
2295      $key = sprintf( '%d-%s', get_current_blog_id(), (string) $time );
2296  
2297      if ( $refresh_cache || empty( $cache[ $key ] ) ) {
2298          $cache[ $key ] = _wp_upload_dir( $time );
2299      }
2300  
2301      /**
2302       * Filters the uploads directory data.
2303       *
2304       * @since 2.0.0
2305       *
2306       * @param array $uploads {
2307       *     Array of information about the upload directory.
2308       *
2309       *     @type string       $path    Base directory and subdirectory or full path to upload directory.
2310       *     @type string       $url     Base URL and subdirectory or absolute URL to upload directory.
2311       *     @type string       $subdir  Subdirectory if uploads use year/month folders option is on.
2312       *     @type string       $basedir Path without subdir.
2313       *     @type string       $baseurl URL path without subdir.
2314       *     @type string|false $error   False or error message.
2315       * }
2316       */
2317      $uploads = apply_filters( 'upload_dir', $cache[ $key ] );
2318  
2319      if ( $create_dir ) {
2320          $path = $uploads['path'];
2321  
2322          if ( array_key_exists( $path, $tested_paths ) ) {
2323              $uploads['error'] = $tested_paths[ $path ];
2324          } else {
2325              if ( ! wp_mkdir_p( $path ) ) {
2326                  if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) {
2327                      $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
2328                  } else {
2329                      $error_path = wp_basename( $uploads['basedir'] ) . $uploads['subdir'];
2330                  }
2331  
2332                  $uploads['error'] = sprintf(
2333                      /* translators: %s: Directory path. */
2334                      __( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
2335                      esc_html( $error_path )
2336                  );
2337              }
2338  
2339              $tested_paths[ $path ] = $uploads['error'];
2340          }
2341      }
2342  
2343      return $uploads;
2344  }
2345  
2346  /**
2347   * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
2348   *
2349   * @since 4.5.0
2350   * @access private
2351   *
2352   * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
2353   * @return array See wp_upload_dir()
2354   */
2355  function _wp_upload_dir( $time = null ) {
2356      $siteurl     = get_option( 'siteurl' );
2357      $upload_path = trim( get_option( 'upload_path' ) );
2358  
2359      if ( empty( $upload_path ) || 'wp-content/uploads' === $upload_path ) {
2360          $dir = WP_CONTENT_DIR . '/uploads';
2361      } elseif ( 0 !== strpos( $upload_path, ABSPATH ) ) {
2362          // $dir is absolute, $upload_path is (maybe) relative to ABSPATH.
2363          $dir = path_join( ABSPATH, $upload_path );
2364      } else {
2365          $dir = $upload_path;
2366      }
2367  
2368      $url = get_option( 'upload_url_path' );
2369      if ( ! $url ) {
2370          if ( empty( $upload_path ) || ( 'wp-content/uploads' === $upload_path ) || ( $upload_path == $dir ) ) {
2371              $url = WP_CONTENT_URL . '/uploads';
2372          } else {
2373              $url = trailingslashit( $siteurl ) . $upload_path;
2374          }
2375      }
2376  
2377      /*
2378       * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
2379       * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
2380       */
2381      if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {
2382          $dir = ABSPATH . UPLOADS;
2383          $url = trailingslashit( $siteurl ) . UPLOADS;
2384      }
2385  
2386      // If multisite (and if not the main site in a post-MU network).
2387      if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) {
2388  
2389          if ( ! get_site_option( 'ms_files_rewriting' ) ) {
2390              /*
2391               * If ms-files rewriting is disabled (networks created post-3.5), it is fairly
2392               * straightforward: Append sites/%d if we're not on the main site (for post-MU
2393               * networks). (The extra directory prevents a four-digit ID from conflicting with
2394               * a year-based directory for the main site. But if a MU-era network has disabled
2395               * ms-files rewriting manually, they don't need the extra directory, as they never
2396               * had wp-content/uploads for the main site.)
2397               */
2398  
2399              if ( defined( 'MULTISITE' ) ) {
2400                  $ms_dir = '/sites/' . get_current_blog_id();
2401              } else {
2402                  $ms_dir = '/' . get_current_blog_id();
2403              }
2404  
2405              $dir .= $ms_dir;
2406              $url .= $ms_dir;
2407  
2408          } elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {
2409              /*
2410               * Handle the old-form ms-files.php rewriting if the network still has that enabled.
2411               * When ms-files rewriting is enabled, then we only listen to UPLOADS when:
2412               * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used
2413               *    there, and
2414               * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect
2415               *    the original blog ID.
2416               *
2417               * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
2418               * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
2419               * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
2420               * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
2421               */
2422  
2423              if ( defined( 'BLOGUPLOADDIR' ) ) {
2424                  $dir = untrailingslashit( BLOGUPLOADDIR );
2425              } else {
2426                  $dir = ABSPATH . UPLOADS;
2427              }
2428              $url = trailingslashit( $siteurl ) . 'files';
2429          }
2430      }
2431  
2432      $basedir = $dir;
2433      $baseurl = $url;
2434  
2435      $subdir = '';
2436      if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
2437          // Generate the yearly and monthly directories.
2438          if ( ! $time ) {
2439              $time = current_time( 'mysql' );
2440          }
2441          $y      = substr( $time, 0, 4 );
2442          $m      = substr( $time, 5, 2 );
2443          $subdir = "/$y/$m";
2444      }
2445  
2446      $dir .= $subdir;
2447      $url .= $subdir;
2448  
2449      return array(
2450          'path'    => $dir,
2451          'url'     => $url,
2452          'subdir'  => $subdir,
2453          'basedir' => $basedir,
2454          'baseurl' => $baseurl,
2455          'error'   => false,
2456      );
2457  }
2458  
2459  /**
2460   * Get a filename that is sanitized and unique for the given directory.
2461   *
2462   * If the filename is not unique, then a number will be added to the filename
2463   * before the extension, and will continue adding numbers until the filename
2464   * is unique.
2465   *
2466   * The callback function allows the caller to use their own method to create
2467   * unique file names. If defined, the callback should take three arguments:
2468   * - directory, base filename, and extension - and return a unique filename.
2469   *
2470   * @since 2.5.0
2471   *
2472   * @param string   $dir                      Directory.
2473   * @param string   $filename                 File name.
2474   * @param callable $unique_filename_callback Callback. Default null.
2475   * @return string New filename, if given wasn't unique.
2476   */
2477  function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
2478      // Sanitize the file name before we begin processing.
2479      $filename = sanitize_file_name( $filename );
2480      $ext2     = null;
2481  
2482      // Separate the filename into a name and extension.
2483      $ext  = pathinfo( $filename, PATHINFO_EXTENSION );
2484      $name = pathinfo( $filename, PATHINFO_BASENAME );
2485  
2486      if ( $ext ) {
2487          $ext = '.' . $ext;
2488      }
2489  
2490      // Edge case: if file is named '.ext', treat as an empty name.
2491      if ( $name === $ext ) {
2492          $name = '';
2493      }
2494  
2495      /*
2496       * Increment the file number until we have a unique file to save in $dir.
2497       * Use callback if supplied.
2498       */
2499      if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
2500          $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
2501      } else {
2502          $number = '';
2503          $fname  = pathinfo( $filename, PATHINFO_FILENAME );
2504  
2505          // Always append a number to file names that can potentially match image sub-size file names.
2506          if ( $fname && preg_match( '/-(?:\d+x\d+|scaled|rotated)$/', $fname ) ) {
2507              $number = 1;
2508  
2509              // At this point the file name may not be unique. This is tested below and the $number is incremented.
2510              $filename = str_replace( "{$fname}{$ext}", "{$fname}-{$number}{$ext}", $filename );
2511          }
2512  
2513          // Change '.ext' to lower case.
2514          if ( $ext && strtolower( $ext ) != $ext ) {
2515              $ext2      = strtolower( $ext );
2516              $filename2 = preg_replace( '|' . preg_quote( $ext ) . '$|', $ext2, $filename );
2517  
2518              // Check for both lower and upper case extension or image sub-sizes may be overwritten.
2519              while ( file_exists( $dir . "/{$filename}" ) || file_exists( $dir . "/{$filename2}" ) ) {
2520                  $new_number = (int) $number + 1;
2521                  $filename   = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
2522                  $filename2  = str_replace( array( "-{$number}{$ext2}", "{$number}{$ext2}" ), "-{$new_number}{$ext2}", $filename2 );
2523                  $number     = $new_number;
2524              }
2525  
2526              $filename = $filename2;
2527          } else {
2528              while ( file_exists( $dir . "/{$filename}" ) ) {
2529                  $new_number = (int) $number + 1;
2530  
2531                  if ( '' === "{$number}{$ext}" ) {
2532                      $filename = "{$filename}-{$new_number}";
2533                  } else {
2534                      $filename = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
2535                  }
2536  
2537                  $number = $new_number;
2538              }
2539          }
2540  
2541          // Prevent collisions with existing file names that contain dimension-like strings
2542          // (whether they are subsizes or originals uploaded prior to #42437).
2543          $upload_dir = wp_get_upload_dir();
2544  
2545          // The (resized) image files would have name and extension, and will be in the uploads dir.
2546          if ( $name && $ext && @is_dir( $dir ) && false !== strpos( $dir, $upload_dir['basedir'] ) ) {
2547              /**
2548               * Filters the file list used for calculating a unique filename for a newly added file.
2549               *
2550               * Returning an array from the filter will effectively short-circuit retrieval
2551               * from the filesystem and return the passed value instead.
2552               *
2553               * @since 5.5.0
2554               *
2555               * @param array|null $files    The list of files to use for filename comparisons.
2556               *                             Default null (to retrieve the list from the filesystem).
2557               * @param string     $dir      The directory for the new file.
2558               * @param string     $filename The proposed filename for the new file.
2559               */
2560              $files = apply_filters( 'pre_wp_unique_filename_file_list', null, $dir, $filename );
2561  
2562              if ( null === $files ) {
2563                  // List of all files and directories contained in $dir.
2564                  $files = @scandir( $dir );
2565              }
2566  
2567              if ( ! empty( $files ) ) {
2568                  // Remove "dot" dirs.
2569                  $files = array_diff( $files, array( '.', '..' ) );
2570              }
2571  
2572              if ( ! empty( $files ) ) {
2573                  // The extension case may have changed above.
2574                  $new_ext = ! empty( $ext2 ) ? $ext2 : $ext;
2575  
2576                  // Ensure this never goes into infinite loop
2577                  // as it uses pathinfo() and regex in the check, but string replacement for the changes.
2578                  $count = count( $files );
2579                  $i     = 0;
2580  
2581                  while ( $i <= $count && _wp_check_existing_file_names( $filename, $files ) ) {
2582                      $new_number = (int) $number + 1;
2583                      $filename   = str_replace( array( "-{$number}{$new_ext}", "{$number}{$new_ext}" ), "-{$new_number}{$new_ext}", $filename );
2584                      $number     = $new_number;
2585                      $i++;
2586                  }
2587              }
2588          }
2589      }
2590  
2591      /**
2592       * Filters the result when generating a unique file name.
2593       *
2594       * @since 4.5.0
2595       *
2596       * @param string        $filename                 Unique file name.
2597       * @param string        $ext                      File extension, eg. ".png".
2598       * @param string        $dir                      Directory path.
2599       * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
2600       */
2601      return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback );
2602  }
2603  
2604  /**
2605   * Helper function to check if a file name could match an existing image sub-size file name.
2606   *
2607   * @since 5.3.1
2608   * @access private
2609   *
2610   * @param string $filename The file name to check.
2611   * @param array  $files    An array of existing files in the directory.
2612   * @return bool True if the tested file name could match an existing file, false otherwise.
2613   */
2614  function _wp_check_existing_file_names( $filename, $files ) {
2615      $fname = pathinfo( $filename, PATHINFO_FILENAME );
2616      $ext   = pathinfo( $filename, PATHINFO_EXTENSION );
2617  
2618      // Edge case, file names like `.ext`.
2619      if ( empty( $fname ) ) {
2620          return false;
2621      }
2622  
2623      if ( $ext ) {
2624          $ext = ".$ext";
2625      }
2626  
2627      $regex = '/^' . preg_quote( $fname ) . '-(?:\d+x\d+|scaled|rotated)' . preg_quote( $ext ) . '$/i';
2628  
2629      foreach ( $files as $file ) {
2630          if ( preg_match( $regex, $file ) ) {
2631              return true;
2632          }
2633      }
2634  
2635      return false;
2636  }
2637  
2638  /**
2639   * Create a file in the upload folder with given content.
2640   *
2641   * If there is an error, then the key 'error' will exist with the error message.
2642   * If success, then the key 'file' will have the unique file path, the 'url' key
2643   * will have the link to the new file. and the 'error' key will be set to false.
2644   *
2645   * This function will not move an uploaded file to the upload folder. It will
2646   * create a new file with the content in $bits parameter. If you move the upload
2647   * file, read the content of the uploaded file, and then you can give the
2648   * filename and content to this function, which will add it to the upload
2649   * folder.
2650   *
2651   * The permissions will be set on the new file automatically by this function.
2652   *
2653   * @since 2.0.0
2654   *
2655   * @param string      $name       Filename.
2656   * @param null|string $deprecated Never used. Set to null.
2657   * @param string      $bits       File content
2658   * @param string      $time       Optional. Time formatted in 'yyyy/mm'. Default null.
2659   * @return array {
2660   *     Information about the newly-uploaded file.
2661   *
2662   *     @type string       $file  Filename of the newly-uploaded file.
2663   *     @type string       $url   URL of the uploaded file.
2664   *     @type string       $type  File type.
2665   *     @type string|false $error Error message, if there has been an error.
2666   * }
2667   */
2668  function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
2669      if ( ! empty( $deprecated ) ) {
2670          _deprecated_argument( __FUNCTION__, '2.0.0' );
2671      }
2672  
2673      if ( empty( $name ) ) {
2674          return array( 'error' => __( 'Empty filename' ) );
2675      }
2676  
2677      $wp_filetype = wp_check_filetype( $name );
2678      if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) ) {
2679          return array( 'error' => __( 'Sorry, this file type is not permitted for security reasons.' ) );
2680      }
2681  
2682      $upload = wp_upload_dir( $time );
2683  
2684      if ( false !== $upload['error'] ) {
2685          return $upload;
2686      }
2687  
2688      /**
2689       * Filters whether to treat the upload bits as an error.
2690       *
2691       * Returning a non-array from the filter will effectively short-circuit preparing the upload bits
2692       * and return that value instead. An error message should be returned as a string.
2693       *
2694       * @since 3.0.0
2695       *
2696       * @param array|string $upload_bits_error An array of upload bits data, or error message to return.
2697       */
2698      $upload_bits_error = apply_filters(
2699          'wp_upload_bits',
2700          array(
2701              'name' => $name,
2702              'bits' => $bits,
2703              'time' => $time,
2704          )
2705      );
2706      if ( ! is_array( $upload_bits_error ) ) {
2707          $upload['error'] = $upload_bits_error;
2708          return $upload;
2709      }
2710  
2711      $filename = wp_unique_filename( $upload['path'], $name );
2712  
2713      $new_file = $upload['path'] . "/$filename";
2714      if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
2715          if ( 0 === strpos( $upload['basedir'], ABSPATH ) ) {
2716              $error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir'];
2717          } else {
2718              $error_path = wp_basename( $upload['basedir'] ) . $upload['subdir'];
2719          }
2720  
2721          $message = sprintf(
2722              /* translators: %s: Directory path. */
2723              __( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
2724              $error_path
2725          );
2726          return array( 'error' => $message );
2727      }
2728  
2729      $ifp = @fopen( $new_file, 'wb' );
2730      if ( ! $ifp ) {
2731          return array(
2732              /* translators: %s: File name. */
2733              'error' => sprintf( __( 'Could not write file %s' ), $new_file ),
2734          );
2735      }
2736  
2737      fwrite( $ifp, $bits );
2738      fclose( $ifp );
2739      clearstatcache();
2740  
2741      // Set correct file permissions.
2742      $stat  = @ stat( dirname( $new_file ) );
2743      $perms = $stat['mode'] & 0007777;
2744      $perms = $perms & 0000666;
2745      chmod( $new_file, $perms );
2746      clearstatcache();
2747  
2748      // Compute the URL.
2749      $url = $upload['url'] . "/$filename";
2750  
2751      if ( is_multisite() ) {
2752          clean_dirsize_cache( $new_file );
2753      }
2754  
2755      /** This filter is documented in wp-admin/includes/file.php */
2756      return apply_filters(
2757          'wp_handle_upload',
2758          array(
2759              'file'  => $new_file,
2760              'url'   => $url,
2761              'type'  => $wp_filetype['type'],
2762              'error' => false,
2763          ),
2764          'sideload'
2765      );
2766  }
2767  
2768  /**
2769   * Retrieve the file type based on the extension name.
2770   *
2771   * @since 2.5.0
2772   *
2773   * @param string $ext The extension to search.
2774   * @return string|void The file type, example: audio, video, document, spreadsheet, etc.
2775   */
2776  function wp_ext2type( $ext ) {
2777      $ext = strtolower( $ext );
2778  
2779      $ext2type = wp_get_ext_types();
2780      foreach ( $ext2type as $type => $exts ) {
2781          if ( in_array( $ext, $exts, true ) ) {
2782              return $type;
2783          }
2784      }
2785  }
2786  
2787  /**
2788   * Retrieve the file type from the file name.
2789   *
2790   * You can optionally define the mime array, if needed.
2791   *
2792   * @since 2.0.4
2793   *
2794   * @param string   $filename File name or path.
2795   * @param string[] $mimes    Optional. Array of allowed mime types keyed by their file extension regex.
2796   * @return array {
2797   *     Values for the extension and mime type.
2798   *
2799   *     @type string|false $ext  File extension, or false if the file doesn't match a mime type.
2800   *     @type string|false $type File mime type, or false if the file doesn't match a mime type.
2801   * }
2802   */
2803  function wp_check_filetype( $filename, $mimes = null ) {
2804      if ( empty( $mimes ) ) {
2805          $mimes = get_allowed_mime_types();
2806      }
2807      $type = false;
2808      $ext  = false;
2809  
2810      foreach ( $mimes as $ext_preg => $mime_match ) {
2811          $ext_preg = '!\.(' . $ext_preg . ')$!i';
2812          if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
2813              $type = $mime_match;
2814              $ext  = $ext_matches[1];
2815              break;
2816          }
2817      }
2818  
2819      return compact( 'ext', 'type' );
2820  }
2821  
2822  /**
2823   * Attempt to determine the real file type of a file.
2824   *
2825   * If unable to, the file name extension will be used to determine type.
2826   *
2827   * If it's determined that the extension does not match the file's real type,
2828   * then the "proper_filename" value will be set with a proper filename and extension.
2829   *
2830   * Currently this function only supports renaming images validated via wp_get_image_mime().
2831   *
2832   * @since 3.0.0
2833   *
2834   * @param string   $file     Full path to the file.
2835   * @param string   $filename The name of the file (may differ from $file due to $file being
2836   *                           in a tmp directory).
2837   * @param string[] $mimes    Optional. Array of allowed mime types keyed by their file extension regex.
2838   * @return array {
2839   *     Values for the extension, mime type, and corrected filename.
2840   *
2841   *     @type string|false $ext             File extension, or false if the file doesn't match a mime type.
2842   *     @type string|false $type            File mime type, or false if the file doesn't match a mime type.
2843   *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
2844   * }
2845   */
2846  function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
2847      $proper_filename = false;
2848  
2849      // Do basic extension validation and MIME mapping.
2850      $wp_filetype = wp_check_filetype( $filename, $mimes );
2851      $ext         = $wp_filetype['ext'];
2852      $type        = $wp_filetype['type'];
2853  
2854      // We can't do any further validation without a file to work with.
2855      if ( ! file_exists( $file ) ) {
2856          return compact( 'ext', 'type', 'proper_filename' );
2857      }
2858  
2859      $real_mime = false;
2860  
2861      // Validate image types.
2862      if ( $type && 0 === strpos( $type, 'image/' ) ) {
2863  
2864          // Attempt to figure out what type of image it actually is.
2865          $real_mime = wp_get_image_mime( $file );
2866  
2867          if ( $real_mime && $real_mime != $type ) {
2868              /**
2869               * Filters the list mapping image mime types to their respective extensions.
2870               *
2871               * @since 3.0.0
2872               *
2873               * @param array $mime_to_ext Array of image mime types and their matching extensions.
2874               */
2875              $mime_to_ext = apply_filters(
2876                  'getimagesize_mimes_to_exts',
2877                  array(
2878                      'image/jpeg' => 'jpg',
2879                      'image/png'  => 'png',
2880                      'image/gif'  => 'gif',
2881                      'image/bmp'  => 'bmp',
2882                      'image/tiff' => 'tif',
2883                  )
2884              );
2885  
2886              // Replace whatever is after the last period in the filename with the correct extension.
2887              if ( ! empty( $mime_to_ext[ $real_mime ] ) ) {
2888                  $filename_parts = explode( '.', $filename );
2889                  array_pop( $filename_parts );
2890                  $filename_parts[] = $mime_to_ext[ $real_mime ];
2891                  $new_filename     = implode( '.', $filename_parts );
2892  
2893                  if ( $new_filename != $filename ) {
2894                      $proper_filename = $new_filename; // Mark that it changed.
2895                  }
2896                  // Redefine the extension / MIME.
2897                  $wp_filetype = wp_check_filetype( $new_filename, $mimes );
2898                  $ext         = $wp_filetype['ext'];
2899                  $type        = $wp_filetype['type'];
2900              } else {
2901                  // Reset $real_mime and try validating again.
2902                  $real_mime = false;
2903              }
2904          }
2905      }
2906  
2907      // Validate files that didn't get validated during previous checks.
2908      if ( $type && ! $real_mime && extension_loaded( 'fileinfo' ) ) {
2909          $finfo     = finfo_open( FILEINFO_MIME_TYPE );
2910          $real_mime = finfo_file( $finfo, $file );
2911          finfo_close( $finfo );
2912  
2913          // fileinfo often misidentifies obscure files as one of these types.
2914          $nonspecific_types = array(
2915              'application/octet-stream',
2916              'application/encrypted',
2917              'application/CDFV2-encrypted',
2918              'application/zip',
2919          );
2920  
2921          /*
2922           * If $real_mime doesn't match the content type we're expecting from the file's extension,
2923           * we need to do some additional vetting. Media types and those listed in $nonspecific_types are
2924           * allowed some leeway, but anything else must exactly match the real content type.
2925           */
2926          if ( in_array( $real_mime, $nonspecific_types, true ) ) {
2927              // File is a non-specific binary type. That's ok if it's a type that generally tends to be binary.
2928              if ( ! in_array( substr( $type, 0, strcspn( $type, '/' ) ), array( 'application', 'video', 'audio' ), true ) ) {
2929                  $type = false;
2930                  $ext  = false;
2931              }
2932          } elseif ( 0 === strpos( $real_mime, 'video/' ) || 0 === strpos( $real_mime, 'audio/' ) ) {
2933              /*
2934               * For these types, only the major type must match the real value.
2935               * This means that common mismatches are forgiven: application/vnd.apple.numbers is often misidentified as application/zip,
2936               * and some media files are commonly named with the wrong extension (.mov instead of .mp4)
2937               */
2938              if ( substr( $real_mime, 0, strcspn( $real_mime, '/' ) ) !== substr( $type, 0, strcspn( $type, '/' ) ) ) {
2939                  $type = false;
2940                  $ext  = false;
2941              }
2942          } elseif ( 'text/plain' === $real_mime ) {
2943              // A few common file types are occasionally detected as text/plain; allow those.
2944              if ( ! in_array(
2945                  $type,
2946                  array(
2947                      'text/plain',
2948                      'text/csv',
2949                      'application/csv',
2950                      'text/richtext',
2951                      'text/tsv',
2952                      'text/vtt',
2953                  ),
2954                  true
2955              )
2956              ) {
2957                  $type = false;
2958                  $ext  = false;
2959              }
2960          } elseif ( 'application/csv' === $real_mime ) {
2961              // Special casing for CSV files.
2962              if ( ! in_array(
2963                  $type,
2964                  array(
2965                      'text/csv',
2966                      'text/plain',
2967                      'application/csv',
2968                  ),
2969                  true
2970              )
2971              ) {
2972                  $type = false;
2973                  $ext  = false;
2974              }
2975          } elseif ( 'text/rtf' === $real_mime ) {
2976              // Special casing for RTF files.
2977              if ( ! in_array(
2978                  $type,
2979                  array(
2980                      'text/rtf',
2981                      'text/plain',
2982                      'application/rtf',
2983                  ),
2984                  true
2985              )
2986              ) {
2987                  $type = false;
2988                  $ext  = false;
2989              }
2990          } else {
2991              if ( $type !== $real_mime ) {
2992                  /*
2993                   * Everything else including image/* and application/*:
2994                   * If the real content type doesn't match the file extension, assume it's dangerous.
2995                   */
2996                  $type = false;
2997                  $ext  = false;
2998              }
2999          }
3000      }
3001  
3002      // The mime type must be allowed.
3003      if ( $type ) {
3004          $allowed = get_allowed_mime_types();
3005  
3006          if ( ! in_array( $type, $allowed, true ) ) {
3007              $type = false;
3008              $ext  = false;
3009          }
3010      }
3011  
3012      /**
3013       * Filters the "real" file type of the given file.
3014       *
3015       * @since 3.0.0
3016       * @since 5.1.0 The $real_mime parameter was added.
3017       *
3018       * @param array        $wp_check_filetype_and_ext {
3019       *     Values for the extension, mime type, and corrected filename.
3020       *
3021       *     @type string|false $ext             File extension, or false if the file doesn't match a mime type.
3022       *     @type string|false $type            File mime type, or false if the file doesn't match a mime type.
3023       *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
3024       * }
3025       * @param string       $file                      Full path to the file.
3026       * @param string       $filename                  The name of the file (may differ from $file due to
3027       *                                                $file being in a tmp directory).
3028       * @param string[]     $mimes                     Array of mime types keyed by their file extension regex.
3029       * @param string|false $real_mime                 The actual mime type or false if the type cannot be determined.
3030       */
3031      return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes, $real_mime );
3032  }
3033  
3034  /**
3035   * Returns the real mime type of an image file.
3036   *
3037   * This depends on exif_imagetype() or getimagesize() to determine real mime types.
3038   *
3039   * @since 4.7.1
3040   *
3041   * @param string $file Full path to the file.
3042   * @return string|false The actual mime type or false if the type cannot be determined.
3043   */
3044  function wp_get_image_mime( $file ) {
3045      /*
3046       * Use exif_imagetype() to check the mimetype if available or fall back to
3047       * getimagesize() if exif isn't avaialbe. If either function throws an Exception
3048       * we assume the file could not be validated.
3049       */
3050      try {
3051          if ( is_callable( 'exif_imagetype' ) ) {
3052              $imagetype = exif_imagetype( $file );
3053              $mime      = ( $imagetype ) ? image_type_to_mime_type( $imagetype ) : false;
3054          } elseif ( function_exists( 'getimagesize' ) ) {
3055              $imagesize = wp_getimagesize( $file );
3056              $mime      = ( isset( $imagesize['mime'] ) ) ? $imagesize['mime'] : false;
3057          } else {
3058              $mime = false;
3059          }
3060      } catch ( Exception $e ) {
3061          $mime = false;
3062      }
3063  
3064      return $mime;
3065  }
3066  
3067  /**
3068   * Retrieve list of mime types and file extensions.
3069   *
3070   * @since 3.5.0
3071   * @since 4.2.0 Support was added for GIMP (.xcf) files.
3072   * @since 4.9.2 Support was added for Flac (.flac) files.
3073   * @since 4.9.6 Support was added for AAC (.aac) files.
3074   *
3075   * @return string[] Array of mime types keyed by the file extension regex corresponding to those types.
3076   */
3077  function wp_get_mime_types() {
3078      /**
3079       * Filters the list of mime types and file extensions.
3080       *
3081       * This filter should be used to add, not remove, mime types. To remove
3082       * mime types, use the {@see 'upload_mimes'} filter.
3083       *
3084       * @since 3.5.0
3085       *
3086       * @param string[] $wp_get_mime_types Mime types keyed by the file extension regex
3087       *                                 corresponding to those types.
3088       */
3089      return apply_filters(
3090          'mime_types',
3091          array(
3092              // Image formats.
3093              'jpg|jpeg|jpe'                 => 'image/jpeg',
3094              'gif'                          => 'image/gif',
3095              'png'                          => 'image/png',
3096              'bmp'                          => 'image/bmp',
3097              'tiff|tif'                     => 'image/tiff',
3098              'ico'                          => 'image/x-icon',
3099              'heic'                         => 'image/heic',
3100              // Video formats.
3101              'asf|asx'                      => 'video/x-ms-asf',
3102              'wmv'                          => 'video/x-ms-wmv',
3103              'wmx'                          => 'video/x-ms-wmx',
3104              'wm'                           => 'video/x-ms-wm',
3105              'avi'                          => 'video/avi',
3106              'divx'                         => 'video/divx',
3107              'flv'                          => 'video/x-flv',
3108              'mov|qt'                       => 'video/quicktime',
3109              'mpeg|mpg|mpe'                 => 'video/mpeg',
3110              'mp4|m4v'                      => 'video/mp4',
3111              'ogv'                          => 'video/ogg',
3112              'webm'                         => 'video/webm',
3113              'mkv'                          => 'video/x-matroska',
3114              '3gp|3gpp'                     => 'video/3gpp',  // Can also be audio.
3115              '3g2|3gp2'                     => 'video/3gpp2', // Can also be audio.
3116              // Text formats.
3117              'txt|asc|c|cc|h|srt'           => 'text/plain',
3118              'csv'                          => 'text/csv',
3119              'tsv'                          => 'text/tab-separated-values',
3120              'ics'                          => 'text/calendar',
3121              'rtx'                          => 'text/richtext',
3122              'css'                          => 'text/css',
3123              'htm|html'                     => 'text/html',
3124              'vtt'                          => 'text/vtt',
3125              'dfxp'                         => 'application/ttaf+xml',
3126              // Audio formats.
3127              'mp3|m4a|m4b'                  => 'audio/mpeg',
3128              'aac'                          => 'audio/aac',
3129              'ra|ram'                       => 'audio/x-realaudio',
3130              'wav'                          => 'audio/wav',
3131              'ogg|oga'                      => 'audio/ogg',
3132              'flac'                         => 'audio/flac',
3133              'mid|midi'                     => 'audio/midi',
3134              'wma'                          => 'audio/x-ms-wma',
3135              'wax'                          => 'audio/x-ms-wax',
3136              'mka'                          => 'audio/x-matroska',
3137              // Misc application formats.
3138              'rtf'                          => 'application/rtf',
3139              'js'                           => 'application/javascript',
3140              'pdf'                          => 'application/pdf',
3141              'swf'                          => 'application/x-shockwave-flash',
3142              'class'                        => 'application/java',
3143              'tar'                          => 'application/x-tar',
3144              'zip'                          => 'application/zip',
3145              'gz|gzip'                      => 'application/x-gzip',
3146              'rar'                          => 'application/rar',
3147              '7z'                           => 'application/x-7z-compressed',
3148              'exe'                          => 'application/x-msdownload',
3149              'psd'                          => 'application/octet-stream',
3150              'xcf'                          => 'application/octet-stream',
3151              // MS Office formats.
3152              'doc'                          => 'application/msword',
3153              'pot|pps|ppt'                  => 'application/vnd.ms-powerpoint',
3154              'wri'                          => 'application/vnd.ms-write',
3155              'xla|xls|xlt|xlw'              => 'application/vnd.ms-excel',
3156              'mdb'                          => 'application/vnd.ms-access',
3157              'mpp'                          => 'application/vnd.ms-project',
3158              'docx'                         => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
3159              'docm'                         => 'application/vnd.ms-word.document.macroEnabled.12',
3160              'dotx'                         => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
3161              'dotm'                         => 'application/vnd.ms-word.template.macroEnabled.12',
3162              'xlsx'                         => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
3163              'xlsm'                         => 'application/vnd.ms-excel.sheet.macroEnabled.12',
3164              'xlsb'                         => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
3165              'xltx'                         => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
3166              'xltm'                         => 'application/vnd.ms-excel.template.macroEnabled.12',
3167              'xlam'                         => 'application/vnd.ms-excel.addin.macroEnabled.12',
3168              'pptx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
3169              'pptm'                         => 'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
3170              'ppsx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
3171              'ppsm'                         => 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
3172              'potx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.template',
3173              'potm'                         => 'application/vnd.ms-powerpoint.template.macroEnabled.12',
3174              'ppam'                         => 'application/vnd.ms-powerpoint.addin.macroEnabled.12',
3175              'sldx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
3176              'sldm'                         => 'application/vnd.ms-powerpoint.slide.macroEnabled.12',
3177              'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
3178              'oxps'                         => 'application/oxps',
3179              'xps'                          => 'application/vnd.ms-xpsdocument',
3180              // OpenOffice formats.
3181              'odt'                          => 'application/vnd.oasis.opendocument.text',
3182              'odp'                          => 'application/vnd.oasis.opendocument.presentation',
3183              'ods'                          => 'application/vnd.oasis.opendocument.spreadsheet',
3184              'odg'                          => 'application/vnd.oasis.opendocument.graphics',
3185              'odc'                          => 'application/vnd.oasis.opendocument.chart',
3186              'odb'                          => 'application/vnd.oasis.opendocument.database',
3187              'odf'                          => 'application/vnd.oasis.opendocument.formula',
3188              // WordPerfect formats.
3189              'wp|wpd'                       => 'application/wordperfect',
3190              // iWork formats.
3191              'key'                          => 'application/vnd.apple.keynote',
3192              'numbers'                      => 'application/vnd.apple.numbers',
3193              'pages'                        => 'application/vnd.apple.pages',
3194          )
3195      );
3196  }
3197  
3198  /**
3199   * Retrieves the list of common file extensions and their types.
3200   *
3201   * @since 4.6.0
3202   *
3203   * @return array[] Multi-dimensional array of file extensions types keyed by the type of file.
3204   */
3205  function wp_get_ext_types() {
3206  
3207      /**
3208       * Filters file type based on the extension name.
3209       *
3210       * @since 2.5.0
3211       *
3212       * @see wp_ext2type()
3213       *
3214       * @param array[] $ext2type Multi-dimensional array of file extensions types keyed by the type of file.
3215       */
3216      return apply_filters(
3217          'ext2type',
3218          array(
3219              'image'       => array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'bmp', 'tif', 'tiff', 'ico', 'heic' ),
3220              'audio'       => array( 'aac', 'ac3', 'aif', 'aiff', 'flac', 'm3a', 'm4a', 'm4b', 'mka', 'mp1', 'mp2', 'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
3221              'video'       => array( '3g2', '3gp', '3gpp', 'asf', 'avi', 'divx', 'dv', 'flv', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt', 'rm', 'vob', 'wmv' ),
3222              'document'    => array( 'doc', 'docx', 'docm', 'dotm', 'odt', 'pages', 'pdf', 'xps', 'oxps', 'rtf', 'wp', 'wpd', 'psd', 'xcf' ),
3223              'spreadsheet' => array( 'numbers', 'ods', 'xls', 'xlsx', 'xlsm', 'xlsb' ),
3224              'interactive' => array( 'swf', 'key', 'ppt', 'pptx', 'pptm', 'pps', 'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ),
3225              'text'        => array( 'asc', 'csv', 'tsv', 'txt' ),
3226              'archive'     => array( 'bz2', 'cab', 'dmg', 'gz', 'rar', 'sea', 'sit', 'sqx', 'tar', 'tgz', 'zip', '7z' ),
3227              'code'        => array( 'css', 'htm', 'html', 'php', 'js' ),
3228          )
3229      );
3230  }
3231  
3232  /**
3233   * Retrieve list of allowed mime types and file extensions.
3234   *
3235   * @since 2.8.6
3236   *
3237   * @param int|WP_User $user Optional. User to check. Defaults to current user.
3238   * @return string[] Array of mime types keyed by the file extension regex corresponding
3239   *                  to those types.
3240   */
3241  function get_allowed_mime_types( $user = null ) {
3242      $t = wp_get_mime_types();
3243  
3244      unset( $t['swf'], $t['exe'] );
3245      if ( function_exists( 'current_user_can' ) ) {
3246          $unfiltered = $user ? user_can( $user, 'unfiltered_html' ) : current_user_can( 'unfiltered_html' );
3247      }
3248  
3249      if ( empty( $unfiltered ) ) {
3250          unset( $t['htm|html'], $t['js'] );
3251      }
3252  
3253      /**
3254       * Filters list of allowed mime types and file extensions.
3255       *
3256       * @since 2.0.0
3257       *
3258       * @param array            $t    Mime types keyed by the file extension regex corresponding to those types.
3259       * @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user).
3260       */
3261      return apply_filters( 'upload_mimes', $t, $user );
3262  }
3263  
3264  /**
3265   * Display "Are You Sure" message to confirm the action being taken.
3266   *
3267   * If the action has the nonce explain message, then it will be displayed
3268   * along with the "Are you sure?" message.
3269   *
3270   * @since 2.0.4
3271   *
3272   * @param string $action The nonce action.
3273   */
3274  function wp_nonce_ays( $action ) {
3275      if ( 'log-out' === $action ) {
3276          $html = sprintf(
3277              /* translators: %s: Site title. */
3278              __( 'You are attempting to log out of %s' ),
3279              get_bloginfo( 'name' )
3280          );
3281          $html       .= '</p><p>';
3282          $redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
3283          $html       .= sprintf(
3284              /* translators: %s: Logout URL. */
3285              __( 'Do you really want to <a href="%s">log out</a>?' ),
3286              wp_logout_url( $redirect_to )
3287          );
3288      } else {
3289          $html = __( 'The link you followed has expired.' );
3290          if ( wp_get_referer() ) {
3291              $html .= '</p><p>';
3292              $html .= sprintf(
3293                  '<a href="%s">%s</a>',
3294                  esc_url( remove_query_arg( 'updated', wp_get_referer() ) ),
3295                  __( 'Please try again.' )
3296              );
3297          }
3298      }
3299  
3300      wp_die( $html, __( 'Something went wrong.' ), 403 );
3301  }
3302  
3303  /**
3304   * Kills WordPress execution and displays HTML page with an error message.
3305   *
3306   * This function complements the `die()` PHP function. The difference is that
3307   * HTML will be displayed to the user. It is recommended to use this function
3308   * only when the execution should not continue any further. It is not recommended
3309   * to call this function very often, and try to handle as many errors as possible
3310   * silently or more gracefully.
3311   *
3312   * As a shorthand, the desired HTTP response code may be passed as an integer to
3313   * the `$title` parameter (the default title would apply) or the `$args` parameter.
3314   *
3315   * @since 2.0.4
3316   * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept
3317   *              an integer to be used as the response code.
3318   * @since 5.1.0 The `$link_url`, `$link_text`, and `$exit` arguments were added.
3319   * @since 5.3.0 The `$charset` argument was added.
3320   * @since 5.5.0 The `$text_direction` argument has a priority over get_language_attributes()
3321   *              in the default handler.
3322   *
3323   * @global WP_Query $wp_query WordPress Query object.
3324   *
3325   * @param string|WP_Error  $message Optional. Error message. If this is a WP_Error object,
3326   *                                  and not an Ajax or XML-RPC request, the error's messages are used.
3327   *                                  Default empty.
3328   * @param string|int       $title   Optional. Error title. If `$message` is a `WP_Error` object,
3329   *                                  error data with the key 'title' may be used to specify the title.
3330   *                                  If `$title` is an integer, then it is treated as the response
3331   *                                  code. Default empty.
3332   * @param string|array|int $args {
3333   *     Optional. Arguments to control behavior. If `$args` is an integer, then it is treated
3334   *     as the response code. Default empty array.
3335   *
3336   *     @type int    $response       The HTTP response code. Default 200 for Ajax requests, 500 otherwise.
3337   *     @type string $link_url       A URL to include a link to. Only works in combination with $link_text.
3338   *                                  Default empty string.
3339   *     @type string $link_text      A label for the link to include. Only works in combination with $link_url.
3340   *                                  Default empty string.
3341   *     @type bool   $back_link      Whether to include a link to go back. Default false.
3342   *     @type string $text_direction The text direction. This is only useful internally, when WordPress is still
3343   *                                  loading and the site's locale is not set up yet. Accepts 'rtl' and 'ltr'.
3344   *                                  Default is the value of is_rtl().
3345   *     @type string $charset        Character set of the HTML output. Default 'utf-8'.
3346   *     @type string $code           Error code to use. Default is 'wp_die', or the main error code if $message
3347   *                                  is a WP_Error.
3348   *     @type bool   $exit           Whether to exit the process after completion. Default true.
3349   * }
3350   */
3351  function wp_die( $message = '', $title = '', $args = array() ) {
3352      global $wp_query;
3353  
3354      if ( is_int( $args ) ) {
3355          $args = array( 'response' => $args );
3356      } elseif ( is_int( $title ) ) {
3357          $args  = array( 'response' => $title );
3358          $title = '';
3359      }
3360  
3361      if ( wp_doing_ajax() ) {
3362          /**
3363           * Filters the callback for killing WordPress execution for Ajax requests.
3364           *
3365           * @since 3.4.0
3366           *
3367           * @param callable $function Callback function name.
3368           */
3369          $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
3370      } elseif ( wp_is_json_request() ) {
3371          /**
3372           * Filters the callback for killing WordPress execution for JSON requests.
3373           *
3374           * @since 5.1.0
3375           *
3376           * @param callable $function Callback function name.
3377           */
3378          $function = apply_filters( 'wp_die_json_handler', '_json_wp_die_handler' );
3379      } elseif ( wp_is_jsonp_request() ) {
3380          /**
3381           * Filters the callback for killing WordPress execution for JSONP requests.
3382           *
3383           * @since 5.2.0
3384           *
3385           * @param callable $function Callback function name.
3386           */
3387          $function = apply_filters( 'wp_die_jsonp_handler', '_jsonp_wp_die_handler' );
3388      } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
3389          /**
3390           * Filters the callback for killing WordPress execution for XML-RPC requests.
3391           *
3392           * @since 3.4.0
3393           *
3394           * @param callable $function Callback function name.
3395           */
3396          $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
3397      } elseif ( wp_is_xml_request()
3398          || isset( $wp_query ) &&
3399              ( function_exists( 'is_feed' ) && is_feed()
3400              || function_exists( 'is_comment_feed' ) && is_comment_feed()
3401              || function_exists( 'is_trackback' ) && is_trackback() ) ) {
3402          /**
3403           * Filters the callback for killing WordPress execution for XML requests.
3404           *
3405           * @since 5.2.0
3406           *
3407           * @param callable $function Callback function name.
3408           */
3409          $function = apply_filters( 'wp_die_xml_handler', '_xml_wp_die_handler' );
3410      } else {
3411          /**
3412           * Filters the callback for killing WordPress execution for all non-Ajax, non-JSON, non-XML requests.
3413           *
3414           * @since 3.0.0
3415           *
3416           * @param callable $function Callback function name.
3417           */
3418          $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
3419      }
3420  
3421      call_user_func( $function, $message, $title, $args );
3422  }
3423  
3424  /**
3425   * Kills WordPress execution and displays HTML page with an error message.
3426   *
3427   * This is the default handler for wp_die(). If you want a custom one,
3428   * you can override this using the {@see 'wp_die_handler'} filter in wp_die().
3429   *
3430   * @since 3.0.0
3431   * @access private
3432   *
3433   * @param string|WP_Error $message Error message or WP_Error object.
3434   * @param string          $title   Optional. Error title. Default empty.
3435   * @param string|array    $args    Optional. Arguments to control behavior. Default empty array.
3436   */
3437  function _default_wp_die_handler( $message, $title = '', $args = array() ) {
3438      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3439  
3440      if ( is_string( $message ) ) {
3441          if ( ! empty( $parsed_args['additional_errors'] ) ) {
3442              $message = array_merge(
3443                  array( $message ),
3444                  wp_list_pluck( $parsed_args['additional_errors'], 'message' )
3445              );
3446              $message = "<ul>\n\t\t<li>" . implode( "</li>\n\t\t<li>", $message ) . "</li>\n\t</ul>";
3447          }
3448  
3449          $message = sprintf(
3450              '<div class="wp-die-message">%s</div>',
3451              $message
3452          );
3453      }
3454  
3455      $have_gettext = function_exists( '__' );
3456  
3457      if ( ! empty( $parsed_args['link_url'] ) && ! empty( $parsed_args['link_text'] ) ) {
3458          $link_url = $parsed_args['link_url'];
3459          if ( function_exists( 'esc_url' ) ) {
3460              $link_url = esc_url( $link_url );
3461          }
3462          $link_text = $parsed_args['link_text'];
3463          $message  .= "\n<p><a href='{$link_url}'>{$link_text}</a></p>";
3464      }
3465  
3466      if ( isset( $parsed_args['back_link'] ) && $parsed_args['back_link'] ) {
3467          $back_text = $have_gettext ? __( '&laquo; Back' ) : '&laquo; Back';
3468          $message  .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";
3469      }
3470  
3471      if ( ! did_action( 'admin_head' ) ) :
3472          if ( ! headers_sent() ) {
3473              header( "Content-Type: text/html; charset={$parsed_args['charset']}" );
3474              status_header( $parsed_args['response'] );
3475              nocache_headers();
3476          }
3477  
3478          $text_direction = $parsed_args['text_direction'];
3479          $dir_attr       = "dir='$text_direction'";
3480  
3481          // If `text_direction` was not explicitly passed,
3482          // use get_language_attributes() if available.
3483          if ( empty( $args['text_direction'] )
3484              && function_exists( 'language_attributes' ) && function_exists( 'is_rtl' )
3485          ) {
3486              $dir_attr = get_language_attributes();
3487          }
3488          ?>
3489  <!DOCTYPE html>
3490  <html <?php echo $dir_attr; ?>>
3491  <head>
3492      <meta http-equiv="Content-Type" content="text/html; charset=<?php echo $parsed_args['charset']; ?>" />
3493      <meta name="viewport" content="width=device-width">
3494          <?php
3495          if ( function_exists( 'wp_robots' ) && function_exists( 'wp_robots_no_robots' ) && function_exists( 'add_filter' ) ) {
3496              add_filter( 'wp_robots', 'wp_robots_no_robots' );
3497              wp_robots();
3498          }
3499          ?>
3500      <title><?php echo $title; ?></title>
3501      <style type="text/css">
3502          html {
3503              background: #f1f1f1;
3504          }
3505          body {
3506              background: #fff;
3507              border: 1px solid #ccd0d4;
3508              color: #444;
3509              font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
3510              margin: 2em auto;
3511              padding: 1em 2em;
3512              max-width: 700px;
3513              -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, .04);
3514              box-shadow: 0 1px 1px rgba(0, 0, 0, .04);
3515          }
3516          h1 {
3517              border-bottom: 1px solid #dadada;
3518              clear: both;
3519              color: #666;
3520              font-size: 24px;
3521              margin: 30px 0 0 0;
3522              padding: 0;
3523              padding-bottom: 7px;
3524          }
3525          #error-page {
3526              margin-top: 50px;
3527          }
3528          #error-page p,
3529          #error-page .wp-die-message {
3530              font-size: 14px;
3531              line-height: 1.5;
3532              margin: 25px 0 20px;
3533          }
3534          #error-page code {
3535              font-family: Consolas, Monaco, monospace;
3536          }
3537          ul li {
3538              margin-bottom: 10px;
3539              font-size: 14px ;
3540          }
3541          a {
3542              color: #0073aa;
3543          }
3544          a:hover,
3545          a:active {
3546              color: #006799;
3547          }
3548          a:focus {
3549              color: #124964;
3550              -webkit-box-shadow:
3551                  0 0 0 1px #5b9dd9,
3552                  0 0 2px 1px rgba(30, 140, 190, 0.8);
3553              box-shadow:
3554                  0 0 0 1px #5b9dd9,
3555                  0 0 2px 1px rgba(30, 140, 190, 0.8);
3556              outline: none;
3557          }
3558          .button {
3559              background: #f3f5f6;
3560              border: 1px solid #016087;
3561              color: #016087;
3562              display: inline-block;
3563              text-decoration: none;
3564              font-size: 13px;
3565              line-height: 2;
3566              height: 28px;
3567              margin: 0;
3568              padding: 0 10px 1px;
3569              cursor: pointer;
3570              -webkit-border-radius: 3px;
3571              -webkit-appearance: none;
3572              border-radius: 3px;
3573              white-space: nowrap;
3574              -webkit-box-sizing: border-box;
3575              -moz-box-sizing:    border-box;
3576              box-sizing:         border-box;
3577  
3578              vertical-align: top;
3579          }
3580  
3581          .button.button-large {
3582              line-height: 2.30769231;
3583              min-height: 32px;
3584              padding: 0 12px;
3585          }
3586  
3587          .button:hover,
3588          .button:focus {
3589              background: #f1f1f1;
3590          }
3591  
3592          .button:focus {
3593              background: #f3f5f6;
3594              border-color: #007cba;
3595              -webkit-box-shadow: 0 0 0 1px #007cba;
3596              box-shadow: 0 0 0 1px #007cba;
3597              color: #016087;
3598              outline: 2px solid transparent;
3599              outline-offset: 0;
3600          }
3601  
3602          .button:active {
3603              background: #f3f5f6;
3604              border-color: #7e8993;
3605              -webkit-box-shadow: none;
3606              box-shadow: none;
3607          }
3608  
3609          <?php
3610          if ( 'rtl' === $text_direction ) {
3611              echo 'body { font-family: Tahoma, Arial; }';
3612          }
3613          ?>
3614      </style>
3615  </head>
3616  <body id="error-page">
3617  <?php endif; // ! did_action( 'admin_head' ) ?>
3618      <?php echo $message; ?>
3619  </body>
3620  </html>
3621      <?php
3622      if ( $parsed_args['exit'] ) {
3623          die();
3624      }
3625  }
3626  
3627  /**
3628   * Kills WordPress execution and displays Ajax response with an error message.
3629   *
3630   * This is the handler for wp_die() when processing Ajax requests.
3631   *
3632   * @since 3.4.0
3633   * @access private
3634   *
3635   * @param string       $message Error message.
3636   * @param string       $title   Optional. Error title (unused). Default empty.
3637   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3638   */
3639  function _ajax_wp_die_handler( $message, $title = '', $args = array() ) {
3640      // Set default 'response' to 200 for Ajax requests.
3641      $args = wp_parse_args(
3642          $args,
3643          array( 'response' => 200 )
3644      );
3645  
3646      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3647  
3648      if ( ! headers_sent() ) {
3649          // This is intentional. For backward-compatibility, support passing null here.
3650          if ( null !== $args['response'] ) {
3651              status_header( $parsed_args['response'] );
3652          }
3653          nocache_headers();
3654      }
3655  
3656      if ( is_scalar( $message ) ) {
3657          $message = (string) $message;
3658      } else {
3659          $message = '0';
3660      }
3661  
3662      if ( $parsed_args['exit'] ) {
3663          die( $message );
3664      }
3665  
3666      echo $message;
3667  }
3668  
3669  /**
3670   * Kills WordPress execution and displays JSON response with an error message.
3671   *
3672   * This is the handler for wp_die() when processing JSON requests.
3673   *
3674   * @since 5.1.0
3675   * @access private
3676   *
3677   * @param string       $message Error message.
3678   * @param string       $title   Optional. Error title. Default empty.
3679   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3680   */
3681  function _json_wp_die_handler( $message, $title = '', $args = array() ) {
3682      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3683  
3684      $data = array(
3685          'code'              => $parsed_args['code'],
3686          'message'           => $message,
3687          'data'              => array(
3688              'status' => $parsed_args['response'],
3689          ),
3690          'additional_errors' => $parsed_args['additional_errors'],
3691      );
3692  
3693      if ( ! headers_sent() ) {
3694          header( "Content-Type: application/json; charset={$parsed_args['charset']}" );
3695          if ( null !== $parsed_args['response'] ) {
3696              status_header( $parsed_args['response'] );
3697          }
3698          nocache_headers();
3699      }
3700  
3701      echo wp_json_encode( $data );
3702      if ( $parsed_args['exit'] ) {
3703          die();
3704      }
3705  }
3706  
3707  /**
3708   * Kills WordPress execution and displays JSONP response with an error message.
3709   *
3710   * This is the handler for wp_die() when processing JSONP requests.
3711   *
3712   * @since 5.2.0
3713   * @access private
3714   *
3715   * @param string       $message Error message.
3716   * @param string       $title   Optional. Error title. Default empty.
3717   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3718   */
3719  function _jsonp_wp_die_handler( $message, $title = '', $args = array() ) {
3720      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3721  
3722      $data = array(
3723          'code'              => $parsed_args['code'],
3724          'message'           => $message,
3725          'data'              => array(
3726              'status' => $parsed_args['response'],
3727          ),
3728          'additional_errors' => $parsed_args['additional_errors'],
3729      );
3730  
3731      if ( ! headers_sent() ) {
3732          header( "Content-Type: application/javascript; charset={$parsed_args['charset']}" );
3733          header( 'X-Content-Type-Options: nosniff' );
3734          header( 'X-Robots-Tag: noindex' );
3735          if ( null !== $parsed_args['response'] ) {
3736              status_header( $parsed_args['response'] );
3737          }
3738          nocache_headers();
3739      }
3740  
3741      $result         = wp_json_encode( $data );
3742      $jsonp_callback = $_GET['_jsonp'];
3743      echo '/**/' . $jsonp_callback . '(' . $result . ')';
3744      if ( $parsed_args['exit'] ) {
3745          die();
3746      }
3747  }
3748  
3749  /**
3750   * Kills WordPress execution and displays XML response with an error message.
3751   *
3752   * This is the handler for wp_die() when processing XMLRPC requests.
3753   *
3754   * @since 3.2.0
3755   * @access private
3756   *
3757   * @global wp_xmlrpc_server $wp_xmlrpc_server
3758   *
3759   * @param string       $message Error message.
3760   * @param string       $title   Optional. Error title. Default empty.
3761   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3762   */
3763  function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
3764      global $wp_xmlrpc_server;
3765  
3766      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3767  
3768      if ( ! headers_sent() ) {
3769          nocache_headers();
3770      }
3771  
3772      if ( $wp_xmlrpc_server ) {
3773          $error = new IXR_Error( $parsed_args['response'], $message );
3774          $wp_xmlrpc_server->output( $error->getXml() );
3775      }
3776      if ( $parsed_args['exit'] ) {
3777          die();
3778      }
3779  }
3780  
3781  /**
3782   * Kills WordPress execution and displays XML response with an error message.
3783   *
3784   * This is the handler for wp_die() when processing XML requests.
3785   *
3786   * @since 5.2.0
3787   * @access private
3788   *
3789   * @param string       $message Error message.
3790   * @param string       $title   Optional. Error title. Default empty.
3791   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3792   */
3793  function _xml_wp_die_handler( $message, $title = '', $args = array() ) {
3794      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3795  
3796      $message = htmlspecialchars( $message );
3797      $title   = htmlspecialchars( $title );
3798  
3799      $xml = <<<EOD
3800  <error>
3801      <code>{$parsed_args['code']}</code>
3802      <title><![CDATA[{$title}]]></title>
3803      <message><![CDATA[{$message}]]></message>
3804      <data>
3805          <status>{$parsed_args['response']}</status>
3806      </data>
3807  </error>
3808  
3809  EOD;
3810  
3811      if ( ! headers_sent() ) {
3812          header( "Content-Type: text/xml; charset={$parsed_args['charset']}" );
3813          if ( null !== $parsed_args['response'] ) {
3814              status_header( $parsed_args['response'] );
3815          }
3816          nocache_headers();
3817      }
3818  
3819      echo $xml;
3820      if ( $parsed_args['exit'] ) {
3821          die();
3822      }
3823  }
3824  
3825  /**
3826   * Kills WordPress execution and displays an error message.
3827   *
3828   * This is the handler for wp_die() when processing APP requests.
3829   *
3830   * @since 3.4.0
3831   * @since 5.1.0 Added the $title and $args parameters.
3832   * @access private
3833   *
3834   * @param string       $message Optional. Response to print. Default empty.
3835   * @param string       $title   Optional. Error title (unused). Default empty.
3836   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3837   */
3838  function _scalar_wp_die_handler( $message = '', $title = '', $args = array() ) {
3839      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3840  
3841      if ( $parsed_args['exit'] ) {
3842          if ( is_scalar( $message ) ) {
3843              die( (string) $message );
3844          }
3845          die();
3846      }
3847  
3848      if ( is_scalar( $message ) ) {
3849          echo (string) $message;
3850      }
3851  }
3852  
3853  /**
3854   * Processes arguments passed to wp_die() consistently for its handlers.
3855   *
3856   * @since 5.1.0
3857   * @access private
3858   *
3859   * @param string|WP_Error $message Error message or WP_Error object.
3860   * @param string          $title   Optional. Error title. Default empty.
3861   * @param string|array    $args    Optional. Arguments to control behavior. Default empty array.
3862   * @return array {
3863   *     Processed arguments.
3864   *
3865   *     @type string $0 Error message.
3866   *     @type string $1 Error title.
3867   *     @type array  $2 Arguments to control behavior.
3868   * }
3869   */
3870  function _wp_die_process_input( $message, $title = '', $args = array() ) {
3871      $defaults = array(
3872          'response'          => 0,
3873          'code'              => '',
3874          'exit'              => true,
3875          'back_link'         => false,
3876          'link_url'          => '',
3877          'link_text'         => '',
3878          'text_direction'    => '',
3879          'charset'           => 'utf-8',
3880          'additional_errors' => array(),
3881      );
3882  
3883      $args = wp_parse_args( $args, $defaults );
3884  
3885      if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
3886          if ( ! empty( $message->errors ) ) {
3887              $errors = array();
3888              foreach ( (array) $message->errors as $error_code => $error_messages ) {
3889                  foreach ( (array) $error_messages as $error_message ) {
3890                      $errors[] = array(
3891                          'code'    => $error_code,
3892                          'message' => $error_message,
3893                          'data'    => $message->get_error_data( $error_code ),
3894                      );
3895                  }
3896              }
3897  
3898              $message = $errors[0]['message'];
3899              if ( empty( $args['code'] ) ) {
3900                  $args['code'] = $errors[0]['code'];
3901              }
3902              if ( empty( $args['response'] ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['status'] ) ) {
3903                  $args['response'] = $errors[0]['data']['status'];
3904              }
3905              if ( empty( $title ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['title'] ) ) {
3906                  $title = $errors[0]['data']['title'];
3907              }
3908  
3909              unset( $errors[0] );
3910              $args['additional_errors'] = array_values( $errors );
3911          } else {
3912              $message = '';
3913          }
3914      }
3915  
3916      $have_gettext = function_exists( '__' );
3917  
3918      // The $title and these specific $args must always have a non-empty value.
3919      if ( empty( $args['code'] ) ) {
3920          $args['code'] = 'wp_die';
3921      }
3922      if ( empty( $args['response'] ) ) {
3923          $args['response'] = 500;
3924      }
3925      if ( empty( $title ) ) {
3926          $title = $have_gettext ? __( 'WordPress &rsaquo; Error' ) : 'WordPress &rsaquo; Error';
3927      }
3928      if ( empty( $args['text_direction'] ) || ! in_array( $args['text_direction'], array( 'ltr', 'rtl' ), true ) ) {
3929          $args['text_direction'] = 'ltr';
3930          if ( function_exists( 'is_rtl' ) && is_rtl() ) {
3931              $args['text_direction'] = 'rtl';
3932          }
3933      }
3934  
3935      if ( ! empty( $args['charset'] ) ) {
3936          $args['charset'] = _canonical_charset( $args['charset'] );
3937      }
3938  
3939      return array( $message, $title, $args );
3940  }
3941  
3942  /**
3943   * Encode a variable into JSON, with some sanity checks.
3944   *
3945   * @since 4.1.0
3946   * @since 5.3.0 No longer handles support for PHP < 5.6.
3947   *
3948   * @param mixed $data    Variable (usually an array or object) to encode as JSON.
3949   * @param int   $options Optional. Options to be passed to json_encode(). Default 0.
3950   * @param int   $depth   Optional. Maximum depth to walk through $data. Must be
3951   *                       greater than 0. Default 512.
3952   * @return string|false The JSON encoded string, or false if it cannot be encoded.
3953   */
3954  function wp_json_encode( $data, $options = 0, $depth = 512 ) {
3955      $json = json_encode( $data, $options, $depth );
3956  
3957      // If json_encode() was successful, no need to do more sanity checking.
3958      if ( false !== $json ) {
3959          return $json;
3960      }
3961  
3962      try {
3963          $data = _wp_json_sanity_check( $data, $depth );
3964      } catch ( Exception $e ) {
3965          return false;
3966      }
3967  
3968      return json_encode( $data, $options, $depth );
3969  }
3970  
3971  /**
3972   * Perform sanity checks on data that shall be encoded to JSON.
3973   *
3974   * @ignore
3975   * @since 4.1.0
3976   * @access private
3977   *
3978   * @see wp_json_encode()
3979   *
3980   * @throws Exception If depth limit is reached.
3981   *
3982   * @param mixed $data  Variable (usually an array or object) to encode as JSON.
3983   * @param int   $depth Maximum depth to walk through $data. Must be greater than 0.
3984   * @return mixed The sanitized data that shall be encoded to JSON.
3985   */
3986  function _wp_json_sanity_check( $data, $depth ) {
3987      if ( $depth < 0 ) {
3988          throw new Exception( 'Reached depth limit' );
3989      }
3990  
3991      if ( is_array( $data ) ) {
3992          $output = array();
3993          foreach ( $data as $id => $el ) {
3994              // Don't forget to sanitize the ID!
3995              if ( is_string( $id ) ) {
3996                  $clean_id = _wp_json_convert_string( $id );
3997              } else {
3998                  $clean_id = $id;
3999              }
4000  
4001              // Check the element type, so that we're only recursing if we really have to.
4002              if ( is_array( $el ) || is_object( $el ) ) {
4003                  $output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 );
4004              } elseif ( is_string( $el ) ) {
4005                  $output[ $clean_id ] = _wp_json_convert_string( $el );
4006              } else {
4007                  $output[ $clean_id ] = $el;
4008              }
4009          }
4010      } elseif ( is_object( $data ) ) {
4011          $output = new stdClass;
4012          foreach ( $data as $id => $el ) {
4013              if ( is_string( $id ) ) {
4014                  $clean_id = _wp_json_convert_string( $id );
4015              } else {
4016                  $clean_id = $id;
4017              }
4018  
4019              if ( is_array( $el ) || is_object( $el ) ) {
4020                  $output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 );
4021              } elseif ( is_string( $el ) ) {
4022                  $output->$clean_id = _wp_json_convert_string( $el );
4023              } else {
4024                  $output->$clean_id = $el;
4025              }
4026          }
4027      } elseif ( is_string( $data ) ) {
4028          return _wp_json_convert_string( $data );
4029      } else {
4030          return $data;
4031      }
4032  
4033      return $output;
4034  }
4035  
4036  /**
4037   * Convert a string to UTF-8, so that it can be safely encoded to JSON.
4038   *
4039   * @ignore
4040   * @since 4.1.0
4041   * @access private
4042   *
4043   * @see _wp_json_sanity_check()
4044   *
4045   * @param string $string The string which is to be converted.
4046   * @return string The checked string.
4047   */
4048  function _wp_json_convert_string( $string ) {
4049      static $use_mb = null;
4050      if ( is_null( $use_mb ) ) {
4051          $use_mb = function_exists( 'mb_convert_encoding' );
4052      }
4053  
4054      if ( $use_mb ) {
4055          $encoding = mb_detect_encoding( $string, mb_detect_order(), true );
4056          if ( $encoding ) {
4057              return mb_convert_encoding( $string, 'UTF-8', $encoding );
4058          } else {
4059              return mb_convert_encoding( $string, 'UTF-8', 'UTF-8' );
4060          }
4061      } else {
4062          return wp_check_invalid_utf8( $string, true );
4063      }
4064  }
4065  
4066  /**
4067   * Prepares response data to be serialized to JSON.
4068   *
4069   * This supports the JsonSerializable interface for PHP 5.2-5.3 as well.
4070   *
4071   * @ignore
4072   * @since 4.4.0
4073   * @deprecated 5.3.0 This function is no longer needed as support for PHP 5.2-5.3
4074   *                   has been dropped.
4075   * @access private
4076   *
4077   * @param mixed $data Native representation.
4078   * @return bool|int|float|null|string|array Data ready for `json_encode()`.
4079   */
4080  function _wp_json_prepare_data( $data ) {
4081      _deprecated_function( __FUNCTION__, '5.3.0' );
4082      return $data;
4083  }
4084  
4085  /**
4086   * Send a JSON response back to an Ajax request.
4087   *
4088   * @since 3.5.0
4089   * @since 4.7.0 The `$status_code` parameter was added.
4090   * @since 5.6.0 The `$options` parameter was added.
4091   *
4092   * @param mixed $response    Variable (usually an array or object) to encode as JSON,
4093   *                           then print and die.
4094   * @param int   $status_code Optional. The HTTP status code to output. Default null.
4095   * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
4096   */
4097  function wp_send_json( $response, $status_code = null, $options = 0 ) {
4098      if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
4099          _doing_it_wrong(
4100              __FUNCTION__,
4101              sprintf(
4102                  /* translators: 1: WP_REST_Response, 2: WP_Error */
4103                  __( 'Return a %1$s or %2$s object from your callback when using the REST API.' ),
4104                  'WP_REST_Response',
4105                  'WP_Error'
4106              ),
4107              '5.5.0'
4108          );
4109      }
4110  
4111      if ( ! headers_sent() ) {
4112          header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
4113          if ( null !== $status_code ) {
4114              status_header( $status_code );
4115          }
4116      }
4117  
4118      echo wp_json_encode( $response, $options );
4119  
4120      if ( wp_doing_ajax() ) {
4121          wp_die(
4122              '',
4123              '',
4124              array(
4125                  'response' => null,
4126              )
4127          );
4128      } else {
4129          die;
4130      }
4131  }
4132  
4133  /**
4134   * Send a JSON response back to an Ajax request, indicating success.
4135   *
4136   * @since 3.5.0
4137   * @since 4.7.0 The `$status_code` parameter was added.
4138   * @since 5.6.0 The `$options` parameter was added.
4139   *
4140   * @param mixed $data        Optional. Data to encode as JSON, then print and die. Default null.
4141   * @param int   $status_code Optional. The HTTP status code to output. Default null.
4142   * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
4143   */
4144  function wp_send_json_success( $data = null, $status_code = null, $options = 0 ) {
4145      $response = array( 'success' => true );
4146  
4147      if ( isset( $data ) ) {
4148          $response['data'] = $data;
4149      }
4150  
4151      wp_send_json( $response, $status_code, $options );
4152  }
4153  
4154  /**
4155   * Send a JSON response back to an Ajax request, indicating failure.
4156   *
4157   * If the `$data` parameter is a WP_Error object, the errors
4158   * within the object are processed and output as an array of error
4159   * codes and corresponding messages. All other types are output
4160   * without further processing.
4161   *
4162   * @since 3.5.0
4163   * @since 4.1.0 The `$data` parameter is now processed if a WP_Error object is passed in.
4164   * @since 4.7.0 The `$status_code` parameter was added.
4165   * @since 5.6.0 The `$options` parameter was added.
4166   *
4167   * @param mixed $data        Optional. Data to encode as JSON, then print and die. Default null.
4168   * @param int   $status_code Optional. The HTTP status code to output. Default null.
4169   * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
4170   */
4171  function wp_send_json_error( $data = null, $status_code = null, $options = 0 ) {
4172      $response = array( 'success' => false );
4173  
4174      if ( isset( $data ) ) {
4175          if ( is_wp_error( $data ) ) {
4176              $result = array();
4177              foreach ( $data->errors as $code => $messages ) {
4178                  foreach ( $messages as $message ) {
4179                      $result[] = array(
4180                          'code'    => $code,
4181                          'message' => $message,
4182                      );
4183                  }
4184              }
4185  
4186              $response['data'] = $result;
4187          } else {
4188              $response['data'] = $data;
4189          }
4190      }
4191  
4192      wp_send_json( $response, $status_code, $options );
4193  }
4194  
4195  /**
4196   * Checks that a JSONP callback is a valid JavaScript callback name.
4197   *
4198   * Only allows alphanumeric characters and the dot character in callback
4199   * function names. This helps to mitigate XSS attacks caused by directly
4200   * outputting user input.
4201   *
4202   * @since 4.6.0
4203   *
4204   * @param string $callback Supplied JSONP callback function name.
4205   * @return bool Whether the callback function name is valid.
4206   */
4207  function wp_check_jsonp_callback( $callback ) {
4208      if ( ! is_string( $callback ) ) {
4209          return false;
4210      }
4211  
4212      preg_replace( '/[^\w\.]/', '', $callback, -1, $illegal_char_count );
4213  
4214      return 0 === $illegal_char_count;
4215  }
4216  
4217  /**
4218   * Retrieve the WordPress home page URL.
4219   *
4220   * If the constant named 'WP_HOME' exists, then it will be used and returned
4221   * by the function. This can be used to counter the redirection on your local
4222   * development environment.
4223   *
4224   * @since 2.2.0
4225   * @access private
4226   *
4227   * @see WP_HOME
4228   *
4229   * @param string $url URL for the home location.
4230   * @return string Homepage location.
4231   */
4232  function _config_wp_home( $url = '' ) {
4233      if ( defined( 'WP_HOME' ) ) {
4234          return untrailingslashit( WP_HOME );
4235      }
4236      return $url;
4237  }
4238  
4239  /**
4240   * Retrieve the WordPress site URL.
4241   *
4242   * If the constant named 'WP_SITEURL' is defined, then the value in that
4243   * constant will always be returned. This can be used for debugging a site
4244   * on your localhost while not having to change the database to your URL.
4245   *
4246   * @since 2.2.0
4247   * @access private
4248   *
4249   * @see WP_SITEURL
4250   *
4251   * @param string $url URL to set the WordPress site location.
4252   * @return string The WordPress Site URL.
4253   */
4254  function _config_wp_siteurl( $url = '' ) {
4255      if ( defined( 'WP_SITEURL' ) ) {
4256          return untrailingslashit( WP_SITEURL );
4257      }
4258      return $url;
4259  }
4260  
4261  /**
4262   * Delete the fresh site option.
4263   *
4264   * @since 4.7.0
4265   * @access private
4266   */
4267  function _delete_option_fresh_site() {
4268      update_option( 'fresh_site', '0' );
4269  }
4270  
4271  /**
4272   * Set the localized direction for MCE plugin.
4273   *
4274   * Will only set the direction to 'rtl', if the WordPress locale has
4275   * the text direction set to 'rtl'.
4276   *
4277   * Fills in the 'directionality' setting, enables the 'directionality'
4278   * plugin, and adds the 'ltr' button to 'toolbar1', formerly
4279   * 'theme_advanced_buttons1' array keys. These keys are then returned
4280   * in the $mce_init (TinyMCE settings) array.
4281   *
4282   * @since 2.1.0
4283   * @access private
4284   *
4285   * @param array $mce_init MCE settings array.
4286   * @return array Direction set for 'rtl', if needed by locale.
4287   */
4288  function _mce_set_direction( $mce_init ) {
4289      if ( is_rtl() ) {
4290          $mce_init['directionality'] = 'rtl';
4291          $mce_init['rtl_ui']         = true;
4292  
4293          if ( ! empty( $mce_init['plugins'] ) && strpos( $mce_init['plugins'], 'directionality' ) === false ) {
4294              $mce_init['plugins'] .= ',directionality';
4295          }
4296  
4297          if ( ! empty( $mce_init['toolbar1'] ) && ! preg_match( '/\bltr\b/', $mce_init['toolbar1'] ) ) {
4298              $mce_init['toolbar1'] .= ',ltr';
4299          }
4300      }
4301  
4302      return $mce_init;
4303  }
4304  
4305  
4306  /**
4307   * Convert smiley code to the icon graphic file equivalent.
4308   *
4309   * You can turn off smilies, by going to the write setting screen and unchecking
4310   * the box, or by setting 'use_smilies' option to false or removing the option.
4311   *
4312   * Plugins may override the default smiley list by setting the $wpsmiliestrans
4313   * to an array, with the key the code the blogger types in and the value the
4314   * image file.
4315   *
4316   * The $wp_smiliessearch global is for the regular expression and is set each
4317   * time the function is called.
4318   *
4319   * The full list of smilies can be found in the function and won't be listed in
4320   * the description. Probably should create a Codex page for it, so that it is
4321   * available.
4322   *
4323   * @global array $wpsmiliestrans
4324   * @global array $wp_smiliessearch
4325   *
4326   * @since 2.2.0
4327   */
4328  function smilies_init() {
4329      global $wpsmiliestrans, $wp_smiliessearch;
4330  
4331      // Don't bother setting up smilies if they are disabled.
4332      if ( ! get_option( 'use_smilies' ) ) {
4333          return;
4334      }
4335  
4336      if ( ! isset( $wpsmiliestrans ) ) {
4337          $wpsmiliestrans = array(
4338              ':mrgreen:' => 'mrgreen.png',
4339              ':neutral:' => "\xf0\x9f\x98\x90",
4340              ':twisted:' => "\xf0\x9f\x98\x88",
4341              ':arrow:'   => "\xe2\x9e\xa1",
4342              ':shock:'   => "\xf0\x9f\x98\xaf",
4343              ':smile:'   => "\xf0\x9f\x99\x82",
4344              ':???:'     => "\xf0\x9f\x98\x95",
4345              ':cool:'    => "\xf0\x9f\x98\x8e",
4346              ':evil:'    => "\xf0\x9f\x91\xbf",
4347              ':grin:'    => "\xf0\x9f\x98\x80",
4348              ':idea:'    => "\xf0\x9f\x92\xa1",
4349              ':oops:'    => "\xf0\x9f\x98\xb3",
4350              ':razz:'    => "\xf0\x9f\x98\x9b",
4351              ':roll:'    => "\xf0\x9f\x99\x84",
4352              ':wink:'    => "\xf0\x9f\x98\x89",
4353              ':cry:'     => "\xf0\x9f\x98\xa5",
4354              ':eek:'     => "\xf0\x9f\x98\xae",
4355              ':lol:'     => "\xf0\x9f\x98\x86",
4356              ':mad:'     => "\xf0\x9f\x98\xa1",
4357              ':sad:'     => "\xf0\x9f\x99\x81",
4358              '8-)'       => "\xf0\x9f\x98\x8e",
4359              '8-O'       => "\xf0\x9f\x98\xaf",
4360              ':-('       => "\xf0\x9f\x99\x81",
4361              ':-)'       => "\xf0\x9f\x99\x82",
4362              ':-?'       => "\xf0\x9f\x98\x95",
4363              ':-D'       => "\xf0\x9f\x98\x80",
4364              ':-P'       => "\xf0\x9f\x98\x9b",
4365              ':-o'       => "\xf0\x9f\x98\xae",
4366              ':-x'       => "\xf0\x9f\x98\xa1",
4367              ':-|'       => "\xf0\x9f\x98\x90",
4368              ';-)'       => "\xf0\x9f\x98\x89",
4369              // This one transformation breaks regular text with frequency.
4370              //     '8)' => "\xf0\x9f\x98\x8e",
4371              '8O'        => "\xf0\x9f\x98\xaf",
4372              ':('        => "\xf0\x9f\x99\x81",
4373              ':)'        => "\xf0\x9f\x99\x82",
4374              ':?'        => "\xf0\x9f\x98\x95",
4375              ':D'        => "\xf0\x9f\x98\x80",
4376              ':P'        => "\xf0\x9f\x98\x9b",
4377              ':o'        => "\xf0\x9f\x98\xae",
4378              ':x'        => "\xf0\x9f\x98\xa1",
4379              ':|'        => "\xf0\x9f\x98\x90",
4380              ';)'        => "\xf0\x9f\x98\x89",
4381              ':!:'       => "\xe2\x9d\x97",
4382              ':?:'       => "\xe2\x9d\x93",
4383          );
4384      }
4385  
4386      /**
4387       * Filters all the smilies.
4388       *
4389       * This filter must be added before `smilies_init` is run, as
4390       * it is normally only run once to setup the smilies regex.
4391       *
4392       * @since 4.7.0
4393       *
4394       * @param string[] $wpsmiliestrans List of the smilies' hexadecimal representations, keyed by their smily code.
4395       */
4396      $wpsmiliestrans = apply_filters( 'smilies', $wpsmiliestrans );
4397  
4398      if ( count( $wpsmiliestrans ) == 0 ) {
4399          return;
4400      }
4401  
4402      /*
4403       * NOTE: we sort the smilies in reverse key order. This is to make sure
4404       * we match the longest possible smilie (:???: vs :?) as the regular
4405       * expression used below is first-match
4406       */
4407      krsort( $wpsmiliestrans );
4408  
4409      $spaces = wp_spaces_regexp();
4410  
4411      // Begin first "subpattern".
4412      $wp_smiliessearch = '/(?<=' . $spaces . '|^)';
4413  
4414      $subchar = '';
4415      foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
4416          $firstchar = substr( $smiley, 0, 1 );
4417          $rest      = substr( $smiley, 1 );
4418  
4419          // New subpattern?
4420          if ( $firstchar != $subchar ) {
4421              if ( '' !== $subchar ) {
4422                  $wp_smiliessearch .= ')(?=' . $spaces . '|$)';  // End previous "subpattern".
4423                  $wp_smiliessearch .= '|(?<=' . $spaces . '|^)'; // Begin another "subpattern".
4424              }
4425              $subchar           = $firstchar;
4426              $wp_smiliessearch .= preg_quote( $firstchar, '/' ) . '(?:';
4427          } else {
4428              $wp_smiliessearch .= '|';
4429          }
4430          $wp_smiliessearch .= preg_quote( $rest, '/' );
4431      }
4432  
4433      $wp_smiliessearch .= ')(?=' . $spaces . '|$)/m';
4434  
4435  }
4436  
4437  /**
4438   * Merges user defined arguments into defaults array.
4439   *
4440   * This function is used throughout WordPress to allow for both string or array
4441   * to be merged into another array.
4442   *
4443   * @since 2.2.0
4444   * @since 2.3.0 `$args` can now also be an object.
4445   *
4446   * @param string|array|object $args     Value to merge with $defaults.
4447   * @param array               $defaults Optional. Array that serves as the defaults.
4448   *                                      Default empty array.
4449   * @return array Merged user defined values with defaults.
4450   */
4451  function wp_parse_args( $args, $defaults = array() ) {
4452      if ( is_object( $args ) ) {
4453          $parsed_args = get_object_vars( $args );
4454      } elseif ( is_array( $args ) ) {
4455          $parsed_args =& $args;
4456      } else {
4457          wp_parse_str( $args, $parsed_args );
4458      }
4459  
4460      if ( is_array( $defaults ) && $defaults ) {
4461          return array_merge( $defaults, $parsed_args );
4462      }
4463      return $parsed_args;
4464  }
4465  
4466  /**
4467   * Converts a comma- or space-separated list of scalar values to an array.
4468   *
4469   * @since 5.1.0
4470   *
4471   * @param array|string $list List of values.
4472   * @return array Array of values.
4473   */
4474  function wp_parse_list( $list ) {
4475      if ( ! is_array( $list ) ) {
4476          return preg_split( '/[\s,]+/', $list, -1, PREG_SPLIT_NO_EMPTY );
4477      }
4478  
4479      return $list;
4480  }
4481  
4482  /**
4483   * Cleans up an array, comma- or space-separated list of IDs.
4484   *
4485   * @since 3.0.0
4486   *
4487   * @param array|string $list List of IDs.
4488   * @return int[] Sanitized array of IDs.
4489   */
4490  function wp_parse_id_list( $list ) {
4491      $list = wp_parse_list( $list );
4492  
4493      return array_unique( array_map( 'absint', $list ) );
4494  }
4495  
4496  /**
4497   * Cleans up an array, comma- or space-separated list of slugs.
4498   *
4499   * @since 4.7.0
4500   *
4501   * @param array|string $list List of slugs.
4502   * @return string[] Sanitized array of slugs.
4503   */
4504  function wp_parse_slug_list( $list ) {
4505      $list = wp_parse_list( $list );
4506  
4507      return array_unique( array_map( 'sanitize_title', $list ) );
4508  }
4509  
4510  /**
4511   * Extract a slice of an array, given a list of keys.
4512   *
4513   * @since 3.1.0
4514   *
4515   * @param array $array The original array.
4516   * @param array $keys  The list of keys.
4517   * @return array The array slice.
4518   */
4519  function wp_array_slice_assoc( $array, $keys ) {
4520      $slice = array();
4521  
4522      foreach ( $keys as $key ) {
4523          if ( isset( $array[ $key ] ) ) {
4524              $slice[ $key ] = $array[ $key ];
4525          }
4526      }
4527  
4528      return $slice;
4529  }
4530  
4531  /**
4532   * Accesses an array in depth based on a path of keys.
4533   *
4534   * It is the PHP equivalent of JavaScript's `lodash.get()` and mirroring it may help other components
4535   * retain some symmetry between client and server implementations.
4536   *
4537   * Example usage:
4538   *
4539   *     $array = array(
4540   *         'a' => array(
4541   *             'b' => array(
4542   *                 'c' => 1,
4543   *             ),
4544   *         ),
4545   *     );
4546   *     _wp_array_get( $array, array( 'a', 'b', 'c' );
4547   *
4548   * @internal
4549   *
4550   * @since 5.6.0
4551   * @access private
4552   *
4553   * @param array $array   An array from which we want to retrieve some information.
4554   * @param array $path    An array of keys describing the path with which to retrieve information.
4555   * @param mixed $default The return value if the path does not exist within the array,
4556   *                       or if `$array` or `$path` are not arrays.
4557   * @return mixed The value from the path specified.
4558   */
4559  function _wp_array_get( $array, $path, $default = null ) {
4560      // Confirm $path is valid.
4561      if ( ! is_array( $path ) || 0 === count( $path ) ) {
4562          return $default;
4563      }
4564  
4565      foreach ( $path as $path_element ) {
4566          if (
4567              ! is_array( $array ) ||
4568              ( ! is_string( $path_element ) && ! is_integer( $path_element ) && ! is_null( $path_element ) ) ||
4569              ! array_key_exists( $path_element, $array )
4570          ) {
4571              return $default;
4572          }
4573          $array = $array[ $path_element ];
4574      }
4575  
4576      return $array;
4577  }
4578  
4579  /**
4580   * Determines if the variable is a numeric-indexed array.
4581   *
4582   * @since 4.4.0
4583   *
4584   * @param mixed $data Variable to check.
4585   * @return bool Whether the variable is a list.
4586   */
4587  function wp_is_numeric_array( $data ) {
4588      if ( ! is_array( $data ) ) {
4589          return false;
4590      }
4591  
4592      $keys        = array_keys( $data );
4593      $string_keys = array_filter( $keys, 'is_string' );
4594  
4595      return count( $string_keys ) === 0;
4596  }
4597  
4598  /**
4599   * Filters a list of objects, based on a set of key => value arguments.
4600   *
4601   * @since 3.0.0
4602   * @since 4.7.0 Uses `WP_List_Util` class.
4603   *
4604   * @param array       $list     An array of objects to filter
4605   * @param array       $args     Optional. An array of key => value arguments to match
4606   *                              against each object. Default empty array.
4607   * @param string      $operator Optional. The logical operation to perform. 'or' means
4608   *                              only one element from the array needs to match; 'and'
4609   *                              means all elements must match; 'not' means no elements may
4610   *                              match. Default 'and'.
4611   * @param bool|string $field    A field from the object to place instead of the entire object.
4612   *                              Default false.
4613   * @return array A list of objects or object fields.
4614   */
4615  function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
4616      if ( ! is_array( $list ) ) {
4617          return array();
4618      }
4619  
4620      $util = new WP_List_Util( $list );
4621  
4622      $util->filter( $args, $operator );
4623  
4624      if ( $field ) {
4625          $util->pluck( $field );
4626      }
4627  
4628      return $util->get_output();
4629  }
4630  
4631  /**
4632   * Filters a list of objects, based on a set of key => value arguments.
4633   *
4634   * @since 3.1.0
4635   * @since 4.7.0 Uses `WP_List_Util` class.
4636   *
4637   * @param array  $list     An array of objects to filter.
4638   * @param array  $args     Optional. An array of key => value arguments to match
4639   *                         against each object. Default empty array.
4640   * @param string $operator Optional. The logical operation to perform. 'AND' means
4641   *                         all elements from the array must match. 'OR' means only
4642   *                         one element needs to match. 'NOT' means no elements may
4643   *                         match. Default 'AND'.
4644   * @return array Array of found values.
4645   */
4646  function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
4647      if ( ! is_array( $list ) ) {
4648          return array();
4649      }
4650  
4651      $util = new WP_List_Util( $list );
4652      return $util->filter( $args, $operator );
4653  }
4654  
4655  /**
4656   * Pluck a certain field out of each object in a list.
4657   *
4658   * This has the same functionality and prototype of
4659   * array_column() (PHP 5.5) but also supports objects.
4660   *
4661   * @since 3.1.0
4662   * @since 4.0.0 $index_key parameter added.
4663   * @since 4.7.0 Uses `WP_List_Util` class.
4664   *
4665   * @param array      $list      List of objects or arrays
4666   * @param int|string $field     Field from the object to place instead of the entire object
4667   * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
4668   *                              Default null.
4669   * @return array Array of found values. If `$index_key` is set, an array of found values with keys
4670   *               corresponding to `$index_key`. If `$index_key` is null, array keys from the original
4671   *               `$list` will be preserved in the results.
4672   */
4673  function wp_list_pluck( $list, $field, $index_key = null ) {
4674      $util = new WP_List_Util( $list );
4675      return $util->pluck( $field, $index_key );
4676  }
4677  
4678  /**
4679   * Sorts a list of objects, based on one or more orderby arguments.
4680   *
4681   * @since 4.7.0
4682   *
4683   * @param array        $list          An array of objects to sort.
4684   * @param string|array $orderby       Optional. Either the field name to order by or an array
4685   *                                    of multiple orderby fields as $orderby => $order.
4686   * @param string       $order         Optional. Either 'ASC' or 'DESC'. Only used if $orderby
4687   *                                    is a string.
4688   * @param bool         $preserve_keys Optional. Whether to preserve keys. Default false.
4689   * @return array The sorted array.
4690   */
4691  function wp_list_sort( $list, $orderby = array(), $order = 'ASC', $preserve_keys = false ) {
4692      if ( ! is_array( $list ) ) {
4693          return array();
4694      }
4695  
4696      $util = new WP_List_Util( $list );
4697      return $util->sort( $orderby, $order, $preserve_keys );
4698  }
4699  
4700  /**
4701   * Determines if Widgets library should be loaded.
4702   *
4703   * Checks to make sure that the widgets library hasn't already been loaded.
4704   * If it hasn't, then it will load the widgets library and run an action hook.
4705   *
4706   * @since 2.2.0
4707   */
4708  function wp_maybe_load_widgets() {
4709      /**
4710       * Filters whether to load the Widgets library.
4711       *
4712       * Returning a falsey value from the filter will effectively short-circuit
4713       * the Widgets library from loading.
4714       *
4715       * @since 2.8.0
4716       *
4717       * @param bool $wp_maybe_load_widgets Whether to load the Widgets library.
4718       *                                    Default true.
4719       */
4720      if ( ! apply_filters( 'load_default_widgets', true ) ) {
4721          return;
4722      }
4723  
4724      require_once  ABSPATH . WPINC . '/default-widgets.php';
4725  
4726      add_action( '_admin_menu', 'wp_widgets_add_menu' );
4727  }
4728  
4729  /**
4730   * Append the Widgets menu to the themes main menu.
4731   *
4732   * @since 2.2.0
4733   *
4734   * @global array $submenu
4735   */
4736  function wp_widgets_add_menu() {
4737      global $submenu;
4738  
4739      if ( ! current_theme_supports( 'widgets' ) ) {
4740          return;
4741      }
4742  
4743      $submenu['themes.php'][7] = array( __( 'Widgets' ), 'edit_theme_options', 'widgets.php' );
4744      ksort( $submenu['themes.php'], SORT_NUMERIC );
4745  }
4746  
4747  /**
4748   * Flush all output buffers for PHP 5.2.
4749   *
4750   * Make sure all output buffers are flushed before our singletons are destroyed.
4751   *
4752   * @since 2.2.0
4753   */
4754  function wp_ob_end_flush_all() {
4755      $levels = ob_get_level();
4756      for ( $i = 0; $i < $levels; $i++ ) {
4757          ob_end_flush();
4758      }
4759  }
4760  
4761  /**
4762   * Load custom DB error or display WordPress DB error.
4763   *
4764   * If a file exists in the wp-content directory named db-error.php, then it will
4765   * be loaded instead of displaying the WordPress DB error. If it is not found,
4766   * then the WordPress DB error will be displayed instead.
4767   *
4768   * The WordPress DB error sets the HTTP status header to 500 to try to prevent
4769   * search engines from caching the message. Custom DB messages should do the
4770   * same.
4771   *
4772   * This function was backported to WordPress 2.3.2, but originally was added
4773   * in WordPress 2.5.0.
4774   *
4775   * @since 2.3.2
4776   *
4777   * @global wpdb $wpdb WordPress database abstraction object.
4778   */
4779  function dead_db() {
4780      global $wpdb;
4781  
4782      wp_load_translations_early();
4783  
4784      // Load custom DB error template, if present.
4785      if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
4786          require_once WP_CONTENT_DIR . '/db-error.php';
4787          die();
4788      }
4789  
4790      // If installing or in the admin, provide the verbose message.
4791      if ( wp_installing() || defined( 'WP_ADMIN' ) ) {
4792          wp_die( $wpdb->error );
4793      }
4794  
4795      // Otherwise, be terse.
4796      wp_die( '<h1>' . __( 'Error establishing a database connection' ) . '</h1>', __( 'Database Error' ) );
4797  }
4798  
4799  /**
4800   * Convert a value to non-negative integer.
4801   *
4802   * @since 2.5.0
4803   *
4804   * @param mixed $maybeint Data you wish to have converted to a non-negative integer.
4805   * @return int A non-negative integer.
4806   */
4807  function absint( $maybeint ) {
4808      return abs( (int) $maybeint );
4809  }
4810  
4811  /**
4812   * Mark a function as deprecated and inform when it has been used.
4813   *
4814   * There is a {@see 'hook deprecated_function_run'} that will be called that can be used
4815   * to get the backtrace up to what file and function called the deprecated
4816   * function.
4817   *
4818   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
4819   *
4820   * This function is to be used in every function that is deprecated.
4821   *
4822   * @since 2.5.0
4823   * @since 5.4.0 This function is no longer marked as "private".
4824   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
4825   *
4826   * @param string $function    The function that was called.
4827   * @param string $version     The version of WordPress that deprecated the function.
4828   * @param string $replacement Optional. The function that should have been called. Default empty.
4829   */
4830  function _deprecated_function( $function, $version, $replacement = '' ) {
4831  
4832      /**
4833       * Fires when a deprecated function is called.
4834       *
4835       * @since 2.5.0
4836       *
4837       * @param string $function    The function that was called.
4838       * @param string $replacement The function that should have been called.
4839       * @param string $version     The version of WordPress that deprecated the function.
4840       */
4841      do_action( 'deprecated_function_run', $function, $replacement, $version );
4842  
4843      /**
4844       * Filters whether to trigger an error for deprecated functions.
4845       *
4846       * @since 2.5.0
4847       *
4848       * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
4849       */
4850      if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
4851          if ( function_exists( '__' ) ) {
4852              if ( $replacement ) {
4853                  trigger_error(
4854                      sprintf(
4855                          /* translators: 1: PHP function name, 2: Version number, 3: Alternative function name. */
4856                          __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
4857                          $function,
4858                          $version,
4859                          $replacement
4860                      ),
4861                      E_USER_DEPRECATED
4862                  );
4863              } else {
4864                  trigger_error(
4865                      sprintf(
4866                          /* translators: 1: PHP function name, 2: Version number. */
4867                          __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
4868                          $function,
4869                          $version
4870                      ),
4871                      E_USER_DEPRECATED
4872                  );
4873              }
4874          } else {
4875              if ( $replacement ) {
4876                  trigger_error(
4877                      sprintf(
4878                          '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
4879                          $function,
4880                          $version,
4881                          $replacement
4882                      ),
4883                      E_USER_DEPRECATED
4884                  );
4885              } else {
4886                  trigger_error(
4887                      sprintf(
4888                          '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',
4889                          $function,
4890                          $version
4891                      ),
4892                      E_USER_DEPRECATED
4893                  );
4894              }
4895          }
4896      }
4897  }
4898  
4899  /**
4900   * Marks a constructor as deprecated and informs when it has been used.
4901   *
4902   * Similar to _deprecated_function(), but with different strings. Used to
4903   * remove PHP4 style constructors.
4904   *
4905   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
4906   *
4907   * This function is to be used in every PHP4 style constructor method that is deprecated.
4908   *
4909   * @since 4.3.0
4910   * @since 4.5.0 Added the `$parent_class` parameter.
4911   * @since 5.4.0 This function is no longer marked as "private".
4912   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
4913   *
4914   * @param string $class        The class containing the deprecated constructor.
4915   * @param string $version      The version of WordPress that deprecated the function.
4916   * @param string $parent_class Optional. The parent class calling the deprecated constructor.
4917   *                             Default empty string.
4918   */
4919  function _deprecated_constructor( $class, $version, $parent_class = '' ) {
4920  
4921      /**
4922       * Fires when a deprecated constructor is called.
4923       *
4924       * @since 4.3.0
4925       * @since 4.5.0 Added the `$parent_class` parameter.
4926       *
4927       * @param string $class        The class containing the deprecated constructor.
4928       * @param string $version      The version of WordPress that deprecated the function.
4929       * @param string $parent_class The parent class calling the deprecated constructor.
4930       */
4931      do_action( 'deprecated_constructor_run', $class, $version, $parent_class );
4932  
4933      /**
4934       * Filters whether to trigger an error for deprecated functions.
4935       *
4936       * `WP_DEBUG` must be true in addition to the filter evaluating to true.
4937       *
4938       * @since 4.3.0
4939       *
4940       * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
4941       */
4942      if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) {
4943          if ( function_exists( '__' ) ) {
4944              if ( $parent_class ) {
4945                  trigger_error(
4946                      sprintf(
4947                          /* translators: 1: PHP class name, 2: PHP parent class name, 3: Version number, 4: __construct() method. */
4948                          __( 'The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.' ),
4949                          $class,
4950                          $parent_class,
4951                          $version,
4952                          '<code>__construct()</code>'
4953                      ),
4954                      E_USER_DEPRECATED
4955                  );
4956              } else {
4957                  trigger_error(
4958                      sprintf(
4959                          /* translators: 1: PHP class name, 2: Version number, 3: __construct() method. */
4960                          __( 'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
4961                          $class,
4962                          $version,
4963                          '<code>__construct()</code>'
4964                      ),
4965                      E_USER_DEPRECATED
4966                  );
4967              }
4968          } else {
4969              if ( $parent_class ) {
4970                  trigger_error(
4971                      sprintf(
4972                          'The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.',
4973                          $class,
4974                          $parent_class,
4975                          $version,
4976                          '<code>__construct()</code>'
4977                      ),
4978                      E_USER_DEPRECATED
4979                  );
4980              } else {
4981                  trigger_error(
4982                      sprintf(
4983                          'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
4984                          $class,
4985                          $version,
4986                          '<code>__construct()</code>'
4987                      ),
4988                      E_USER_DEPRECATED
4989                  );
4990              }
4991          }
4992      }
4993  
4994  }
4995  
4996  /**
4997   * Mark a file as deprecated and inform when it has been used.
4998   *
4999   * There is a hook {@see 'deprecated_file_included'} that will be called that can be used
5000   * to get the backtrace up to what file and function included the deprecated
5001   * file.
5002   *
5003   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
5004   *
5005   * This function is to be used in every file that is deprecated.
5006   *
5007   * @since 2.5.0
5008   * @since 5.4.0 This function is no longer marked as "private".
5009   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
5010   *
5011   * @param string $file        The file that was included.
5012   * @param string $version     The version of WordPress that deprecated the file.
5013   * @param string $replacement Optional. The file that should have been included based on ABSPATH.
5014   *                            Default empty.
5015   * @param string $message     Optional. A message regarding the change. Default empty.
5016   */
5017  function _deprecated_file( $file, $version, $replacement = '', $message = '' ) {
5018  
5019      /**
5020       * Fires when a deprecated file is called.
5021       *
5022       * @since 2.5.0
5023       *
5024       * @param string $file        The file that was called.
5025       * @param string $replacement The file that should have been included based on ABSPATH.
5026       * @param string $version     The version of WordPress that deprecated the file.
5027       * @param string $message     A message regarding the change.
5028       */
5029      do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
5030  
5031      /**
5032       * Filters whether to trigger an error for deprecated files.
5033       *
5034       * @since 2.5.0
5035       *
5036       * @param bool $trigger Whether to trigger the error for deprecated files. Default true.
5037       */
5038      if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
5039          $message = empty( $message ) ? '' : ' ' . $message;
5040  
5041          if ( function_exists( '__' ) ) {
5042              if ( $replacement ) {
5043                  trigger_error(
5044                      sprintf(
5045                          /* translators: 1: PHP file name, 2: Version number, 3: Alternative file name. */
5046                          __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
5047                          $file,
5048                          $version,
5049                          $replacement
5050                      ) . $message,
5051                      E_USER_DEPRECATED
5052                  );
5053              } else {
5054                  trigger_error(
5055                      sprintf(
5056                          /* translators: 1: PHP file name, 2: Version number. */
5057                          __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
5058                          $file,
5059                          $version
5060                      ) . $message,
5061                      E_USER_DEPRECATED
5062                  );
5063              }
5064          } else {
5065              if ( $replacement ) {
5066                  trigger_error(
5067                      sprintf(
5068                          '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
5069                          $file,
5070                          $version,
5071                          $replacement
5072                      ) . $message,
5073                      E_USER_DEPRECATED
5074                  );
5075              } else {
5076                  trigger_error(
5077                      sprintf(
5078                          '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',
5079                          $file,
5080                          $version
5081                      ) . $message,
5082                      E_USER_DEPRECATED
5083                  );
5084              }
5085          }
5086      }
5087  }
5088  /**
5089   * Mark a function argument as deprecated and inform when it has been used.
5090   *
5091   * This function is to be used whenever a deprecated function argument is used.
5092   * Before this function is called, the argument must be checked for whether it was
5093   * used by comparing it to its default value or evaluating whether it is empty.
5094   * For example:
5095   *
5096   *     if ( ! empty( $deprecated ) ) {
5097   *         _deprecated_argument( __FUNCTION__, '3.0.0' );
5098   *     }
5099   *
5100   * There is a hook deprecated_argument_run that will be called that can be used
5101   * to get the backtrace up to what file and function used the deprecated
5102   * argument.
5103   *
5104   * The current behavior is to trigger a user error if WP_DEBUG is true.
5105   *
5106   * @since 3.0.0
5107   * @since 5.4.0 This function is no longer marked as "private".
5108   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
5109   *
5110   * @param string $function The function that was called.
5111   * @param string $version  The version of WordPress that deprecated the argument used.
5112   * @param string $message  Optional. A message regarding the change. Default empty.
5113   */
5114  function _deprecated_argument( $function, $version, $message = '' ) {
5115  
5116      /**
5117       * Fires when a deprecated argument is called.
5118       *
5119       * @since 3.0.0
5120       *
5121       * @param string $function The function that was called.
5122       * @param string $message  A message regarding the change.
5123       * @param string $version  The version of WordPress that deprecated the argument used.
5124       */
5125      do_action( 'deprecated_argument_run', $function, $message, $version );
5126  
5127      /**
5128       * Filters whether to trigger an error for deprecated arguments.
5129       *
5130       * @since 3.0.0
5131       *
5132       * @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
5133       */
5134      if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
5135          if ( function_exists( '__' ) ) {
5136              if ( $message ) {
5137                  trigger_error(
5138                      sprintf(
5139                          /* translators: 1: PHP function name, 2: Version number, 3: Optional message regarding the change. */
5140                          __( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s' ),
5141                          $function,
5142                          $version,
5143                          $message
5144                      ),
5145                      E_USER_DEPRECATED
5146                  );
5147              } else {
5148                  trigger_error(
5149                      sprintf(
5150                          /* translators: 1: PHP function name, 2: Version number. */
5151                          __( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
5152                          $function,
5153                          $version
5154                      ),
5155                      E_USER_DEPRECATED
5156                  );
5157              }
5158          } else {
5159              if ( $message ) {
5160                  trigger_error(
5161                      sprintf(
5162                          '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s',
5163                          $function,
5164                          $version,
5165                          $message
5166                      ),
5167                      E_USER_DEPRECATED
5168                  );
5169              } else {
5170                  trigger_error(
5171                      sprintf(
5172                          '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.',
5173                          $function,
5174                          $version
5175                      ),
5176                      E_USER_DEPRECATED
5177                  );
5178              }
5179          }
5180      }
5181  }
5182  
5183  /**
5184   * Marks a deprecated action or filter hook as deprecated and throws a notice.
5185   *
5186   * Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where
5187   * the deprecated hook was called.
5188   *
5189   * Default behavior is to trigger a user error if `WP_DEBUG` is true.
5190   *
5191   * This function is called by the do_action_deprecated() and apply_filters_deprecated()
5192   * functions, and so generally does not need to be called directly.
5193   *
5194   * @since 4.6.0
5195   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
5196   * @access private
5197   *
5198   * @param string $hook        The hook that was used.
5199   * @param string $version     The version of WordPress that deprecated the hook.
5200   * @param string $replacement Optional. The hook that should have been used. Default empty.
5201   * @param string $message     Optional. A message regarding the change. Default empty.
5202   */
5203  function _deprecated_hook( $hook, $version, $replacement = '', $message = '' ) {
5204      /**
5205       * Fires when a deprecated hook is called.
5206       *
5207       * @since 4.6.0
5208       *
5209       * @param string $hook        The hook that was called.
5210       * @param string $replacement The hook that should be used as a replacement.
5211       * @param string $version     The version of WordPress that deprecated the argument used.
5212       * @param string $message     A message regarding the change.
5213       */
5214      do_action( 'deprecated_hook_run', $hook, $replacement, $version, $message );
5215  
5216      /**
5217       * Filters whether to trigger deprecated hook errors.
5218       *
5219       * @since 4.6.0
5220       *
5221       * @param bool $trigger Whether to trigger deprecated hook errors. Requires
5222       *                      `WP_DEBUG` to be defined true.
5223       */
5224      if ( WP_DEBUG && apply_filters( 'deprecated_hook_trigger_error', true ) ) {
5225          $message = empty( $message ) ? '' : ' ' . $message;
5226  
5227          if ( $replacement ) {
5228              trigger_error(
5229                  sprintf(
5230                      /* translators: 1: WordPress hook name, 2: Version number, 3: Alternative hook name. */
5231                      __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
5232                      $hook,
5233                      $version,
5234                      $replacement
5235                  ) . $message,
5236                  E_USER_DEPRECATED
5237              );
5238          } else {
5239              trigger_error(
5240                  sprintf(
5241                      /* translators: 1: WordPress hook name, 2: Version number. */
5242                      __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
5243                      $hook,
5244                      $version
5245                  ) . $message,
5246                  E_USER_DEPRECATED
5247              );
5248          }
5249      }
5250  }
5251  
5252  /**
5253   * Mark something as being incorrectly called.
5254   *
5255   * There is a hook {@see 'doing_it_wrong_run'} that will be called that can be used
5256   * to get the backtrace up to what file and function called the deprecated
5257   * function.
5258   *
5259   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
5260   *
5261   * @since 3.1.0
5262   * @since 5.4.0 This function is no longer marked as "private".
5263   *
5264   * @param string $function The function that was called.
5265   * @param string $message  A message explaining what has been done incorrectly.
5266   * @param string $version  The version of WordPress where the message was added.
5267   */
5268  function _doing_it_wrong( $function, $message, $version ) {
5269  
5270      /**
5271       * Fires when the given function is being used incorrectly.
5272       *
5273       * @since 3.1.0
5274       *
5275       * @param string $function The function that was called.
5276       * @param string $message  A message explaining what has been done incorrectly.
5277       * @param string $version  The version of WordPress where the message was added.
5278       */
5279      do_action( 'doing_it_wrong_run', $function, $message, $version );
5280  
5281      /**
5282       * Filters whether to trigger an error for _doing_it_wrong() calls.
5283       *
5284       * @since 3.1.0
5285       * @since 5.1.0 Added the $function, $message and $version parameters.
5286       *
5287       * @param bool   $trigger  Whether to trigger the error for _doing_it_wrong() calls. Default true.
5288       * @param string $function The function that was called.
5289       * @param string $message  A message explaining what has been done incorrectly.
5290       * @param string $version  The version of WordPress where the message was added.
5291       */
5292      if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true, $function, $message, $version ) ) {
5293          if ( function_exists( '__' ) ) {
5294              if ( $version ) {
5295                  /* translators: %s: Version number. */
5296                  $version = sprintf( __( '(This message was added in version %s.)' ), $version );
5297              }
5298  
5299              $message .= ' ' . sprintf(
5300                  /* translators: %s: Documentation URL. */
5301                  __( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ),
5302                  __( 'https://wordpress.org/support/article/debugging-in-wordpress/' )
5303              );
5304  
5305              trigger_error(
5306                  sprintf(
5307                      /* translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: WordPress version number. */
5308                      __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ),
5309                      $function,
5310                      $message,
5311                      $version
5312                  ),
5313                  E_USER_NOTICE
5314              );
5315          } else {
5316              if ( $version ) {
5317                  $version = sprintf( '(This message was added in version %s.)', $version );
5318              }
5319  
5320              $message .= sprintf(
5321                  ' Please see <a href="%s">Debugging in WordPress</a> for more information.',
5322                  'https://wordpress.org/support/article/debugging-in-wordpress/'
5323              );
5324  
5325              trigger_error(
5326                  sprintf(
5327                      '%1$s was called <strong>incorrectly</strong>. %2$s %3$s',
5328                      $function,
5329                      $message,
5330                      $version
5331                  ),
5332                  E_USER_NOTICE
5333              );
5334          }
5335      }
5336  }
5337  
5338  /**
5339   * Is the server running earlier than 1.5.0 version of lighttpd?
5340   *
5341   * @since 2.5.0
5342   *
5343   * @return bool Whether the server is running lighttpd < 1.5.0.
5344   */
5345  function is_lighttpd_before_150() {
5346      $server_parts    = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : '' );
5347      $server_parts[1] = isset( $server_parts[1] ) ? $server_parts[1] : '';
5348  
5349      return ( 'lighttpd' === $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' ) );
5350  }
5351  
5352  /**
5353   * Does the specified module exist in the Apache config?
5354   *
5355   * @since 2.5.0
5356   *
5357   * @global bool $is_apache
5358   *
5359   * @param string $mod     The module, e.g. mod_rewrite.
5360   * @param bool   $default Optional. The default return value if the module is not found. Default false.
5361   * @return bool Whether the specified module is loaded.
5362   */
5363  function apache_mod_loaded( $mod, $default = false ) {
5364      global $is_apache;
5365  
5366      if ( ! $is_apache ) {
5367          return false;
5368      }
5369  
5370      if ( function_exists( 'apache_get_modules' ) ) {
5371          $mods = apache_get_modules();
5372          if ( in_array( $mod, $mods, true ) ) {
5373              return true;
5374          }
5375      } elseif ( function_exists( 'phpinfo' ) && false === strpos( ini_get( 'disable_functions' ), 'phpinfo' ) ) {
5376              ob_start();
5377              phpinfo( 8 );
5378              $phpinfo = ob_get_clean();
5379          if ( false !== strpos( $phpinfo, $mod ) ) {
5380              return true;
5381          }
5382      }
5383  
5384      return $default;
5385  }
5386  
5387  /**
5388   * Check if IIS 7+ supports pretty permalinks.
5389   *
5390   * @since 2.8.0
5391   *
5392   * @global bool $is_iis7
5393   *
5394   * @return bool Whether IIS7 supports permalinks.
5395   */
5396  function iis7_supports_permalinks() {
5397      global $is_iis7;
5398  
5399      $supports_permalinks = false;
5400      if ( $is_iis7 ) {
5401          /* First we check if the DOMDocument class exists. If it does not exist, then we cannot
5402           * easily update the xml configuration file, hence we just bail out and tell user that
5403           * pretty permalinks cannot be used.
5404           *
5405           * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
5406           * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
5407           * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
5408           * via ISAPI then pretty permalinks will not work.
5409           */
5410          $supports_permalinks = class_exists( 'DOMDocument', false ) && isset( $_SERVER['IIS_UrlRewriteModule'] ) && ( 'cgi-fcgi' === PHP_SAPI );
5411      }
5412  
5413      /**
5414       * Filters whether IIS 7+ supports pretty permalinks.
5415       *
5416       * @since 2.8.0
5417       *
5418       * @param bool $supports_permalinks Whether IIS7 supports permalinks. Default false.
5419       */
5420      return apply_filters( 'iis7_supports_permalinks', $supports_permalinks );
5421  }
5422  
5423  /**
5424   * Validates a file name and path against an allowed set of rules.
5425   *
5426   * A return value of `1` means the file path contains directory traversal.
5427   *
5428   * A return value of `2` means the file path contains a Windows drive path.
5429   *
5430   * A return value of `3` means the file is not in the allowed files list.
5431   *
5432   * @since 1.2.0
5433   *
5434   * @param string   $file          File path.
5435   * @param string[] $allowed_files Optional. Array of allowed files.
5436   * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
5437   */
5438  function validate_file( $file, $allowed_files = array() ) {
5439      // `../` on its own is not allowed:
5440      if ( '../' === $file ) {
5441          return 1;
5442      }
5443  
5444      // More than one occurence of `../` is not allowed:
5445      if ( preg_match_all( '#\.\./#', $file, $matches, PREG_SET_ORDER ) && ( count( $matches ) > 1 ) ) {
5446          return 1;
5447      }
5448  
5449      // `../` which does not occur at the end of the path is not allowed:
5450      if ( false !== strpos( $file, '../' ) && '../' !== mb_substr( $file, -3, 3 ) ) {
5451          return 1;
5452      }
5453  
5454      // Files not in the allowed file list are not allowed:
5455      if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files, true ) ) {
5456          return 3;
5457      }
5458  
5459      // Absolute Windows drive paths are not allowed:
5460      if ( ':' === substr( $file, 1, 1 ) ) {
5461          return 2;
5462      }
5463  
5464      return 0;
5465  }
5466  
5467  /**
5468   * Whether to force SSL used for the Administration Screens.
5469   *
5470   * @since 2.6.0
5471   *
5472   * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
5473   * @return bool True if forced, false if not forced.
5474   */
5475  function force_ssl_admin( $force = null ) {
5476      static $forced = false;
5477  
5478      if ( ! is_null( $force ) ) {
5479          $old_forced = $forced;
5480          $forced     = $force;
5481          return $old_forced;
5482      }
5483  
5484      return $forced;
5485  }
5486  
5487  /**
5488   * Guess the URL for the site.
5489   *
5490   * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
5491   * directory.
5492   *
5493   * @since 2.6.0
5494   *
5495   * @return string The guessed URL.
5496   */
5497  function wp_guess_url() {
5498      if ( defined( 'WP_SITEURL' ) && '' !== WP_SITEURL ) {
5499          $url = WP_SITEURL;
5500      } else {
5501          $abspath_fix         = str_replace( '\\', '/', ABSPATH );
5502          $script_filename_dir = dirname( $_SERVER['SCRIPT_FILENAME'] );
5503  
5504          // The request is for the admin.
5505          if ( strpos( $_SERVER['REQUEST_URI'], 'wp-admin' ) !== false || strpos( $_SERVER['REQUEST_URI'], 'wp-login.php' ) !== false ) {
5506              $path = preg_replace( '#/(wp-admin/.*|wp-login.php)#i', '', $_SERVER['REQUEST_URI'] );
5507  
5508              // The request is for a file in ABSPATH.
5509          } elseif ( $script_filename_dir . '/' === $abspath_fix ) {
5510              // Strip off any file/query params in the path.
5511              $path = preg_replace( '#/[^/]*$#i', '', $_SERVER['PHP_SELF'] );
5512  
5513          } else {
5514              if ( false !== strpos( $_SERVER['SCRIPT_FILENAME'], $abspath_fix ) ) {
5515                  // Request is hitting a file inside ABSPATH.
5516                  $directory = str_replace( ABSPATH, '', $script_filename_dir );
5517                  // Strip off the subdirectory, and any file/query params.
5518                  $path = preg_replace( '#/' . preg_quote( $directory, '#' ) . '/[^/]*$#i', '', $_SERVER['REQUEST_URI'] );
5519              } elseif ( false !== strpos( $abspath_fix, $script_filename_dir ) ) {
5520                  // Request is hitting a file above ABSPATH.
5521                  $subdirectory = substr( $abspath_fix, strpos( $abspath_fix, $script_filename_dir ) + strlen( $script_filename_dir ) );
5522                  // Strip off any file/query params from the path, appending the subdirectory to the installation.
5523                  $path = preg_replace( '#/[^/]*$#i', '', $_SERVER['REQUEST_URI'] ) . $subdirectory;
5524              } else {
5525                  $path = $_SERVER['REQUEST_URI'];
5526              }
5527          }
5528  
5529          $schema = is_ssl() ? 'https://' : 'http://'; // set_url_scheme() is not defined yet.
5530          $url    = $schema . $_SERVER['HTTP_HOST'] . $path;
5531      }
5532  
5533      return rtrim( $url, '/' );
5534  }
5535  
5536  /**
5537   * Temporarily suspend cache additions.
5538   *
5539   * Stops more data being added to the cache, but still allows cache retrieval.
5540   * This is useful for actions, such as imports, when a lot of data would otherwise
5541   * be almost uselessly added to the cache.
5542   *
5543   * Suspension lasts for a single page load at most. Remember to call this
5544   * function again if you wish to re-enable cache adds earlier.
5545   *
5546   * @since 3.3.0
5547   *
5548   * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
5549   * @return bool The current suspend setting
5550   */
5551  function wp_suspend_cache_addition( $suspend = null ) {
5552      static $_suspend = false;
5553  
5554      if ( is_bool( $suspend ) ) {
5555          $_suspend = $suspend;
5556      }
5557  
5558      return $_suspend;
5559  }
5560  
5561  /**
5562   * Suspend cache invalidation.
5563   *
5564   * Turns cache invalidation on and off. Useful during imports where you don't want to do
5565   * invalidations every time a post is inserted. Callers must be sure that what they are
5566   * doing won't lead to an inconsistent cache when invalidation is suspended.
5567   *
5568   * @since 2.7.0
5569   *
5570   * @global bool $_wp_suspend_cache_invalidation
5571   *
5572   * @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true.
5573   * @return bool The current suspend setting.
5574   */
5575  function wp_suspend_cache_invalidation( $suspend = true ) {
5576      global $_wp_suspend_cache_invalidation;
5577  
5578      $current_suspend                = $_wp_suspend_cache_invalidation;
5579      $_wp_suspend_cache_invalidation = $suspend;
5580      return $current_suspend;
5581  }
5582  
5583  /**
5584   * Determine whether a site is the main site of the current network.
5585   *
5586