[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

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 null|bool Returns false if 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 bool|string False on failure, headers on success.
 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 parameters 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 variables to remove.
1217       *
1218       * @since 4.2.0
1219       *
1220       * @param string[] $removable_query_args An array of query variables 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 in wp_no_robots().
1644   */
1645  function do_robots() {
1646      header( 'Content-Type: text/plain; charset=utf-8' );
1647  
1648      /**
1649       * Fires when displaying the robots.txt file.
1650       *
1651       * @since 2.1.0
1652       */
1653      do_action( 'do_robotstxt' );
1654  
1655      $output = "User-agent: *\n";
1656      $public = get_option( 'blog_public' );
1657  
1658      $site_url = parse_url( site_url() );
1659      $path     = ( ! empty( $site_url['path'] ) ) ? $site_url['path'] : '';
1660      $output  .= "Disallow: $path/wp-admin/\n";
1661      $output  .= "Allow: $path/wp-admin/admin-ajax.php\n";
1662  
1663      /**
1664       * Filters the robots.txt output.
1665       *
1666       * @since 3.0.0
1667       *
1668       * @param string $output The robots.txt output.
1669       * @param bool   $public Whether the site is considered "public".
1670       */
1671      echo apply_filters( 'robots_txt', $output, $public );
1672  }
1673  
1674  /**
1675   * Display the favicon.ico file content.
1676   *
1677   * @since 5.4.0
1678   */
1679  function do_favicon() {
1680      /**
1681       * Fires when serving the favicon.ico file.
1682       *
1683       * @since 5.4.0
1684       */
1685      do_action( 'do_faviconico' );
1686  
1687      wp_redirect( get_site_icon_url( 32, includes_url( 'images/w-logo-blue-white-bg.png' ) ) );
1688      exit;
1689  }
1690  
1691  /**
1692   * Determines whether WordPress is already installed.
1693   *
1694   * The cache will be checked first. If you have a cache plugin, which saves
1695   * the cache values, then this will work. If you use the default WordPress
1696   * cache, and the database goes away, then you might have problems.
1697   *
1698   * Checks for the 'siteurl' option for whether WordPress is installed.
1699   *
1700   * For more information on this and similar theme functions, check out
1701   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
1702   * Conditional Tags} article in the Theme Developer Handbook.
1703   *
1704   * @since 2.1.0
1705   *
1706   * @global wpdb $wpdb WordPress database abstraction object.
1707   *
1708   * @return bool Whether the site is already installed.
1709   */
1710  function is_blog_installed() {
1711      global $wpdb;
1712  
1713      /*
1714       * Check cache first. If options table goes away and we have true
1715       * cached, oh well.
1716       */
1717      if ( wp_cache_get( 'is_blog_installed' ) ) {
1718          return true;
1719      }
1720  
1721      $suppress = $wpdb->suppress_errors();
1722      if ( ! wp_installing() ) {
1723          $alloptions = wp_load_alloptions();
1724      }
1725      // If siteurl is not set to autoload, check it specifically.
1726      if ( ! isset( $alloptions['siteurl'] ) ) {
1727          $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
1728      } else {
1729          $installed = $alloptions['siteurl'];
1730      }
1731      $wpdb->suppress_errors( $suppress );
1732  
1733      $installed = ! empty( $installed );
1734      wp_cache_set( 'is_blog_installed', $installed );
1735  
1736      if ( $installed ) {
1737          return true;
1738      }
1739  
1740      // If visiting repair.php, return true and let it take over.
1741      if ( defined( 'WP_REPAIRING' ) ) {
1742          return true;
1743      }
1744  
1745      $suppress = $wpdb->suppress_errors();
1746  
1747      /*
1748       * Loop over the WP tables. If none exist, then scratch installation is allowed.
1749       * If one or more exist, suggest table repair since we got here because the
1750       * options table could not be accessed.
1751       */
1752      $wp_tables = $wpdb->tables();
1753      foreach ( $wp_tables as $table ) {
1754          // The existence of custom user tables shouldn't suggest an unwise state or prevent a clean installation.
1755          if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table ) {
1756              continue;
1757          }
1758          if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table ) {
1759              continue;
1760          }
1761  
1762          $described_table = $wpdb->get_results( "DESCRIBE $table;" );
1763          if (
1764              ( ! $described_table && empty( $wpdb->last_error ) ) ||
1765              ( is_array( $described_table ) && 0 === count( $described_table ) )
1766          ) {
1767              continue;
1768          }
1769  
1770          // One or more tables exist. This is not good.
1771  
1772          wp_load_translations_early();
1773  
1774          // Die with a DB error.
1775          $wpdb->error = sprintf(
1776              /* translators: %s: Database repair URL. */
1777              __( 'One or more database tables are unavailable. The database may need to be <a href="%s">repaired</a>.' ),
1778              'maint/repair.php?referrer=is_blog_installed'
1779          );
1780  
1781          dead_db();
1782      }
1783  
1784      $wpdb->suppress_errors( $suppress );
1785  
1786      wp_cache_set( 'is_blog_installed', false );
1787  
1788      return false;
1789  }
1790  
1791  /**
1792   * Retrieve URL with nonce added to URL query.
1793   *
1794   * @since 2.0.4
1795   *
1796   * @param string     $actionurl URL to add nonce action.
1797   * @param int|string $action    Optional. Nonce action name. Default -1.
1798   * @param string     $name      Optional. Nonce name. Default '_wpnonce'.
1799   * @return string Escaped URL with nonce action added.
1800   */
1801  function wp_nonce_url( $actionurl, $action = -1, $name = '_wpnonce' ) {
1802      $actionurl = str_replace( '&amp;', '&', $actionurl );
1803      return esc_html( add_query_arg( $name, wp_create_nonce( $action ), $actionurl ) );
1804  }
1805  
1806  /**
1807   * Retrieve or display nonce hidden field for forms.
1808   *
1809   * The nonce field is used to validate that the contents of the form came from
1810   * the location on the current site and not somewhere else. The nonce does not
1811   * offer absolute protection, but should protect against most cases. It is very
1812   * important to use nonce field in forms.
1813   *
1814   * The $action and $name are optional, but if you want to have better security,
1815   * it is strongly suggested to set those two parameters. It is easier to just
1816   * call the function without any parameters, because validation of the nonce
1817   * doesn't require any parameters, but since crackers know what the default is
1818   * it won't be difficult for them to find a way around your nonce and cause
1819   * damage.
1820   *
1821   * The input name will be whatever $name value you gave. The input value will be
1822   * the nonce creation value.
1823   *
1824   * @since 2.0.4
1825   *
1826   * @param int|string $action  Optional. Action name. Default -1.
1827   * @param string     $name    Optional. Nonce name. Default '_wpnonce'.
1828   * @param bool       $referer Optional. Whether to set the referer field for validation. Default true.
1829   * @param bool       $echo    Optional. Whether to display or return hidden form field. Default true.
1830   * @return string Nonce field HTML markup.
1831   */
1832  function wp_nonce_field( $action = -1, $name = '_wpnonce', $referer = true, $echo = true ) {
1833      $name        = esc_attr( $name );
1834      $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
1835  
1836      if ( $referer ) {
1837          $nonce_field .= wp_referer_field( false );
1838      }
1839  
1840      if ( $echo ) {
1841          echo $nonce_field;
1842      }
1843  
1844      return $nonce_field;
1845  }
1846  
1847  /**
1848   * Retrieve or display referer hidden field for forms.
1849   *
1850   * The referer link is the current Request URI from the server super global. The
1851   * input name is '_wp_http_referer', in case you wanted to check manually.
1852   *
1853   * @since 2.0.4
1854   *
1855   * @param bool $echo Optional. Whether to echo or return the referer field. Default true.
1856   * @return string Referer field HTML markup.
1857   */
1858  function wp_referer_field( $echo = true ) {
1859      $referer_field = '<input type="hidden" name="_wp_http_referer" value="' . esc_attr( wp_unslash( $_SERVER['REQUEST_URI'] ) ) . '" />';
1860  
1861      if ( $echo ) {
1862          echo $referer_field;
1863      }
1864  
1865      return $referer_field;
1866  }
1867  
1868  /**
1869   * Retrieve or display original referer hidden field for forms.
1870   *
1871   * The input name is '_wp_original_http_referer' and will be either the same
1872   * value of wp_referer_field(), if that was posted already or it will be the
1873   * current page, if it doesn't exist.
1874   *
1875   * @since 2.0.4
1876   *
1877   * @param bool   $echo         Optional. Whether to echo the original http referer. Default true.
1878   * @param string $jump_back_to Optional. Can be 'previous' or page you want to jump back to.
1879   *                             Default 'current'.
1880   * @return string Original referer field.
1881   */
1882  function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
1883      $ref = wp_get_original_referer();
1884  
1885      if ( ! $ref ) {
1886          $ref = ( 'previous' === $jump_back_to ) ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] );
1887      }
1888  
1889      $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( $ref ) . '" />';
1890  
1891      if ( $echo ) {
1892          echo $orig_referer_field;
1893      }
1894  
1895      return $orig_referer_field;
1896  }
1897  
1898  /**
1899   * Retrieve referer from '_wp_http_referer' or HTTP referer.
1900   *
1901   * If it's the same as the current request URL, will return false.
1902   *
1903   * @since 2.0.4
1904   *
1905   * @return string|false Referer URL on success, false on failure.
1906   */
1907  function wp_get_referer() {
1908      if ( ! function_exists( 'wp_validate_redirect' ) ) {
1909          return false;
1910      }
1911  
1912      $ref = wp_get_raw_referer();
1913  
1914      if ( $ref && wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref && home_url() . wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref ) {
1915          return wp_validate_redirect( $ref, false );
1916      }
1917  
1918      return false;
1919  }
1920  
1921  /**
1922   * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
1923   *
1924   * Do not use for redirects, use wp_get_referer() instead.
1925   *
1926   * @since 4.5.0
1927   *
1928   * @return string|false Referer URL on success, false on failure.
1929   */
1930  function wp_get_raw_referer() {
1931      if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
1932          return wp_unslash( $_REQUEST['_wp_http_referer'] );
1933      } elseif ( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
1934          return wp_unslash( $_SERVER['HTTP_REFERER'] );
1935      }
1936  
1937      return false;
1938  }
1939  
1940  /**
1941   * Retrieve original referer that was posted, if it exists.
1942   *
1943   * @since 2.0.4
1944   *
1945   * @return string|false Original referer URL on success, false on failure.
1946   */
1947  function wp_get_original_referer() {
1948      if ( ! empty( $_REQUEST['_wp_original_http_referer'] ) && function_exists( 'wp_validate_redirect' ) ) {
1949          return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false );
1950      }
1951  
1952      return false;
1953  }
1954  
1955  /**
1956   * Recursive directory creation based on full path.
1957   *
1958   * Will attempt to set permissions on folders.
1959   *
1960   * @since 2.0.1
1961   *
1962   * @param string $target Full path to attempt to create.
1963   * @return bool Whether the path was created. True if path already exists.
1964   */
1965  function wp_mkdir_p( $target ) {
1966      $wrapper = null;
1967  
1968      // Strip the protocol.
1969      if ( wp_is_stream( $target ) ) {
1970          list( $wrapper, $target ) = explode( '://', $target, 2 );
1971      }
1972  
1973      // From php.net/mkdir user contributed notes.
1974      $target = str_replace( '//', '/', $target );
1975  
1976      // Put the wrapper back on the target.
1977      if ( null !== $wrapper ) {
1978          $target = $wrapper . '://' . $target;
1979      }
1980  
1981      /*
1982       * Safe mode fails with a trailing slash under certain PHP versions.
1983       * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
1984       */
1985      $target = rtrim( $target, '/' );
1986      if ( empty( $target ) ) {
1987          $target = '/';
1988      }
1989  
1990      if ( file_exists( $target ) ) {
1991          return @is_dir( $target );
1992      }
1993  
1994      // Do not allow path traversals.
1995      if ( false !== strpos( $target, '../' ) || false !== strpos( $target, '..' . DIRECTORY_SEPARATOR ) ) {
1996          return false;
1997      }
1998  
1999      // We need to find the permissions of the parent folder that exists and inherit that.
2000      $target_parent = dirname( $target );
2001      while ( '.' !== $target_parent && ! is_dir( $target_parent ) && dirname( $target_parent ) !== $target_parent ) {
2002          $target_parent = dirname( $target_parent );
2003      }
2004  
2005      // Get the permission bits.
2006      $stat = @stat( $target_parent );
2007      if ( $stat ) {
2008          $dir_perms = $stat['mode'] & 0007777;
2009      } else {
2010          $dir_perms = 0777;
2011      }
2012  
2013      if ( @mkdir( $target, $dir_perms, true ) ) {
2014  
2015          /*
2016           * If a umask is set that modifies $dir_perms, we'll have to re-set
2017           * the $dir_perms correctly with chmod()
2018           */
2019          if ( ( $dir_perms & ~umask() ) != $dir_perms ) {
2020              $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) );
2021              for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) {
2022                  chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms );
2023              }
2024          }
2025  
2026          return true;
2027      }
2028  
2029      return false;
2030  }
2031  
2032  /**
2033   * Test if a given filesystem path is absolute.
2034   *
2035   * For example, '/foo/bar', or 'c:\windows'.
2036   *
2037   * @since 2.5.0
2038   *
2039   * @param string $path File path.
2040   * @return bool True if path is absolute, false is not absolute.
2041   */
2042  function path_is_absolute( $path ) {
2043      /*
2044       * Check to see if the path is a stream and check to see if its an actual
2045       * path or file as realpath() does not support stream wrappers.
2046       */
2047      if ( wp_is_stream( $path ) && ( is_dir( $path ) || is_file( $path ) ) ) {
2048          return true;
2049      }
2050  
2051      /*
2052       * This is definitive if true but fails if $path does not exist or contains
2053       * a symbolic link.
2054       */
2055      if ( realpath( $path ) == $path ) {
2056          return true;
2057      }
2058  
2059      if ( strlen( $path ) == 0 || '.' === $path[0] ) {
2060          return false;
2061      }
2062  
2063      // Windows allows absolute paths like this.
2064      if ( preg_match( '#^[a-zA-Z]:\\\\#', $path ) ) {
2065          return true;
2066      }
2067  
2068      // A path starting with / or \ is absolute; anything else is relative.
2069      return ( '/' === $path[0] || '\\' === $path[0] );
2070  }
2071  
2072  /**
2073   * Join two filesystem paths together.
2074   *
2075   * For example, 'give me $path relative to $base'. If the $path is absolute,
2076   * then it the full path is returned.
2077   *
2078   * @since 2.5.0
2079   *
2080   * @param string $base Base path.
2081   * @param string $path Path relative to $base.
2082   * @return string The path with the base or absolute path.
2083   */
2084  function path_join( $base, $path ) {
2085      if ( path_is_absolute( $path ) ) {
2086          return $path;
2087      }
2088  
2089      return rtrim( $base, '/' ) . '/' . ltrim( $path, '/' );
2090  }
2091  
2092  /**
2093   * Normalize a filesystem path.
2094   *
2095   * On windows systems, replaces backslashes with forward slashes
2096   * and forces upper-case drive letters.
2097   * Allows for two leading slashes for Windows network shares, but
2098   * ensures that all other duplicate slashes are reduced to a single.
2099   *
2100   * @since 3.9.0
2101   * @since 4.4.0 Ensures upper-case drive letters on Windows systems.
2102   * @since 4.5.0 Allows for Windows network shares.
2103   * @since 4.9.7 Allows for PHP file wrappers.
2104   *
2105   * @param string $path Path to normalize.
2106   * @return string Normalized path.
2107   */
2108  function wp_normalize_path( $path ) {
2109      $wrapper = '';
2110  
2111      if ( wp_is_stream( $path ) ) {
2112          list( $wrapper, $path ) = explode( '://', $path, 2 );
2113  
2114          $wrapper .= '://';
2115      }
2116  
2117      // Standardise all paths to use '/'.
2118      $path = str_replace( '\\', '/', $path );
2119  
2120      // Replace multiple slashes down to a singular, allowing for network shares having two slashes.
2121      $path = preg_replace( '|(?<=.)/+|', '/', $path );
2122  
2123      // Windows paths should uppercase the drive letter.
2124      if ( ':' === substr( $path, 1, 1 ) ) {
2125          $path = ucfirst( $path );
2126      }
2127  
2128      return $wrapper . $path;
2129  }
2130  
2131  /**
2132   * Determine a writable directory for temporary files.
2133   *
2134   * Function's preference is the return value of sys_get_temp_dir(),
2135   * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR,
2136   * before finally defaulting to /tmp/
2137   *
2138   * In the event that this function does not find a writable location,
2139   * It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file.
2140   *
2141   * @since 2.5.0
2142   *
2143   * @return string Writable temporary directory.
2144   */
2145  function get_temp_dir() {
2146      static $temp = '';
2147      if ( defined( 'WP_TEMP_DIR' ) ) {
2148          return trailingslashit( WP_TEMP_DIR );
2149      }
2150  
2151      if ( $temp ) {
2152          return trailingslashit( $temp );
2153      }
2154  
2155      if ( function_exists( 'sys_get_temp_dir' ) ) {
2156          $temp = sys_get_temp_dir();
2157          if ( @is_dir( $temp ) && wp_is_writable( $temp ) ) {
2158              return trailingslashit( $temp );
2159          }
2160      }
2161  
2162      $temp = ini_get( 'upload_tmp_dir' );
2163      if ( @is_dir( $temp ) && wp_is_writable( $temp ) ) {
2164          return trailingslashit( $temp );
2165      }
2166  
2167      $temp = WP_CONTENT_DIR . '/';
2168      if ( is_dir( $temp ) && wp_is_writable( $temp ) ) {
2169          return $temp;
2170      }
2171  
2172      return '/tmp/';
2173  }
2174  
2175  /**
2176   * Determine if a directory is writable.
2177   *
2178   * This function is used to work around certain ACL issues in PHP primarily
2179   * affecting Windows Servers.
2180   *
2181   * @since 3.6.0
2182   *
2183   * @see win_is_writable()
2184   *
2185   * @param string $path Path to check for write-ability.
2186   * @return bool Whether the path is writable.
2187   */
2188  function wp_is_writable( $path ) {
2189      if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
2190          return win_is_writable( $path );
2191      } else {
2192          return @is_writable( $path );
2193      }
2194  }
2195  
2196  /**
2197   * Workaround for Windows bug in is_writable() function
2198   *
2199   * PHP has issues with Windows ACL's for determine if a
2200   * directory is writable or not, this works around them by
2201   * checking the ability to open files rather than relying
2202   * upon PHP to interprate the OS ACL.
2203   *
2204   * @since 2.8.0
2205   *
2206   * @see https://bugs.php.net/bug.php?id=27609
2207   * @see https://bugs.php.net/bug.php?id=30931
2208   *
2209   * @param string $path Windows path to check for write-ability.
2210   * @return bool Whether the path is writable.
2211   */
2212  function win_is_writable( $path ) {
2213      if ( '/' === $path[ strlen( $path ) - 1 ] ) {
2214          // If it looks like a directory, check a random file within the directory.
2215          return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp' );
2216      } elseif ( is_dir( $path ) ) {
2217          // If it's a directory (and not a file), check a random file within the directory.
2218          return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
2219      }
2220  
2221      // Check tmp file for read/write capabilities.
2222      $should_delete_tmp_file = ! file_exists( $path );
2223  
2224      $f = @fopen( $path, 'a' );
2225      if ( false === $f ) {
2226          return false;
2227      }
2228      fclose( $f );
2229  
2230      if ( $should_delete_tmp_file ) {
2231          unlink( $path );
2232      }
2233  
2234      return true;
2235  }
2236  
2237  /**
2238   * Retrieves uploads directory information.
2239   *
2240   * Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory.
2241   * Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases
2242   * when not uploading files.
2243   *
2244   * @since 4.5.0
2245   *
2246   * @see wp_upload_dir()
2247   *
2248   * @return array See wp_upload_dir() for description.
2249   */
2250  function wp_get_upload_dir() {
2251      return wp_upload_dir( null, false );
2252  }
2253  
2254  /**
2255   * Returns an array containing the current upload directory's path and URL.
2256   *
2257   * Checks the 'upload_path' option, which should be from the web root folder,
2258   * and if it isn't empty it will be used. If it is empty, then the path will be
2259   * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
2260   * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
2261   *
2262   * The upload URL path is set either by the 'upload_url_path' option or by using
2263   * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
2264   *
2265   * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
2266   * the administration settings panel), then the time will be used. The format
2267   * will be year first and then month.
2268   *
2269   * If the path couldn't be created, then an error will be returned with the key
2270   * 'error' containing the error message. The error suggests that the parent
2271   * directory is not writable by the server.
2272   *
2273   * @since 2.0.0
2274   * @uses _wp_upload_dir()
2275   *
2276   * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
2277   * @param bool   $create_dir Optional. Whether to check and create the uploads directory.
2278   *                           Default true for backward compatibility.
2279   * @param bool   $refresh_cache Optional. Whether to refresh the cache. Default false.
2280   * @return array {
2281   *     Array of information about the upload directory.
2282   *
2283   *     @type string       $path    Base directory and subdirectory or full path to upload directory.
2284   *     @type string       $url     Base URL and subdirectory or absolute URL to upload directory.
2285   *     @type string       $subdir  Subdirectory if uploads use year/month folders option is on.
2286   *     @type string       $basedir Path without subdir.
2287   *     @type string       $baseurl URL path without subdir.
2288   *     @type string|false $error   False or error message.
2289   * }
2290   */
2291  function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
2292      static $cache = array(), $tested_paths = array();
2293  
2294      $key = sprintf( '%d-%s', get_current_blog_id(), (string) $time );
2295  
2296      if ( $refresh_cache || empty( $cache[ $key ] ) ) {
2297          $cache[ $key ] = _wp_upload_dir( $time );
2298      }
2299  
2300      /**
2301       * Filters the uploads directory data.
2302       *
2303       * @since 2.0.0
2304       *
2305       * @param array $uploads {
2306       *     Array of information about the upload directory.
2307       *
2308       *     @type string       $path    Base directory and subdirectory or full path to upload directory.
2309       *     @type string       $url     Base URL and subdirectory or absolute URL to upload directory.
2310       *     @type string       $subdir  Subdirectory if uploads use year/month folders option is on.
2311       *     @type string       $basedir Path without subdir.
2312       *     @type string       $baseurl URL path without subdir.
2313       *     @type string|false $error   False or error message.
2314       * }
2315       */
2316      $uploads = apply_filters( 'upload_dir', $cache[ $key ] );
2317  
2318      if ( $create_dir ) {
2319          $path = $uploads['path'];
2320  
2321          if ( array_key_exists( $path, $tested_paths ) ) {
2322              $uploads['error'] = $tested_paths[ $path ];
2323          } else {
2324              if ( ! wp_mkdir_p( $path ) ) {
2325                  if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) {
2326                      $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
2327                  } else {
2328                      $error_path = wp_basename( $uploads['basedir'] ) . $uploads['subdir'];
2329                  }
2330  
2331                  $uploads['error'] = sprintf(
2332                      /* translators: %s: Directory path. */
2333                      __( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
2334                      esc_html( $error_path )
2335                  );
2336              }
2337  
2338              $tested_paths[ $path ] = $uploads['error'];
2339          }
2340      }
2341  
2342      return $uploads;
2343  }
2344  
2345  /**
2346   * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
2347   *
2348   * @since 4.5.0
2349   * @access private
2350   *
2351   * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
2352   * @return array See wp_upload_dir()
2353   */
2354  function _wp_upload_dir( $time = null ) {
2355      $siteurl     = get_option( 'siteurl' );
2356      $upload_path = trim( get_option( 'upload_path' ) );
2357  
2358      if ( empty( $upload_path ) || 'wp-content/uploads' === $upload_path ) {
2359          $dir = WP_CONTENT_DIR . '/uploads';
2360      } elseif ( 0 !== strpos( $upload_path, ABSPATH ) ) {
2361          // $dir is absolute, $upload_path is (maybe) relative to ABSPATH.
2362          $dir = path_join( ABSPATH, $upload_path );
2363      } else {
2364          $dir = $upload_path;
2365      }
2366  
2367      $url = get_option( 'upload_url_path' );
2368      if ( ! $url ) {
2369          if ( empty( $upload_path ) || ( 'wp-content/uploads' === $upload_path ) || ( $upload_path == $dir ) ) {
2370              $url = WP_CONTENT_URL . '/uploads';
2371          } else {
2372              $url = trailingslashit( $siteurl ) . $upload_path;
2373          }
2374      }
2375  
2376      /*
2377       * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
2378       * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
2379       */
2380      if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {
2381          $dir = ABSPATH . UPLOADS;
2382          $url = trailingslashit( $siteurl ) . UPLOADS;
2383      }
2384  
2385      // If multisite (and if not the main site in a post-MU network).
2386      if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) {
2387  
2388          if ( ! get_site_option( 'ms_files_rewriting' ) ) {
2389              /*
2390               * If ms-files rewriting is disabled (networks created post-3.5), it is fairly
2391               * straightforward: Append sites/%d if we're not on the main site (for post-MU
2392               * networks). (The extra directory prevents a four-digit ID from conflicting with
2393               * a year-based directory for the main site. But if a MU-era network has disabled
2394               * ms-files rewriting manually, they don't need the extra directory, as they never
2395               * had wp-content/uploads for the main site.)
2396               */
2397  
2398              if ( defined( 'MULTISITE' ) ) {
2399                  $ms_dir = '/sites/' . get_current_blog_id();
2400              } else {
2401                  $ms_dir = '/' . get_current_blog_id();
2402              }
2403  
2404              $dir .= $ms_dir;
2405              $url .= $ms_dir;
2406  
2407          } elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {
2408              /*
2409               * Handle the old-form ms-files.php rewriting if the network still has that enabled.
2410               * When ms-files rewriting is enabled, then we only listen to UPLOADS when:
2411               * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used
2412               *    there, and
2413               * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect
2414               *    the original blog ID.
2415               *
2416               * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
2417               * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
2418               * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
2419               * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
2420               */
2421  
2422              if ( defined( 'BLOGUPLOADDIR' ) ) {
2423                  $dir = untrailingslashit( BLOGUPLOADDIR );
2424              } else {
2425                  $dir = ABSPATH . UPLOADS;
2426              }
2427              $url = trailingslashit( $siteurl ) . 'files';
2428          }
2429      }
2430  
2431      $basedir = $dir;
2432      $baseurl = $url;
2433  
2434      $subdir = '';
2435      if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
2436          // Generate the yearly and monthly directories.
2437          if ( ! $time ) {
2438              $time = current_time( 'mysql' );
2439          }
2440          $y      = substr( $time, 0, 4 );
2441          $m      = substr( $time, 5, 2 );
2442          $subdir = "/$y/$m";
2443      }
2444  
2445      $dir .= $subdir;
2446      $url .= $subdir;
2447  
2448      return array(
2449          'path'    => $dir,
2450          'url'     => $url,
2451          'subdir'  => $subdir,
2452          'basedir' => $basedir,
2453          'baseurl' => $baseurl,
2454          'error'   => false,
2455      );
2456  }
2457  
2458  /**
2459   * Get a filename that is sanitized and unique for the given directory.
2460   *
2461   * If the filename is not unique, then a number will be added to the filename
2462   * before the extension, and will continue adding numbers until the filename
2463   * is unique.
2464   *
2465   * The callback function allows the caller to use their own method to create
2466   * unique file names. If defined, the callback should take three arguments:
2467   * - directory, base filename, and extension - and return a unique filename.
2468   *
2469   * @since 2.5.0
2470   *
2471   * @param string   $dir                      Directory.
2472   * @param string   $filename                 File name.
2473   * @param callable $unique_filename_callback Callback. Default null.
2474   * @return string New filename, if given wasn't unique.
2475   */
2476  function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
2477      // Sanitize the file name before we begin processing.
2478      $filename = sanitize_file_name( $filename );
2479      $ext2     = null;
2480  
2481      // Separate the filename into a name and extension.
2482      $ext  = pathinfo( $filename, PATHINFO_EXTENSION );
2483      $name = pathinfo( $filename, PATHINFO_BASENAME );
2484  
2485      if ( $ext ) {
2486          $ext = '.' . $ext;
2487      }
2488  
2489      // Edge case: if file is named '.ext', treat as an empty name.
2490      if ( $name === $ext ) {
2491          $name = '';
2492      }
2493  
2494      /*
2495       * Increment the file number until we have a unique file to save in $dir.
2496       * Use callback if supplied.
2497       */
2498      if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
2499          $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
2500      } else {
2501          $number = '';
2502          $fname  = pathinfo( $filename, PATHINFO_FILENAME );
2503  
2504          // Always append a number to file names that can potentially match image sub-size file names.
2505          if ( $fname && preg_match( '/-(?:\d+x\d+|scaled|rotated)$/', $fname ) ) {
2506              $number = 1;
2507  
2508              // At this point the file name may not be unique. This is tested below and the $number is incremented.
2509              $filename = str_replace( "{$fname}{$ext}", "{$fname}-{$number}{$ext}", $filename );
2510          }
2511  
2512          // Change '.ext' to lower case.
2513          if ( $ext && strtolower( $ext ) != $ext ) {
2514              $ext2      = strtolower( $ext );
2515              $filename2 = preg_replace( '|' . preg_quote( $ext ) . '$|', $ext2, $filename );
2516  
2517              // Check for both lower and upper case extension or image sub-sizes may be overwritten.
2518              while ( file_exists( $dir . "/{$filename}" ) || file_exists( $dir . "/{$filename2}" ) ) {
2519                  $new_number = (int) $number + 1;
2520                  $filename   = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
2521                  $filename2  = str_replace( array( "-{$number}{$ext2}", "{$number}{$ext2}" ), "-{$new_number}{$ext2}", $filename2 );
2522                  $number     = $new_number;
2523              }
2524  
2525              $filename = $filename2;
2526          } else {
2527              while ( file_exists( $dir . "/{$filename}" ) ) {
2528                  $new_number = (int) $number + 1;
2529  
2530                  if ( '' === "{$number}{$ext}" ) {
2531                      $filename = "{$filename}-{$new_number}";
2532                  } else {
2533                      $filename = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename );
2534                  }
2535  
2536                  $number = $new_number;
2537              }
2538          }
2539  
2540          // Prevent collisions with existing file names that contain dimension-like strings
2541          // (whether they are subsizes or originals uploaded prior to #42437).
2542          $upload_dir = wp_get_upload_dir();
2543  
2544          // The (resized) image files would have name and extension, and will be in the uploads dir.
2545          if ( $name && $ext && @is_dir( $dir ) && false !== strpos( $dir, $upload_dir['basedir'] ) ) {
2546              /**
2547               * Filters the file list used for calculating a unique filename for a newly added file.
2548               *
2549               * Returning an array from the filter will effectively short-circuit retrieval
2550               * from the filesystem and return the passed value instead.
2551               *
2552               * @since 5.5.0
2553               *
2554               * @param array|null $files    The list of files to use for filename comparisons.
2555               *                             Default null (to retrieve the list from the filesystem).
2556               * @param string     $dir      The directory for the new file.
2557               * @param string     $filename The proposed filename for the new file.
2558               */
2559              $files = apply_filters( 'pre_wp_unique_filename_file_list', null, $dir, $filename );
2560  
2561              if ( null === $files ) {
2562                  // List of all files and directories contained in $dir.
2563                  $files = @scandir( $dir );
2564              }
2565  
2566              if ( ! empty( $files ) ) {
2567                  // Remove "dot" dirs.
2568                  $files = array_diff( $files, array( '.', '..' ) );
2569              }
2570  
2571              if ( ! empty( $files ) ) {
2572                  // The extension case may have changed above.
2573                  $new_ext = ! empty( $ext2 ) ? $ext2 : $ext;
2574  
2575                  // Ensure this never goes into infinite loop
2576                  // as it uses pathinfo() and regex in the check, but string replacement for the changes.
2577                  $count = count( $files );
2578                  $i     = 0;
2579  
2580                  while ( $i <= $count && _wp_check_existing_file_names( $filename, $files ) ) {
2581                      $new_number = (int) $number + 1;
2582                      $filename   = str_replace( array( "-{$number}{$new_ext}", "{$number}{$new_ext}" ), "-{$new_number}{$new_ext}", $filename );
2583                      $number     = $new_number;
2584                      $i++;
2585                  }
2586              }
2587          }
2588      }
2589  
2590      /**
2591       * Filters the result when generating a unique file name.
2592       *
2593       * @since 4.5.0
2594       *
2595       * @param string        $filename                 Unique file name.
2596       * @param string        $ext                      File extension, eg. ".png".
2597       * @param string        $dir                      Directory path.
2598       * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
2599       */
2600      return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback );
2601  }
2602  
2603  /**
2604   * Helper function to check if a file name could match an existing image sub-size file name.
2605   *
2606   * @since 5.3.1
2607   * @access private
2608   *
2609   * @param string $filename The file name to check.
2610   * @param array  $files    An array of existing files in the directory.
2611   * @return bool True if the tested file name could match an existing file, false otherwise.
2612   */
2613  function _wp_check_existing_file_names( $filename, $files ) {
2614      $fname = pathinfo( $filename, PATHINFO_FILENAME );
2615      $ext   = pathinfo( $filename, PATHINFO_EXTENSION );
2616  
2617      // Edge case, file names like `.ext`.
2618      if ( empty( $fname ) ) {
2619          return false;
2620      }
2621  
2622      if ( $ext ) {
2623          $ext = ".$ext";
2624      }
2625  
2626      $regex = '/^' . preg_quote( $fname ) . '-(?:\d+x\d+|scaled|rotated)' . preg_quote( $ext ) . '$/i';
2627  
2628      foreach ( $files as $file ) {
2629          if ( preg_match( $regex, $file ) ) {
2630              return true;
2631          }
2632      }
2633  
2634      return false;
2635  }
2636  
2637  /**
2638   * Create a file in the upload folder with given content.
2639   *
2640   * If there is an error, then the key 'error' will exist with the error message.
2641   * If success, then the key 'file' will have the unique file path, the 'url' key
2642   * will have the link to the new file. and the 'error' key will be set to false.
2643   *
2644   * This function will not move an uploaded file to the upload folder. It will
2645   * create a new file with the content in $bits parameter. If you move the upload
2646   * file, read the content of the uploaded file, and then you can give the
2647   * filename and content to this function, which will add it to the upload
2648   * folder.
2649   *
2650   * The permissions will be set on the new file automatically by this function.
2651   *
2652   * @since 2.0.0
2653   *
2654   * @param string      $name       Filename.
2655   * @param null|string $deprecated Never used. Set to null.
2656   * @param string      $bits       File content
2657   * @param string      $time       Optional. Time formatted in 'yyyy/mm'. Default null.
2658   * @return array {
2659   *     Information about the newly-uploaded file.
2660   *
2661   *     @type string       $file  Filename of the newly-uploaded file.
2662   *     @type string       $url   URL of the uploaded file.
2663   *     @type string       $type  File type.
2664   *     @type string|false $error Error message, if there has been an error.
2665   * }
2666   */
2667  function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
2668      if ( ! empty( $deprecated ) ) {
2669          _deprecated_argument( __FUNCTION__, '2.0.0' );
2670      }
2671  
2672      if ( empty( $name ) ) {
2673          return array( 'error' => __( 'Empty filename' ) );
2674      }
2675  
2676      $wp_filetype = wp_check_filetype( $name );
2677      if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) ) {
2678          return array( 'error' => __( 'Sorry, this file type is not permitted for security reasons.' ) );
2679      }
2680  
2681      $upload = wp_upload_dir( $time );
2682  
2683      if ( false !== $upload['error'] ) {
2684          return $upload;
2685      }
2686  
2687      /**
2688       * Filters whether to treat the upload bits as an error.
2689       *
2690       * Returning a non-array from the filter will effectively short-circuit preparing the upload bits
2691       * and return that value instead. An error message should be returned as a string.
2692       *
2693       * @since 3.0.0
2694       *
2695       * @param array|string $upload_bits_error An array of upload bits data, or error message to return.
2696       */
2697      $upload_bits_error = apply_filters(
2698          'wp_upload_bits',
2699          array(
2700              'name' => $name,
2701              'bits' => $bits,
2702              'time' => $time,
2703          )
2704      );
2705      if ( ! is_array( $upload_bits_error ) ) {
2706          $upload['error'] = $upload_bits_error;
2707          return $upload;
2708      }
2709  
2710      $filename = wp_unique_filename( $upload['path'], $name );
2711  
2712      $new_file = $upload['path'] . "/$filename";
2713      if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
2714          if ( 0 === strpos( $upload['basedir'], ABSPATH ) ) {
2715              $error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir'];
2716          } else {
2717              $error_path = wp_basename( $upload['basedir'] ) . $upload['subdir'];
2718          }
2719  
2720          $message = sprintf(
2721              /* translators: %s: Directory path. */
2722              __( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
2723              $error_path
2724          );
2725          return array( 'error' => $message );
2726      }
2727  
2728      $ifp = @fopen( $new_file, 'wb' );
2729      if ( ! $ifp ) {
2730          return array(
2731              /* translators: %s: File name. */
2732              'error' => sprintf( __( 'Could not write file %s' ), $new_file ),
2733          );
2734      }
2735  
2736      fwrite( $ifp, $bits );
2737      fclose( $ifp );
2738      clearstatcache();
2739  
2740      // Set correct file permissions.
2741      $stat  = @ stat( dirname( $new_file ) );
2742      $perms = $stat['mode'] & 0007777;
2743      $perms = $perms & 0000666;
2744      chmod( $new_file, $perms );
2745      clearstatcache();
2746  
2747      // Compute the URL.
2748      $url = $upload['url'] . "/$filename";
2749  
2750      if ( is_multisite() ) {
2751          clean_dirsize_cache( $new_file );
2752      }
2753  
2754      /** This filter is documented in wp-admin/includes/file.php */
2755      return apply_filters(
2756          'wp_handle_upload',
2757          array(
2758              'file'  => $new_file,
2759              'url'   => $url,
2760              'type'  => $wp_filetype['type'],
2761              'error' => false,
2762          ),
2763          'sideload'
2764      );
2765  }
2766  
2767  /**
2768   * Retrieve the file type based on the extension name.
2769   *
2770   * @since 2.5.0
2771   *
2772   * @param string $ext The extension to search.
2773   * @return string|void The file type, example: audio, video, document, spreadsheet, etc.
2774   */
2775  function wp_ext2type( $ext ) {
2776      $ext = strtolower( $ext );
2777  
2778      $ext2type = wp_get_ext_types();
2779      foreach ( $ext2type as $type => $exts ) {
2780          if ( in_array( $ext, $exts, true ) ) {
2781              return $type;
2782          }
2783      }
2784  }
2785  
2786  /**
2787   * Retrieve the file type from the file name.
2788   *
2789   * You can optionally define the mime array, if needed.
2790   *
2791   * @since 2.0.4
2792   *
2793   * @param string   $filename File name or path.
2794   * @param string[] $mimes    Optional. Array of mime types keyed by their file extension regex.
2795   * @return array {
2796   *     Values for the extension and mime type.
2797   *
2798   *     @type string|false $ext  File extension, or false if the file doesn't match a mime type.
2799   *     @type string|false $type File mime type, or false if the file doesn't match a mime type.
2800   * }
2801   */
2802  function wp_check_filetype( $filename, $mimes = null ) {
2803      if ( empty( $mimes ) ) {
2804          $mimes = get_allowed_mime_types();
2805      }
2806      $type = false;
2807      $ext  = false;
2808  
2809      foreach ( $mimes as $ext_preg => $mime_match ) {
2810          $ext_preg = '!\.(' . $ext_preg . ')$!i';
2811          if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
2812              $type = $mime_match;
2813              $ext  = $ext_matches[1];
2814              break;
2815          }
2816      }
2817  
2818      return compact( 'ext', 'type' );
2819  }
2820  
2821  /**
2822   * Attempt to determine the real file type of a file.
2823   *
2824   * If unable to, the file name extension will be used to determine type.
2825   *
2826   * If it's determined that the extension does not match the file's real type,
2827   * then the "proper_filename" value will be set with a proper filename and extension.
2828   *
2829   * Currently this function only supports renaming images validated via wp_get_image_mime().
2830   *
2831   * @since 3.0.0
2832   *
2833   * @param string   $file     Full path to the file.
2834   * @param string   $filename The name of the file (may differ from $file due to $file being
2835   *                           in a tmp directory).
2836   * @param string[] $mimes    Optional. Array of mime types keyed by their file extension regex.
2837   * @return array {
2838   *     Values for the extension, mime type, and corrected filename.
2839   *
2840   *     @type string|false $ext             File extension, or false if the file doesn't match a mime type.
2841   *     @type string|false $type            File mime type, or false if the file doesn't match a mime type.
2842   *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
2843   * }
2844   */
2845  function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
2846      $proper_filename = false;
2847  
2848      // Do basic extension validation and MIME mapping.
2849      $wp_filetype = wp_check_filetype( $filename, $mimes );
2850      $ext         = $wp_filetype['ext'];
2851      $type        = $wp_filetype['type'];
2852  
2853      // We can't do any further validation without a file to work with.
2854      if ( ! file_exists( $file ) ) {
2855          return compact( 'ext', 'type', 'proper_filename' );
2856      }
2857  
2858      $real_mime = false;
2859  
2860      // Validate image types.
2861      if ( $type && 0 === strpos( $type, 'image/' ) ) {
2862  
2863          // Attempt to figure out what type of image it actually is.
2864          $real_mime = wp_get_image_mime( $file );
2865  
2866          if ( $real_mime && $real_mime != $type ) {
2867              /**
2868               * Filters the list mapping image mime types to their respective extensions.
2869               *
2870               * @since 3.0.0
2871               *
2872               * @param array $mime_to_ext Array of image mime types and their matching extensions.
2873               */
2874              $mime_to_ext = apply_filters(
2875                  'getimagesize_mimes_to_exts',
2876                  array(
2877                      'image/jpeg' => 'jpg',
2878                      'image/png'  => 'png',
2879                      'image/gif'  => 'gif',
2880                      'image/bmp'  => 'bmp',
2881                      'image/tiff' => 'tif',
2882                  )
2883              );
2884  
2885              // Replace whatever is after the last period in the filename with the correct extension.
2886              if ( ! empty( $mime_to_ext[ $real_mime ] ) ) {
2887                  $filename_parts = explode( '.', $filename );
2888                  array_pop( $filename_parts );
2889                  $filename_parts[] = $mime_to_ext[ $real_mime ];
2890                  $new_filename     = implode( '.', $filename_parts );
2891  
2892                  if ( $new_filename != $filename ) {
2893                      $proper_filename = $new_filename; // Mark that it changed.
2894                  }
2895                  // Redefine the extension / MIME.
2896                  $wp_filetype = wp_check_filetype( $new_filename, $mimes );
2897                  $ext         = $wp_filetype['ext'];
2898                  $type        = $wp_filetype['type'];
2899              } else {
2900                  // Reset $real_mime and try validating again.
2901                  $real_mime = false;
2902              }
2903          }
2904      }
2905  
2906      // Validate files that didn't get validated during previous checks.
2907      if ( $type && ! $real_mime && extension_loaded( 'fileinfo' ) ) {
2908          $finfo     = finfo_open( FILEINFO_MIME_TYPE );
2909          $real_mime = finfo_file( $finfo, $file );
2910          finfo_close( $finfo );
2911  
2912          // fileinfo often misidentifies obscure files as one of these types.
2913          $nonspecific_types = array(
2914              'application/octet-stream',
2915              'application/encrypted',
2916              'application/CDFV2-encrypted',
2917              'application/zip',
2918          );
2919  
2920          /*
2921           * If $real_mime doesn't match the content type we're expecting from the file's extension,
2922           * we need to do some additional vetting. Media types and those listed in $nonspecific_types are
2923           * allowed some leeway, but anything else must exactly match the real content type.
2924           */
2925          if ( in_array( $real_mime, $nonspecific_types, true ) ) {
2926              // File is a non-specific binary type. That's ok if it's a type that generally tends to be binary.
2927              if ( ! in_array( substr( $type, 0, strcspn( $type, '/' ) ), array( 'application', 'video', 'audio' ), true ) ) {
2928                  $type = false;
2929                  $ext  = false;
2930              }
2931          } elseif ( 0 === strpos( $real_mime, 'video/' ) || 0 === strpos( $real_mime, 'audio/' ) ) {
2932              /*
2933               * For these types, only the major type must match the real value.
2934               * This means that common mismatches are forgiven: application/vnd.apple.numbers is often misidentified as application/zip,
2935               * and some media files are commonly named with the wrong extension (.mov instead of .mp4)
2936               */
2937              if ( substr( $real_mime, 0, strcspn( $real_mime, '/' ) ) !== substr( $type, 0, strcspn( $type, '/' ) ) ) {
2938                  $type = false;
2939                  $ext  = false;
2940              }
2941          } elseif ( 'text/plain' === $real_mime ) {
2942              // A few common file types are occasionally detected as text/plain; allow those.
2943              if ( ! in_array(
2944                  $type,
2945                  array(
2946                      'text/plain',
2947                      'text/csv',
2948                      'application/csv',
2949                      'text/richtext',
2950                      'text/tsv',
2951                      'text/vtt',
2952                  ),
2953                  true
2954              )
2955              ) {
2956                  $type = false;
2957                  $ext  = false;
2958              }
2959          } elseif ( 'application/csv' === $real_mime ) {
2960              // Special casing for CSV files.
2961              if ( ! in_array(
2962                  $type,
2963                  array(
2964                      'text/csv',
2965                      'text/plain',
2966                      'application/csv',
2967                  ),
2968                  true
2969              )
2970              ) {
2971                  $type = false;
2972                  $ext  = false;
2973              }
2974          } elseif ( 'text/rtf' === $real_mime ) {
2975              // Special casing for RTF files.
2976              if ( ! in_array(
2977                  $type,
2978                  array(
2979                      'text/rtf',
2980                      'text/plain',
2981                      'application/rtf',
2982                  ),
2983                  true
2984              )
2985              ) {
2986                  $type = false;
2987                  $ext  = false;
2988              }
2989          } else {
2990              if ( $type !== $real_mime ) {
2991                  /*
2992                   * Everything else including image/* and application/*:
2993                   * If the real content type doesn't match the file extension, assume it's dangerous.
2994                   */
2995                  $type = false;
2996                  $ext  = false;
2997              }
2998          }
2999      }
3000  
3001      // The mime type must be allowed.
3002      if ( $type ) {
3003          $allowed = get_allowed_mime_types();
3004  
3005          if ( ! in_array( $type, $allowed, true ) ) {
3006              $type = false;
3007              $ext  = false;
3008          }
3009      }
3010  
3011      /**
3012       * Filters the "real" file type of the given file.
3013       *
3014       * @since 3.0.0
3015       * @since 5.1.0 The $real_mime parameter was added.
3016       *
3017       * @param array       $wp_check_filetype_and_ext {
3018       *     Values for the extension, mime type, and corrected filename.
3019       *
3020       *     @type string|false $ext             File extension, or false if the file doesn't match a mime type.
3021       *     @type string|false $type            File mime type, or false if the file doesn't match a mime type.
3022       *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
3023       * }
3024       * @param string      $file                      Full path to the file.
3025       * @param string      $filename                  The name of the file (may differ from $file due to
3026       *                                               $file being in a tmp directory).
3027       * @param string[]    $mimes                     Array of mime types keyed by their file extension regex.
3028       * @param string|bool $real_mime                 The actual mime type or false if the type cannot be determined.
3029       */
3030      return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes, $real_mime );
3031  }
3032  
3033  /**
3034   * Returns the real mime type of an image file.
3035   *
3036   * This depends on exif_imagetype() or getimagesize() to determine real mime types.
3037   *
3038   * @since 4.7.1
3039   *
3040   * @param string $file Full path to the file.
3041   * @return string|false The actual mime type or false if the type cannot be determined.
3042   */
3043  function wp_get_image_mime( $file ) {
3044      /*
3045       * Use exif_imagetype() to check the mimetype if available or fall back to
3046       * getimagesize() if exif isn't avaialbe. If either function throws an Exception
3047       * we assume the file could not be validated.
3048       */
3049      try {
3050          if ( is_callable( 'exif_imagetype' ) ) {
3051              $imagetype = exif_imagetype( $file );
3052              $mime      = ( $imagetype ) ? image_type_to_mime_type( $imagetype ) : false;
3053          } elseif ( function_exists( 'getimagesize' ) ) {
3054              $imagesize = @getimagesize( $file );
3055              $mime      = ( isset( $imagesize['mime'] ) ) ? $imagesize['mime'] : false;
3056          } else {
3057              $mime = false;
3058          }
3059      } catch ( Exception $e ) {
3060          $mime = false;
3061      }
3062  
3063      return $mime;
3064  }
3065  
3066  /**
3067   * Retrieve list of mime types and file extensions.
3068   *
3069   * @since 3.5.0
3070   * @since 4.2.0 Support was added for GIMP (.xcf) files.
3071   * @since 4.9.2 Support was added for Flac (.flac) files.
3072   * @since 4.9.6 Support was added for AAC (.aac) files.
3073   *
3074   * @return string[] Array of mime types keyed by the file extension regex corresponding to those types.
3075   */
3076  function wp_get_mime_types() {
3077      /**
3078       * Filters the list of mime types and file extensions.
3079       *
3080       * This filter should be used to add, not remove, mime types. To remove
3081       * mime types, use the {@see 'upload_mimes'} filter.
3082       *
3083       * @since 3.5.0
3084       *
3085       * @param string[] $wp_get_mime_types Mime types keyed by the file extension regex
3086       *                                 corresponding to those types.
3087       */
3088      return apply_filters(
3089          'mime_types',
3090          array(
3091              // Image formats.
3092              'jpg|jpeg|jpe'                 => 'image/jpeg',
3093              'gif'                          => 'image/gif',
3094              'png'                          => 'image/png',
3095              'bmp'                          => 'image/bmp',
3096              'tiff|tif'                     => 'image/tiff',
3097              'ico'                          => 'image/x-icon',
3098              'heic'                         => 'image/heic',
3099              // Video formats.
3100              'asf|asx'                      => 'video/x-ms-asf',
3101              'wmv'                          => 'video/x-ms-wmv',
3102              'wmx'                          => 'video/x-ms-wmx',
3103              'wm'                           => 'video/x-ms-wm',
3104              'avi'                          => 'video/avi',
3105              'divx'                         => 'video/divx',
3106              'flv'                          => 'video/x-flv',
3107              'mov|qt'                       => 'video/quicktime',
3108              'mpeg|mpg|mpe'                 => 'video/mpeg',
3109              'mp4|m4v'                      => 'video/mp4',
3110              'ogv'                          => 'video/ogg',
3111              'webm'                         => 'video/webm',
3112              'mkv'                          => 'video/x-matroska',
3113              '3gp|3gpp'                     => 'video/3gpp',  // Can also be audio.
3114              '3g2|3gp2'                     => 'video/3gpp2', // Can also be audio.
3115              // Text formats.
3116              'txt|asc|c|cc|h|srt'           => 'text/plain',
3117              'csv'                          => 'text/csv',
3118              'tsv'                          => 'text/tab-separated-values',
3119              'ics'                          => 'text/calendar',
3120              'rtx'                          => 'text/richtext',
3121              'css'                          => 'text/css',
3122              'htm|html'                     => 'text/html',
3123              'vtt'                          => 'text/vtt',
3124              'dfxp'                         => 'application/ttaf+xml',
3125              // Audio formats.
3126              'mp3|m4a|m4b'                  => 'audio/mpeg',
3127              'aac'                          => 'audio/aac',
3128              'ra|ram'                       => 'audio/x-realaudio',
3129              'wav'                          => 'audio/wav',
3130              'ogg|oga'                      => 'audio/ogg',
3131              'flac'                         => 'audio/flac',
3132              'mid|midi'                     => 'audio/midi',
3133              'wma'                          => 'audio/x-ms-wma',
3134              'wax'                          => 'audio/x-ms-wax',
3135              'mka'                          => 'audio/x-matroska',
3136              // Misc application formats.
3137              'rtf'                          => 'application/rtf',
3138              'js'                           => 'application/javascript',
3139              'pdf'                          => 'application/pdf',
3140              'swf'                          => 'application/x-shockwave-flash',
3141              'class'                        => 'application/java',
3142              'tar'                          => 'application/x-tar',
3143              'zip'                          => 'application/zip',
3144              'gz|gzip'                      => 'application/x-gzip',
3145              'rar'                          => 'application/rar',
3146              '7z'                           => 'application/x-7z-compressed',
3147              'exe'                          => 'application/x-msdownload',
3148              'psd'                          => 'application/octet-stream',
3149              'xcf'                          => 'application/octet-stream',
3150              // MS Office formats.
3151              'doc'                          => 'application/msword',
3152              'pot|pps|ppt'                  => 'application/vnd.ms-powerpoint',
3153              'wri'                          => 'application/vnd.ms-write',
3154              'xla|xls|xlt|xlw'              => 'application/vnd.ms-excel',
3155              'mdb'                          => 'application/vnd.ms-access',
3156              'mpp'                          => 'application/vnd.ms-project',
3157              'docx'                         => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
3158              'docm'                         => 'application/vnd.ms-word.document.macroEnabled.12',
3159              'dotx'                         => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
3160              'dotm'                         => 'application/vnd.ms-word.template.macroEnabled.12',
3161              'xlsx'                         => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
3162              'xlsm'                         => 'application/vnd.ms-excel.sheet.macroEnabled.12',
3163              'xlsb'                         => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
3164              'xltx'                         => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
3165              'xltm'                         => 'application/vnd.ms-excel.template.macroEnabled.12',
3166              'xlam'                         => 'application/vnd.ms-excel.addin.macroEnabled.12',
3167              'pptx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
3168              'pptm'                         => 'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
3169              'ppsx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
3170              'ppsm'                         => 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
3171              'potx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.template',
3172              'potm'                         => 'application/vnd.ms-powerpoint.template.macroEnabled.12',
3173              'ppam'                         => 'application/vnd.ms-powerpoint.addin.macroEnabled.12',
3174              'sldx'                         => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
3175              'sldm'                         => 'application/vnd.ms-powerpoint.slide.macroEnabled.12',
3176              'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
3177              'oxps'                         => 'application/oxps',
3178              'xps'                          => 'application/vnd.ms-xpsdocument',
3179              // OpenOffice formats.
3180              'odt'                          => 'application/vnd.oasis.opendocument.text',
3181              'odp'                          => 'application/vnd.oasis.opendocument.presentation',
3182              'ods'                          => 'application/vnd.oasis.opendocument.spreadsheet',
3183              'odg'                          => 'application/vnd.oasis.opendocument.graphics',
3184              'odc'                          => 'application/vnd.oasis.opendocument.chart',
3185              'odb'                          => 'application/vnd.oasis.opendocument.database',
3186              'odf'                          => 'application/vnd.oasis.opendocument.formula',
3187              // WordPerfect formats.
3188              'wp|wpd'                       => 'application/wordperfect',
3189              // iWork formats.
3190              'key'                          => 'application/vnd.apple.keynote',
3191              'numbers'                      => 'application/vnd.apple.numbers',
3192              'pages'                        => 'application/vnd.apple.pages',
3193          )
3194      );
3195  }
3196  
3197  /**
3198   * Retrieves the list of common file extensions and their types.
3199   *
3200   * @since 4.6.0
3201   *
3202   * @return array[] Multi-dimensional array of file extensions types keyed by the type of file.
3203   */
3204  function wp_get_ext_types() {
3205  
3206      /**
3207       * Filters file type based on the extension name.
3208       *
3209       * @since 2.5.0
3210       *
3211       * @see wp_ext2type()
3212       *
3213       * @param array[] $ext2type Multi-dimensional array of file extensions types keyed by the type of file.
3214       */
3215      return apply_filters(
3216          'ext2type',
3217          array(
3218              'image'       => array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'bmp', 'tif', 'tiff', 'ico', 'heic' ),
3219              'audio'       => array( 'aac', 'ac3', 'aif', 'aiff', 'flac', 'm3a', 'm4a', 'm4b', 'mka', 'mp1', 'mp2', 'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
3220              'video'       => array( '3g2', '3gp', '3gpp', 'asf', 'avi', 'divx', 'dv', 'flv', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt', 'rm', 'vob', 'wmv' ),
3221              'document'    => array( 'doc', 'docx', 'docm', 'dotm', 'odt', 'pages', 'pdf', 'xps', 'oxps', 'rtf', 'wp', 'wpd', 'psd', 'xcf' ),
3222              'spreadsheet' => array( 'numbers', 'ods', 'xls', 'xlsx', 'xlsm', 'xlsb' ),
3223              'interactive' => array( 'swf', 'key', 'ppt', 'pptx', 'pptm', 'pps', 'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ),
3224              'text'        => array( 'asc', 'csv', 'tsv', 'txt' ),
3225              'archive'     => array( 'bz2', 'cab', 'dmg', 'gz', 'rar', 'sea', 'sit', 'sqx', 'tar', 'tgz', 'zip', '7z' ),
3226              'code'        => array( 'css', 'htm', 'html', 'php', 'js' ),
3227          )
3228      );
3229  }
3230  
3231  /**
3232   * Retrieve list of allowed mime types and file extensions.
3233   *
3234   * @since 2.8.6
3235   *
3236   * @param int|WP_User $user Optional. User to check. Defaults to current user.
3237   * @return string[] Array of mime types keyed by the file extension regex corresponding
3238   *                  to those types.
3239   */
3240  function get_allowed_mime_types( $user = null ) {
3241      $t = wp_get_mime_types();
3242  
3243      unset( $t['swf'], $t['exe'] );
3244      if ( function_exists( 'current_user_can' ) ) {
3245          $unfiltered = $user ? user_can( $user, 'unfiltered_html' ) : current_user_can( 'unfiltered_html' );
3246      }
3247  
3248      if ( empty( $unfiltered ) ) {
3249          unset( $t['htm|html'], $t['js'] );
3250      }
3251  
3252      /**
3253       * Filters list of allowed mime types and file extensions.
3254       *
3255       * @since 2.0.0
3256       *
3257       * @param array            $t    Mime types keyed by the file extension regex corresponding to those types.
3258       * @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user).
3259       */
3260      return apply_filters( 'upload_mimes', $t, $user );
3261  }
3262  
3263  /**
3264   * Display "Are You Sure" message to confirm the action being taken.
3265   *
3266   * If the action has the nonce explain message, then it will be displayed
3267   * along with the "Are you sure?" message.
3268   *
3269   * @since 2.0.4
3270   *
3271   * @param string $action The nonce action.
3272   */
3273  function wp_nonce_ays( $action ) {
3274      if ( 'log-out' === $action ) {
3275          $html = sprintf(
3276              /* translators: %s: Site title. */
3277              __( 'You are attempting to log out of %s' ),
3278              get_bloginfo( 'name' )
3279          );
3280          $html       .= '</p><p>';
3281          $redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
3282          $html       .= sprintf(
3283              /* translators: %s: Logout URL. */
3284              __( 'Do you really want to <a href="%s">log out</a>?' ),
3285              wp_logout_url( $redirect_to )
3286          );
3287      } else {
3288          $html = __( 'The link you followed has expired.' );
3289          if ( wp_get_referer() ) {
3290              $html .= '</p><p>';
3291              $html .= sprintf(
3292                  '<a href="%s">%s</a>',
3293                  esc_url( remove_query_arg( 'updated', wp_get_referer() ) ),
3294                  __( 'Please try again.' )
3295              );
3296          }
3297      }
3298  
3299      wp_die( $html, __( 'Something went wrong.' ), 403 );
3300  }
3301  
3302  /**
3303   * Kills WordPress execution and displays HTML page with an error message.
3304   *
3305   * This function complements the `die()` PHP function. The difference is that
3306   * HTML will be displayed to the user. It is recommended to use this function
3307   * only when the execution should not continue any further. It is not recommended
3308   * to call this function very often, and try to handle as many errors as possible
3309   * silently or more gracefully.
3310   *
3311   * As a shorthand, the desired HTTP response code may be passed as an integer to
3312   * the `$title` parameter (the default title would apply) or the `$args` parameter.
3313   *
3314   * @since 2.0.4
3315   * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept
3316   *              an integer to be used as the response code.
3317   * @since 5.1.0 The `$link_url`, `$link_text`, and `$exit` arguments were added.
3318   * @since 5.3.0 The `$charset` argument was added.
3319   * @since 5.5.0 The `$text_direction` argument has a priority over get_language_attributes()
3320   *              in the default handler.
3321   *
3322   * @global WP_Query $wp_query WordPress Query object.
3323   *
3324   * @param string|WP_Error  $message Optional. Error message. If this is a WP_Error object,
3325   *                                  and not an Ajax or XML-RPC request, the error's messages are used.
3326   *                                  Default empty.
3327   * @param string|int       $title   Optional. Error title. If `$message` is a `WP_Error` object,
3328   *                                  error data with the key 'title' may be used to specify the title.
3329   *                                  If `$title` is an integer, then it is treated as the response
3330   *                                  code. Default empty.
3331   * @param string|array|int $args {
3332   *     Optional. Arguments to control behavior. If `$args` is an integer, then it is treated
3333   *     as the response code. Default empty array.
3334   *
3335   *     @type int    $response       The HTTP response code. Default 200 for Ajax requests, 500 otherwise.
3336   *     @type string $link_url       A URL to include a link to. Only works in combination with $link_text.
3337   *                                  Default empty string.
3338   *     @type string $link_text      A label for the link to include. Only works in combination with $link_url.
3339   *                                  Default empty string.
3340   *     @type bool   $back_link      Whether to include a link to go back. Default false.
3341   *     @type string $text_direction The text direction. This is only useful internally, when WordPress is still
3342   *                                  loading and the site's locale is not set up yet. Accepts 'rtl' and 'ltr'.
3343   *                                  Default is the value of is_rtl().
3344   *     @type string $charset        Character set of the HTML output. Default 'utf-8'.
3345   *     @type string $code           Error code to use. Default is 'wp_die', or the main error code if $message
3346   *                                  is a WP_Error.
3347   *     @type bool   $exit           Whether to exit the process after completion. Default true.
3348   * }
3349   */
3350  function wp_die( $message = '', $title = '', $args = array() ) {
3351      global $wp_query;
3352  
3353      if ( is_int( $args ) ) {
3354          $args = array( 'response' => $args );
3355      } elseif ( is_int( $title ) ) {
3356          $args  = array( 'response' => $title );
3357          $title = '';
3358      }
3359  
3360      if ( wp_doing_ajax() ) {
3361          /**
3362           * Filters the callback for killing WordPress execution for Ajax requests.
3363           *
3364           * @since 3.4.0
3365           *
3366           * @param callable $function Callback function name.
3367           */
3368          $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
3369      } elseif ( wp_is_json_request() ) {
3370          /**
3371           * Filters the callback for killing WordPress execution for JSON requests.
3372           *
3373           * @since 5.1.0
3374           *
3375           * @param callable $function Callback function name.
3376           */
3377          $function = apply_filters( 'wp_die_json_handler', '_json_wp_die_handler' );
3378      } elseif ( wp_is_jsonp_request() ) {
3379          /**
3380           * Filters the callback for killing WordPress execution for JSONP requests.
3381           *
3382           * @since 5.2.0
3383           *
3384           * @param callable $function Callback function name.
3385           */
3386          $function = apply_filters( 'wp_die_jsonp_handler', '_jsonp_wp_die_handler' );
3387      } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
3388          /**
3389           * Filters the callback for killing WordPress execution for XML-RPC requests.
3390           *
3391           * @since 3.4.0
3392           *
3393           * @param callable $function Callback function name.
3394           */
3395          $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
3396      } elseif ( wp_is_xml_request()
3397          || isset( $wp_query ) &&
3398              ( function_exists( 'is_feed' ) && is_feed()
3399              || function_exists( 'is_comment_feed' ) && is_comment_feed()
3400              || function_exists( 'is_trackback' ) && is_trackback() ) ) {
3401          /**
3402           * Filters the callback for killing WordPress execution for XML requests.
3403           *
3404           * @since 5.2.0
3405           *
3406           * @param callable $function Callback function name.
3407           */
3408          $function = apply_filters( 'wp_die_xml_handler', '_xml_wp_die_handler' );
3409      } else {
3410          /**
3411           * Filters the callback for killing WordPress execution for all non-Ajax, non-JSON, non-XML requests.
3412           *
3413           * @since 3.0.0
3414           *
3415           * @param callable $function Callback function name.
3416           */
3417          $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
3418      }
3419  
3420      call_user_func( $function, $message, $title, $args );
3421  }
3422  
3423  /**
3424   * Kills WordPress execution and displays HTML page with an error message.
3425   *
3426   * This is the default handler for wp_die(). If you want a custom one,
3427   * you can override this using the {@see 'wp_die_handler'} filter in wp_die().
3428   *
3429   * @since 3.0.0
3430   * @access private
3431   *
3432   * @param string|WP_Error $message Error message or WP_Error object.
3433   * @param string          $title   Optional. Error title. Default empty.
3434   * @param string|array    $args    Optional. Arguments to control behavior. Default empty array.
3435   */
3436  function _default_wp_die_handler( $message, $title = '', $args = array() ) {
3437      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3438  
3439      if ( is_string( $message ) ) {
3440          if ( ! empty( $parsed_args['additional_errors'] ) ) {
3441              $message = array_merge(
3442                  array( $message ),
3443                  wp_list_pluck( $parsed_args['additional_errors'], 'message' )
3444              );
3445              $message = "<ul>\n\t\t<li>" . implode( "</li>\n\t\t<li>", $message ) . "</li>\n\t</ul>";
3446          }
3447  
3448          $message = sprintf(
3449              '<div class="wp-die-message">%s</div>',
3450              $message
3451          );
3452      }
3453  
3454      $have_gettext = function_exists( '__' );
3455  
3456      if ( ! empty( $parsed_args['link_url'] ) && ! empty( $parsed_args['link_text'] ) ) {
3457          $link_url = $parsed_args['link_url'];
3458          if ( function_exists( 'esc_url' ) ) {
3459              $link_url = esc_url( $link_url );
3460          }
3461          $link_text = $parsed_args['link_text'];
3462          $message  .= "\n<p><a href='{$link_url}'>{$link_text}</a></p>";
3463      }
3464  
3465      if ( isset( $parsed_args['back_link'] ) && $parsed_args['back_link'] ) {
3466          $back_text = $have_gettext ? __( '&laquo; Back' ) : '&laquo; Back';
3467          $message  .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";
3468      }
3469  
3470      if ( ! did_action( 'admin_head' ) ) :
3471          if ( ! headers_sent() ) {
3472              header( "Content-Type: text/html; charset={$parsed_args['charset']}" );
3473              status_header( $parsed_args['response'] );
3474              nocache_headers();
3475          }
3476  
3477          $text_direction = $parsed_args['text_direction'];
3478          $dir_attr       = "dir='$text_direction'";
3479  
3480          // If `text_direction` was not explicitly passed,
3481          // use get_language_attributes() if available.
3482          if ( empty( $args['text_direction'] )
3483              && function_exists( 'language_attributes' ) && function_exists( 'is_rtl' )
3484          ) {
3485              $dir_attr = get_language_attributes();
3486          }
3487          ?>
3488  <!DOCTYPE html>
3489  <html <?php echo $dir_attr; ?>>
3490  <head>
3491      <meta http-equiv="Content-Type" content="text/html; charset=<?php echo $parsed_args['charset']; ?>" />
3492      <meta name="viewport" content="width=device-width">
3493          <?php
3494          if ( function_exists( 'wp_no_robots' ) ) {
3495              wp_no_robots();
3496          }
3497          ?>
3498      <title><?php echo $title; ?></title>
3499      <style type="text/css">
3500          html {
3501              background: #f1f1f1;
3502          }
3503          body {
3504              background: #fff;
3505              color: #444;
3506              font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
3507              margin: 2em auto;
3508              padding: 1em 2em;
3509              max-width: 700px;
3510              -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
3511              box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
3512          }
3513          h1 {
3514              border-bottom: 1px solid #dadada;
3515              clear: both;
3516              color: #666;
3517              font-size: 24px;
3518              margin: 30px 0 0 0;
3519              padding: 0;
3520              padding-bottom: 7px;
3521          }
3522          #error-page {
3523              margin-top: 50px;
3524          }
3525          #error-page p,
3526          #error-page .wp-die-message {
3527              font-size: 14px;
3528              line-height: 1.5;
3529              margin: 25px 0 20px;
3530          }
3531          #error-page code {
3532              font-family: Consolas, Monaco, monospace;
3533          }
3534          ul li {
3535              margin-bottom: 10px;
3536              font-size: 14px ;
3537          }
3538          a {
3539              color: #0073aa;
3540          }
3541          a:hover,
3542          a:active {
3543              color: #006799;
3544          }
3545          a:focus {
3546              color: #124964;
3547              -webkit-box-shadow:
3548                  0 0 0 1px #5b9dd9,
3549                  0 0 2px 1px rgba(30, 140, 190, 0.8);
3550              box-shadow:
3551                  0 0 0 1px #5b9dd9,
3552                  0 0 2px 1px rgba(30, 140, 190, 0.8);
3553              outline: none;
3554          }
3555          .button {
3556              background: #f7f7f7;
3557              border: 1px solid #ccc;
3558              color: #555;
3559              display: inline-block;
3560              text-decoration: none;
3561              font-size: 13px;
3562              line-height: 2;
3563              height: 28px;
3564              margin: 0;
3565              padding: 0 10px 1px;
3566              cursor: pointer;
3567              -webkit-border-radius: 3px;
3568              -webkit-appearance: none;
3569              border-radius: 3px;
3570              white-space: nowrap;
3571              -webkit-box-sizing: border-box;
3572              -moz-box-sizing:    border-box;
3573              box-sizing:         border-box;
3574  
3575              -webkit-box-shadow: 0 1px 0 #ccc;
3576              box-shadow: 0 1px 0 #ccc;
3577              vertical-align: top;
3578          }
3579  
3580          .button.button-large {
3581              height: 30px;
3582              line-height: 2.15384615;
3583              padding: 0 12px 2px;
3584          }
3585  
3586          .button:hover,
3587          .button:focus {
3588              background: #fafafa;
3589              border-color: #999;
3590              color: #23282d;
3591          }
3592  
3593          .button:focus {
3594              border-color: #5b9dd9;
3595              -webkit-box-shadow: 0 0 3px rgba(0, 115, 170, 0.8);
3596              box-shadow: 0 0 3px rgba(0, 115, 170, 0.8);
3597              outline: none;
3598          }
3599  
3600          .button:active {
3601              background: #eee;
3602              border-color: #999;
3603              -webkit-box-shadow: inset 0 2px 5px -3px rgba(0, 0, 0, 0.5);
3604              box-shadow: inset 0 2px 5px -3px rgba(0, 0, 0, 0.5);
3605          }
3606  
3607          <?php
3608          if ( 'rtl' === $text_direction ) {
3609              echo 'body { font-family: Tahoma, Arial; }';
3610          }
3611          ?>
3612      </style>
3613  </head>
3614  <body id="error-page">
3615  <?php endif; // ! did_action( 'admin_head' ) ?>
3616      <?php echo $message; ?>
3617  </body>
3618  </html>
3619      <?php
3620      if ( $parsed_args['exit'] ) {
3621          die();
3622      }
3623  }
3624  
3625  /**
3626   * Kills WordPress execution and displays Ajax response with an error message.
3627   *
3628   * This is the handler for wp_die() when processing Ajax requests.
3629   *
3630   * @since 3.4.0
3631   * @access private
3632   *
3633   * @param string       $message Error message.
3634   * @param string       $title   Optional. Error title (unused). Default empty.
3635   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3636   */
3637  function _ajax_wp_die_handler( $message, $title = '', $args = array() ) {
3638      // Set default 'response' to 200 for Ajax requests.
3639      $args = wp_parse_args(
3640          $args,
3641          array( 'response' => 200 )
3642      );
3643  
3644      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3645  
3646      if ( ! headers_sent() ) {
3647          // This is intentional. For backward-compatibility, support passing null here.
3648          if ( null !== $args['response'] ) {
3649              status_header( $parsed_args['response'] );
3650          }
3651          nocache_headers();
3652      }
3653  
3654      if ( is_scalar( $message ) ) {
3655          $message = (string) $message;
3656      } else {
3657          $message = '0';
3658      }
3659  
3660      if ( $parsed_args['exit'] ) {
3661          die( $message );
3662      }
3663  
3664      echo $message;
3665  }
3666  
3667  /**
3668   * Kills WordPress execution and displays JSON response with an error message.
3669   *
3670   * This is the handler for wp_die() when processing JSON requests.
3671   *
3672   * @since 5.1.0
3673   * @access private
3674   *
3675   * @param string       $message Error message.
3676   * @param string       $title   Optional. Error title. Default empty.
3677   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3678   */
3679  function _json_wp_die_handler( $message, $title = '', $args = array() ) {
3680      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3681  
3682      $data = array(
3683          'code'              => $parsed_args['code'],
3684          'message'           => $message,
3685          'data'              => array(
3686              'status' => $parsed_args['response'],
3687          ),
3688          'additional_errors' => $parsed_args['additional_errors'],
3689      );
3690  
3691      if ( ! headers_sent() ) {
3692          header( "Content-Type: application/json; charset={$parsed_args['charset']}" );
3693          if ( null !== $parsed_args['response'] ) {
3694              status_header( $parsed_args['response'] );
3695          }
3696          nocache_headers();
3697      }
3698  
3699      echo wp_json_encode( $data );
3700      if ( $parsed_args['exit'] ) {
3701          die();
3702      }
3703  }
3704  
3705  /**
3706   * Kills WordPress execution and displays JSONP response with an error message.
3707   *
3708   * This is the handler for wp_die() when processing JSONP requests.
3709   *
3710   * @since 5.2.0
3711   * @access private
3712   *
3713   * @param string       $message Error message.
3714   * @param string       $title   Optional. Error title. Default empty.
3715   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3716   */
3717  function _jsonp_wp_die_handler( $message, $title = '', $args = array() ) {
3718      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3719  
3720      $data = array(
3721          'code'              => $parsed_args['code'],
3722          'message'           => $message,
3723          'data'              => array(
3724              'status' => $parsed_args['response'],
3725          ),
3726          'additional_errors' => $parsed_args['additional_errors'],
3727      );
3728  
3729      if ( ! headers_sent() ) {
3730          header( "Content-Type: application/javascript; charset={$parsed_args['charset']}" );
3731          header( 'X-Content-Type-Options: nosniff' );
3732          header( 'X-Robots-Tag: noindex' );
3733          if ( null !== $parsed_args['response'] ) {
3734              status_header( $parsed_args['response'] );
3735          }
3736          nocache_headers();
3737      }
3738  
3739      $result         = wp_json_encode( $data );
3740      $jsonp_callback = $_GET['_jsonp'];
3741      echo '/**/' . $jsonp_callback . '(' . $result . ')';
3742      if ( $parsed_args['exit'] ) {
3743          die();
3744      }
3745  }
3746  
3747  /**
3748   * Kills WordPress execution and displays XML response with an error message.
3749   *
3750   * This is the handler for wp_die() when processing XMLRPC requests.
3751   *
3752   * @since 3.2.0
3753   * @access private
3754   *
3755   * @global wp_xmlrpc_server $wp_xmlrpc_server
3756   *
3757   * @param string       $message Error message.
3758   * @param string       $title   Optional. Error title. Default empty.
3759   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3760   */
3761  function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
3762      global $wp_xmlrpc_server;
3763  
3764      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3765  
3766      if ( ! headers_sent() ) {
3767          nocache_headers();
3768      }
3769  
3770      if ( $wp_xmlrpc_server ) {
3771          $error = new IXR_Error( $parsed_args['response'], $message );
3772          $wp_xmlrpc_server->output( $error->getXml() );
3773      }
3774      if ( $parsed_args['exit'] ) {
3775          die();
3776      }
3777  }
3778  
3779  /**
3780   * Kills WordPress execution and displays XML response with an error message.
3781   *
3782   * This is the handler for wp_die() when processing XML requests.
3783   *
3784   * @since 5.2.0
3785   * @access private
3786   *
3787   * @param string       $message Error message.
3788   * @param string       $title   Optional. Error title. Default empty.
3789   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3790   */
3791  function _xml_wp_die_handler( $message, $title = '', $args = array() ) {
3792      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3793  
3794      $message = htmlspecialchars( $message );
3795      $title   = htmlspecialchars( $title );
3796  
3797      $xml = <<<EOD
3798  <error>
3799      <code>{$parsed_args['code']}</code>
3800      <title><![CDATA[{$title}]]></title>
3801      <message><![CDATA[{$message}]]></message>
3802      <data>
3803          <status>{$parsed_args['response']}</status>
3804      </data>
3805  </error>
3806  
3807  EOD;
3808  
3809      if ( ! headers_sent() ) {
3810          header( "Content-Type: text/xml; charset={$parsed_args['charset']}" );
3811          if ( null !== $parsed_args['response'] ) {
3812              status_header( $parsed_args['response'] );
3813          }
3814          nocache_headers();
3815      }
3816  
3817      echo $xml;
3818      if ( $parsed_args['exit'] ) {
3819          die();
3820      }
3821  }
3822  
3823  /**
3824   * Kills WordPress execution and displays an error message.
3825   *
3826   * This is the handler for wp_die() when processing APP requests.
3827   *
3828   * @since 3.4.0
3829   * @since 5.1.0 Added the $title and $args parameters.
3830   * @access private
3831   *
3832   * @param string       $message Optional. Response to print. Default empty.
3833   * @param string       $title   Optional. Error title (unused). Default empty.
3834   * @param string|array $args    Optional. Arguments to control behavior. Default empty array.
3835   */
3836  function _scalar_wp_die_handler( $message = '', $title = '', $args = array() ) {
3837      list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );
3838  
3839      if ( $parsed_args['exit'] ) {
3840          if ( is_scalar( $message ) ) {
3841              die( (string) $message );
3842          }
3843          die();
3844      }
3845  
3846      if ( is_scalar( $message ) ) {
3847          echo (string) $message;
3848      }
3849  }
3850  
3851  /**
3852   * Processes arguments passed to wp_die() consistently for its handlers.
3853   *
3854   * @since 5.1.0
3855   * @access private
3856   *
3857   * @param string|WP_Error $message Error message or WP_Error object.
3858   * @param string          $title   Optional. Error title. Default empty.
3859   * @param string|array    $args    Optional. Arguments to control behavior. Default empty array.
3860   * @return array {
3861   *     Processed arguments.
3862   *
3863   *     @type string $0 Error message.
3864   *     @type string $1 Error title.
3865   *     @type array  $2 Arguments to control behavior.
3866   * }
3867   */
3868  function _wp_die_process_input( $message, $title = '', $args = array() ) {
3869      $defaults = array(
3870          'response'          => 0,
3871          'code'              => '',
3872          'exit'              => true,
3873          'back_link'         => false,
3874          'link_url'          => '',
3875          'link_text'         => '',
3876          'text_direction'    => '',
3877          'charset'           => 'utf-8',
3878          'additional_errors' => array(),
3879      );
3880  
3881      $args = wp_parse_args( $args, $defaults );
3882  
3883      if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
3884          if ( ! empty( $message->errors ) ) {
3885              $errors = array();
3886              foreach ( (array) $message->errors as $error_code => $error_messages ) {
3887                  foreach ( (array) $error_messages as $error_message ) {
3888                      $errors[] = array(
3889                          'code'    => $error_code,
3890                          'message' => $error_message,
3891                          'data'    => $message->get_error_data( $error_code ),
3892                      );
3893                  }
3894              }
3895  
3896              $message = $errors[0]['message'];
3897              if ( empty( $args['code'] ) ) {
3898                  $args['code'] = $errors[0]['code'];
3899              }
3900              if ( empty( $args['response'] ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['status'] ) ) {
3901                  $args['response'] = $errors[0]['data']['status'];
3902              }
3903              if ( empty( $title ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['title'] ) ) {
3904                  $title = $errors[0]['data']['title'];
3905              }
3906  
3907              unset( $errors[0] );
3908              $args['additional_errors'] = array_values( $errors );
3909          } else {
3910              $message = '';
3911          }
3912      }
3913  
3914      $have_gettext = function_exists( '__' );
3915  
3916      // The $title and these specific $args must always have a non-empty value.
3917      if ( empty( $args['code'] ) ) {
3918          $args['code'] = 'wp_die';
3919      }
3920      if ( empty( $args['response'] ) ) {
3921          $args['response'] = 500;
3922      }
3923      if ( empty( $title ) ) {
3924          $title = $have_gettext ? __( 'WordPress &rsaquo; Error' ) : 'WordPress &rsaquo; Error';
3925      }
3926      if ( empty( $args['text_direction'] ) || ! in_array( $args['text_direction'], array( 'ltr', 'rtl' ), true ) ) {
3927          $args['text_direction'] = 'ltr';
3928          if ( function_exists( 'is_rtl' ) && is_rtl() ) {
3929              $args['text_direction'] = 'rtl';
3930          }
3931      }
3932  
3933      if ( ! empty( $args['charset'] ) ) {
3934          $args['charset'] = _canonical_charset( $args['charset'] );
3935      }
3936  
3937      return array( $message, $title, $args );
3938  }
3939  
3940  /**
3941   * Encode a variable into JSON, with some sanity checks.
3942   *
3943   * @since 4.1.0
3944   * @since 5.3.0 No longer handles support for PHP < 5.6.
3945   *
3946   * @param mixed $data    Variable (usually an array or object) to encode as JSON.
3947   * @param int   $options Optional. Options to be passed to json_encode(). Default 0.
3948   * @param int   $depth   Optional. Maximum depth to walk through $data. Must be
3949   *                       greater than 0. Default 512.
3950   * @return string|false The JSON encoded string, or false if it cannot be encoded.
3951   */
3952  function wp_json_encode( $data, $options = 0, $depth = 512 ) {
3953      $json = json_encode( $data, $options, $depth );
3954  
3955      // If json_encode() was successful, no need to do more sanity checking.
3956      if ( false !== $json ) {
3957          return $json;
3958      }
3959  
3960      try {
3961          $data = _wp_json_sanity_check( $data, $depth );
3962      } catch ( Exception $e ) {
3963          return false;
3964      }
3965  
3966      return json_encode( $data, $options, $depth );
3967  }
3968  
3969  /**
3970   * Perform sanity checks on data that shall be encoded to JSON.
3971   *
3972   * @ignore
3973   * @since 4.1.0
3974   * @access private
3975   *
3976   * @see wp_json_encode()
3977   *
3978   * @throws Exception If depth limit is reached.
3979   *
3980   * @param mixed $data  Variable (usually an array or object) to encode as JSON.
3981   * @param int   $depth Maximum depth to walk through $data. Must be greater than 0.
3982   * @return mixed The sanitized data that shall be encoded to JSON.
3983   */
3984  function _wp_json_sanity_check( $data, $depth ) {
3985      if ( $depth < 0 ) {
3986          throw new Exception( 'Reached depth limit' );
3987      }
3988  
3989      if ( is_array( $data ) ) {
3990          $output = array();
3991          foreach ( $data as $id => $el ) {
3992              // Don't forget to sanitize the ID!
3993              if ( is_string( $id ) ) {
3994                  $clean_id = _wp_json_convert_string( $id );
3995              } else {
3996                  $clean_id = $id;
3997              }
3998  
3999              // Check the element type, so that we're only recursing if we really have to.
4000              if ( is_array( $el ) || is_object( $el ) ) {
4001                  $output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 );
4002              } elseif ( is_string( $el ) ) {
4003                  $output[ $clean_id ] = _wp_json_convert_string( $el );
4004              } else {
4005                  $output[ $clean_id ] = $el;
4006              }
4007          }
4008      } elseif ( is_object( $data ) ) {
4009          $output = new stdClass;
4010          foreach ( $data as $id => $el ) {
4011              if ( is_string( $id ) ) {
4012                  $clean_id = _wp_json_convert_string( $id );
4013              } else {
4014                  $clean_id = $id;
4015              }
4016  
4017              if ( is_array( $el ) || is_object( $el ) ) {
4018                  $output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 );
4019              } elseif ( is_string( $el ) ) {
4020                  $output->$clean_id = _wp_json_convert_string( $el );
4021              } else {
4022                  $output->$clean_id = $el;
4023              }
4024          }
4025      } elseif ( is_string( $data ) ) {
4026          return _wp_json_convert_string( $data );
4027      } else {
4028          return $data;
4029      }
4030  
4031      return $output;
4032  }
4033  
4034  /**
4035   * Convert a string to UTF-8, so that it can be safely encoded to JSON.
4036   *
4037   * @ignore
4038   * @since 4.1.0
4039   * @access private
4040   *
4041   * @see _wp_json_sanity_check()
4042   *
4043   * @param string $string The string which is to be converted.
4044   * @return string The checked string.
4045   */
4046  function _wp_json_convert_string( $string ) {
4047      static $use_mb = null;
4048      if ( is_null( $use_mb ) ) {
4049          $use_mb = function_exists( 'mb_convert_encoding' );
4050      }
4051  
4052      if ( $use_mb ) {
4053          $encoding = mb_detect_encoding( $string, mb_detect_order(), true );
4054          if ( $encoding ) {
4055              return mb_convert_encoding( $string, 'UTF-8', $encoding );
4056          } else {
4057              return mb_convert_encoding( $string, 'UTF-8', 'UTF-8' );
4058          }
4059      } else {
4060          return wp_check_invalid_utf8( $string, true );
4061      }
4062  }
4063  
4064  /**
4065   * Prepares response data to be serialized to JSON.
4066   *
4067   * This supports the JsonSerializable interface for PHP 5.2-5.3 as well.
4068   *
4069   * @ignore
4070   * @since 4.4.0
4071   * @deprecated 5.3.0 This function is no longer needed as support for PHP 5.2-5.3
4072   *                   has been dropped.
4073   * @access private
4074   *
4075   * @param mixed $data Native representation.
4076   * @return bool|int|float|null|string|array Data ready for `json_encode()`.
4077   */
4078  function _wp_json_prepare_data( $data ) {
4079      _deprecated_function( __FUNCTION__, '5.3.0' );
4080      return $data;
4081  }
4082  
4083  /**
4084   * Send a JSON response back to an Ajax request.
4085   *
4086   * @since 3.5.0
4087   * @since 4.7.0 The `$status_code` parameter was added.
4088   * @since 5.6.0 The `$options` parameter was added.
4089   *
4090   * @param mixed $response    Variable (usually an array or object) to encode as JSON,
4091   *                           then print and die.
4092   * @param int   $status_code Optional. The HTTP status code to output. Default null.
4093   * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
4094   */
4095  function wp_send_json( $response, $status_code = null, $options = 0 ) {
4096      if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
4097          _doing_it_wrong(
4098              __FUNCTION__,
4099              sprintf(
4100                  /* translators: 1: WP_REST_Response, 2: WP_Error */
4101                  __( 'Return a %1$s or %2$s object from your callback when using the REST API.' ),
4102                  'WP_REST_Response',
4103                  'WP_Error'
4104              ),
4105              '5.5.0'
4106          );
4107      }
4108  
4109      if ( ! headers_sent() ) {
4110          header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
4111          if ( null !== $status_code ) {
4112              status_header( $status_code );
4113          }
4114      }
4115  
4116      echo wp_json_encode( $response, $options );
4117  
4118      if ( wp_doing_ajax() ) {
4119          wp_die(
4120              '',
4121              '',
4122              array(
4123                  'response' => null,
4124              )
4125          );
4126      } else {
4127          die;
4128      }
4129  }
4130  
4131  /**
4132   * Send a JSON response back to an Ajax request, indicating success.
4133   *
4134   * @since 3.5.0
4135   * @since 4.7.0 The `$status_code` parameter was added.
4136   * @since 5.6.0 The `$options` parameter was added.
4137   *
4138   * @param mixed $data        Optional. Data to encode as JSON, then print and die. Default null.
4139   * @param int   $status_code Optional. The HTTP status code to output. Default null.
4140   * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
4141   */
4142  function wp_send_json_success( $data = null, $status_code = null, $options = 0 ) {
4143      $response = array( 'success' => true );
4144  
4145      if ( isset( $data ) ) {
4146          $response['data'] = $data;
4147      }
4148  
4149      wp_send_json( $response, $status_code, $options );
4150  }
4151  
4152  /**
4153   * Send a JSON response back to an Ajax request, indicating failure.
4154   *
4155   * If the `$data` parameter is a WP_Error object, the errors
4156   * within the object are processed and output as an array of error
4157   * codes and corresponding messages. All other types are output
4158   * without further processing.
4159   *
4160   * @since 3.5.0
4161   * @since 4.1.0 The `$data` parameter is now processed if a WP_Error object is passed in.
4162   * @since 4.7.0 The `$status_code` parameter was added.
4163   * @since 5.6.0 The `$options` parameter was added.
4164   *
4165   * @param mixed $data        Optional. Data to encode as JSON, then print and die. Default null.
4166   * @param int   $status_code Optional. The HTTP status code to output. Default null.
4167   * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
4168   */
4169  function wp_send_json_error( $data = null, $status_code = null, $options = 0 ) {
4170      $response = array( 'success' => false );
4171  
4172      if ( isset( $data ) ) {
4173          if ( is_wp_error( $data ) ) {
4174              $result = array();
4175              foreach ( $data->errors as $code => $messages ) {
4176                  foreach ( $messages as $message ) {
4177                      $result[] = array(
4178                          'code'    => $code,
4179                          'message' => $message,
4180                      );
4181                  }
4182              }
4183  
4184              $response['data'] = $result;
4185          } else {
4186              $response['data'] = $data;
4187          }
4188      }
4189  
4190      wp_send_json( $response, $status_code, $options );
4191  }
4192  
4193  /**
4194   * Checks that a JSONP callback is a valid JavaScript callback name.
4195   *
4196   * Only allows alphanumeric characters and the dot character in callback
4197   * function names. This helps to mitigate XSS attacks caused by directly
4198   * outputting user input.
4199   *
4200   * @since 4.6.0
4201   *
4202   * @param string $callback Supplied JSONP callback function name.
4203   * @return bool Whether the callback function name is valid.
4204   */
4205  function wp_check_jsonp_callback( $callback ) {
4206      if ( ! is_string( $callback ) ) {
4207          return false;
4208      }
4209  
4210      preg_replace( '/[^\w\.]/', '', $callback, -1, $illegal_char_count );
4211  
4212      return 0 === $illegal_char_count;
4213  }
4214  
4215  /**
4216   * Retrieve the WordPress home page URL.
4217   *
4218   * If the constant named 'WP_HOME' exists, then it will be used and returned
4219   * by the function. This can be used to counter the redirection on your local
4220   * development environment.
4221   *
4222   * @since 2.2.0
4223   * @access private
4224   *
4225   * @see WP_HOME
4226   *
4227   * @param string $url URL for the home location.
4228   * @return string Homepage location.
4229   */
4230  function _config_wp_home( $url = '' ) {
4231      if ( defined( 'WP_HOME' ) ) {
4232          return untrailingslashit( WP_HOME );
4233      }
4234      return $url;
4235  }
4236  
4237  /**
4238   * Retrieve the WordPress site URL.
4239   *
4240   * If the constant named 'WP_SITEURL' is defined, then the value in that
4241   * constant will always be returned. This can be used for debugging a site
4242   * on your localhost while not having to change the database to your URL.
4243   *
4244   * @since 2.2.0
4245   * @access private
4246   *
4247   * @see WP_SITEURL
4248   *
4249   * @param string $url URL to set the WordPress site location.
4250   * @return string The WordPress Site URL.
4251   */
4252  function _config_wp_siteurl( $url = '' ) {
4253      if ( defined( 'WP_SITEURL' ) ) {
4254          return untrailingslashit( WP_SITEURL );
4255      }
4256      return $url;
4257  }
4258  
4259  /**
4260   * Delete the fresh site option.
4261   *
4262   * @since 4.7.0
4263   * @access private
4264   */
4265  function _delete_option_fresh_site() {
4266      update_option( 'fresh_site', '0' );
4267  }
4268  
4269  /**
4270   * Set the localized direction for MCE plugin.
4271   *
4272   * Will only set the direction to 'rtl', if the WordPress locale has
4273   * the text direction set to 'rtl'.
4274   *
4275   * Fills in the 'directionality' setting, enables the 'directionality'
4276   * plugin, and adds the 'ltr' button to 'toolbar1', formerly
4277   * 'theme_advanced_buttons1' array keys. These keys are then returned
4278   * in the $mce_init (TinyMCE settings) array.
4279   *
4280   * @since 2.1.0
4281   * @access private
4282   *
4283   * @param array $mce_init MCE settings array.
4284   * @return array Direction set for 'rtl', if needed by locale.
4285   */
4286  function _mce_set_direction( $mce_init ) {
4287      if ( is_rtl() ) {
4288          $mce_init['directionality'] = 'rtl';
4289          $mce_init['rtl_ui']         = true;
4290  
4291          if ( ! empty( $mce_init['plugins'] ) && strpos( $mce_init['plugins'], 'directionality' ) === false ) {
4292              $mce_init['plugins'] .= ',directionality';
4293          }
4294  
4295          if ( ! empty( $mce_init['toolbar1'] ) && ! preg_match( '/\bltr\b/', $mce_init['toolbar1'] ) ) {
4296              $mce_init['toolbar1'] .= ',ltr';
4297          }
4298      }
4299  
4300      return $mce_init;
4301  }
4302  
4303  
4304  /**
4305   * Convert smiley code to the icon graphic file equivalent.
4306   *
4307   * You can turn off smilies, by going to the write setting screen and unchecking
4308   * the box, or by setting 'use_smilies' option to false or removing the option.
4309   *
4310   * Plugins may override the default smiley list by setting the $wpsmiliestrans
4311   * to an array, with the key the code the blogger types in and the value the
4312   * image file.
4313   *
4314   * The $wp_smiliessearch global is for the regular expression and is set each
4315   * time the function is called.
4316   *
4317   * The full list of smilies can be found in the function and won't be listed in
4318   * the description. Probably should create a Codex page for it, so that it is
4319   * available.
4320   *
4321   * @global array $wpsmiliestrans
4322   * @global array $wp_smiliessearch
4323   *
4324   * @since 2.2.0
4325   */
4326  function smilies_init() {
4327      global $wpsmiliestrans, $wp_smiliessearch;
4328  
4329      // Don't bother setting up smilies if they are disabled.
4330      if ( ! get_option( 'use_smilies' ) ) {
4331          return;
4332      }
4333  
4334      if ( ! isset( $wpsmiliestrans ) ) {
4335          $wpsmiliestrans = array(
4336              ':mrgreen:' => 'mrgreen.png',
4337              ':neutral:' => "\xf0\x9f\x98\x90",
4338              ':twisted:' => "\xf0\x9f\x98\x88",
4339              ':arrow:'   => "\xe2\x9e\xa1",
4340              ':shock:'   => "\xf0\x9f\x98\xaf",
4341              ':smile:'   => "\xf0\x9f\x99\x82",
4342              ':???:'     => "\xf0\x9f\x98\x95",
4343              ':cool:'    => "\xf0\x9f\x98\x8e",
4344              ':evil:'    => "\xf0\x9f\x91\xbf",
4345              ':grin:'    => "\xf0\x9f\x98\x80",
4346              ':idea:'    => "\xf0\x9f\x92\xa1",
4347              ':oops:'    => "\xf0\x9f\x98\xb3",
4348              ':razz:'    => "\xf0\x9f\x98\x9b",
4349              ':roll:'    => "\xf0\x9f\x99\x84",
4350              ':wink:'    => "\xf0\x9f\x98\x89",
4351              ':cry:'     => "\xf0\x9f\x98\xa5",
4352              ':eek:'     => "\xf0\x9f\x98\xae",
4353              ':lol:'     => "\xf0\x9f\x98\x86",
4354              ':mad:'     => "\xf0\x9f\x98\xa1",
4355              ':sad:'     => "\xf0\x9f\x99\x81",
4356              '8-)'       => "\xf0\x9f\x98\x8e",
4357              '8-O'       => "\xf0\x9f\x98\xaf",
4358              ':-('       => "\xf0\x9f\x99\x81",
4359              ':-)'       => "\xf0\x9f\x99\x82",
4360              ':-?'       => "\xf0\x9f\x98\x95",
4361              ':-D'       => "\xf0\x9f\x98\x80",
4362              ':-P'       => "\xf0\x9f\x98\x9b",
4363              ':-o'       => "\xf0\x9f\x98\xae",
4364              ':-x'       => "\xf0\x9f\x98\xa1",
4365              ':-|'       => "\xf0\x9f\x98\x90",
4366              ';-)'       => "\xf0\x9f\x98\x89",
4367              // This one transformation breaks regular text with frequency.
4368              //     '8)' => "\xf0\x9f\x98\x8e",
4369              '8O'        => "\xf0\x9f\x98\xaf",
4370              ':('        => "\xf0\x9f\x99\x81",
4371              ':)'        => "\xf0\x9f\x99\x82",
4372              ':?'        => "\xf0\x9f\x98\x95",
4373              ':D'        => "\xf0\x9f\x98\x80",
4374              ':P'        => "\xf0\x9f\x98\x9b",
4375              ':o'        => "\xf0\x9f\x98\xae",
4376              ':x'        => "\xf0\x9f\x98\xa1",
4377              ':|'        => "\xf0\x9f\x98\x90",
4378              ';)'        => "\xf0\x9f\x98\x89",
4379              ':!:'       => "\xe2\x9d\x97",
4380              ':?:'       => "\xe2\x9d\x93",
4381          );
4382      }
4383  
4384      /**
4385       * Filters all the smilies.
4386       *
4387       * This filter must be added before `smilies_init` is run, as
4388       * it is normally only run once to setup the smilies regex.
4389       *
4390       * @since 4.7.0
4391       *
4392       * @param string[] $wpsmiliestrans List of the smilies' hexadecimal representations, keyed by their smily code.
4393       */
4394      $wpsmiliestrans = apply_filters( 'smilies', $wpsmiliestrans );
4395  
4396      if ( count( $wpsmiliestrans ) == 0 ) {
4397          return;
4398      }
4399  
4400      /*
4401       * NOTE: we sort the smilies in reverse key order. This is to make sure
4402       * we match the longest possible smilie (:???: vs :?) as the regular
4403       * expression used below is first-match
4404       */
4405      krsort( $wpsmiliestrans );
4406  
4407      $spaces = wp_spaces_regexp();
4408  
4409      // Begin first "subpattern".
4410      $wp_smiliessearch = '/(?<=' . $spaces . '|^)';
4411  
4412      $subchar = '';
4413      foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
4414          $firstchar = substr( $smiley, 0, 1 );
4415          $rest      = substr( $smiley, 1 );
4416  
4417          // New subpattern?
4418          if ( $firstchar != $subchar ) {
4419              if ( '' !== $subchar ) {
4420                  $wp_smiliessearch .= ')(?=' . $spaces . '|$)';  // End previous "subpattern".
4421                  $wp_smiliessearch .= '|(?<=' . $spaces . '|^)'; // Begin another "subpattern".
4422              }
4423              $subchar           = $firstchar;
4424              $wp_smiliessearch .= preg_quote( $firstchar, '/' ) . '(?:';
4425          } else {
4426              $wp_smiliessearch .= '|';
4427          }
4428          $wp_smiliessearch .= preg_quote( $rest, '/' );
4429      }
4430  
4431      $wp_smiliessearch .= ')(?=' . $spaces . '|$)/m';
4432  
4433  }
4434  
4435  /**
4436   * Merge user defined arguments into defaults array.
4437   *
4438   * This function is used throughout WordPress to allow for both string or array
4439   * to be merged into another array.
4440   *
4441   * @since 2.2.0
4442   * @since 2.3.0 `$args` can now also be an object.
4443   *
4444   * @param string|array|object $args     Value to merge with $defaults.
4445   * @param array               $defaults Optional. Array that serves as the defaults.
4446   *                                      Default empty array.
4447   * @return array Merged user defined values with defaults.
4448   */
4449  function wp_parse_args( $args, $defaults = array() ) {
4450      if ( is_object( $args ) ) {
4451          $parsed_args = get_object_vars( $args );
4452      } elseif ( is_array( $args ) ) {
4453          $parsed_args =& $args;
4454      } else {
4455          wp_parse_str( $args, $parsed_args );
4456      }
4457  
4458      if ( is_array( $defaults ) && $defaults ) {
4459          return array_merge( $defaults, $parsed_args );
4460      }
4461      return $parsed_args;
4462  }
4463  
4464  /**
4465   * Cleans up an array, comma- or space-separated list of scalar values.
4466   *
4467   * @since 5.1.0
4468   *
4469   * @param array|string $list List of values.
4470   * @return array Sanitized array of values.
4471   */
4472  function wp_parse_list( $list ) {
4473      if ( ! is_array( $list ) ) {
4474          return preg_split( '/[\s,]+/', $list, -1, PREG_SPLIT_NO_EMPTY );
4475      }
4476  
4477      return $list;
4478  }
4479  
4480  /**
4481   * Clean up an array, comma- or space-separated list of IDs.
4482   *
4483   * @since 3.0.0
4484   *
4485   * @param array|string $list List of IDs.
4486   * @return int[] Sanitized array of IDs.
4487   */
4488  function wp_parse_id_list( $list ) {
4489      $list = wp_parse_list( $list );
4490  
4491      return array_unique( array_map( 'absint', $list ) );
4492  }
4493  
4494  /**
4495   * Clean up an array, comma- or space-separated list of slugs.
4496   *
4497   * @since 4.7.0
4498   *
4499   * @param array|string $list List of slugs.
4500   * @return string[] Sanitized array of slugs.
4501   */
4502  function wp_parse_slug_list( $list ) {
4503      $list = wp_parse_list( $list );
4504  
4505      return array_unique( array_map( 'sanitize_title', $list ) );
4506  }
4507  
4508  /**
4509   * Extract a slice of an array, given a list of keys.
4510   *
4511   * @since 3.1.0
4512   *
4513   * @param array $array The original array.
4514   * @param array $keys  The list of keys.
4515   * @return array The array slice.
4516   */
4517  function wp_array_slice_assoc( $array, $keys ) {
4518      $slice = array();
4519  
4520      foreach ( $keys as $key ) {
4521          if ( isset( $array[ $key ] ) ) {
4522              $slice[ $key ] = $array[ $key ];
4523          }
4524      }
4525  
4526      return $slice;
4527  }
4528  
4529  /**
4530   * Accesses an array in depth based on a path of keys.
4531   *
4532   * It is the PHP equivalent of JavaScript's `lodash.get()` and mirroring it may help other components
4533   * retain some symmetry between client and server implementations.
4534   *
4535   * Example usage:
4536   *
4537   *     $array = array(
4538   *         'a' => array(
4539   *             'b' => array(
4540   *                 'c' => 1,
4541   *             ),
4542   *         ),
4543   *     );
4544   *     _wp_array_get( $array, array( 'a', 'b', 'c' );
4545   *
4546   * @internal
4547   *
4548   * @since 5.6.0
4549   * @access private
4550   *
4551   * @param array $array   An array from which we want to retrieve some information.
4552   * @param array $path    An array of keys describing the path with which to retrieve information.
4553   * @param mixed $default The return value if the path does not exist within the array,
4554   *                       or if `$array` or `$path` are not arrays.
4555   * @return mixed The value from the path specified.
4556   */
4557  function _wp_array_get( $array, $path, $default = null ) {
4558      // Confirm $path is valid.
4559      if ( ! is_array( $path ) || 0 === count( $path ) ) {
4560          return $default;
4561      }
4562  
4563      foreach ( $path as $path_element ) {
4564          if (
4565              ! is_array( $array ) ||
4566              ( ! is_string( $path_element ) && ! is_integer( $path_element ) && ! is_null( $path_element ) ) ||
4567              ! array_key_exists( $path_element, $array )
4568          ) {
4569              return $default;
4570          }
4571          $array = $array[ $path_element ];
4572      }
4573  
4574      return $array;
4575  }
4576  
4577  /**
4578   * Determines if the variable is a numeric-indexed array.
4579   *
4580   * @since 4.4.0
4581   *
4582   * @param mixed $data Variable to check.
4583   * @return bool Whether the variable is a list.
4584   */
4585  function wp_is_numeric_array( $data ) {
4586      if ( ! is_array( $data ) ) {
4587          return false;
4588      }
4589  
4590      $keys        = array_keys( $data );
4591      $string_keys = array_filter( $keys, 'is_string' );
4592  
4593      return count( $string_keys ) === 0;
4594  }
4595  
4596  /**
4597   * Filters a list of objects, based on a set of key => value arguments.
4598   *
4599   * @since 3.0.0
4600   * @since 4.7.0 Uses `WP_List_Util` class.
4601   *
4602   * @param array       $list     An array of objects to filter
4603   * @param array       $args     Optional. An array of key => value arguments to match
4604   *                              against each object. Default empty array.
4605   * @param string      $operator Optional. The logical operation to perform. 'or' means
4606   *                              only one element from the array needs to match; 'and'
4607   *                              means all elements must match; 'not' means no elements may
4608   *                              match. Default 'and'.
4609   * @param bool|string $field    A field from the object to place instead of the entire object.
4610   *                              Default false.
4611   * @return array A list of objects or object fields.
4612   */
4613  function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
4614      if ( ! is_array( $list ) ) {
4615          return array();
4616      }
4617  
4618      $util = new WP_List_Util( $list );
4619  
4620      $util->filter( $args, $operator );
4621  
4622      if ( $field ) {
4623          $util->pluck( $field );
4624      }
4625  
4626      return $util->get_output();
4627  }
4628  
4629  /**
4630   * Filters a list of objects, based on a set of key => value arguments.
4631   *
4632   * @since 3.1.0
4633   * @since 4.7.0 Uses `WP_List_Util` class.
4634   *
4635   * @param array  $list     An array of objects to filter.
4636   * @param array  $args     Optional. An array of key => value arguments to match
4637   *                         against each object. Default empty array.
4638   * @param string $operator Optional. The logical operation to perform. 'AND' means
4639   *                         all elements from the array must match. 'OR' means only
4640   *                         one element needs to match. 'NOT' means no elements may
4641   *                         match. Default 'AND'.
4642   * @return array Array of found values.
4643   */
4644  function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
4645      if ( ! is_array( $list ) ) {
4646          return array();
4647      }
4648  
4649      $util = new WP_List_Util( $list );
4650      return $util->filter( $args, $operator );
4651  }
4652  
4653  /**
4654   * Pluck a certain field out of each object in a list.
4655   *
4656   * This has the same functionality and prototype of
4657   * array_column() (PHP 5.5) but also supports objects.
4658   *
4659   * @since 3.1.0
4660   * @since 4.0.0 $index_key parameter added.
4661   * @since 4.7.0 Uses `WP_List_Util` class.
4662   *
4663   * @param array      $list      List of objects or arrays
4664   * @param int|string $field     Field from the object to place instead of the entire object
4665   * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
4666   *                              Default null.
4667   * @return array Array of found values. If `$index_key` is set, an array of found values with keys
4668   *               corresponding to `$index_key`. If `$index_key` is null, array keys from the original
4669   *               `$list` will be preserved in the results.
4670   */
4671  function wp_list_pluck( $list, $field, $index_key = null ) {
4672      $util = new WP_List_Util( $list );
4673      return $util->pluck( $field, $index_key );
4674  }
4675  
4676  /**
4677   * Sorts a list of objects, based on one or more orderby arguments.
4678   *
4679   * @since 4.7.0
4680   *
4681   * @param array        $list          An array of objects to sort.
4682   * @param string|array $orderby       Optional. Either the field name to order by or an array
4683   *                                    of multiple orderby fields as $orderby => $order.
4684   * @param string       $order         Optional. Either 'ASC' or 'DESC'. Only used if $orderby
4685   *                                    is a string.
4686   * @param bool         $preserve_keys Optional. Whether to preserve keys. Default false.
4687   * @return array The sorted array.
4688   */
4689  function wp_list_sort( $list, $orderby = array(), $order = 'ASC', $preserve_keys = false ) {
4690      if ( ! is_array( $list ) ) {
4691          return array();
4692      }
4693  
4694      $util = new WP_List_Util( $list );
4695      return $util->sort( $orderby, $order, $preserve_keys );
4696  }
4697  
4698  /**
4699   * Determines if Widgets library should be loaded.
4700   *
4701   * Checks to make sure that the widgets library hasn't already been loaded.
4702   * If it hasn't, then it will load the widgets library and run an action hook.
4703   *
4704   * @since 2.2.0
4705   */
4706  function wp_maybe_load_widgets() {
4707      /**
4708       * Filters whether to load the Widgets library.
4709       *
4710       * Returning a falsey value from the filter will effectively short-circuit
4711       * the Widgets library from loading.
4712       *
4713       * @since 2.8.0
4714       *
4715       * @param bool $wp_maybe_load_widgets Whether to load the Widgets library.
4716       *                                    Default true.
4717       */
4718      if ( ! apply_filters( 'load_default_widgets', true ) ) {
4719          return;
4720      }
4721  
4722      require_once  ABSPATH . WPINC . '/default-widgets.php';
4723  
4724      add_action( '_admin_menu', 'wp_widgets_add_menu' );
4725  }
4726  
4727  /**
4728   * Append the Widgets menu to the themes main menu.
4729   *
4730   * @since 2.2.0
4731   *
4732   * @global array $submenu
4733   */
4734  function wp_widgets_add_menu() {
4735      global $submenu;
4736  
4737      if ( ! current_theme_supports( 'widgets' ) ) {
4738          return;
4739      }
4740  
4741      $submenu['themes.php'][7] = array( __( 'Widgets' ), 'edit_theme_options', 'widgets.php' );
4742      ksort( $submenu['themes.php'], SORT_NUMERIC );
4743  }
4744  
4745  /**
4746   * Flush all output buffers for PHP 5.2.
4747   *
4748   * Make sure all output buffers are flushed before our singletons are destroyed.
4749   *
4750   * @since 2.2.0
4751   */
4752  function wp_ob_end_flush_all() {
4753      $levels = ob_get_level();
4754      for ( $i = 0; $i < $levels; $i++ ) {
4755          ob_end_flush();
4756      }
4757  }
4758  
4759  /**
4760   * Load custom DB error or display WordPress DB error.
4761   *
4762   * If a file exists in the wp-content directory named db-error.php, then it will
4763   * be loaded instead of displaying the WordPress DB error. If it is not found,
4764   * then the WordPress DB error will be displayed instead.
4765   *
4766   * The WordPress DB error sets the HTTP status header to 500 to try to prevent
4767   * search engines from caching the message. Custom DB messages should do the
4768   * same.
4769   *
4770   * This function was backported to WordPress 2.3.2, but originally was added
4771   * in WordPress 2.5.0.
4772   *
4773   * @since 2.3.2
4774   *
4775   * @global wpdb $wpdb WordPress database abstraction object.
4776   */
4777  function dead_db() {
4778      global $wpdb;
4779  
4780      wp_load_translations_early();
4781  
4782      // Load custom DB error template, if present.
4783      if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
4784          require_once WP_CONTENT_DIR . '/db-error.php';
4785          die();
4786      }
4787  
4788      // If installing or in the admin, provide the verbose message.
4789      if ( wp_installing() || defined( 'WP_ADMIN' ) ) {
4790          wp_die( $wpdb->error );
4791      }
4792  
4793      // Otherwise, be terse.
4794      wp_die( '<h1>' . __( 'Error establishing a database connection' ) . '</h1>', __( 'Database Error' ) );
4795  }
4796  
4797  /**
4798   * Convert a value to non-negative integer.
4799   *
4800   * @since 2.5.0
4801   *
4802   * @param mixed $maybeint Data you wish to have converted to a non-negative integer.
4803   * @return int A non-negative integer.
4804   */
4805  function absint( $maybeint ) {
4806      return abs( (int) $maybeint );
4807  }
4808  
4809  /**
4810   * Mark a function as deprecated and inform when it has been used.
4811   *
4812   * There is a {@see 'hook deprecated_function_run'} that will be called that can be used
4813   * to get the backtrace up to what file and function called the deprecated
4814   * function.
4815   *
4816   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
4817   *
4818   * This function is to be used in every function that is deprecated.
4819   *
4820   * @since 2.5.0
4821   * @since 5.4.0 This function is no longer marked as "private".
4822   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
4823   *
4824   * @param string $function    The function that was called.
4825   * @param string $version     The version of WordPress that deprecated the function.
4826   * @param string $replacement Optional. The function that should have been called. Default empty.
4827   */
4828  function _deprecated_function( $function, $version, $replacement = '' ) {
4829  
4830      /**
4831       * Fires when a deprecated function is called.
4832       *
4833       * @since 2.5.0
4834       *
4835       * @param string $function    The function that was called.
4836       * @param string $replacement The function that should have been called.
4837       * @param string $version     The version of WordPress that deprecated the function.
4838       */
4839      do_action( 'deprecated_function_run', $function, $replacement, $version );
4840  
4841      /**
4842       * Filters whether to trigger an error for deprecated functions.
4843       *
4844       * @since 2.5.0
4845       *
4846       * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
4847       */
4848      if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
4849          if ( function_exists( '__' ) ) {
4850              if ( $replacement ) {
4851                  trigger_error(
4852                      sprintf(
4853                          /* translators: 1: PHP function name, 2: Version number, 3: Alternative function name. */
4854                          __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
4855                          $function,
4856                          $version,
4857                          $replacement
4858                      ),
4859                      E_USER_DEPRECATED
4860                  );
4861              } else {
4862                  trigger_error(
4863                      sprintf(
4864                          /* translators: 1: PHP function name, 2: Version number. */
4865                          __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
4866                          $function,
4867                          $version
4868                      ),
4869                      E_USER_DEPRECATED
4870                  );
4871              }
4872          } else {
4873              if ( $replacement ) {
4874                  trigger_error(
4875                      sprintf(
4876                          '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
4877                          $function,
4878                          $version,
4879                          $replacement
4880                      ),
4881                      E_USER_DEPRECATED
4882                  );
4883              } else {
4884                  trigger_error(
4885                      sprintf(
4886                          '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',
4887                          $function,
4888                          $version
4889                      ),
4890                      E_USER_DEPRECATED
4891                  );
4892              }
4893          }
4894      }
4895  }
4896  
4897  /**
4898   * Marks a constructor as deprecated and informs when it has been used.
4899   *
4900   * Similar to _deprecated_function(), but with different strings. Used to
4901   * remove PHP4 style constructors.
4902   *
4903   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
4904   *
4905   * This function is to be used in every PHP4 style constructor method that is deprecated.
4906   *
4907   * @since 4.3.0
4908   * @since 4.5.0 Added the `$parent_class` parameter.
4909   * @since 5.4.0 This function is no longer marked as "private".
4910   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
4911   *
4912   * @param string $class        The class containing the deprecated constructor.
4913   * @param string $version      The version of WordPress that deprecated the function.
4914   * @param string $parent_class Optional. The parent class calling the deprecated constructor.
4915   *                             Default empty string.
4916   */
4917  function _deprecated_constructor( $class, $version, $parent_class = '' ) {
4918  
4919      /**
4920       * Fires when a deprecated constructor is called.
4921       *
4922       * @since 4.3.0
4923       * @since 4.5.0 Added the `$parent_class` parameter.
4924       *
4925       * @param string $class        The class containing the deprecated constructor.
4926       * @param string $version      The version of WordPress that deprecated the function.
4927       * @param string $parent_class The parent class calling the deprecated constructor.
4928       */
4929      do_action( 'deprecated_constructor_run', $class, $version, $parent_class );
4930  
4931      /**
4932       * Filters whether to trigger an error for deprecated functions.
4933       *
4934       * `WP_DEBUG` must be true in addition to the filter evaluating to true.
4935       *
4936       * @since 4.3.0
4937       *
4938       * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
4939       */
4940      if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) {
4941          if ( function_exists( '__' ) ) {
4942              if ( $parent_class ) {
4943                  trigger_error(
4944                      sprintf(
4945                          /* translators: 1: PHP class name, 2: PHP parent class name, 3: Version number, 4: __construct() method. */
4946                          __( 'The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.' ),
4947                          $class,
4948                          $parent_class,
4949                          $version,
4950                          '<code>__construct()</code>'
4951                      ),
4952                      E_USER_DEPRECATED
4953                  );
4954              } else {
4955                  trigger_error(
4956                      sprintf(
4957                          /* translators: 1: PHP class name, 2: Version number, 3: __construct() method. */
4958                          __( 'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
4959                          $class,
4960                          $version,
4961                          '<code>__construct()</code>'
4962                      ),
4963                      E_USER_DEPRECATED
4964                  );
4965              }
4966          } else {
4967              if ( $parent_class ) {
4968                  trigger_error(
4969                      sprintf(
4970                          'The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.',
4971                          $class,
4972                          $parent_class,
4973                          $version,
4974                          '<code>__construct()</code>'
4975                      ),
4976                      E_USER_DEPRECATED
4977                  );
4978              } else {
4979                  trigger_error(
4980                      sprintf(
4981                          'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
4982                          $class,
4983                          $version,
4984                          '<code>__construct()</code>'
4985                      ),
4986                      E_USER_DEPRECATED
4987                  );
4988              }
4989          }
4990      }
4991  
4992  }
4993  
4994  /**
4995   * Mark a file as deprecated and inform when it has been used.
4996   *
4997   * There is a hook {@see 'deprecated_file_included'} that will be called that can be used
4998   * to get the backtrace up to what file and function included the deprecated
4999   * file.
5000   *
5001   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
5002   *
5003   * This function is to be used in every file that is deprecated.
5004   *
5005   * @since 2.5.0
5006   * @since 5.4.0 This function is no longer marked as "private".
5007   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
5008   *
5009   * @param string $file        The file that was included.
5010   * @param string $version     The version of WordPress that deprecated the file.
5011   * @param string $replacement Optional. The file that should have been included based on ABSPATH.
5012   *                            Default empty.
5013   * @param string $message     Optional. A message regarding the change. Default empty.
5014   */
5015  function _deprecated_file( $file, $version, $replacement = '', $message = '' ) {
5016  
5017      /**
5018       * Fires when a deprecated file is called.
5019       *
5020       * @since 2.5.0
5021       *
5022       * @param string $file        The file that was called.
5023       * @param string $replacement The file that should have been included based on ABSPATH.
5024       * @param string $version     The version of WordPress that deprecated the file.
5025       * @param string $message     A message regarding the change.
5026       */
5027      do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
5028  
5029      /**
5030       * Filters whether to trigger an error for deprecated files.
5031       *
5032       * @since 2.5.0
5033       *
5034       * @param bool $trigger Whether to trigger the error for deprecated files. Default true.
5035       */
5036      if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
5037          $message = empty( $message ) ? '' : ' ' . $message;
5038  
5039          if ( function_exists( '__' ) ) {
5040              if ( $replacement ) {
5041                  trigger_error(
5042                      sprintf(
5043                          /* translators: 1: PHP file name, 2: Version number, 3: Alternative file name. */
5044                          __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
5045                          $file,
5046                          $version,
5047                          $replacement
5048                      ) . $message,
5049                      E_USER_DEPRECATED
5050                  );
5051              } else {
5052                  trigger_error(
5053                      sprintf(
5054                          /* translators: 1: PHP file name, 2: Version number. */
5055                          __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
5056                          $file,
5057                          $version
5058                      ) . $message,
5059                      E_USER_DEPRECATED
5060                  );
5061              }
5062          } else {
5063              if ( $replacement ) {
5064                  trigger_error(
5065                      sprintf(
5066                          '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
5067                          $file,
5068                          $version,
5069                          $replacement
5070                      ) . $message,
5071                      E_USER_DEPRECATED
5072                  );
5073              } else {
5074                  trigger_error(
5075                      sprintf(
5076                          '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',
5077                          $file,
5078                          $version
5079                      ) . $message,
5080                      E_USER_DEPRECATED
5081                  );
5082              }
5083          }
5084      }
5085  }
5086  /**
5087   * Mark a function argument as deprecated and inform when it has been used.
5088   *
5089   * This function is to be used whenever a deprecated function argument is used.
5090   * Before this function is called, the argument must be checked for whether it was
5091   * used by comparing it to its default value or evaluating whether it is empty.
5092   * For example:
5093   *
5094   *     if ( ! empty( $deprecated ) ) {
5095   *         _deprecated_argument( __FUNCTION__, '3.0.0' );
5096   *     }
5097   *
5098   * There is a hook deprecated_argument_run that will be called that can be used
5099   * to get the backtrace up to what file and function used the deprecated
5100   * argument.
5101   *
5102   * The current behavior is to trigger a user error if WP_DEBUG is true.
5103   *
5104   * @since 3.0.0
5105   * @since 5.4.0 This function is no longer marked as "private".
5106   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
5107   *
5108   * @param string $function The function that was called.
5109   * @param string $version  The version of WordPress that deprecated the argument used.
5110   * @param string $message  Optional. A message regarding the change. Default empty.
5111   */
5112  function _deprecated_argument( $function, $version, $message = '' ) {
5113  
5114      /**
5115       * Fires when a deprecated argument is called.
5116       *
5117       * @since 3.0.0
5118       *
5119       * @param string $function The function that was called.
5120       * @param string $message  A message regarding the change.
5121       * @param string $version  The version of WordPress that deprecated the argument used.
5122       */
5123      do_action( 'deprecated_argument_run', $function, $message, $version );
5124  
5125      /**
5126       * Filters whether to trigger an error for deprecated arguments.
5127       *
5128       * @since 3.0.0
5129       *
5130       * @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
5131       */
5132      if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
5133          if ( function_exists( '__' ) ) {
5134              if ( $message ) {
5135                  trigger_error(
5136                      sprintf(
5137                          /* translators: 1: PHP function name, 2: Version number, 3: Optional message regarding the change. */
5138                          __( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s' ),
5139                          $function,
5140                          $version,
5141                          $message
5142                      ),
5143                      E_USER_DEPRECATED
5144                  );
5145              } else {
5146                  trigger_error(
5147                      sprintf(
5148                          /* translators: 1: PHP function name, 2: Version number. */
5149                          __( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
5150                          $function,
5151                          $version
5152                      ),
5153                      E_USER_DEPRECATED
5154                  );
5155              }
5156          } else {
5157              if ( $message ) {
5158                  trigger_error(
5159                      sprintf(
5160                          '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s',
5161                          $function,
5162                          $version,
5163                          $message
5164                      ),
5165                      E_USER_DEPRECATED
5166                  );
5167              } else {
5168                  trigger_error(
5169                      sprintf(
5170                          '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.',
5171                          $function,
5172                          $version
5173                      ),
5174                      E_USER_DEPRECATED
5175                  );
5176              }
5177          }
5178      }
5179  }
5180  
5181  /**
5182   * Marks a deprecated action or filter hook as deprecated and throws a notice.
5183   *
5184   * Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where
5185   * the deprecated hook was called.
5186   *
5187   * Default behavior is to trigger a user error if `WP_DEBUG` is true.
5188   *
5189   * This function is called by the do_action_deprecated() and apply_filters_deprecated()
5190   * functions, and so generally does not need to be called directly.
5191   *
5192   * @since 4.6.0
5193   * @since 5.4.0 The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
5194   * @access private
5195   *
5196   * @param string $hook        The hook that was used.
5197   * @param string $version     The version of WordPress that deprecated the hook.
5198   * @param string $replacement Optional. The hook that should have been used. Default empty.
5199   * @param string $message     Optional. A message regarding the change. Default empty.
5200   */
5201  function _deprecated_hook( $hook, $version, $replacement = '', $message = '' ) {
5202      /**
5203       * Fires when a deprecated hook is called.
5204       *
5205       * @since 4.6.0
5206       *
5207       * @param string $hook        The hook that was called.
5208       * @param string $replacement The hook that should be used as a replacement.
5209       * @param string $version     The version of WordPress that deprecated the argument used.
5210       * @param string $message     A message regarding the change.
5211       */
5212      do_action( 'deprecated_hook_run', $hook, $replacement, $version, $message );
5213  
5214      /**
5215       * Filters whether to trigger deprecated hook errors.
5216       *
5217       * @since 4.6.0
5218       *
5219       * @param bool $trigger Whether to trigger deprecated hook errors. Requires
5220       *                      `WP_DEBUG` to be defined true.
5221       */
5222      if ( WP_DEBUG && apply_filters( 'deprecated_hook_trigger_error', true ) ) {
5223          $message = empty( $message ) ? '' : ' ' . $message;
5224  
5225          if ( $replacement ) {
5226              trigger_error(
5227                  sprintf(
5228                      /* translators: 1: WordPress hook name, 2: Version number, 3: Alternative hook name. */
5229                      __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
5230                      $hook,
5231                      $version,
5232                      $replacement
5233                  ) . $message,
5234                  E_USER_DEPRECATED
5235              );
5236          } else {
5237              trigger_error(
5238                  sprintf(
5239                      /* translators: 1: WordPress hook name, 2: Version number. */
5240                      __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
5241                      $hook,
5242                      $version
5243                  ) . $message,
5244                  E_USER_DEPRECATED
5245              );
5246          }
5247      }
5248  }
5249  
5250  /**
5251   * Mark something as being incorrectly called.
5252   *
5253   * There is a hook {@see 'doing_it_wrong_run'} that will be called that can be used
5254   * to get the backtrace up to what file and function called the deprecated
5255   * function.
5256   *
5257   * The current behavior is to trigger a user error if `WP_DEBUG` is true.
5258   *
5259   * @since 3.1.0
5260   * @since 5.4.0 This function is no longer marked as "private".
5261   *
5262   * @param string $function The function that was called.
5263   * @param string $message  A message explaining what has been done incorrectly.
5264   * @param string $version  The version of WordPress where the message was added.
5265   */
5266  function _doing_it_wrong( $function, $message, $version ) {
5267  
5268      /**
5269       * Fires when the given function is being used incorrectly.
5270       *
5271       * @since 3.1.0
5272       *
5273       * @param string $function The function that was called.
5274       * @param string $message  A message explaining what has been done incorrectly.
5275       * @param string $version  The version of WordPress where the message was added.
5276       */
5277      do_action( 'doing_it_wrong_run', $function, $message, $version );
5278  
5279      /**
5280       * Filters whether to trigger an error for _doing_it_wrong() calls.
5281       *
5282       * @since 3.1.0
5283       * @since 5.1.0 Added the $function, $message and $version parameters.
5284       *
5285       * @param bool   $trigger  Whether to trigger the error for _doing_it_wrong() calls. Default true.
5286       * @param string $function The function that was called.
5287       * @param string $message  A message explaining what has been done incorrectly.
5288       * @param string $version  The version of WordPress where the message was added.
5289       */
5290      if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true, $function, $message, $version ) ) {
5291          if ( function_exists( '__' ) ) {
5292              if ( $version ) {
5293                  /* translators: %s: Version number. */
5294                  $version = sprintf( __( '(This message was added in version %s.)' ), $version );
5295              }
5296  
5297              $message .= ' ' . sprintf(
5298                  /* translators: %s: Documentation URL. */
5299                  __( 'Please see <a href="%s">Debugging in WordPress</a> for more information.' ),
5300                  __( 'https://wordpress.org/support/article/debugging-in-wordpress/' )
5301              );
5302  
5303              trigger_error(
5304                  sprintf(
5305                      /* translators: Developer debugging message. 1: PHP function name, 2: Explanatory message, 3: WordPress version number. */
5306                      __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ),
5307                      $function,
5308                      $message,
5309                      $version
5310                  ),
5311                  E_USER_NOTICE
5312              );
5313          } else {
5314              if ( $version ) {
5315                  $version = sprintf( '(This message was added in version %s.)', $version );
5316              }
5317  
5318              $message .= sprintf(
5319                  ' Please see <a href="%s">Debugging in WordPress</a> for more information.',
5320                  'https://wordpress.org/support/article/debugging-in-wordpress/'
5321              );
5322  
5323              trigger_error(
5324                  sprintf(
5325                      '%1$s was called <strong>incorrectly</strong>. %2$s %3$s',
5326                      $function,
5327                      $message,
5328                      $version
5329                  ),
5330                  E_USER_NOTICE
5331              );
5332          }
5333      }
5334  }
5335  
5336  /**
5337   * Is the server running earlier than 1.5.0 version of lighttpd?
5338   *
5339   * @since 2.5.0
5340   *
5341   * @return bool Whether the server is running lighttpd < 1.5.0.
5342   */
5343  function is_lighttpd_before_150() {
5344      $server_parts    = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : '' );
5345      $server_parts[1] = isset( $server_parts[1] ) ? $server_parts[1] : '';
5346  
5347      return ( 'lighttpd' === $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' ) );
5348  }
5349  
5350  /**
5351   * Does the specified module exist in the Apache config?
5352   *
5353   * @since 2.5.0
5354   *
5355   * @global bool $is_apache
5356   *
5357   * @param string $mod     The module, e.g. mod_rewrite.
5358   * @param bool   $default Optional. The default return value if the module is not found. Default false.
5359   * @return bool Whether the specified module is loaded.
5360   */
5361  function apache_mod_loaded( $mod, $default = false ) {
5362      global $is_apache;
5363  
5364      if ( ! $is_apache ) {
5365          return false;
5366      }
5367  
5368      if ( function_exists( 'apache_get_modules' ) ) {
5369          $mods = apache_get_modules();
5370          if ( in_array( $mod, $mods, true ) ) {
5371              return true;
5372          }
5373      } elseif ( function_exists( 'phpinfo' ) && false === strpos( ini_get( 'disable_functions' ), 'phpinfo' ) ) {
5374              ob_start();
5375              phpinfo( 8 );
5376              $phpinfo = ob_get_clean();
5377          if ( false !== strpos( $phpinfo, $mod ) ) {
5378              return true;
5379          }
5380      }
5381  
5382      return $default;
5383  }
5384  
5385  /**
5386   * Check if IIS 7+ supports pretty permalinks.
5387   *
5388   * @since 2.8.0
5389   *
5390   * @global bool $is_iis7
5391   *
5392   * @return bool Whether IIS7 supports permalinks.
5393   */
5394  function iis7_supports_permalinks() {
5395      global $is_iis7;
5396  
5397      $supports_permalinks = false;
5398      if ( $is_iis7 ) {
5399          /* First we check if the DOMDocument class exists. If it does not exist, then we cannot
5400           * easily update the xml configuration file, hence we just bail out and tell user that
5401           * pretty permalinks cannot be used.
5402           *
5403           * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
5404           * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
5405           * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
5406           * via ISAPI then pretty permalinks will not work.
5407           */
5408          $supports_permalinks = class_exists( 'DOMDocument', false ) && isset( $_SERVER['IIS_UrlRewriteModule'] ) && ( 'cgi-fcgi' === PHP_SAPI );
5409      }
5410  
5411      /**
5412       * Filters whether IIS 7+ supports pretty permalinks.
5413       *
5414       * @since 2.8.0
5415       *
5416       * @param bool $supports_permalinks Whether IIS7 supports permalinks. Default false.
5417       */
5418      return apply_filters( 'iis7_supports_permalinks', $supports_permalinks );
5419  }
5420  
5421  /**
5422   * Validates a file name and path against an allowed set of rules.
5423   *
5424   * A return value of `1` means the file path contains directory traversal.
5425   *
5426   * A return value of `2` means the file path contains a Windows drive path.
5427   *
5428   * A return value of `3` means the file is not in the allowed files list.
5429   *
5430   * @since 1.2.0
5431   *
5432   * @param string   $file          File path.
5433   * @param string[] $allowed_files Optional. Array of allowed files.
5434   * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
5435   */
5436  function validate_file( $file, $allowed_files = array() ) {
5437      // `../` on its own is not allowed:
5438      if ( '../' === $file ) {
5439          return 1;
5440      }
5441  
5442      // More than one occurence of `../` is not allowed:
5443      if ( preg_match_all( '#\.\./#', $file, $matches, PREG_SET_ORDER ) && ( count( $matches ) > 1 ) ) {
5444          return 1;
5445      }
5446  
5447      // `../` which does not occur at the end of the path is not allowed:
5448      if ( false !== strpos( $file, '../' ) && '../' !== mb_substr( $file, -3, 3 ) ) {
5449          return 1;
5450      }
5451  
5452      // Files not in the allowed file list are not allowed:
5453      if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files, true ) ) {
5454          return 3;
5455      }
5456  
5457      // Absolute Windows drive paths are not allowed:
5458      if ( ':' === substr( $file, 1, 1 ) ) {
5459          return 2;
5460      }
5461  
5462      return 0;
5463  }
5464  
5465  /**
5466   * Whether to force SSL used for the Administration Screens.
5467   *
5468   * @since 2.6.0
5469   *
5470   * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
5471   * @return bool True if forced, false if not forced.
5472   */
5473  function force_ssl_admin( $force = null ) {
5474      static $forced = false;
5475  
5476      if ( ! is_null( $force ) ) {
5477          $old_forced = $forced;
5478          $forced     = $force;
5479          return $old_forced;
5480      }
5481  
5482      return $forced;
5483  }
5484  
5485  /**
5486   * Guess the URL for the site.
5487   *
5488   * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
5489   * directory.
5490   *
5491   * @since 2.6.0
5492   *
5493   * @return string The guessed URL.
5494   */
5495  function wp_guess_url() {
5496      if ( defined( 'WP_SITEURL' ) && '' !== WP_SITEURL ) {
5497          $url = WP_SITEURL;
5498      } else {
5499          $abspath_fix         = str_replace( '\\', '/', ABSPATH );
5500          $script_filename_dir = dirname( $_SERVER['SCRIPT_FILENAME'] );
5501  
5502          // The request is for the admin.
5503          if ( strpos( $_SERVER['REQUEST_URI'], 'wp-admin' ) !== false || strpos( $_SERVER['REQUEST_URI'], 'wp-login.php' ) !== false ) {
5504              $path = preg_replace( '#/(wp-admin/.*|wp-login.php)#i', '', $_SERVER['REQUEST_URI'] );
5505  
5506              // The request is for a file in ABSPATH.
5507          } elseif ( $script_filename_dir . '/' === $abspath_fix ) {
5508              // Strip off any file/query params in the path.
5509              $path = preg_replace( '#/[^/]*$#i', '', $_SERVER['PHP_SELF'] );
5510  
5511          } else {
5512              if ( false !== strpos( $_SERVER['SCRIPT_FILENAME'], $abspath_fix ) ) {
5513                  // Request is hitting a file inside ABSPATH.
5514                  $directory = str_replace( ABSPATH, '', $script_filename_dir );
5515                  // Strip off the subdirectory, and any file/query params.
5516                  $path = preg_replace( '#/' . preg_quote( $directory, '#' ) . '/[^/]*$#i', '', $_SERVER['REQUEST_URI'] );
5517              } elseif ( false !== strpos( $abspath_fix, $script_filename_dir ) ) {
5518                  // Request is hitting a file above ABSPATH.
5519                  $subdirectory = substr( $abspath_fix, strpos( $abspath_fix, $script_filename_dir ) + strlen( $script_filename_dir ) );
5520                  // Strip off any file/query params from the path, appending the subdirectory to the installation.
5521                  $path = preg_replace( '#/[^/]*$#i', '', $_SERVER['REQUEST_URI'] ) . $subdirectory;
5522              } else {
5523                  $path = $_SERVER['REQUEST_URI'];
5524              }
5525          }
5526  
5527          $schema = is_ssl() ? 'https://' : 'http://'; // set_url_scheme() is not defined yet.
5528          $url    = $schema . $_SERVER['HTTP_HOST'] . $path;
5529      }
5530  
5531      return rtrim( $url, '/' );
5532  }
5533  
5534  /**
5535   * Temporarily suspend cache additions.
5536   *
5537   * Stops more data being added to the cache, but still allows cache retrieval.
5538   * This is useful for actions, such as imports, when a lot of data would otherwise
5539   * be almost uselessly added to the cache.
5540   *
5541   * Suspension lasts for a single page load at most. Remember to call this
5542   * function again if you wish to re-enable cache adds earlier.
5543   *
5544   * @since 3.3.0
5545   *
5546   * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
5547   * @return bool The current suspend setting
5548   */
5549  function wp_suspend_cache_addition( $suspend = null ) {
5550      static $_suspend = false;
5551  
5552      if ( is_bool( $suspend ) ) {
5553          $_suspend = $suspend;
5554      }
5555  
5556      return $_suspend;
5557  }
5558  
5559  /**
5560   * Suspend cache invalidation.
5561   *
5562   * Turns cache invalidation on and off. Useful during imports where you don't want to do
5563   * invalidations every time a post is inserted. Callers must be sure that what they are
5564   * doing won't lead to an inconsistent cache when invalidation is suspended.
5565   *
5566   * @since 2.7.0
5567   *
5568   * @global bool $_wp_suspend_cache_invalidation
5569   *
5570   * @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true.
5571   * @return bool The current suspend setting.
5572   */
5573  function wp_suspend_cache_invalidation( $suspend = true ) {
5574      global $_wp_suspend_cache_invalidation;
5575  
5576      $current_suspend                = $_wp_suspend_cache_invalidation;
5577      $_wp_suspend_cache_invalidation = $suspend;
5578      return $current_suspend;
5579  }
5580  
5581  /**
5582   * Determine whether a site is the main site of the current network.
5583   *
5584   * @since 3.0.0
5585   * @since 4.9.0 The `$network_id` parameter was added.
5586   *
5587   * @param int $site_id    Optional. Site ID to test. Defaults to current site.
5588   * @param int $network_id Optional. Network ID of the network to check for.
5589   *                        Defaults to current network.
5590   * @return bool True if $site_id is the main site of the network, or if not
5591   *              running Multisite.
5592   */
5593  function is_main_site( $site_id = null, $network_id = null ) {
5594      if ( ! is_multisite() ) {
5595          return true;
5596      }
5597  
5598      if ( ! $site_id ) {
5599          $site_id = get_current_blog_id();
5600      }
5601  
5602      $site_id = (int) $site_id;
5603  
5604      return get_main_site_id( $network_id ) === $site_id;
5605  }
5606  
5607  /**
5608   * Gets the main site ID.
5609   *
5610   * @since 4.9.0
5611   *
5612   * @param int $network_id Optional. The ID of the network for which to get the main site.
5613   *                        Defaults to the current network.
5614   * @return int The ID of the main site.
5615   */
5616  function get_main_site_id( $network_id = null ) {
5617      if ( ! is_multisite() ) {
5618          return get_current_blog_id();
5619      }
5620  
5621      $network = get_network( $network_id );
5622      if ( ! $network ) {
5623          return 0;
5624      }
5625  
5626      return $network->site_id;
5627  }
5628  
5629  /**
5630   * Determine whether a network is the main network of the Multisite installation.
5631   *
5632   * @since 3.7.0
5633   *
5634   * @param int $network_id Optional. Network ID to test. Defaults to current network.
5635   * @return bool True if $network_id is the main network, or if not running Multisite.
5636   */
5637  function is_main_network( $network_id = null ) {
5638      if ( ! is_multisite() ) {
5639          return true;
5640      }
5641  
5642      if ( null === $network_id ) {
5643          $network_id = get_current_network_id();
5644      }
5645  
5646      $network_id = (int) $network_id;
5647  
5648      return ( get_main_network_id() === $network_id );
5649  }
5650  
5651  /**
5652   * Get the main network ID.
5653   *
5654   * @since 4.3.0
5655   *
5656   * @return int The ID of the main network.
5657   */
5658  function get_main_network_id() {
5659      if ( ! is_multisite() ) {
5660          return 1;
5661      }
5662  
5663      $current_network = get_network();
5664  
5665      if ( defined( 'PRIMARY_NETWORK_ID' ) ) {
5666          $main_network_id = PRIMARY_NETWORK_ID;
5667      } elseif ( isset( $current_network->id ) && 1 === (int) $current_network->id ) {
5668          // If the current network has an ID of 1, assume it is the main network.
5669          $main_network_id = 1;
5670      } else {
5671          $_networks       = get_networks(
5672              array(
5673                  'fields' => 'ids',
5674                  'number' => 1,
5675              )
5676          );
5677          $main_network_id = array_shift( $_networks );
5678      }
5679  
5680      /**
5681       * Filters the main network ID.
5682       *
5683       * @since 4.3.0
5684       *
5685       * @param int $main_network_id The ID of the main network.
5686       */
5687      return (int) apply_filters( 'get_main_network_id', $main_network_id );
5688  }
5689  
5690  /**
5691   * Determine whether global terms are enabled.
5692   *
5693   * @since 3.0.0
5694   *
5695   * @return bool True if multisite and global terms enabled.
5696   */
5697  function global_terms_enabled() {
5698      if ( ! is_multisite() ) {
5699          return false;
5700      }
5701  
5702      static $global_terms = null;
5703      if ( is_null( $global_terms ) ) {
5704  
5705          /**
5706           * Filters whether global terms are enabled.
5707           *
5708           * Returning a non-null value from the filter will effectively short-circuit the function
5709           * and return the value of the 'global_terms_enabled' site option instead.
5710           *
5711           * @since 3.0.0
5712           *
5713           * @param null $enabled Whether global terms are enabled.
5714           */
5715          $filter = apply_filters( 'global_terms_enabled', null );
5716          if ( ! is_null( $filter ) ) {
5717              $global_terms = (bool) $filter;
5718          } else {
5719              $global_terms = (bool) get_site_option( 'global_terms_enabled', false );
5720          }
5721      }
5722      return $global_terms;
5723  }
5724  
5725  /**
5726   * Determines whether site meta is enabled.
5727   *
5728   * This function checks whether the 'blogmeta' database table exists. The result is saved as
5729   * a setting for the main network, making it essentially a global setting. Subsequent requests
5730   * will refer to this setting instead of running the query.
5731   *
5732   * @since 5.1.0
5733   *
5734   * @global wpdb $wpdb WordPress database abstraction object.
5735   *
5736   * @return bool True if site meta is supported, false otherwise.
5737   */
5738  function is_site_meta_supported() {
5739      global $wpdb;
5740  
5741      if ( ! is_multisite() ) {
5742          return false;
5743      }
5744  
5745      $network_id = get_main_network_id();
5746  
5747      $supported = get_network_option( $network_id, 'site_meta_supported', false );
5748      if ( false === $supported ) {
5749          $supported = $wpdb->get_var( "SHOW TABLES LIKE '{$wpdb->blogmeta}'" ) ? 1 : 0;
5750  
5751          update_network_option( $network_id, 'site_meta_supported', $supported );
5752      }
5753  
5754      return (bool) $supported;
5755  }
5756  
5757  /**
5758   * gmt_offset modification for smart timezone handling.
5759   *
5760   * Overrides the gmt_offset option if we have a timezone_string available.
5761   *
5762   * @since 2.8.0
5763   *
5764   * @return float|false Timezone GMT offset, false otherwise.
5765   */
5766  function wp_timezone_override_offset() {
5767      $timezone_string = get_option( 'timezone_string' );
5768      if ( ! $timezone_string ) {
5769          return false;
5770      }
5771  
5772      $timezone_object = timezone_open( $timezone_string );
5773      $datetime_object = date_create();
5774      if ( false === $timezone_object || false === $datetime_object ) {
5775          return false;
5776      }
5777      return round( timezone_offset_get( $timezone_object, $datetime_object ) / HOUR_IN_SECONDS, 2 );
5778  }
5779  
5780  /**
5781   * Sort-helper for timezones.
5782   *
5783   * @since 2.9.0
5784   * @access private
5785   *
5786   * @param array $a
5787   * @param array $b
5788   * @return int
5789   */
5790  function _wp_timezone_choice_usort_callback( $a, $b ) {
5791      // Don't use translated versions of Etc.
5792      if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) {
5793          // Make the order of these more like the old dropdown.
5794          if ( 'GMT+' === substr( $a['city'], 0, 4 ) && 'GMT+' === substr( $b['city'], 0, 4 ) ) {
5795              return -1 * ( strnatcasecmp( $a['city'], $b['city'] ) );
5796          }
5797          if ( 'UTC' === $a['city'] ) {
5798              if ( 'GMT+' === substr( $b['city'], 0, 4 ) ) {
5799                  return 1;
5800              }
5801              return -1;
5802          }
5803          if ( 'UTC' === $b['city'] ) {
5804              if ( 'GMT+' === substr( $a['city'], 0, 4 ) ) {
5805                  return -1;
5806              }
5807              return 1;
5808          }
5809          return strnatcasecmp( $a['city'], $b['city'] );
5810      }
5811      if ( $a['t_continent'] == $b['t_continent'] ) {
5812          if ( $a['t_city'] == $b['t_city'] ) {
5813              return strnatcasecmp( $a['t_subcity'], $b['t_subcity'] );
5814          }
5815          return strnatcasecmp( $a['t_city'], $b['t_city'] );
5816      } else {
5817          // Force Etc to the bottom of the list.
5818          if ( 'Etc' === $a['continent'] ) {
5819              return 1;
5820          }
5821          if ( 'Etc' === $b['continent'] ) {
5822              return -1;
5823          }
5824          return strnatcasecmp( $a['t_continent'], $b['t_continent'] );
5825      }
5826  }
5827  
5828  /**
5829   * Gives a nicely-formatted list of timezone strings.
5830   *
5831   * @since 2.9.0
5832   * @since 4.7.0 Added the `$locale` parameter.
5833   *
5834   * @param string $selected_zone Selected timezone.
5835   * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
5836   * @return string
5837   */
5838  function wp_timezone_choice( $selected_zone, $locale = null ) {
5839      static $mo_loaded = false, $locale_loaded = null;
5840  
5841      $continents = array( 'Africa', 'America', 'Antarctica', 'Arctic', 'Asia', 'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific' );
5842  
5843      // Load translations for continents and cities.
5844      if ( ! $mo_loaded || $locale !== $locale_loaded ) {
5845          $locale_loaded = $locale ? $locale : get_locale();
5846          $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
5847          unload_textdomain( 'continents-cities' );
5848          load_textdomain( 'continents-cities', $mofile );
5849          $mo_loaded = true;
5850      }
5851  
5852      $zonen = array();
5853      foreach ( timezone_identifiers_list() as $zone ) {
5854          $zone = explode( '/', $zone );
5855          if ( ! in_array( $zone[0], $continents, true ) ) {
5856              continue;
5857          }
5858  
5859          // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later.
5860          $exists    = array(
5861              0 => ( isset( $zone[0] ) && $zone[0] ),
5862              1 => ( isset(