[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

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