wp-includes/functions.php

   1 <?php
   2 /**
   3  * Main WordPress API
   4  *
   5  * @package WordPress
   6  */
   7
   8 require( ABSPATH . WPINC . '/option.php' );
   9
  10 /**
  11  * Converts 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 is true.
  24  * @return string|int Formatted date string, or Unix timestamp.
  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  *
  50  * If $gmt is set to either '1' or 'true', then both types will use GMT time.
  51  * if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
  52  *
  53  * @since 1.0.0
  54  *
  55  * @param string $type Either 'mysql' or 'timestamp'.
  56  * @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
  57  * @return int|string String if $type is 'gmt', int if $type is 'timestamp'.
  58  */
  59 function current_time( $type, $gmt = 0 ) {
  60         switch ( $type ) {
  61                 case 'mysql':
  62                         return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * 3600 ) ) );
  63                         break;
  64                 case 'timestamp':
  65                         return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * 3600 );
  66                         break;
  67         }
  68 }
  69
  70 /**
  71  * Retrieve the date in localized format, based on timestamp.
  72  *
  73  * If the locale specifies the locale month and weekday, then the locale will
  74  * take over the format for the date. If it isn't, then the date format string
  75  * will be used instead.
  76  *
  77  * @since 0.71
  78  *
  79  * @param string $dateformatstring Format to display the date.
  80  * @param int $unixtimestamp Optional. Unix timestamp.
  81  * @param bool $gmt Optional, default is false. Whether to convert to GMT for time.
  82  * @return string The date, translated if locale specifies it.
  83  */
  84 function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
  85         global $wp_locale;
  86         $i = $unixtimestamp;
  87
  88         if ( false === $i ) {
  89                 if ( ! $gmt )
  90                         $i = current_time( 'timestamp' );
  91                 else
  92                         $i = time();
  93                 // we should not let date() interfere with our
  94                 // specially computed timestamp
  95                 $gmt = true;
  96         }
  97
  98         // store original value for language with untypical grammars
  99         // see http://core.trac.wordpress.org/ticket/9396
 100         $req_format = $dateformatstring;
 101
 102         $datefunc = $gmt? 'gmdate' : 'date';
 103
 104         if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
 105                 $datemonth = $wp_locale->get_month( $datefunc( 'm', $i ) );
 106                 $datemonth_abbrev = $wp_locale->get_month_abbrev( $datemonth );
 107                 $dateweekday = $wp_locale->get_weekday( $datefunc( 'w', $i ) );
 108                 $dateweekday_abbrev = $wp_locale->get_weekday_abbrev( $dateweekday );
 109                 $datemeridiem = $wp_locale->get_meridiem( $datefunc( 'a', $i ) );
 110                 $datemeridiem_capital = $wp_locale->get_meridiem( $datefunc( 'A', $i ) );
 111                 $dateformatstring = ' '.$dateformatstring;
 112                 $dateformatstring = preg_replace( "/([^\\\])D/", "\\1" . backslashit( $dateweekday_abbrev ), $dateformatstring );
 113                 $dateformatstring = preg_replace( "/([^\\\])F/", "\\1" . backslashit( $datemonth ), $dateformatstring );
 114                 $dateformatstring = preg_replace( "/([^\\\])l/", "\\1" . backslashit( $dateweekday ), $dateformatstring );
 115                 $dateformatstring = preg_replace( "/([^\\\])M/", "\\1" . backslashit( $datemonth_abbrev ), $dateformatstring );
 116                 $dateformatstring = preg_replace( "/([^\\\])a/", "\\1" . backslashit( $datemeridiem ), $dateformatstring );
 117                 $dateformatstring = preg_replace( "/([^\\\])A/", "\\1" . backslashit( $datemeridiem_capital ), $dateformatstring );
 118
 119                 $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
 120         }
 121         $timezone_formats = array( 'P', 'I', 'O', 'T', 'Z', 'e' );
 122         $timezone_formats_re = implode( '|', $timezone_formats );
 123         if ( preg_match( "/$timezone_formats_re/", $dateformatstring ) ) {
 124                 $timezone_string = get_option( 'timezone_string' );
 125                 if ( $timezone_string ) {
 126                         $timezone_object = timezone_open( $timezone_string );
 127                         $date_object = date_create( null, $timezone_object );
 128                         foreach( $timezone_formats as $timezone_format ) {
 129                                 if ( false !== strpos( $dateformatstring, $timezone_format ) ) {
 130                                         $formatted = date_format( $date_object, $timezone_format );
 131                                         $dateformatstring = ' '.$dateformatstring;
 132                                         $dateformatstring = preg_replace( "/([^\\\])$timezone_format/", "\\1" . backslashit( $formatted ), $dateformatstring );
 133                                         $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
 134                                 }
 135                         }
 136                 }
 137         }
 138         $j = @$datefunc( $dateformatstring, $i );
 139         // allow plugins to redo this entirely for languages with untypical grammars
 140         $j = apply_filters('date_i18n', $j, $req_format, $i, $gmt);
 141         return $j;
 142 }
 143
 144 /**
 145  * Convert integer number to format based on the locale.
 146  *
 147  * @since 2.3.0
 148  *
 149  * @param int $number The number to convert based on locale.
 150  * @param int $decimals Precision of the number of decimal places.
 151  * @return string Converted number in string format.
 152  */
 153 function number_format_i18n( $number, $decimals = 0 ) {
 154         global $wp_locale;
 155         $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
 156         return apply_filters( 'number_format_i18n', $formatted );
 157 }
 158
 159 /**
 160  * Convert number of bytes largest unit bytes will fit into.
 161  *
 162  * It is easier to read 1kB than 1024 bytes and 1MB than 1048576 bytes. Converts
 163  * number of bytes to human readable number by taking the number of that unit
 164  * that the bytes will go into it. Supports TB value.
 165  *
 166  * Please note that integers in PHP are limited to 32 bits, unless they are on
 167  * 64 bit architecture, then they have 64 bit size. If you need to place the
 168  * larger size then what PHP integer type will hold, then use a string. It will
 169  * be converted to a double, which should always have 64 bit length.
 170  *
 171  * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
 172  * @link http://en.wikipedia.org/wiki/Byte
 173  *
 174  * @since 2.3.0
 175  *
 176  * @param int|string $bytes Number of bytes. Note max integer size for integers.
 177  * @param int $decimals Precision of number of decimal places. Deprecated.
 178  * @return bool|string False on failure. Number string on success.
 179  */
 180 function size_format( $bytes, $decimals = 0 ) {
 181         $quant = array(
 182                 // ========================= Origin ====
 183                 'TB' => 1099511627776,  // pow( 1024, 4)
 184                 'GB' => 1073741824,     // pow( 1024, 3)
 185                 'MB' => 1048576,        // pow( 1024, 2)
 186                 'kB' => 1024,           // pow( 1024, 1)
 187                 'B ' => 1,              // pow( 1024, 0)
 188         );
 189         foreach ( $quant as $unit => $mag )
 190                 if ( doubleval($bytes) >= $mag )
 191                         return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
 192
 193         return false;
 194 }
 195
 196 /**
 197  * Get the week start and end from the datetime or date string from mysql.
 198  *
 199  * @since 0.71
 200  *
 201  * @param string $mysqlstring Date or datetime field type from mysql.
 202  * @param int $start_of_week Optional. Start of the week as an integer.
 203  * @return array Keys are 'start' and 'end'.
 204  */
 205 function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
 206         $my = substr( $mysqlstring, 0, 4 ); // Mysql string Year
 207         $mm = substr( $mysqlstring, 8, 2 ); // Mysql string Month
 208         $md = substr( $mysqlstring, 5, 2 ); // Mysql string day
 209         $day = mktime( 0, 0, 0, $md, $mm, $my ); // The timestamp for mysqlstring day.
 210         $weekday = date( 'w', $day ); // The day of the week from the timestamp
 211         if ( !is_numeric($start_of_week) )
 212                 $start_of_week = get_option( 'start_of_week' );
 213
 214         if ( $weekday < $start_of_week )
 215                 $weekday += 7;
 216
 217         $start = $day - 86400 * ( $weekday - $start_of_week ); // The most recent week start day on or before $day
 218         $end = $start + 604799; // $start + 7 days - 1 second
 219         return compact( 'start', 'end' );
 220 }
 221
 222 /**
 223  * Unserialize value only if it was serialized.
 224  *
 225  * @since 2.0.0
 226  *
 227  * @param string $original Maybe unserialized original, if is needed.
 228  * @return mixed Unserialized data can be any type.
 229  */
 230 function maybe_unserialize( $original ) {
 231         if ( is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
 232                 return @unserialize( $original );
 233         return $original;
 234 }
 235
 236 /**
 237  * Check value to find if it was serialized.
 238  *
 239  * If $data is not an string, then returned value will always be false.
 240  * Serialized data is always a string.
 241  *
 242  * @since 2.0.5
 243  *
 244  * @param mixed $data Value to check to see if was serialized.
 245  * @return bool False if not serialized and true if it was.
 246  */
 247 function is_serialized( $data ) {
 248         // if it isn't a string, it isn't serialized
 249         if ( ! is_string( $data ) )
 250                 return false;
 251         $data = trim( $data );
 252         if ( 'N;' == $data )
 253                 return true;
 254         $length = strlen( $data );
 255         if ( $length < 4 )
 256                 return false;
 257         if ( ':' !== $data[1] )
 258                 return false;
 259         $lastc = $data[$length-1];
 260         if ( ';' !== $lastc && '}' !== $lastc )
 261                 return false;
 262         $token = $data[0];
 263         switch ( $token ) {
 264                 case 's' :
 265                         if ( '"' !== $data[$length-2] )
 266                                 return false;
 267                 case 'a' :
 268                 case 'O' :
 269                         return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
 270                 case 'b' :
 271                 case 'i' :
 272                 case 'd' :
 273                         return (bool) preg_match( "/^{$token}:[0-9.E-]+;\$/", $data );
 274         }
 275         return false;
 276 }
 277
 278 /**
 279  * Check whether serialized data is of string type.
 280  *
 281  * @since 2.0.5
 282  *
 283  * @param mixed $data Serialized data
 284  * @return bool False if not a serialized string, true if it is.
 285  */
 286 function is_serialized_string( $data ) {
 287         // if it isn't a string, it isn't a serialized string
 288         if ( !is_string( $data ) )
 289                 return false;
 290         $data = trim( $data );
 291         $length = strlen( $data );
 292         if ( $length < 4 )
 293                 return false;
 294         elseif ( ':' !== $data[1] )
 295                 return false;
 296         elseif ( ';' !== $data[$length-1] )
 297                 return false;
 298         elseif ( $data[0] !== 's' )
 299                 return false;
 300         elseif ( '"' !== $data[$length-2] )
 301                 return false;
 302         else
 303                 return true;
 304 }
 305
 306 /**
 307  * Serialize data, if needed.
 308  *
 309  * @since 2.0.5
 310  *
 311  * @param mixed $data Data that might be serialized.
 312  * @return mixed A scalar data
 313  */
 314 function maybe_serialize( $data ) {
 315         if ( is_array( $data ) || is_object( $data ) )
 316                 return serialize( $data );
 317
 318         // Double serialization is required for backward compatibility.
 319         // See http://core.trac.wordpress.org/ticket/12930
 320         if ( is_serialized( $data ) )
 321                 return serialize( $data );
 322
 323         return $data;
 324 }
 325
 326 /**
 327  * Retrieve post title from XMLRPC XML.
 328  *
 329  * If the title element is not part of the XML, then the default post title from
 330  * the $post_default_title will be used instead.
 331  *
 332  * @package WordPress
 333  * @subpackage XMLRPC
 334  * @since 0.71
 335  *
 336  * @global string $post_default_title Default XMLRPC post title.
 337  *
 338  * @param string $content XMLRPC XML Request content
 339  * @return string Post title
 340  */
 341 function xmlrpc_getposttitle( $content ) {
 342         global $post_default_title;
 343         if ( preg_match( '/<title>(.+?)<\/title>/is', $content, $matchtitle ) ) {
 344                 $post_title = $matchtitle[1];
 345         } else {
 346                 $post_title = $post_default_title;
 347         }
 348         return $post_title;
 349 }
 350
 351 /**
 352  * Retrieve the post category or categories from XMLRPC XML.
 353  *
 354  * If the category element is not found, then the default post category will be
 355  * used. The return type then would be what $post_default_category. If the
 356  * category is found, then it will always be an array.
 357  *
 358  * @package WordPress
 359  * @subpackage XMLRPC
 360  * @since 0.71
 361  *
 362  * @global string $post_default_category Default XMLRPC post category.
 363  *
 364  * @param string $content XMLRPC XML Request content
 365  * @return string|array List of categories or category name.
 366  */
 367 function xmlrpc_getpostcategory( $content ) {
 368         global $post_default_category;
 369         if ( preg_match( '/<category>(.+?)<\/category>/is', $content, $matchcat ) ) {
 370                 $post_category = trim( $matchcat[1], ',' );
 371                 $post_category = explode( ',', $post_category );
 372         } else {
 373                 $post_category = $post_default_category;
 374         }
 375         return $post_category;
 376 }
 377
 378 /**
 379  * XMLRPC XML content without title and category elements.
 380  *
 381  * @package WordPress
 382  * @subpackage XMLRPC
 383  * @since 0.71
 384  *
 385  * @param string $content XMLRPC XML Request content
 386  * @return string XMLRPC XML Request content without title and category elements.
 387  */
 388 function xmlrpc_removepostdata( $content ) {
 389         $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
 390         $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
 391         $content = trim( $content );
 392         return $content;
 393 }
 394
 395 /**
 396  * Check content for video and audio links to add as enclosures.
 397  *
 398  * Will not add enclosures that have already been added and will
 399  * remove enclosures that are no longer in the post. This is called as
 400  * pingbacks and trackbacks.
 401  *
 402  * @package WordPress
 403  * @since 1.5.0
 404  *
 405  * @uses $wpdb
 406  *
 407  * @param string $content Post Content
 408  * @param int $post_ID Post ID
 409  */
 410 function do_enclose( $content, $post_ID ) {
 411         global $wpdb;
 412
 413         //TODO: Tidy this ghetto code up and make the debug code optional
 414         include_once( ABSPATH . WPINC . '/class-IXR.php' );
 415
 416         $post_links = array();
 417
 418         $pung = get_enclosed( $post_ID );
 419
 420         $ltrs = '\w';
 421         $gunk = '/#~:.?+=&%@!\-';
 422         $punc = '.:?\-';
 423         $any = $ltrs . $gunk . $punc;
 424
 425         preg_match_all( "{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp );
 426
 427         foreach ( $pung as $link_test ) {
 428                 if ( !in_array( $link_test, $post_links_temp[0] ) ) { // link no longer in post
 429                         $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, like_escape( $link_test ) . '%') );
 430                         foreach ( $mids as $mid )
 431                                 delete_metadata_by_mid( 'post', $mid );
 432                 }
 433         }
 434
 435         foreach ( (array) $post_links_temp[0] as $link_test ) {
 436                 if ( !in_array( $link_test, $pung ) ) { // If we haven't pung it already
 437                         $test = @parse_url( $link_test );
 438                         if ( false === $test )
 439                                 continue;
 440                         if ( isset( $test['query'] ) )
 441                                 $post_links[] = $link_test;
 442                         elseif ( isset($test['path']) && ( $test['path'] != '/' ) &&  ($test['path'] != '' ) )
 443                                 $post_links[] = $link_test;
 444                 }
 445         }
 446
 447         foreach ( (array) $post_links as $url ) {
 448                 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, like_escape( $url ) . '%' ) ) ) {
 449
 450                         if ( $headers = wp_get_http_headers( $url) ) {
 451                                 $len = isset( $headers['content-length'] ) ? (int) $headers['content-length'] : 0;
 452                                 $type = isset( $headers['content-type'] ) ? $headers['content-type'] : '';
 453                                 $allowed_types = array( 'video', 'audio' );
 454
 455                                 // Check to see if we can figure out the mime type from
 456                                 // the extension
 457                                 $url_parts = @parse_url( $url );
 458                                 if ( false !== $url_parts ) {
 459                                         $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );
 460                                         if ( !empty( $extension ) ) {
 461                                                 foreach ( get_allowed_mime_types( ) as $exts => $mime ) {
 462                                                         if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
 463                                                                 $type = $mime;
 464                                                                 break;
 465                                                         }
 466                                                 }
 467                                         }
 468                                 }
 469
 470                                 if ( in_array( substr( $type, 0, strpos( $type, "/" ) ), $allowed_types ) ) {
 471                                         add_post_meta( $post_ID, 'enclosure', "$url\n$len\n$mime\n" );
 472                                 }
 473                         }
 474                 }
 475         }
 476 }
 477
 478 /**
 479  * Perform a HTTP HEAD or GET request.
 480  *
 481  * If $file_path is a writable filename, this will do a GET request and write
 482  * the file to that path.
 483  *
 484  * @since 2.5.0
 485  *
 486  * @param string $url URL to fetch.
 487  * @param string|bool $file_path Optional. File path to write request to.
 488  * @param int $red (private) The number of Redirects followed, Upon 5 being hit, returns false.
 489  * @return bool|string False on failure and string of headers if HEAD request.
 490  */
 491 function wp_get_http( $url, $file_path = false, $red = 1 ) {
 492         @set_time_limit( 60 );
 493
 494         if ( $red > 5 )
 495                 return false;
 496
 497         $options = array();
 498         $options['redirection'] = 5;
 499
 500         if ( false == $file_path )
 501                 $options['method'] = 'HEAD';
 502         else
 503                 $options['method'] = 'GET';
 504
 505         $response = wp_remote_request($url, $options);
 506
 507         if ( is_wp_error( $response ) )
 508                 return false;
 509
 510         $headers = wp_remote_retrieve_headers( $response );
 511         $headers['response'] = wp_remote_retrieve_response_code( $response );
 512
 513         // WP_HTTP no longer follows redirects for HEAD requests.
 514         if ( 'HEAD' == $options['method'] && in_array($headers['response'], array(301, 302)) && isset( $headers['location'] ) ) {
 515                 return wp_get_http( $headers['location'], $file_path, ++$red );
 516         }
 517
 518         if ( false == $file_path )
 519                 return $headers;
 520
 521         // GET request - write it to the supplied filename
 522         $out_fp = fopen($file_path, 'w');
 523         if ( !$out_fp )
 524                 return $headers;
 525
 526         fwrite( $out_fp,  wp_remote_retrieve_body( $response ) );
 527         fclose($out_fp);
 528         clearstatcache();
 529
 530         return $headers;
 531 }
 532
 533 /**
 534  * Retrieve HTTP Headers from URL.
 535  *
 536  * @since 1.5.1
 537  *
 538  * @param string $url
 539  * @param bool $deprecated Not Used.
 540  * @return bool|string False on failure, headers on success.
 541  */
 542 function wp_get_http_headers( $url, $deprecated = false ) {
 543         if ( !empty( $deprecated ) )
 544                 _deprecated_argument( __FUNCTION__, '2.7' );
 545
 546         $response = wp_remote_head( $url );
 547
 548         if ( is_wp_error( $response ) )
 549                 return false;
 550
 551         return wp_remote_retrieve_headers( $response );
 552 }
 553
 554 /**
 555  * Whether today is a new day.
 556  *
 557  * @since 0.71
 558  * @uses $day Today
 559  * @uses $previousday Previous day
 560  *
 561  * @return int 1 when new day, 0 if not a new day.
 562  */
 563 function is_new_day() {
 564         global $currentday, $previousday;
 565         if ( $currentday != $previousday )
 566                 return 1;
 567         else
 568                 return 0;
 569 }
 570
 571 /**
 572  * Build URL query based on an associative and, or indexed array.
 573  *
 574  * This is a convenient function for easily building url queries. It sets the
 575  * separator to '&' and uses _http_build_query() function.
 576  *
 577  * @see _http_build_query() Used to build the query
 578  * @link http://us2.php.net/manual/en/function.http-build-query.php more on what
 579  *              http_build_query() does.
 580  *
 581  * @since 2.3.0
 582  *
 583  * @param array $data URL-encode key/value pairs.
 584  * @return string URL encoded string
 585  */
 586 function build_query( $data ) {
 587         return _http_build_query( $data, null, '&', '', false );
 588 }
 589
 590 // from php.net (modified by Mark Jaquith to behave like the native PHP5 function)
 591 function _http_build_query($data, $prefix=null, $sep=null, $key='', $urlencode=true) {
 592         $ret = array();
 593
 594         foreach ( (array) $data as $k => $v ) {
 595                 if ( $urlencode)
 596                         $k = urlencode($k);
 597                 if ( is_int($k) && $prefix != null )
 598                         $k = $prefix.$k;
 599                 if ( !empty($key) )
 600                         $k = $key . '%5B' . $k . '%5D';
 601                 if ( $v === null )
 602                         continue;
 603                 elseif ( $v === FALSE )
 604                         $v = '0';
 605
 606                 if ( is_array($v) || is_object($v) )
 607                         array_push($ret,_http_build_query($v, '', $sep, $k, $urlencode));
 608                 elseif ( $urlencode )
 609                         array_push($ret, $k.'='.urlencode($v));
 610                 else
 611                         array_push($ret, $k.'='.$v);
 612         }
 613
 614         if ( null === $sep )
 615                 $sep = ini_get('arg_separator.output');
 616
 617         return implode($sep, $ret);
 618 }
 619
 620 /**
 621  * Retrieve a modified URL query string.
 622  *
 623  * You can rebuild the URL and append a new query variable to the URL query by
 624  * using this function. You can also retrieve the full URL with query data.
 625  *
 626  * Adding a single key & value or an associative array. Setting a key value to
 627  * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER
 628  * value. Additional values provided are expected to be encoded appropriately
 629  * with urlencode() or rawurlencode().
 630  *
 631  * @since 1.5.0
 632  *
 633  * @param mixed $param1 Either newkey or an associative_array
 634  * @param mixed $param2 Either newvalue or oldquery or uri
 635  * @param mixed $param3 Optional. Old query or uri
 636  * @return string New URL query string.
 637  */
 638 function add_query_arg() {
 639         $ret = '';
 640         if ( is_array( func_get_arg(0) ) ) {
 641                 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
 642                         $uri = $_SERVER['REQUEST_URI'];
 643                 else
 644                         $uri = @func_get_arg( 1 );
 645         } else {
 646                 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
 647                         $uri = $_SERVER['REQUEST_URI'];
 648                 else
 649                         $uri = @func_get_arg( 2 );
 650         }
 651
 652         if ( $frag = strstr( $uri, '#' ) )
 653                 $uri = substr( $uri, 0, -strlen( $frag ) );
 654         else
 655                 $frag = '';
 656
 657         if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
 658                 $protocol = $matches[0];
 659                 $uri = substr( $uri, strlen( $protocol ) );
 660         } else {
 661                 $protocol = '';
 662         }
 663
 664         if ( strpos( $uri, '?' ) !== false ) {
 665                 $parts = explode( '?', $uri, 2 );
 666                 if ( 1 == count( $parts ) ) {
 667                         $base = '?';
 668                         $query = $parts[0];
 669                 } else {
 670                         $base = $parts[0] . '?';
 671                         $query = $parts[1];
 672                 }
 673         } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
 674                 $base = $uri . '?';
 675                 $query = '';
 676         } else {
 677                 $base = '';
 678                 $query = $uri;
 679         }
 680
 681         wp_parse_str( $query, $qs );
 682         $qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
 683         if ( is_array( func_get_arg( 0 ) ) ) {
 684                 $kayvees = func_get_arg( 0 );
 685                 $qs = array_merge( $qs, $kayvees );
 686         } else {
 687                 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
 688         }
 689
 690         foreach ( (array) $qs as $k => $v ) {
 691                 if ( $v === false )
 692                         unset( $qs[$k] );
 693         }
 694
 695         $ret = build_query( $qs );
 696         $ret = trim( $ret, '?' );
 697         $ret = preg_replace( '#=(&|$)#', '$1', $ret );
 698         $ret = $protocol . $base . $ret . $frag;
 699         $ret = rtrim( $ret, '?' );
 700         return $ret;
 701 }
 702
 703 /**
 704  * Removes an item or list from the query string.
 705  *
 706  * @since 1.5.0
 707  *
 708  * @param string|array $key Query key or keys to remove.
 709  * @param bool $query When false uses the $_SERVER value.
 710  * @return string New URL query string.
 711  */
 712 function remove_query_arg( $key, $query=false ) {
 713         if ( is_array( $key ) ) { // removing multiple keys
 714                 foreach ( $key as $k )
 715                         $query = add_query_arg( $k, false, $query );
 716                 return $query;
 717         }
 718         return add_query_arg( $key, false, $query );
 719 }
 720
 721 /**
 722  * Walks the array while sanitizing the contents.
 723  *
 724  * @since 0.71
 725  *
 726  * @param array $array Array to used to walk while sanitizing contents.
 727  * @return array Sanitized $array.
 728  */
 729 function add_magic_quotes( $array ) {
 730         foreach ( (array) $array as $k => $v ) {
 731                 if ( is_array( $v ) ) {
 732                         $array[$k] = add_magic_quotes( $v );
 733                 } else {
 734                         $array[$k] = addslashes( $v );
 735                 }
 736         }
 737         return $array;
 738 }
 739
 740 /**
 741  * HTTP request for URI to retrieve content.
 742  *
 743  * @since 1.5.1
 744  * @uses wp_remote_get()
 745  *
 746  * @param string $uri URI/URL of web page to retrieve.
 747  * @return bool|string HTTP content. False on failure.
 748  */
 749 function wp_remote_fopen( $uri ) {
 750         $parsed_url = @parse_url( $uri );
 751
 752         if ( !$parsed_url || !is_array( $parsed_url ) )
 753                 return false;
 754
 755         $options = array();
 756         $options['timeout'] = 10;
 757
 758         $response = wp_remote_get( $uri, $options );
 759
 760         if ( is_wp_error( $response ) )
 761                 return false;
 762
 763         return wp_remote_retrieve_body( $response );
 764 }
 765
 766 /**
 767  * Set up the WordPress query.
 768  *
 769  * @since 2.0.0
 770  *
 771  * @param string $query_vars Default WP_Query arguments.
 772  */
 773 function wp( $query_vars = '' ) {
 774         global $wp, $wp_query, $wp_the_query;
 775         $wp->main( $query_vars );
 776
 777         if ( !isset($wp_the_query) )
 778                 $wp_the_query = $wp_query;
 779 }
 780
 781 /**
 782  * Retrieve the description for the HTTP status.
 783  *
 784  * @since 2.3.0
 785  *
 786  * @param int $code HTTP status code.
 787  * @return string Empty string if not found, or description if found.
 788  */
 789 function get_status_header_desc( $code ) {
 790         global $wp_header_to_desc;
 791
 792         $code = absint( $code );
 793
 794         if ( !isset( $wp_header_to_desc ) ) {
 795                 $wp_header_to_desc = array(
 796                         100 => 'Continue',
 797                         101 => 'Switching Protocols',
 798                         102 => 'Processing',
 799
 800                         200 => 'OK',
 801                         201 => 'Created',
 802                         202 => 'Accepted',
 803                         203 => 'Non-Authoritative Information',
 804                         204 => 'No Content',
 805                         205 => 'Reset Content',
 806                         206 => 'Partial Content',
 807                         207 => 'Multi-Status',
 808                         226 => 'IM Used',
 809
 810                         300 => 'Multiple Choices',
 811                         301 => 'Moved Permanently',
 812                         302 => 'Found',
 813                         303 => 'See Other',
 814                         304 => 'Not Modified',
 815                         305 => 'Use Proxy',
 816                         306 => 'Reserved',
 817                         307 => 'Temporary Redirect',
 818
 819                         400 => 'Bad Request',
 820                         401 => 'Unauthorized',
 821                         402 => 'Payment Required',
 822                         403 => 'Forbidden',
 823                         404 => 'Not Found',
 824                         405 => 'Method Not Allowed',
 825                         406 => 'Not Acceptable',
 826                         407 => 'Proxy Authentication Required',
 827                         408 => 'Request Timeout',
 828                         409 => 'Conflict',
 829                         410 => 'Gone',
 830                         411 => 'Length Required',
 831                         412 => 'Precondition Failed',
 832                         413 => 'Request Entity Too Large',
 833                         414 => 'Request-URI Too Long',
 834                         415 => 'Unsupported Media Type',
 835                         416 => 'Requested Range Not Satisfiable',
 836                         417 => 'Expectation Failed',
 837                         422 => 'Unprocessable Entity',
 838                         423 => 'Locked',
 839                         424 => 'Failed Dependency',
 840                         426 => 'Upgrade Required',
 841
 842                         500 => 'Internal Server Error',
 843                         501 => 'Not Implemented',
 844                         502 => 'Bad Gateway',
 845                         503 => 'Service Unavailable',
 846                         504 => 'Gateway Timeout',
 847                         505 => 'HTTP Version Not Supported',
 848                         506 => 'Variant Also Negotiates',
 849                         507 => 'Insufficient Storage',
 850                         510 => 'Not Extended'
 851                 );
 852         }
 853
 854         if ( isset( $wp_header_to_desc[$code] ) )
 855                 return $wp_header_to_desc[$code];
 856         else
 857                 return '';
 858 }
 859
 860 /**
 861  * Set HTTP status header.
 862  *
 863  * @since 2.0.0
 864  * @uses apply_filters() Calls 'status_header' on status header string, HTTP
 865  *              HTTP code, HTTP code description, and protocol string as separate
 866  *              parameters.
 867  *
 868  * @param int $header HTTP status code
 869  * @return unknown
 870  */
 871 function status_header( $header ) {
 872         $text = get_status_header_desc( $header );
 873
 874         if ( empty( $text ) )
 875                 return false;
 876
 877         $protocol = $_SERVER["SERVER_PROTOCOL"];
 878         if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
 879                 $protocol = 'HTTP/1.0';
 880         $status_header = "$protocol $header $text";
 881         if ( function_exists( 'apply_filters' ) )
 882                 $status_header = apply_filters( 'status_header', $status_header, $header, $text, $protocol );
 883
 884         return @header( $status_header, true, $header );
 885 }
 886
 887 /**
 888  * Gets the header information to prevent caching.
 889  *
 890  * The several different headers cover the different ways cache prevention is handled
 891  * by different browsers
 892  *
 893  * @since 2.8.0
 894  *
 895  * @uses apply_filters()
 896  * @return array The associative array of header names and field values.
 897  */
 898 function wp_get_nocache_headers() {
 899         $headers = array(
 900                 'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
 901                 'Last-Modified' => gmdate( 'D, d M Y H:i:s' ) . ' GMT',
 902                 'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
 903                 'Pragma' => 'no-cache',
 904         );
 905
 906         if ( function_exists('apply_filters') ) {
 907                 $headers = (array) apply_filters('nocache_headers', $headers);
 908         }
 909         return $headers;
 910 }
 911
 912 /**
 913  * Sets the headers to prevent caching for the different browsers.
 914  *
 915  * Different browsers support different nocache headers, so several headers must
 916  * be sent so that all of them get the point that no caching should occur.
 917  *
 918  * @since 2.0.0
 919  * @uses wp_get_nocache_headers()
 920  */
 921 function nocache_headers() {
 922         $headers = wp_get_nocache_headers();
 923         foreach( $headers as $name => $field_value )
 924                 @header("{$name}: {$field_value}");
 925 }
 926
 927 /**
 928  * Set the headers for caching for 10 days with JavaScript content type.
 929  *
 930  * @since 2.1.0
 931  */
 932 function cache_javascript_headers() {
 933         $expiresOffset = 864000; // 10 days
 934         header( "Content-Type: text/javascript; charset=" . get_bloginfo( 'charset' ) );
 935         header( "Vary: Accept-Encoding" ); // Handle proxies
 936         header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $expiresOffset ) . " GMT" );
 937 }
 938
 939 /**
 940  * Retrieve the number of database queries during the WordPress execution.
 941  *
 942  * @since 2.0.0
 943  *
 944  * @return int Number of database queries
 945  */
 946 function get_num_queries() {
 947         global $wpdb;
 948         return $wpdb->num_queries;
 949 }
 950
 951 /**
 952  * Whether input is yes or no. Must be 'y' to be true.
 953  *
 954  * @since 1.0.0
 955  *
 956  * @param string $yn Character string containing either 'y' or 'n'
 957  * @return bool True if yes, false on anything else
 958  */
 959 function bool_from_yn( $yn ) {
 960         return ( strtolower( $yn ) == 'y' );
 961 }
 962
 963 /**
 964  * Loads the feed template from the use of an action hook.
 965  *
 966  * If the feed action does not have a hook, then the function will die with a
 967  * message telling the visitor that the feed is not valid.
 968  *
 969  * It is better to only have one hook for each feed.
 970  *
 971  * @since 2.1.0
 972  * @uses $wp_query Used to tell if the use a comment feed.
 973  * @uses do_action() Calls 'do_feed_$feed' hook, if a hook exists for the feed.
 974  */
 975 function do_feed() {
 976         global $wp_query;
 977
 978         $feed = get_query_var( 'feed' );
 979
 980         // Remove the pad, if present.
 981         $feed = preg_replace( '/^_+/', '', $feed );
 982
 983         if ( $feed == '' || $feed == 'feed' )
 984                 $feed = get_default_feed();
 985
 986         $hook = 'do_feed_' . $feed;
 987         if ( !has_action($hook) ) {
 988                 $message = sprintf( __( 'ERROR: %s is not a valid feed template.' ), esc_html($feed));
 989                 wp_die( $message, '', array( 'response' => 404 ) );
 990         }
 991
 992         do_action( $hook, $wp_query->is_comment_feed );
 993 }
 994
 995 /**
 996  * Load the RDF RSS 0.91 Feed template.
 997  *
 998  * @since 2.1.0
 999  */
1000 function do_feed_rdf() {
1001         load_template( ABSPATH . WPINC . '/feed-rdf.php' );
1002 }
1003
1004 /**
1005  * Load the RSS 1.0 Feed Template.
1006  *
1007  * @since 2.1.0
1008  */
1009 function do_feed_rss() {
1010         load_template( ABSPATH . WPINC . '/feed-rss.php' );
1011 }
1012
1013 /**
1014  * Load either the RSS2 comment feed or the RSS2 posts feed.
1015  *
1016  * @since 2.1.0
1017  *
1018  * @param bool $for_comments True for the comment feed, false for normal feed.
1019  */
1020 function do_feed_rss2( $for_comments ) {
1021         if ( $for_comments )
1022                 load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' );
1023         else
1024                 load_template( ABSPATH . WPINC . '/feed-rss2.php' );
1025 }
1026
1027 /**
1028  * Load either Atom comment feed or Atom posts feed.
1029  *
1030  * @since 2.1.0
1031  *
1032  * @param bool $for_comments True for the comment feed, false for normal feed.
1033  */
1034 function do_feed_atom( $for_comments ) {
1035         if ($for_comments)
1036                 load_template( ABSPATH . WPINC . '/feed-atom-comments.php');
1037         else
1038                 load_template( ABSPATH . WPINC . '/feed-atom.php' );
1039 }
1040
1041 /**
1042  * Display the robots.txt file content.
1043  *
1044  * The echo content should be with usage of the permalinks or for creating the
1045  * robots.txt file.
1046  *
1047  * @since 2.1.0
1048  * @uses do_action() Calls 'do_robotstxt' hook for displaying robots.txt rules.
1049  */
1050 function do_robots() {
1051         header( 'Content-Type: text/plain; charset=utf-8' );
1052
1053         do_action( 'do_robotstxt' );
1054
1055         $output = "User-agent: *\n";
1056         $public = get_option( 'blog_public' );
1057         if ( '0' == $public ) {
1058                 $output .= "Disallow: /\n";
1059         } else {
1060                 $site_url = parse_url( site_url() );
1061                 $path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : '';
1062                 $output .= "Disallow: $path/wp-admin/\n";
1063                 $output .= "Disallow: $path/wp-includes/\n";
1064         }
1065
1066         echo apply_filters('robots_txt', $output, $public);
1067 }
1068
1069 /**
1070  * Test whether blog is already installed.
1071  *
1072  * The cache will be checked first. If you have a cache plugin, which saves the
1073  * cache values, then this will work. If you use the default WordPress cache,
1074  * and the database goes away, then you might have problems.
1075  *
1076  * Checks for the option siteurl for whether WordPress is installed.
1077  *
1078  * @since 2.1.0
1079  * @uses $wpdb
1080  *
1081  * @return bool Whether blog is already installed.
1082  */
1083 function is_blog_installed() {
1084         global $wpdb;
1085
1086         // Check cache first. If options table goes away and we have true cached, oh well.
1087         if ( wp_cache_get( 'is_blog_installed' ) )
1088                 return true;
1089
1090         $suppress = $wpdb->suppress_errors();
1091         if ( ! defined( 'WP_INSTALLING' ) ) {
1092                 $alloptions = wp_load_alloptions();
1093         }
1094         // If siteurl is not set to autoload, check it specifically
1095         if ( !isset( $alloptions['siteurl'] ) )
1096                 $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
1097         else
1098                 $installed = $alloptions['siteurl'];
1099         $wpdb->suppress_errors( $suppress );
1100
1101         $installed = !empty( $installed );
1102         wp_cache_set( 'is_blog_installed', $installed );
1103
1104         if ( $installed )
1105                 return true;
1106
1107         // If visiting repair.php, return true and let it take over.
1108         if ( defined( 'WP_REPAIRING' ) )
1109                 return true;
1110
1111         $suppress = $wpdb->suppress_errors();
1112
1113         // Loop over the WP tables. If none exist, then scratch install is allowed.
1114         // If one or more exist, suggest table repair since we got here because the options
1115         // table could not be accessed.
1116         $wp_tables = $wpdb->tables();
1117         foreach ( $wp_tables as $table ) {
1118                 // The existence of custom user tables shouldn't suggest an insane state or prevent a clean install.
1119                 if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table )
1120                         continue;
1121                 if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table )
1122                         continue;
1123
1124                 if ( ! $wpdb->get_results( "DESCRIBE $table;" ) )
1125                         continue;
1126
1127                 // One or more tables exist. We are insane.
1128
1129                 wp_load_translations_early();
1130
1131                 // Die with a DB error.
1132                 $wpdb->error = sprintf( __( 'One or more database tables are unavailable. The database may need to be <a href="%s">repaired</a>.' ), 'maint/repair.php?referrer=is_blog_installed' );
1133                 dead_db();
1134         }
1135
1136         $wpdb->suppress_errors( $suppress );
1137
1138         wp_cache_set( 'is_blog_installed', false );
1139
1140         return false;
1141 }
1142
1143 /**
1144  * Retrieve URL with nonce added to URL query.
1145  *
1146  * @package WordPress
1147  * @subpackage Security
1148  * @since 2.0.4
1149  *
1150  * @param string $actionurl URL to add nonce action
1151  * @param string $action Optional. Nonce action name
1152  * @return string URL with nonce action added.
1153  */
1154 function wp_nonce_url( $actionurl, $action = -1 ) {
1155         $actionurl = str_replace( '&amp;', '&', $actionurl );
1156         return esc_html( add_query_arg( '_wpnonce', wp_create_nonce( $action ), $actionurl ) );
1157 }
1158
1159 /**
1160  * Retrieve or display nonce hidden field for forms.
1161  *
1162  * The nonce field is used to validate that the contents of the form came from
1163  * the location on the current site and not somewhere else. The nonce does not
1164  * offer absolute protection, but should protect against most cases. It is very
1165  * important to use nonce field in forms.
1166  *
1167  * The $action and $name are optional, but if you want to have better security,
1168  * it is strongly suggested to set those two parameters. It is easier to just
1169  * call the function without any parameters, because validation of the nonce
1170  * doesn't require any parameters, but since crackers know what the default is
1171  * it won't be difficult for them to find a way around your nonce and cause
1172  * damage.
1173  *
1174  * The input name will be whatever $name value you gave. The input value will be
1175  * the nonce creation value.
1176  *
1177  * @package WordPress
1178  * @subpackage Security
1179  * @since 2.0.4
1180  *
1181  * @param string $action Optional. Action name.
1182  * @param string $name Optional. Nonce name.
1183  * @param bool $referer Optional, default true. Whether to set the referer field for validation.
1184  * @param bool $echo Optional, default true. Whether to display or return hidden form field.
1185  * @return string Nonce field.
1186  */
1187 function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
1188         $name = esc_attr( $name );
1189         $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
1190
1191         if ( $referer )
1192                 $nonce_field .= wp_referer_field( false );
1193
1194         if ( $echo )
1195                 echo $nonce_field;
1196
1197         return $nonce_field;
1198 }
1199
1200 /**
1201  * Retrieve or display referer hidden field for forms.
1202  *
1203  * The referer link is the current Request URI from the server super global. The
1204  * input name is '_wp_http_referer', in case you wanted to check manually.
1205  *
1206  * @package WordPress
1207  * @subpackage Security
1208  * @since 2.0.4
1209  *
1210  * @param bool $echo Whether to echo or return the referer field.
1211  * @return string Referer field.
1212  */
1213 function wp_referer_field( $echo = true ) {
1214         $ref = esc_attr( $_SERVER['REQUEST_URI'] );
1215         $referer_field = '<input type="hidden" name="_wp_http_referer" value="'. $ref . '" />';
1216
1217         if ( $echo )
1218                 echo $referer_field;
1219         return $referer_field;
1220 }
1221
1222 /**
1223  * Retrieve or display original referer hidden field for forms.
1224  *
1225  * The input name is '_wp_original_http_referer' and will be either the same
1226  * value of {@link wp_referer_field()}, if that was posted already or it will
1227  * be the current page, if it doesn't exist.
1228  *
1229  * @package WordPress
1230  * @subpackage Security
1231  * @since 2.0.4
1232  *
1233  * @param bool $echo Whether to echo the original http referer
1234  * @param string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to.
1235  * @return string Original referer field.
1236  */
1237 function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
1238         $jump_back_to = ( 'previous' == $jump_back_to ) ? wp_get_referer() : $_SERVER['REQUEST_URI'];
1239         $ref = ( wp_get_original_referer() ) ? wp_get_original_referer() : $jump_back_to;
1240         $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( stripslashes( $ref ) ) . '" />';
1241         if ( $echo )
1242                 echo $orig_referer_field;
1243         return $orig_referer_field;
1244 }
1245
1246 /**
1247  * Retrieve referer from '_wp_http_referer' or HTTP referer. If it's the same
1248  * as the current request URL, will return false.
1249  *
1250  * @package WordPress
1251  * @subpackage Security
1252  * @since 2.0.4
1253  *
1254  * @return string|bool False on failure. Referer URL on success.
1255  */
1256 function wp_get_referer() {
1257         $ref = false;
1258         if ( ! empty( $_REQUEST['_wp_http_referer'] ) )
1259                 $ref = $_REQUEST['_wp_http_referer'];
1260         else if ( ! empty( $_SERVER['HTTP_REFERER'] ) )
1261                 $ref = $_SERVER['HTTP_REFERER'];
1262
1263         if ( $ref && $ref !== $_SERVER['REQUEST_URI'] )
1264                 return $ref;
1265         return false;
1266 }
1267
1268 /**
1269  * Retrieve original referer that was posted, if it exists.
1270  *
1271  * @package WordPress
1272  * @subpackage Security
1273  * @since 2.0.4
1274  *
1275  * @return string|bool False if no original referer or original referer if set.
1276  */
1277 function wp_get_original_referer() {
1278         if ( !empty( $_REQUEST['_wp_original_http_referer'] ) )
1279                 return $_REQUEST['_wp_original_http_referer'];
1280         return false;
1281 }
1282
1283 /**
1284  * Recursive directory creation based on full path.
1285  *
1286  * Will attempt to set permissions on folders.
1287  *
1288  * @since 2.0.1
1289  *
1290  * @param string $target Full path to attempt to create.
1291  * @return bool Whether the path was created. True if path already exists.
1292  */
1293 function wp_mkdir_p( $target ) {
1294         // from php.net/mkdir user contributed notes
1295         $target = str_replace( '//', '/', $target );
1296
1297         // safe mode fails with a trailing slash under certain PHP versions.
1298         $target = rtrim($target, '/'); // Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
1299         if ( empty($target) )
1300                 $target = '/';
1301
1302         if ( file_exists( $target ) )
1303                 return @is_dir( $target );
1304
1305         // Attempting to create the directory may clutter up our display.
1306         if ( @mkdir( $target ) ) {
1307                 $stat = @stat( dirname( $target ) );
1308                 $dir_perms = $stat['mode'] & 0007777;  // Get the permission bits.
1309                 @chmod( $target, $dir_perms );
1310                 return true;
1311         } elseif ( is_dir( dirname( $target ) ) ) {
1312                         return false;
1313         }
1314
1315         // If the above failed, attempt to create the parent node, then try again.
1316         if ( ( $target != '/' ) && ( wp_mkdir_p( dirname( $target ) ) ) )
1317                 return wp_mkdir_p( $target );
1318
1319         return false;
1320 }
1321
1322 /**
1323  * Test if a give filesystem path is absolute ('/foo/bar', 'c:\windows').
1324  *
1325  * @since 2.5.0
1326  *
1327  * @param string $path File path
1328  * @return bool True if path is absolute, false is not absolute.
1329  */
1330 function path_is_absolute( $path ) {
1331         // this is definitive if true but fails if $path does not exist or contains a symbolic link
1332         if ( realpath($path) == $path )
1333                 return true;
1334
1335         if ( strlen($path) == 0 || $path[0] == '.' )
1336                 return false;
1337
1338         // windows allows absolute paths like this
1339         if ( preg_match('#^[a-zA-Z]:\\\\#', $path) )
1340                 return true;
1341
1342         // a path starting with / or \ is absolute; anything else is relative
1343         return ( $path[0] == '/' || $path[0] == '\\' );
1344 }
1345
1346 /**
1347  * Join two filesystem paths together (e.g. 'give me $path relative to $base').
1348  *
1349  * If the $path is absolute, then it the full path is returned.
1350  *
1351  * @since 2.5.0
1352  *
1353  * @param string $base
1354  * @param string $path
1355  * @return string The path with the base or absolute path.
1356  */
1357 function path_join( $base, $path ) {
1358         if ( path_is_absolute($path) )
1359                 return $path;
1360
1361         return rtrim($base, '/') . '/' . ltrim($path, '/');
1362 }
1363
1364 /**
1365  * Determines a writable directory for temporary files.
1366  * Function's preference is to WP_CONTENT_DIR followed by the return value of <code>sys_get_temp_dir()</code>, before finally defaulting to /tmp/
1367  *
1368  * In the event that this function does not find a writable location, It may be overridden by the <code>WP_TEMP_DIR</code> constant in your <code>wp-config.php</code> file.
1369  *
1370  * @since 2.5.0
1371  *
1372  * @return string Writable temporary directory
1373  */
1374 function get_temp_dir() {
1375         static $temp;
1376         if ( defined('WP_TEMP_DIR') )
1377                 return trailingslashit(WP_TEMP_DIR);
1378
1379         if ( $temp )
1380                 return trailingslashit($temp);
1381
1382         $temp = WP_CONTENT_DIR . '/';
1383         if ( is_dir($temp) && @is_writable($temp) )
1384                 return $temp;
1385
1386         if  ( function_exists('sys_get_temp_dir') ) {
1387                 $temp = sys_get_temp_dir();
1388                 if ( @is_writable($temp) )
1389                         return trailingslashit($temp);
1390         }
1391
1392         $temp = ini_get('upload_tmp_dir');
1393         if ( is_dir($temp) && @is_writable($temp) )
1394                 return trailingslashit($temp);
1395
1396         $temp = '/tmp/';
1397         return $temp;
1398 }
1399
1400 /**
1401  * Get an array containing the current upload directory's path and url.
1402  *
1403  * Checks the 'upload_path' option, which should be from the web root folder,
1404  * and if it isn't empty it will be used. If it is empty, then the path will be
1405  * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
1406  * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
1407  *
1408  * The upload URL path is set either by the 'upload_url_path' option or by using
1409  * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
1410  *
1411  * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
1412  * the administration settings panel), then the time will be used. The format
1413  * will be year first and then month.
1414  *
1415  * If the path couldn't be created, then an error will be returned with the key
1416  * 'error' containing the error message. The error suggests that the parent
1417  * directory is not writable by the server.
1418  *
1419  * On success, the returned array will have many indices:
1420  * 'path' - base directory and sub directory or full path to upload directory.
1421  * 'url' - base url and sub directory or absolute URL to upload directory.
1422  * 'subdir' - sub directory if uploads use year/month folders option is on.
1423  * 'basedir' - path without subdir.
1424  * 'baseurl' - URL path without subdir.
1425  * 'error' - set to false.
1426  *
1427  * @since 2.0.0
1428  * @uses apply_filters() Calls 'upload_dir' on returned array.
1429  *
1430  * @param string $time Optional. Time formatted in 'yyyy/mm'.
1431  * @return array See above for description.
1432  */
1433 function wp_upload_dir( $time = null ) {
1434         global $switched;
1435         $siteurl = get_option( 'siteurl' );
1436         $upload_path = get_option( 'upload_path' );
1437         $upload_path = trim($upload_path);
1438         $main_override = is_multisite() && defined( 'MULTISITE' ) && is_main_site();
1439         if ( empty($upload_path) ) {
1440                 $dir = WP_CONTENT_DIR . '/uploads';
1441         } else {
1442                 $dir = $upload_path;
1443                 if ( 'wp-content/uploads' == $upload_path ) {
1444                         $dir = WP_CONTENT_DIR . '/uploads';
1445                 } elseif ( 0 !== strpos($dir, ABSPATH) ) {
1446                         // $dir is absolute, $upload_path is (maybe) relative to ABSPATH
1447                         $dir = path_join( ABSPATH, $dir );
1448                 }
1449         }
1450
1451         if ( !$url = get_option( 'upload_url_path' ) ) {
1452                 if ( empty($upload_path) || ( 'wp-content/uploads' == $upload_path ) || ( $upload_path == $dir ) )
1453                         $url = WP_CONTENT_URL . '/uploads';
1454                 else
1455                         $url = trailingslashit( $siteurl ) . $upload_path;
1456         }
1457
1458         if ( defined('UPLOADS') && !$main_override && ( !isset( $switched ) || $switched === false ) ) {
1459                 $dir = ABSPATH . UPLOADS;
1460                 $url = trailingslashit( $siteurl ) . UPLOADS;
1461         }
1462
1463         if ( is_multisite() && !$main_override && ( !isset( $switched ) || $switched === false ) ) {
1464                 if ( defined( 'BLOGUPLOADDIR' ) )
1465                         $dir = untrailingslashit(BLOGUPLOADDIR);
1466                 $url = str_replace( UPLOADS, 'files', $url );
1467         }
1468
1469         $bdir = $dir;
1470         $burl = $url;
1471
1472         $subdir = '';
1473         if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
1474                 // Generate the yearly and monthly dirs
1475                 if ( !$time )
1476                         $time = current_time( 'mysql' );
1477                 $y = substr( $time, 0, 4 );
1478                 $m = substr( $time, 5, 2 );
1479                 $subdir = "/$y/$m";
1480         }
1481
1482         $dir .= $subdir;
1483         $url .= $subdir;
1484
1485         $uploads = apply_filters( 'upload_dir', array( 'path' => $dir, 'url' => $url, 'subdir' => $subdir, 'basedir' => $bdir, 'baseurl' => $burl, 'error' => false ) );
1486
1487         // Make sure we have an uploads dir
1488         if ( ! wp_mkdir_p( $uploads['path'] ) ) {
1489                 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $uploads['path'] );
1490                 return array( 'error' => $message );
1491         }
1492
1493         return $uploads;
1494 }
1495
1496 /**
1497  * Get a filename that is sanitized and unique for the given directory.
1498  *
1499  * If the filename is not unique, then a number will be added to the filename
1500  * before the extension, and will continue adding numbers until the filename is
1501  * unique.
1502  *
1503  * The callback is passed three parameters, the first one is the directory, the
1504  * second is the filename, and the third is the extension.
1505  *
1506  * @since 2.5.0
1507  *
1508  * @param string $dir
1509  * @param string $filename
1510  * @param mixed $unique_filename_callback Callback.
1511  * @return string New filename, if given wasn't unique.
1512  */
1513 function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
1514         // sanitize the file name before we begin processing
1515         $filename = sanitize_file_name($filename);
1516
1517         // separate the filename into a name and extension
1518         $info = pathinfo($filename);
1519         $ext = !empty($info['extension']) ? '.' . $info['extension'] : '';
1520         $name = basename($filename, $ext);
1521
1522         // edge case: if file is named '.ext', treat as an empty name
1523         if ( $name === $ext )
1524                 $name = '';
1525
1526         // Increment the file number until we have a unique file to save in $dir. Use callback if supplied.
1527         if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
1528                 $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
1529         } else {
1530                 $number = '';
1531
1532                 // change '.ext' to lower case
1533                 if ( $ext && strtolower($ext) != $ext ) {
1534                         $ext2 = strtolower($ext);
1535                         $filename2 = preg_replace( '|' . preg_quote($ext) . '$|', $ext2, $filename );
1536
1537                         // check for both lower and upper case extension or image sub-sizes may be overwritten
1538                         while ( file_exists($dir . "/$filename") || file_exists($dir . "/$filename2") ) {
1539                                 $new_number = $number + 1;
1540                                 $filename = str_replace( "$number$ext", "$new_number$ext", $filename );
1541                                 $filename2 = str_replace( "$number$ext2", "$new_number$ext2", $filename2 );
1542                                 $number = $new_number;
1543                         }
1544                         return $filename2;
1545                 }
1546
1547                 while ( file_exists( $dir . "/$filename" ) ) {
1548                         if ( '' == "$number$ext" )
1549                                 $filename = $filename . ++$number . $ext;
1550                         else
1551                                 $filename = str_replace( "$number$ext", ++$number . $ext, $filename );
1552                 }
1553         }
1554
1555         return $filename;
1556 }
1557
1558 /**
1559  * Create a file in the upload folder with given content.
1560  *
1561  * If there is an error, then the key 'error' will exist with the error message.
1562  * If success, then the key 'file' will have the unique file path, the 'url' key
1563  * will have the link to the new file. and the 'error' key will be set to false.
1564  *
1565  * This function will not move an uploaded file to the upload folder. It will
1566  * create a new file with the content in $bits parameter. If you move the upload
1567  * file, read the content of the uploaded file, and then you can give the
1568  * filename and content to this function, which will add it to the upload
1569  * folder.
1570  *
1571  * The permissions will be set on the new file automatically by this function.
1572  *
1573  * @since 2.0.0
1574  *
1575  * @param string $name
1576  * @param null $deprecated Never used. Set to null.
1577  * @param mixed $bits File content
1578  * @param string $time Optional. Time formatted in 'yyyy/mm'.
1579  * @return array
1580  */
1581 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
1582         if ( !empty( $deprecated ) )
1583                 _deprecated_argument( __FUNCTION__, '2.0' );
1584
1585         if ( empty( $name ) )
1586                 return array( 'error' => __( 'Empty filename' ) );
1587
1588         $wp_filetype = wp_check_filetype( $name );
1589         if ( !$wp_filetype['ext'] )
1590                 return array( 'error' => __( 'Invalid file type' ) );
1591
1592         $upload = wp_upload_dir( $time );
1593
1594         if ( $upload['error'] !== false )
1595                 return $upload;
1596
1597         $upload_bits_error = apply_filters( 'wp_upload_bits', array( 'name' => $name, 'bits' => $bits, 'time' => $time ) );
1598         if ( !is_array( $upload_bits_error ) ) {
1599                 $upload[ 'error' ] = $upload_bits_error;
1600                 return $upload;
1601         }
1602
1603         $filename = wp_unique_filename( $upload['path'], $name );
1604
1605         $new_file = $upload['path'] . "/$filename";
1606         if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
1607                 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), dirname( $new_file ) );
1608                 return array( 'error' => $message );
1609         }
1610
1611         $ifp = @ fopen( $new_file, 'wb' );
1612         if ( ! $ifp )
1613                 return array( 'error' => sprintf( __( 'Could not write file %s' ), $new_file ) );
1614
1615         @fwrite( $ifp, $bits );
1616         fclose( $ifp );
1617         clearstatcache();
1618
1619         // Set correct file permissions
1620         $stat = @ stat( dirname( $new_file ) );
1621         $perms = $stat['mode'] & 0007777;
1622         $perms = $perms & 0000666;
1623         @ chmod( $new_file, $perms );
1624         clearstatcache();
1625
1626         // Compute the URL
1627         $url = $upload['url'] . "/$filename";
1628
1629         return array( 'file' => $new_file, 'url' => $url, 'error' => false );
1630 }
1631
1632 /**
1633  * Retrieve the file type based on the extension name.
1634  *
1635  * @package WordPress
1636  * @since 2.5.0
1637  * @uses apply_filters() Calls 'ext2type' hook on default supported types.
1638  *
1639  * @param string $ext The extension to search.
1640  * @return string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found.
1641  */
1642 function wp_ext2type( $ext ) {
1643         $ext2type = apply_filters( 'ext2type', array(
1644                 'audio'       => array( 'aac', 'ac3',  'aif',  'aiff', 'm3a',  'm4a',   'm4b', 'mka', 'mp1', 'mp2',  'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
1645                 'video'       => array( 'asf', 'avi',  'divx', 'dv',   'flv',  'm4v',   'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt',  'rm', 'vob', 'wmv' ),
1646                 'document'    => array( 'doc', 'docx', 'docm', 'dotm', 'odt',  'pages', 'pdf', 'rtf', 'wp',  'wpd' ),
1647                 'spreadsheet' => array( 'numbers',     'ods',  'xls',  'xlsx', 'xlsb',  'xlsm' ),
1648                 'interactive' => array( 'key', 'ppt',  'pptx', 'pptm', 'odp',  'swf' ),
1649                 'text'        => array( 'asc', 'csv',  'tsv',  'txt' ),
1650                 'archive'     => array( 'bz2', 'cab',  'dmg',  'gz',   'rar',  'sea',   'sit', 'sqx', 'tar', 'tgz',  'zip', '7z' ),
1651                 'code'        => array( 'css', 'htm',  'html', 'php',  'js' ),
1652         ));
1653         foreach ( $ext2type as $type => $exts )
1654                 if ( in_array( $ext, $exts ) )
1655                         return $type;
1656 }
1657
1658 /**
1659  * Retrieve the file type from the file name.
1660  *
1661  * You can optionally define the mime array, if needed.
1662  *
1663  * @since 2.0.4
1664  *
1665  * @param string $filename File name or path.
1666  * @param array $mimes Optional. Key is the file extension with value as the mime type.
1667  * @return array Values with extension first and mime type.
1668  */
1669 function wp_check_filetype( $filename, $mimes = null ) {
1670         if ( empty($mimes) )
1671                 $mimes = get_allowed_mime_types();
1672         $type = false;
1673         $ext = false;
1674
1675         foreach ( $mimes as $ext_preg => $mime_match ) {
1676                 $ext_preg = '!\.(' . $ext_preg . ')$!i';
1677                 if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
1678                         $type = $mime_match;
1679                         $ext = $ext_matches[1];
1680                         break;
1681                 }
1682         }
1683
1684         return compact( 'ext', 'type' );
1685 }
1686
1687 /**
1688  * Attempt to determine the real file type of a file.
1689  * If unable to, the file name extension will be used to determine type.
1690  *
1691  * If it's determined that the extension does not match the file's real type,
1692  * then the "proper_filename" value will be set with a proper filename and extension.
1693  *
1694  * Currently this function only supports validating images known to getimagesize().
1695  *
1696  * @since 3.0.0
1697  *
1698  * @param string $file Full path to the image.
1699  * @param string $filename The filename of the image (may differ from $file due to $file being in a tmp directory)
1700  * @param array $mimes Optional. Key is the file extension with value as the mime type.
1701  * @return array Values for the extension, MIME, and either a corrected filename or false if original $filename is valid
1702  */
1703 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
1704
1705         $proper_filename = false;
1706
1707         // Do basic extension validation and MIME mapping
1708         $wp_filetype = wp_check_filetype( $filename, $mimes );
1709         extract( $wp_filetype );
1710
1711         // We can't do any further validation without a file to work with
1712         if ( ! file_exists( $file ) )
1713                 return compact( 'ext', 'type', 'proper_filename' );
1714
1715         // We're able to validate images using GD
1716         if ( $type && 0 === strpos( $type, 'image/' ) && function_exists('getimagesize') ) {
1717
1718                 // Attempt to figure out what type of image it actually is
1719                 $imgstats = @getimagesize( $file );
1720
1721                 // If getimagesize() knows what kind of image it really is and if the real MIME doesn't match the claimed MIME
1722                 if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
1723                         // This is a simplified array of MIMEs that getimagesize() can detect and their extensions
1724                         // You shouldn't need to use this filter, but it's here just in case
1725                         $mime_to_ext = apply_filters( 'getimagesize_mimes_to_exts', array(
1726                                 'image/jpeg' => 'jpg',
1727                                 'image/png'  => 'png',
1728                                 'image/gif'  => 'gif',
1729                                 'image/bmp'  => 'bmp',
1730                                 'image/tiff' => 'tif',
1731                         ) );
1732
1733                         // Replace whatever is after the last period in the filename with the correct extension
1734                         if ( ! empty( $mime_to_ext[ $imgstats['mime'] ] ) ) {
1735                                 $filename_parts = explode( '.', $filename );
1736                                 array_pop( $filename_parts );
1737                                 $filename_parts[] = $mime_to_ext[ $imgstats['mime'] ];
1738                                 $new_filename = implode( '.', $filename_parts );
1739
1740                                 if ( $new_filename != $filename )
1741                                         $proper_filename = $new_filename; // Mark that it changed
1742
1743                                 // Redefine the extension / MIME
1744                                 $wp_filetype = wp_check_filetype( $new_filename, $mimes );
1745                                 extract( $wp_filetype );
1746                         }
1747                 }
1748         }
1749
1750         // Let plugins try and validate other types of files
1751         // Should return an array in the style of array( 'ext' => $ext, 'type' => $type, 'proper_filename' => $proper_filename )
1752         return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes );
1753 }
1754
1755 /**
1756  * Retrieve list of allowed mime types and file extensions.
1757  *
1758  * @since 2.8.6
1759  *
1760  * @return array Array of mime types keyed by the file extension regex corresponding to those types.
1761  */
1762 function get_allowed_mime_types() {
1763         static $mimes = false;
1764
1765         if ( !$mimes ) {
1766                 // Accepted MIME types are set here as PCRE unless provided.
1767                 $mimes = apply_filters( 'upload_mimes', array(
1768                 'jpg|jpeg|jpe' => 'image/jpeg',
1769                 'gif' => 'image/gif',
1770                 'png' => 'image/png',
1771                 'bmp' => 'image/bmp',
1772                 'tif|tiff' => 'image/tiff',
1773                 'ico' => 'image/x-icon',
1774                 'asf|asx|wax|wmv|wmx' => 'video/asf',
1775                 'avi' => 'video/avi',
1776                 'divx' => 'video/divx',
1777                 'flv' => 'video/x-flv',
1778                 'mov|qt' => 'video/quicktime',
1779                 'mpeg|mpg|mpe' => 'video/mpeg',
1780                 'txt|asc|c|cc|h' => 'text/plain',
1781                 'csv' => 'text/csv',
1782                 'tsv' => 'text/tab-separated-values',
1783                 'ics' => 'text/calendar',
1784                 'rtx' => 'text/richtext',
1785                 'css' => 'text/css',
1786                 'htm|html' => 'text/html',
1787                 'mp3|m4a|m4b' => 'audio/mpeg',
1788                 'mp4|m4v' => 'video/mp4',
1789                 'ra|ram' => 'audio/x-realaudio',
1790                 'wav' => 'audio/wav',
1791                 'ogg|oga' => 'audio/ogg',
1792                 'ogv' => 'video/ogg',
1793                 'mid|midi' => 'audio/midi',
1794                 'wma' => 'audio/wma',
1795                 'mka' => 'audio/x-matroska',
1796                 'mkv' => 'video/x-matroska',
1797                 'rtf' => 'application/rtf',
1798                 'js' => 'application/javascript',
1799                 'pdf' => 'application/pdf',
1800                 'doc|docx' => 'application/msword',
1801                 'pot|pps|ppt|pptx|ppam|pptm|sldm|ppsm|potm' => 'application/vnd.ms-powerpoint',
1802                 'wri' => 'application/vnd.ms-write',
1803                 'xla|xls|xlsx|xlt|xlw|xlam|xlsb|xlsm|xltm' => 'application/vnd.ms-excel',
1804                 'mdb' => 'application/vnd.ms-access',
1805                 'mpp' => 'application/vnd.ms-project',
1806                 'docm|dotm' => 'application/vnd.ms-word',
1807                 'pptx|sldx|ppsx|potx' => 'application/vnd.openxmlformats-officedocument.presentationml',
1808                 'xlsx|xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml',
1809                 'docx|dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml',
1810                 'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
1811                 'swf' => 'application/x-shockwave-flash',
1812                 'class' => 'application/java',
1813                 'tar' => 'application/x-tar',
1814                 'zip' => 'application/zip',
1815                 'gz|gzip' => 'application/x-gzip',
1816                 'rar' => 'application/rar',
1817                 '7z' => 'application/x-7z-compressed',
1818                 'exe' => 'application/x-msdownload',
1819                 // openoffice formats
1820                 'odt' => 'application/vnd.oasis.opendocument.text',
1821                 'odp' => 'application/vnd.oasis.opendocument.presentation',
1822                 'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
1823                 'odg' => 'application/vnd.oasis.opendocument.graphics',
1824                 'odc' => 'application/vnd.oasis.opendocument.chart',
1825                 'odb' => 'application/vnd.oasis.opendocument.database',
1826                 'odf' => 'application/vnd.oasis.opendocument.formula',
1827                 // wordperfect formats
1828                 'wp|wpd' => 'application/wordperfect',
1829                 ) );
1830         }
1831
1832         return $mimes;
1833 }
1834
1835 /**
1836  * Retrieve nonce action "Are you sure" message.
1837  *
1838  * The action is split by verb and noun. The action format is as follows:
1839  * verb-action_extra. The verb is before the first dash and has the format of
1840  * letters and no spaces and numbers. The noun is after the dash and before the
1841  * underscore, if an underscore exists. The noun is also only letters.
1842  *
1843  * The filter will be called for any action, which is not defined by WordPress.
1844  * You may use the filter for your plugin to explain nonce actions to the user,
1845  * when they get the "Are you sure?" message. The filter is in the format of
1846  * 'explain_nonce_$verb-$noun' with the $verb replaced by the found verb and the
1847  * $noun replaced by the found noun. The two parameters that are given to the
1848  * hook are the localized "Are you sure you want to do this?" message with the
1849  * extra text (the text after the underscore).
1850  *
1851  * @package WordPress
1852  * @subpackage Security
1853  * @since 2.0.4
1854  *
1855  * @param string $action Nonce action.
1856  * @return string Are you sure message.
1857  */
1858 function wp_explain_nonce( $action ) {
1859         if ( $action !== -1 && preg_match( '/([a-z]+)-([a-z]+)(_(.+))?/', $action, $matches ) ) {
1860                 $verb = $matches[1];
1861                 $noun = $matches[2];
1862
1863                 $trans = array();
1864                 $trans['update']['attachment'] = array( __( 'Your attempt to edit this attachment: &#8220;%s&#8221; has failed.' ), 'get_the_title' );
1865
1866                 $trans['add']['category']      = array( __( 'Your attempt to add this category has failed.' ), false );
1867                 $trans['delete']['category']   = array( __( 'Your attempt to delete this category: &#8220;%s&#8221; has failed.' ), 'get_cat_name' );
1868                 $trans['update']['category']   = array( __( 'Your attempt to edit this category: &#8220;%s&#8221; has failed.' ), 'get_cat_name' );
1869
1870                 $trans['delete']['comment']    = array( __( 'Your attempt to delete this comment: &#8220;%s&#8221; has failed.' ), 'use_id' );
1871                 $trans['unapprove']['comment'] = array( __( 'Your attempt to unapprove this comment: &#8220;%s&#8221; has failed.' ), 'use_id' );
1872                 $trans['approve']['comment']   = array( __( 'Your attempt to approve this comment: &#8220;%s&#8221; has failed.' ), 'use_id' );
1873                 $trans['update']['comment']    = array( __( 'Your attempt to edit this comment: &#8220;%s&#8221; has failed.' ), 'use_id' );
1874                 $trans['bulk']['comments']     = array( __( 'Your attempt to bulk modify comments has failed.' ), false );
1875                 $trans['moderate']['comments'] = array( __( 'Your attempt to moderate comments has failed.' ), false );
1876
1877                 $trans['add']['bookmark']      = array( __( 'Your attempt to add this link has failed.' ), false );
1878                 $trans['delete']['bookmark']   = array( __( 'Your attempt to delete this link: &#8220;%s&#8221; has failed.' ), 'use_id' );
1879                 $trans['update']['bookmark']   = array( __( 'Your attempt to edit this link: &#8220;%s&#8221; has failed.' ), 'use_id' );
1880                 $trans['bulk']['bookmarks']    = array( __( 'Your attempt to bulk modify links has failed.' ), false );
1881
1882                 $trans['add']['page']          = array( __( 'Your attempt to add this page has failed.' ), false );
1883                 $trans['delete']['page']       = array( __( 'Your attempt to delete this page: &#8220;%s&#8221; has failed.' ), 'get_the_title' );
1884                 $trans['update']['page']       = array( __( 'Your attempt to edit this page: &#8220;%s&#8221; has failed.' ), 'get_the_title' );
1885
1886                 $trans['edit']['plugin']       = array( __( 'Your attempt to edit this plugin file: &#8220;%s&#8221; has failed.' ), 'use_id' );
1887                 $trans['activate']['plugin']   = array( __( 'Your attempt to activate this plugin: &#8220;%s&#8221; has failed.' ), 'use_id' );
1888                 $trans['deactivate']['plugin'] = array( __( 'Your attempt to deactivate this plugin: &#8220;%s&#8221; has failed.' ), 'use_id' );
1889                 $trans['upgrade']['plugin']    = array( __( 'Your attempt to update this plugin: &#8220;%s&#8221; has failed.' ), 'use_id' );
1890
1891                 $trans['add']['post']          = array( __( 'Your attempt to add this post has failed.' ), false );
1892                 $trans['delete']['post']       = array( __( 'Your attempt to delete this post: &#8220;%s&#8221; has failed.' ), 'get_the_title' );
1893                 $trans['update']['post']       = array( __( 'Your attempt to edit this post: &#8220;%s&#8221; has failed.' ), 'get_the_title' );
1894
1895                 $trans['add']['user']          = array( __( 'Your attempt to add this user has failed.' ), false );
1896                 $trans['delete']['users']      = array( __( 'Your attempt to delete users has failed.' ), false );
1897                 $trans['bulk']['users']        = array( __( 'Your attempt to bulk modify users has failed.' ), false );
1898                 $trans['update']['user']       = array( __( 'Your attempt to edit this user: &#8220;%s&#8221; has failed.' ), 'get_the_author_meta', 'display_name' );
1899                 $trans['update']['profile']    = array( __( 'Your attempt to modify the profile for: &#8220;%s&#8221; has failed.' ), 'get_the_author_meta', 'display_name' );
1900
1901                 $trans['update']['options']    = array( __( 'Your attempt to edit your settings has failed.' ), false );
1902                 $trans['update']['permalink']  = array( __( 'Your attempt to change your permalink structure to: %s has failed.' ), 'use_id' );
1903                 $trans['edit']['file']         = array( __( 'Your attempt to edit this file: &#8220;%s&#8221; has failed.' ), 'use_id' );
1904                 $trans['edit']['theme']        = array( __( 'Your attempt to edit this theme file: &#8220;%s&#8221; has failed.' ), 'use_id' );
1905                 $trans['switch']['theme']      = array( __( 'Your attempt to switch to this theme: &#8220;%s&#8221; has failed.' ), 'use_id' );
1906
1907                 $trans['log']['out']           = array( sprintf( __( 'You are attempting to log out of %s' ), get_bloginfo( 'sitename' ) ), false );
1908
1909                 if ( isset( $trans[$verb][$noun] ) ) {
1910                         if ( !empty( $trans[$verb][$noun][1] ) ) {
1911                                 $lookup = $trans[$verb][$noun][1];
1912                                 if ( isset($trans[$verb][$noun][2]) )
1913                                         $lookup_value = $trans[$verb][$noun][2];
1914                                 $object = $matches[4];
1915                                 if ( 'use_id' != $lookup ) {
1916                                         if ( isset( $lookup_value ) )
1917                                                 $object = call_user_func( $lookup, $lookup_value, $object );
1918                                         else
1919                                                 $object = call_user_func( $lookup, $object );
1920                                 }
1921                                 return sprintf( $trans[$verb][$noun][0], esc_html($object) );
1922                         } else {
1923                                 return $trans[$verb][$noun][0];
1924                         }
1925                 }
1926
1927                 return apply_filters( 'explain_nonce_' . $verb . '-' . $noun, __( 'Are you sure you want to do this?' ), isset($matches[4]) ? $matches[4] : '' );
1928         } else {
1929                 return apply_filters( 'explain_nonce_' . $action, __( 'Are you sure you want to do this?' ) );
1930         }
1931 }
1932
1933 /**
1934  * Display "Are You Sure" message to confirm the action being taken.
1935  *
1936  * If the action has the nonce explain message, then it will be displayed along
1937  * with the "Are you sure?" message.
1938  *
1939  * @package WordPress
1940  * @subpackage Security
1941  * @since 2.0.4
1942  *
1943  * @param string $action The nonce action.
1944  */
1945 function wp_nonce_ays( $action ) {
1946         $title = __( 'WordPress Failure Notice' );
1947         $html = esc_html( wp_explain_nonce( $action ) );
1948         if ( 'log-out' == $action )
1949                 $html .= "</p><p>" . sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url() );
1950         elseif ( wp_get_referer() )
1951                 $html .= "</p><p><a href='" . esc_url( remove_query_arg( 'updated', wp_get_referer() ) ) . "'>" . __( 'Please try again.' ) . "</a>";
1952
1953         wp_die( $html, $title, array('response' => 403) );
1954 }
1955
1956 /**
1957  * Kill WordPress execution and display HTML message with error message.
1958  *
1959  * This function complements the die() PHP function. The difference is that
1960  * HTML will be displayed to the user. It is recommended to use this function
1961  * only, when the execution should not continue any further. It is not
1962  * recommended to call this function very often and try to handle as many errors
1963  * as possible silently.
1964  *
1965  * @since 2.0.4
1966  *
1967  * @param string $message Error message.
1968  * @param string $title Error title.
1969  * @param string|array $args Optional arguments to control behavior.
1970  */
1971 function wp_die( $message = '', $title = '', $args = array() ) {
1972         if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
1973                 $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
1974         elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
1975                 $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
1976         elseif ( defined( 'APP_REQUEST' ) && APP_REQUEST )
1977                 $function = apply_filters( 'wp_die_app_handler', '_scalar_wp_die_handler' );
1978         else
1979                 $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
1980
1981         call_user_func( $function, $message, $title, $args );
1982 }
1983
1984 /**
1985  * Kill WordPress execution and display HTML message with error message.
1986  *
1987  * This is the default handler for wp_die if you want a custom one for your
1988  * site then you can overload using the wp_die_handler filter in wp_die
1989  *
1990  * @since 3.0.0
1991  * @access private
1992  *
1993  * @param string $message Error message.
1994  * @param string $title Error title.
1995  * @param string|array $args Optional arguments to control behavior.
1996  */
1997 function _default_wp_die_handler( $message, $title = '', $args = array() ) {
1998         $defaults = array( 'response' => 500 );
1999         $r = wp_parse_args($args, $defaults);
2000
2001         $have_gettext = function_exists('__');
2002
2003         if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
2004                 if ( empty( $title ) ) {
2005                         $error_data = $message->get_error_data();
2006                         if ( is_array( $error_data ) && isset( $error_data['title'] ) )
2007                                 $title = $error_data['title'];
2008                 }
2009                 $errors = $message->get_error_messages();
2010                 switch ( count( $errors ) ) :
2011                 case 0 :
2012                         $message = '';
2013                         break;
2014                 case 1 :
2015                         $message = "<p>{$errors[0]}</p>";
2016                         break;
2017                 default :
2018                         $message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
2019                         break;
2020                 endswitch;
2021         } elseif ( is_string( $message ) ) {
2022                 $message = "<p>$message</p>";
2023         }
2024
2025         if ( isset( $r['back_link'] ) && $r['back_link'] ) {
2026                 $back_text = $have_gettext? __('&laquo; Back') : '&laquo; Back';
2027                 $message .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";
2028         }
2029
2030         if ( ! did_action( 'admin_head' ) ) :
2031                 if ( !headers_sent() ) {
2032                         status_header( $r['response'] );
2033                         nocache_headers();
2034                         header( 'Content-Type: text/html; charset=utf-8' );
2035                 }
2036
2037                 if ( empty($title) )
2038                         $title = $have_gettext ? __('WordPress &rsaquo; Error') : 'WordPress &rsaquo; Error';
2039
2040                 $text_direction = 'ltr';
2041                 if ( isset($r['text_direction']) && 'rtl' == $r['text_direction'] )
2042                         $text_direction = 'rtl';
2043                 elseif ( function_exists( 'is_rtl' ) && is_rtl() )
2044                         $text_direction = 'rtl';
2045 ?>
2046 <!DOCTYPE html>
2047 <!-- 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
2048 -->
2049 <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'"; ?>>
2050 <head>
2051         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2052         <title><?php echo $title ?></title>
2053         <style type="text/css">
2054                 html {
2055                         background: #f9f9f9;
2056                 }
2057                 body {
2058                         background: #fff;
2059                         color: #333;
2060                         font-family: sans-serif;
2061                         margin: 2em auto;
2062                         padding: 1em 2em;
2063                         -webkit-border-radius: 3px;
2064                         border-radius: 3px;
2065                         border: 1px solid #dfdfdf;
2066                         max-width: 700px;
2067                 }
2068                 h1 {
2069                         border-bottom: 1px solid #dadada;
2070                         clear: both;
2071                         color: #666;
2072                         font: 24px Georgia, "Times New Roman", Times, serif;
2073                         margin: 30px 0 0 0;
2074                         padding: 0;
2075                         padding-bottom: 7px;
2076                 }
2077                 #error-page {
2078                         margin-top: 50px;
2079                 }
2080                 #error-page p {
2081                         font-size: 14px;
2082                         line-height: 1.5;
2083                         margin: 25px 0 20px;
2084                 }
2085                 #error-page code {
2086                         font-family: Consolas, Monaco, monospace;
2087                 }
2088                 ul li {
2089                         margin-bottom: 10px;
2090                         font-size: 14px ;
2091                 }
2092                 a {
2093                         color: #21759B;
2094                         text-decoration: none;
2095                 }
2096                 a:hover {
2097                         color: #D54E21;
2098                 }
2099
2100                 .button {
2101                         font-family: sans-serif;
2102                         text-decoration: none;
2103                         font-size: 14px !important;
2104                         line-height: 16px;
2105                         padding: 6px 12px;
2106                         cursor: pointer;
2107                         border: 1px solid #bbb;
2108                         color: #464646;
2109                         -webkit-border-radius: 15px;
2110                         border-radius: 15px;
2111                         -moz-box-sizing: content-box;
2112                         -webkit-box-sizing: content-box;
2113                         box-sizing: content-box;
2114                         background-color: #f5f5f5;
2115                         background-image: -ms-linear-gradient(top, #ffffff, #f2f2f2);
2116                         background-image: -moz-linear-gradient(top, #ffffff, #f2f2f2);
2117                         background-image: -o-linear-gradient(top, #ffffff, #f2f2f2);
2118                         background-image: -webkit-gradient(linear, left top, left bottom, from(#ffffff), to(#f2f2f2));
2119                         background-image: -webkit-linear-gradient(top, #ffffff, #f2f2f2);
2120                         background-image: linear-gradient(top, #ffffff, #f2f2f2);
2121                 }
2122
2123                 .button:hover {
2124                         color: #000;
2125                         border-color: #666;
2126                 }
2127
2128                 .button:active {
2129                         background-image: -ms-linear-gradient(top, #f2f2f2, #ffffff);
2130                         background-image: -moz-linear-gradient(top, #f2f2f2, #ffffff);
2131                         background-image: -o-linear-gradient(top, #f2f2f2, #ffffff);
2132                         background-image: -webkit-gradient(linear, left top, left bottom, from(#f2f2f2), to(#ffffff));
2133                         background-image: -webkit-linear-gradient(top, #f2f2f2, #ffffff);
2134                         background-image: linear-gradient(top, #f2f2f2, #ffffff);
2135                 }
2136
2137                 <?php if ( 'rtl' == $text_direction ) : ?>
2138                 body { font-family: Tahoma, Arial; }
2139                 <?php endif; ?>
2140         </style>
2141 </head>
2142 <body id="error-page">
2143 <?php endif; // ! did_action( 'admin_head' ) ?>
2144         <?php echo $message; ?>
2145 </body>
2146 </html>
2147 <?php
2148         die();
2149 }
2150
2151 /**
2152  * Kill WordPress execution and display XML message with error message.
2153  *
2154  * This is the handler for wp_die when processing XMLRPC requests.
2155  *
2156  * @since 3.2.0
2157  * @access private
2158  *
2159  * @param string $message Error message.
2160  * @param string $title Error title.
2161  * @param string|array $args Optional arguments to control behavior.
2162  */
2163 function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
2164         global $wp_xmlrpc_server;
2165         $defaults = array( 'response' => 500 );
2166
2167         $r = wp_parse_args($args, $defaults);
2168
2169         if ( $wp_xmlrpc_server ) {
2170                 $error = new IXR_Error( $r['response'] , $message);
2171                 $wp_xmlrpc_server->output( $error->getXml() );
2172         }
2173         die();
2174 }
2175
2176 /**
2177  * Kill WordPress ajax execution.
2178  *
2179  * This is the handler for wp_die when processing Ajax requests.
2180  *
2181  * @since 3.4.0
2182  * @access private
2183  *
2184  * @param string $message Optional. Response to print.
2185  */
2186 function _ajax_wp_die_handler( $message = '' ) {
2187         if ( is_scalar( $message ) )
2188                 die( (string) $message );
2189         die( '0' );
2190 }
2191
2192 /**
2193  * Kill WordPress execution.
2194  *
2195  * This is the handler for wp_die when processing APP requests.
2196  *
2197  * @since 3.4.0
2198  * @access private
2199  *
2200  * @param string $message Optional. Response to print.
2201  */
2202 function _scalar_wp_die_handler( $message = '' ) {
2203         if ( is_scalar( $message ) )
2204                 die( (string) $message );
2205         die();
2206 }
2207
2208 /**
2209  * Retrieve the WordPress home page URL.
2210  *
2211  * If the constant named 'WP_HOME' exists, then it will be used and returned by
2212  * the function. This can be used to counter the redirection on your local
2213  * development environment.
2214  *
2215  * @access private
2216  * @package WordPress
2217  * @since 2.2.0
2218  *
2219  * @param string $url URL for the home location
2220  * @return string Homepage location.
2221  */
2222 function _config_wp_home( $url = '' ) {
2223         if ( defined( 'WP_HOME' ) )
2224                 return untrailingslashit( WP_HOME );
2225         return $url;
2226 }
2227
2228 /**
2229  * Retrieve the WordPress site URL.
2230  *
2231  * If the constant named 'WP_SITEURL' is defined, then the value in that
2232  * constant will always be returned. This can be used for debugging a site on
2233  * your localhost while not having to change the database to your URL.
2234  *
2235  * @access private
2236  * @package WordPress
2237  * @since 2.2.0
2238  *
2239  * @param string $url URL to set the WordPress site location.
2240  * @return string The WordPress Site URL
2241  */
2242 function _config_wp_siteurl( $url = '' ) {
2243         if ( defined( 'WP_SITEURL' ) )
2244                 return untrailingslashit( WP_SITEURL );
2245         return $url;
2246 }
2247
2248 /**
2249  * Set the localized direction for MCE plugin.
2250  *
2251  * Will only set the direction to 'rtl', if the WordPress locale has the text
2252  * direction set to 'rtl'.
2253  *
2254  * Fills in the 'directionality', 'plugins', and 'theme_advanced_button1' array
2255  * keys. These keys are then returned in the $input array.
2256  *
2257  * @access private
2258  * @package WordPress
2259  * @subpackage MCE
2260  * @since 2.1.0
2261  *
2262  * @param array $input MCE plugin array.
2263  * @return array Direction set for 'rtl', if needed by locale.
2264  */
2265 function _mce_set_direction( $input ) {
2266         if ( is_rtl() ) {
2267                 $input['directionality'] = 'rtl';
2268                 $input['plugins'] .= ',directionality';
2269                 $input['theme_advanced_buttons1'] .= ',ltr';
2270         }
2271
2272         return $input;
2273 }
2274
2275 /**
2276  * Convert smiley code to the icon graphic file equivalent.
2277  *
2278  * You can turn off smilies, by going to the write setting screen and unchecking
2279  * the box, or by setting 'use_smilies' option to false or removing the option.
2280  *
2281  * Plugins may override the default smiley list by setting the $wpsmiliestrans
2282  * to an array, with the key the code the blogger types in and the value the
2283  * image file.
2284  *
2285  * The $wp_smiliessearch global is for the regular expression and is set each
2286  * time the function is called.
2287  *
2288  * The full list of smilies can be found in the function and won't be listed in
2289  * the description. Probably should create a Codex page for it, so that it is
2290  * available.
2291  *
2292  * @global array $wpsmiliestrans
2293  * @global array $wp_smiliessearch
2294  * @since 2.2.0
2295  */
2296 function smilies_init() {
2297         global $wpsmiliestrans, $wp_smiliessearch;
2298
2299         // don't bother setting up smilies if they are disabled
2300         if ( !get_option( 'use_smilies' ) )
2301                 return;
2302
2303         if ( !isset( $wpsmiliestrans ) ) {
2304                 $wpsmiliestrans = array(
2305                 ':mrgreen:' => 'icon_mrgreen.gif',
2306                 ':neutral:' => 'icon_neutral.gif',
2307                 ':twisted:' => 'icon_twisted.gif',
2308                   ':arrow:' => 'icon_arrow.gif',
2309                   ':shock:' => 'icon_eek.gif',
2310                   ':smile:' => 'icon_smile.gif',
2311                     ':???:' => 'icon_confused.gif',
2312                    ':cool:' => 'icon_cool.gif',
2313                    ':evil:' => 'icon_evil.gif',
2314                    ':grin:' => 'icon_biggrin.gif',
2315                    ':idea:' => 'icon_idea.gif',
2316                    ':oops:' => 'icon_redface.gif',
2317                    ':razz:' => 'icon_razz.gif',
2318                    ':roll:' => 'icon_rolleyes.gif',
2319                    ':wink:' => 'icon_wink.gif',
2320                     ':cry:' => 'icon_cry.gif',
2321                     ':eek:' => 'icon_surprised.gif',
2322                     ':lol:' => 'icon_lol.gif',
2323                     ':mad:' => 'icon_mad.gif',
2324                     ':sad:' => 'icon_sad.gif',
2325                       '8-)' => 'icon_cool.gif',
2326                       '8-O' => 'icon_eek.gif',
2327                       ':-(' => 'icon_sad.gif',
2328                       ':-)' => 'icon_smile.gif',
2329                       ':-?' => 'icon_confused.gif',
2330                       ':-D' => 'icon_biggrin.gif',
2331                       ':-P' => 'icon_razz.gif',
2332                       ':-o' => 'icon_surprised.gif',
2333                       ':-x' => 'icon_mad.gif',
2334                       ':-|' => 'icon_neutral.gif',
2335                       ';-)' => 'icon_wink.gif',
2336                 // This one transformation breaks regular text with frequency.
2337                 //     '8)' => 'icon_cool.gif',
2338                        '8O' => 'icon_eek.gif',
2339                        ':(' => 'icon_sad.gif',
2340                        ':)' => 'icon_smile.gif',
2341                        ':?' => 'icon_confused.gif',
2342                        ':D' => 'icon_biggrin.gif',
2343                        ':P' => 'icon_razz.gif',
2344                        ':o' => 'icon_surprised.gif',
2345                        ':x' => 'icon_mad.gif',
2346                        ':|' => 'icon_neutral.gif',
2347                        ';)' => 'icon_wink.gif',
2348                       ':!:' => 'icon_exclaim.gif',
2349                       ':?:' => 'icon_question.gif',
2350                 );
2351         }
2352
2353         if (count($wpsmiliestrans) == 0) {
2354                 return;
2355         }
2356
2357         /*
2358          * NOTE: we sort the smilies in reverse key order. This is to make sure
2359          * we match the longest possible smilie (:???: vs :?) as the regular
2360          * expression used below is first-match
2361          */
2362         krsort($wpsmiliestrans);
2363
2364         $wp_smiliessearch = '/(?:\s|^)';
2365
2366         $subchar = '';
2367         foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
2368                 $firstchar = substr($smiley, 0, 1);
2369                 $rest = substr($smiley, 1);
2370
2371                 // new subpattern?
2372                 if ($firstchar != $subchar) {
2373                         if ($subchar != '') {
2374                                 $wp_smiliessearch .= ')|(?:\s|^)';
2375                         }
2376                         $subchar = $firstchar;
2377                         $wp_smiliessearch .= preg_quote($firstchar, '/') . '(?:';
2378                 } else {
2379                         $wp_smiliessearch .= '|';
2380                 }
2381                 $wp_smiliessearch .= preg_quote($rest, '/');
2382         }
2383
2384         $wp_smiliessearch .= ')(?:\s|$)/m';
2385 }
2386
2387 /**
2388  * Merge user defined arguments into defaults array.
2389  *
2390  * This function is used throughout WordPress to allow for both string or array
2391  * to be merged into another array.
2392  *
2393  * @since 2.2.0
2394  *
2395  * @param string|array $args Value to merge with $defaults
2396  * @param array $defaults Array that serves as the defaults.
2397  * @return array Merged user defined values with defaults.
2398  */
2399 function wp_parse_args( $args, $defaults = '' ) {
2400         if ( is_object( $args ) )
2401                 $r = get_object_vars( $args );
2402         elseif ( is_array( $args ) )
2403                 $r =& $args;
2404         else
2405                 wp_parse_str( $args, $r );
2406
2407         if ( is_array( $defaults ) )
2408                 return array_merge( $defaults, $r );
2409         return $r;
2410 }
2411
2412 /**
2413  * Clean up an array, comma- or space-separated list of IDs.
2414  *
2415  * @since 3.0.0
2416  *
2417  * @param array|string $list
2418  * @return array Sanitized array of IDs
2419  */
2420 function wp_parse_id_list( $list ) {
2421         if ( !is_array($list) )
2422                 $list = preg_split('/[\s,]+/', $list);
2423
2424         return array_unique(array_map('absint', $list));
2425 }
2426
2427 /**
2428  * Extract a slice of an array, given a list of keys.
2429  *
2430  * @since 3.1.0
2431  *
2432  * @param array $array The original array
2433  * @param array $keys The list of keys
2434  * @return array The array slice
2435  */
2436 function wp_array_slice_assoc( $array, $keys ) {
2437         $slice = array();
2438         foreach ( $keys as $key )
2439                 if ( isset( $array[ $key ] ) )
2440                         $slice[ $key ] = $array[ $key ];
2441
2442         return $slice;
2443 }
2444
2445 /**
2446  * Filters a list of objects, based on a set of key => value arguments.
2447  *
2448  * @since 3.0.0
2449  *
2450  * @param array $list An array of objects to filter
2451  * @param array $args An array of key => value arguments to match against each object
2452  * @param string $operator The logical operation to perform. 'or' means only one element
2453  *      from the array needs to match; 'and' means all elements must match. The default is 'and'.
2454  * @param bool|string $field A field from the object to place instead of the entire object
2455  * @return array A list of objects or object fields
2456  */
2457 function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
2458         if ( ! is_array( $list ) )
2459                 return array();
2460
2461         $list = wp_list_filter( $list, $args, $operator );
2462
2463         if ( $field )
2464                 $list = wp_list_pluck( $list, $field );
2465
2466         return $list;
2467 }
2468
2469 /**
2470  * Filters a list of objects, based on a set of key => value arguments.
2471  *
2472  * @since 3.1.0
2473  *
2474  * @param array $list An array of objects to filter
2475  * @param array $args An array of key => value arguments to match against each object
2476  * @param string $operator The logical operation to perform:
2477  *    'AND' means all elements from the array must match;
2478  *    'OR' means only one element needs to match;
2479  *    'NOT' means no elements may match.
2480  *   The default is 'AND'.
2481  * @return array
2482  */
2483 function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
2484         if ( ! is_array( $list ) )
2485                 return array();
2486
2487         if ( empty( $args ) )
2488                 return $list;
2489
2490         $operator = strtoupper( $operator );
2491         $count = count( $args );
2492         $filtered = array();
2493
2494         foreach ( $list as $key => $obj ) {
2495                 $to_match = (array) $obj;
2496
2497                 $matched = 0;
2498                 foreach ( $args as $m_key => $m_value ) {
2499                         if ( $m_value == $to_match[ $m_key ] )
2500                                 $matched++;
2501                 }
2502
2503                 if ( ( 'AND' == $operator && $matched == $count )
2504                   || ( 'OR' == $operator && $matched > 0 )
2505                   || ( 'NOT' == $operator && 0 == $matched ) ) {
2506                         $filtered[$key] = $obj;
2507                 }
2508         }
2509
2510         return $filtered;
2511 }
2512
2513 /**
2514  * Pluck a certain field out of each object in a list.
2515  *
2516  * @since 3.1.0
2517  *
2518  * @param array $list A list of objects or arrays
2519  * @param int|string $field A field from the object to place instead of the entire object
2520  * @return array
2521  */
2522 function wp_list_pluck( $list, $field ) {
2523         foreach ( $list as $key => $value ) {
2524                 if ( is_object( $value ) )
2525                         $list[ $key ] = $value->$field;
2526                 else
2527                         $list[ $key ] = $value[ $field ];
2528         }
2529
2530         return $list;
2531 }
2532
2533 /**
2534  * Determines if Widgets library should be loaded.
2535  *
2536  * Checks to make sure that the widgets library hasn't already been loaded. If
2537  * it hasn't, then it will load the widgets library and run an action hook.
2538  *
2539  * @since 2.2.0
2540  * @uses add_action() Calls '_admin_menu' hook with 'wp_widgets_add_menu' value.
2541  */
2542 function wp_maybe_load_widgets() {
2543         if ( ! apply_filters('load_default_widgets', true) )
2544                 return;
2545         require_once( ABSPATH . WPINC . '/default-widgets.php' );
2546         add_action( '_admin_menu', 'wp_widgets_add_menu' );
2547 }
2548
2549 /**
2550  * Append the Widgets menu to the themes main menu.
2551  *
2552  * @since 2.2.0
2553  * @uses $submenu The administration submenu list.
2554  */
2555 function wp_widgets_add_menu() {
2556         global $submenu;
2557         $submenu['themes.php'][7] = array( __( 'Widgets' ), 'edit_theme_options', 'widgets.php' );
2558         ksort( $submenu['themes.php'], SORT_NUMERIC );
2559 }
2560
2561 /**
2562  * Flush all output buffers for PHP 5.2.
2563  *
2564  * Make sure all output buffers are flushed before our singletons our destroyed.
2565  *
2566  * @since 2.2.0
2567  */
2568 function wp_ob_end_flush_all() {
2569         $levels = ob_get_level();
2570         for ($i=0; $i<$levels; $i++)
2571                 ob_end_flush();
2572 }
2573
2574 /**
2575  * Load custom DB error or display WordPress DB error.
2576  *
2577  * If a file exists in the wp-content directory named db-error.php, then it will
2578  * be loaded instead of displaying the WordPress DB error. If it is not found,
2579  * then the WordPress DB error will be displayed instead.
2580  *
2581  * The WordPress DB error sets the HTTP status header to 500 to try to prevent
2582  * search engines from caching the message. Custom DB messages should do the
2583  * same.
2584  *
2585  * This function was backported to the the WordPress 2.3.2, but originally was
2586  * added in WordPress 2.5.0.
2587  *
2588  * @since 2.3.2
2589  * @uses $wpdb
2590  */
2591 function dead_db() {
2592         global $wpdb;
2593
2594         // Load custom DB error template, if present.
2595         if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
2596                 require_once( WP_CONTENT_DIR . '/db-error.php' );
2597                 die();
2598         }
2599
2600         // If installing or in the admin, provide the verbose message.
2601         if ( defined('WP_INSTALLING') || defined('WP_ADMIN') )
2602                 wp_die($wpdb->error);
2603
2604         // Otherwise, be terse.
2605         status_header( 500 );
2606         nocache_headers();
2607         header( 'Content-Type: text/html; charset=utf-8' );
2608
2609         wp_load_translations_early();
2610 ?>
2611 <!DOCTYPE html>
2612 <html xmlns="http://www.w3.org/1999/xhtml"<?php if ( is_rtl() ) echo ' dir="rtl"'; ?>>
2613 <head>
2614 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2615         <title><?php _e( 'Database Error' ); ?></title>
2616
2617 </head>
2618 <body>
2619         <h1><?php _e( 'Error establishing a database connection' ); ?></h1>
2620 </body>
2621 </html>
2622 <?php
2623         die();
2624 }
2625
2626 /**
2627  * Converts value to nonnegative integer.
2628  *
2629  * @since 2.5.0
2630  *
2631  * @param mixed $maybeint Data you wish to have converted to a nonnegative integer
2632  * @return int An nonnegative integer
2633  */
2634 function absint( $maybeint ) {
2635         return abs( intval( $maybeint ) );
2636 }
2637
2638 /**
2639  * Determines if the blog can be accessed over SSL.
2640  *
2641  * Determines if blog can be accessed over SSL by using cURL to access the site
2642  * using the https in the siteurl. Requires cURL extension to work correctly.
2643  *
2644  * @since 2.5.0
2645  *
2646  * @param string $url
2647  * @return bool Whether SSL access is available
2648  */
2649 function url_is_accessable_via_ssl($url)
2650 {
2651         if (in_array('curl', get_loaded_extensions())) {
2652                 $ssl = preg_replace( '/^http:\/\//', 'https://',  $url );
2653
2654                 $ch = curl_init();
2655                 curl_setopt($ch, CURLOPT_URL, $ssl);
2656                 curl_setopt($ch, CURLOPT_FAILONERROR, true);
2657                 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
2658                 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
2659                 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
2660
2661                 curl_exec($ch);
2662
2663                 $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
2664                 curl_close ($ch);
2665
2666                 if ($status == 200 || $status == 401) {
2667                         return true;
2668                 }
2669         }
2670         return false;
2671 }
2672
2673 /**
2674  * Marks a function as deprecated and informs when it has been used.
2675  *
2676  * There is a hook deprecated_function_run that will be called that can be used
2677  * to get the backtrace up to what file and function called the deprecated
2678  * function.
2679  *
2680  * The current behavior is to trigger a user error if WP_DEBUG is true.
2681  *
2682  * This function is to be used in every function that is deprecated.
2683  *
2684  * @package WordPress
2685  * @subpackage Debug
2686  * @since 2.5.0
2687  * @access private
2688  *
2689  * @uses do_action() Calls 'deprecated_function_run' and passes the function name, what to use instead,
2690  *   and the version the function was deprecated in.
2691  * @uses apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
2692  *   trigger or false to not trigger error.
2693  *
2694  * @param string $function The function that was called
2695  * @param string $version The version of WordPress that deprecated the function
2696  * @param string $replacement Optional. The function that should have been called
2697  */
2698 function _deprecated_function( $function, $version, $replacement = null ) {
2699
2700         do_action( 'deprecated_function_run', $function, $replacement, $version );
2701
2702         // Allow plugin to filter the output error trigger
2703         if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
2704                 if ( ! is_null($replacement) )
2705                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
2706                 else
2707                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2708         }
2709 }
2710
2711 /**
2712  * Marks a file as deprecated and informs when it has been used.
2713  *
2714  * There is a hook deprecated_file_included that will be called that can be used
2715  * to get the backtrace up to what file and function included the deprecated
2716  * file.
2717  *
2718  * The current behavior is to trigger a user error if WP_DEBUG is true.
2719  *
2720  * This function is to be used in every file that is deprecated.
2721  *
2722  * @package WordPress
2723  * @subpackage Debug
2724  * @since 2.5.0
2725  * @access private
2726  *
2727  * @uses do_action() Calls 'deprecated_file_included' and passes the file name, what to use instead,
2728  *   the version in which the file was deprecated, and any message regarding the change.
2729  * @uses apply_filters() Calls 'deprecated_file_trigger_error' and expects boolean value of true to do
2730  *   trigger or false to not trigger error.
2731  *
2732  * @param string $file The file that was included
2733  * @param string $version The version of WordPress that deprecated the file
2734  * @param string $replacement Optional. The file that should have been included based on ABSPATH
2735  * @param string $message Optional. A message regarding the change
2736  */
2737 function _deprecated_file( $file, $version, $replacement = null, $message = '' ) {
2738
2739         do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
2740
2741         // Allow plugin to filter the output error trigger
2742         if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
2743                 $message = empty( $message ) ? '' : ' ' . $message;
2744                 if ( ! is_null( $replacement ) )
2745                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) . $message );
2746                 else
2747                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) . $message );
2748         }
2749 }
2750 /**
2751  * Marks a function argument as deprecated and informs when it has been used.
2752  *
2753  * This function is to be used whenever a deprecated function argument is used.
2754  * Before this function is called, the argument must be checked for whether it was
2755  * used by comparing it to its default value or evaluating whether it is empty.
2756  * For example:
2757  * <code>
2758  * if ( !empty($deprecated) )
2759  *      _deprecated_argument( __FUNCTION__, '3.0' );
2760  * </code>
2761  *
2762  * There is a hook deprecated_argument_run that will be called that can be used
2763  * to get the backtrace up to what file and function used the deprecated
2764  * argument.
2765  *
2766  * The current behavior is to trigger a user error if WP_DEBUG is true.
2767  *
2768  * @package WordPress
2769  * @subpackage Debug
2770  * @since 3.0.0
2771  * @access private
2772  *
2773  * @uses do_action() Calls 'deprecated_argument_run' and passes the function name, a message on the change,
2774  *   and the version in which the argument was deprecated.
2775  * @uses apply_filters() Calls 'deprecated_argument_trigger_error' and expects boolean value of true to do
2776  *   trigger or false to not trigger error.
2777  *
2778  * @param string $function The function that was called
2779  * @param string $version The version of WordPress that deprecated the argument used
2780  * @param string $message Optional. A message regarding the change.
2781  */
2782 function _deprecated_argument( $function, $version, $message = null ) {
2783
2784         do_action( 'deprecated_argument_run', $function, $message, $version );
2785
2786         // Allow plugin to filter the output error trigger
2787         if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
2788                 if ( ! is_null( $message ) )
2789                         trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s'), $function, $version, $message ) );
2790                 else
2791                         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 ) );
2792         }
2793 }
2794
2795 /**
2796  * Marks something as being incorrectly called.
2797  *
2798  * There is a hook doing_it_wrong_run that will be called that can be used
2799  * to get the backtrace up to what file and function called the deprecated
2800  * function.
2801  *
2802  * The current behavior is to trigger a user error if WP_DEBUG is true.
2803  *
2804  * @package WordPress
2805  * @subpackage Debug
2806  * @since 3.1.0
2807  * @access private
2808  *
2809  * @uses do_action() Calls 'doing_it_wrong_run' and passes the function arguments.
2810  * @uses apply_filters() Calls 'doing_it_wrong_trigger_error' and expects boolean value of true to do
2811  *   trigger or false to not trigger error.
2812  *
2813  * @param string $function The function that was called.
2814  * @param string $message A message explaining what has been done incorrectly.
2815  * @param string $version The version of WordPress where the message was added.
2816  */
2817 function _doing_it_wrong( $function, $message, $version ) {
2818
2819         do_action( 'doing_it_wrong_run', $function, $message, $version );
2820
2821         // Allow plugin to filter the output error trigger
2822         if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true ) ) {
2823                 $version = is_null( $version ) ? '' : sprintf( __( '(This message was added in version %s.)' ), $version );
2824                 $message .= ' ' . __( 'Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.' );
2825                 trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) );
2826         }
2827 }
2828
2829 /**
2830  * Is the server running earlier than 1.5.0 version of lighttpd?
2831  *
2832  * @since 2.5.0
2833  *
2834  * @return bool Whether the server is running lighttpd < 1.5.0
2835  */
2836 function is_lighttpd_before_150() {
2837         $server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] )? $_SERVER['SERVER_SOFTWARE'] : '' );
2838         $server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : '';
2839         return  'lighttpd' == $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' );
2840 }
2841
2842 /**
2843  * Does the specified module exist in the Apache config?
2844  *
2845  * @since 2.5.0
2846  *
2847  * @param string $mod e.g. mod_rewrite
2848  * @param bool $default The default return value if the module is not found
2849  * @return bool
2850  */
2851 function apache_mod_loaded($mod, $default = false) {
2852         global $is_apache;
2853
2854         if ( !$is_apache )
2855                 return false;
2856
2857         if ( function_exists('apache_get_modules') ) {
2858                 $mods = apache_get_modules();
2859                 if ( in_array($mod, $mods) )
2860                         return true;
2861         } elseif ( function_exists('phpinfo') ) {
2862                         ob_start();
2863                         phpinfo(8);
2864                         $phpinfo = ob_get_clean();
2865                         if ( false !== strpos($phpinfo, $mod) )
2866                                 return true;
2867         }
2868         return $default;
2869 }
2870
2871 /**
2872  * Check if IIS 7 supports pretty permalinks.
2873  *
2874  * @since 2.8.0
2875  *
2876  * @return bool
2877  */
2878 function iis7_supports_permalinks() {
2879         global $is_iis7;
2880
2881         $supports_permalinks = false;
2882         if ( $is_iis7 ) {
2883                 /* First we check if the DOMDocument class exists. If it does not exist,
2884                  * which is the case for PHP 4.X, then we cannot easily update the xml configuration file,
2885                  * hence we just bail out and tell user that pretty permalinks cannot be used.
2886                  * This is not a big issue because PHP 4.X is going to be deprecated and for IIS it
2887                  * is recommended to use PHP 5.X NTS.
2888                  * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
2889                  * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
2890                  * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
2891                  * via ISAPI then pretty permalinks will not work.
2892                  */
2893                 $supports_permalinks = class_exists('DOMDocument') && isset($_SERVER['IIS_UrlRewriteModule']) && ( php_sapi_name() == 'cgi-fcgi' );
2894         }
2895
2896         return apply_filters('iis7_supports_permalinks', $supports_permalinks);
2897 }
2898
2899 /**
2900  * File validates against allowed set of defined rules.
2901  *
2902  * A return value of '1' means that the $file contains either '..' or './'. A
2903  * return value of '2' means that the $file contains ':' after the first
2904  * character. A return value of '3' means that the file is not in the allowed
2905  * files list.
2906  *
2907  * @since 1.2.0
2908  *
2909  * @param string $file File path.
2910  * @param array $allowed_files List of allowed files.
2911  * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
2912  */
2913 function validate_file( $file, $allowed_files = '' ) {
2914         if ( false !== strpos( $file, '..' ) )
2915                 return 1;
2916
2917         if ( false !== strpos( $file, './' ) )
2918                 return 1;
2919
2920         if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files ) )
2921                 return 3;
2922
2923         if (':' == substr( $file, 1, 1 ) )
2924                 return 2;
2925
2926         return 0;
2927 }
2928
2929 /**
2930  * Determine if SSL is used.
2931  *
2932  * @since 2.6.0
2933  *
2934  * @return bool True if SSL, false if not used.
2935  */
2936 function is_ssl() {
2937         if ( isset($_SERVER['HTTPS']) ) {
2938                 if ( 'on' == strtolower($_SERVER['HTTPS']) )
2939                         return true;
2940                 if ( '1' == $_SERVER['HTTPS'] )
2941                         return true;
2942         } elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
2943                 return true;
2944         }
2945         return false;
2946 }
2947
2948 /**
2949  * Whether SSL login should be forced.
2950  *
2951  * @since 2.6.0
2952  *
2953  * @param string|bool $force Optional.
2954  * @return bool True if forced, false if not forced.
2955  */
2956 function force_ssl_login( $force = null ) {
2957         static $forced = false;
2958
2959         if ( !is_null( $force ) ) {
2960                 $old_forced = $forced;
2961                 $forced = $force;
2962                 return $old_forced;
2963         }
2964
2965         return $forced;
2966 }
2967
2968 /**
2969  * Whether to force SSL used for the Administration Screens.
2970  *
2971  * @since 2.6.0
2972  *
2973  * @param string|bool $force
2974  * @return bool True if forced, false if not forced.
2975  */
2976 function force_ssl_admin( $force = null ) {
2977         static $forced = false;
2978
2979         if ( !is_null( $force ) ) {
2980                 $old_forced = $forced;
2981                 $forced = $force;
2982                 return $old_forced;
2983         }
2984
2985         return $forced;
2986 }
2987
2988 /**
2989  * Guess the URL for the site.
2990  *
2991  * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
2992  * directory.
2993  *
2994  * @since 2.6.0
2995  *
2996  * @return string
2997  */
2998 function wp_guess_url() {
2999         if ( defined('WP_SITEURL') && '' != WP_SITEURL ) {
3000                 $url = WP_SITEURL;
3001         } else {
3002                 $schema = is_ssl() ? 'https://' : 'http://';
3003                 $url = preg_replace('#/(wp-admin/.*|wp-login.php)#i', '', $schema . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
3004         }
3005         return rtrim($url, '/');
3006 }
3007
3008 /**
3009  * Temporarily suspend cache additions.
3010  *
3011  * Stops more data being added to the cache, but still allows cache retrieval.
3012  * This is useful for actions, such as imports, when a lot of data would otherwise
3013  * be almost uselessly added to the cache.
3014  *
3015  * Suspension lasts for a single page load at most. Remember to call this
3016  * function again if you wish to re-enable cache adds earlier.
3017  *
3018  * @since 3.3.0
3019  *
3020  * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
3021  * @return bool The current suspend setting
3022  */
3023 function wp_suspend_cache_addition( $suspend = null ) {
3024         static $_suspend = false;
3025
3026         if ( is_bool( $suspend ) )
3027                 $_suspend = $suspend;
3028
3029         return $_suspend;
3030 }
3031
3032 /**
3033  * Suspend cache invalidation.
3034  *
3035  * Turns cache invalidation on and off. Useful during imports where you don't wont to do invalidations
3036  * every time a post is inserted. Callers must be sure that what they are doing won't lead to an inconsistent
3037  * cache when invalidation is suspended.
3038  *
3039  * @since 2.7.0
3040  *
3041  * @param bool $suspend Whether to suspend or enable cache invalidation
3042  * @return bool The current suspend setting
3043  */
3044 function wp_suspend_cache_invalidation($suspend = true) {
3045         global $_wp_suspend_cache_invalidation;
3046
3047         $current_suspend = $_wp_suspend_cache_invalidation;
3048         $_wp_suspend_cache_invalidation = $suspend;
3049         return $current_suspend;
3050 }
3051
3052 /**
3053  * Is main site?
3054  *
3055  *
3056  * @since 3.0.0
3057  * @package WordPress
3058  *
3059  * @param int $blog_id optional blog id to test (default current blog)
3060  * @return bool True if not multisite or $blog_id is main site
3061  */
3062 function is_main_site( $blog_id = '' ) {
3063         global $current_site, $current_blog;
3064
3065         if ( !is_multisite() )
3066                 return true;
3067
3068         if ( !$blog_id )
3069                 $blog_id = $current_blog->blog_id;
3070
3071         return $blog_id == $current_site->blog_id;
3072 }
3073
3074 /**
3075  * Whether global terms are enabled.
3076  *
3077  *
3078  * @since 3.0.0
3079  * @package WordPress
3080  *
3081  * @return bool True if multisite and global terms enabled
3082  */
3083 function global_terms_enabled() {
3084         if ( ! is_multisite() )
3085                 return false;
3086
3087         static $global_terms = null;
3088         if ( is_null( $global_terms ) ) {
3089                 $filter = apply_filters( 'global_terms_enabled', null );
3090                 if ( ! is_null( $filter ) )
3091                         $global_terms = (bool) $filter;
3092                 else
3093                         $global_terms = (bool) get_site_option( 'global_terms_enabled', false );
3094         }
3095         return $global_terms;
3096 }
3097
3098 /**
3099  * gmt_offset modification for smart timezone handling.
3100  *
3101  * Overrides the gmt_offset option if we have a timezone_string available.
3102  *
3103  * @since 2.8.0
3104  *
3105  * @return float|bool
3106  */
3107 function wp_timezone_override_offset() {
3108         if ( !$timezone_string = get_option( 'timezone_string' ) ) {
3109                 return false;
3110         }
3111
3112         $timezone_object = timezone_open( $timezone_string );
3113         $datetime_object = date_create();
3114         if ( false === $timezone_object || false === $datetime_object ) {
3115                 return false;
3116         }
3117         return round( timezone_offset_get( $timezone_object, $datetime_object ) / 3600, 2 );
3118 }
3119
3120 /**
3121  * {@internal Missing Short Description}}
3122  *
3123  * @since 2.9.0
3124  *
3125  * @param unknown_type $a
3126  * @param unknown_type $b
3127  * @return int
3128  */
3129 function _wp_timezone_choice_usort_callback( $a, $b ) {
3130         // Don't use translated versions of Etc
3131         if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) {
3132                 // Make the order of these more like the old dropdown
3133                 if ( 'GMT+' === substr( $a['city'], 0, 4 ) && 'GMT+' === substr( $b['city'], 0, 4 ) ) {
3134                         return -1 * ( strnatcasecmp( $a['city'], $b['city'] ) );
3135                 }
3136                 if ( 'UTC' === $a['city'] ) {
3137                         if ( 'GMT+' === substr( $b['city'], 0, 4 ) ) {
3138                                 return 1;
3139                         }
3140                         return -1;
3141                 }
3142                 if ( 'UTC' === $b['city'] ) {
3143                         if ( 'GMT+' === substr( $a['city'], 0, 4 ) ) {
3144                                 return -1;
3145                         }
3146                         return 1;
3147                 }
3148                 return strnatcasecmp( $a['city'], $b['city'] );
3149         }
3150         if ( $a['t_continent'] == $b['t_continent'] ) {
3151                 if ( $a['t_city'] == $b['t_city'] ) {
3152                         return strnatcasecmp( $a['t_subcity'], $b['t_subcity'] );
3153                 }
3154                 return strnatcasecmp( $a['t_city'], $b['t_city'] );
3155         } else {
3156                 // Force Etc to the bottom of the list
3157                 if ( 'Etc' === $a['continent'] ) {
3158                         return 1;
3159                 }
3160                 if ( 'Etc' === $b['continent'] ) {
3161                         return -1;
3162                 }
3163                 return strnatcasecmp( $a['t_continent'], $b['t_continent'] );
3164         }
3165 }
3166
3167 /**
3168  * Gives a nicely formatted list of timezone strings. // temporary! Not in final
3169  *
3170  * @since 2.9.0
3171  *
3172  * @param string $selected_zone Selected Zone
3173  * @return string
3174  */
3175 function wp_timezone_choice( $selected_zone ) {
3176         static $mo_loaded = false;
3177
3178         $continents = array( 'Africa', 'America', 'Antarctica', 'Arctic', 'Asia', 'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific');
3179
3180         // Load translations for continents and cities
3181         if ( !$mo_loaded ) {
3182                 $locale = get_locale();
3183                 $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
3184                 load_textdomain( 'continents-cities', $mofile );
3185                 $mo_loaded = true;
3186         }
3187
3188         $zonen = array();
3189         foreach ( timezone_identifiers_list() as $zone ) {
3190                 $zone = explode( '/', $zone );
3191                 if ( !in_array( $zone[0], $continents ) ) {
3192                         continue;
3193                 }
3194
3195                 // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
3196                 $exists = array(
3197                         0 => ( isset( $zone[0] ) && $zone[0] ),
3198                         1 => ( isset( $zone[1] ) && $zone[1] ),
3199                         2 => ( isset( $zone[2] ) && $zone[2] ),
3200                 );
3201                 $exists[3] = ( $exists[0] && 'Etc' !== $zone[0] );
3202                 $exists[4] = ( $exists[1] && $exists[3] );
3203                 $exists[5] = ( $exists[2] && $exists[3] );
3204
3205                 $zonen[] = array(
3206                         'continent'   => ( $exists[0] ? $zone[0] : '' ),
3207                         'city'        => ( $exists[1] ? $zone[1] : '' ),
3208                         'subcity'     => ( $exists[2] ? $zone[2] : '' ),
3209                         't_continent' => ( $exists[3] ? translate( str_replace( '_', ' ', $zone[0] ), 'continents-cities' ) : '' ),
3210                         't_city'      => ( $exists[4] ? translate( str_replace( '_', ' ', $zone[1] ), 'continents-cities' ) : '' ),
3211                         't_subcity'   => ( $exists[5] ? translate( str_replace( '_', ' ', $zone[2] ), 'continents-cities' ) : '' )
3212                 );
3213         }
3214         usort( $zonen, '_wp_timezone_choice_usort_callback' );
3215
3216         $structure = array();
3217
3218         if ( empty( $selected_zone ) ) {
3219                 $structure[] = '<option selected="selected" value="">' . __( 'Select a city' ) . '</option>';
3220         }
3221
3222         foreach ( $zonen as $key => $zone ) {
3223                 // Build value in an array to join later
3224                 $value = array( $zone['continent'] );
3225
3226                 if ( empty( $zone['city'] ) ) {
3227                         // It's at the continent level (generally won't happen)
3228                         $display = $zone['t_continent'];
3229                 } else {
3230                         // It's inside a continent group
3231
3232                         // Continent optgroup
3233                         if ( !isset( $zonen[$key - 1] ) || $zonen[$key - 1]['continent'] !== $zone['continent'] ) {
3234                                 $label = $zone['t_continent'];
3235                                 $structure[] = '<optgroup label="'. esc_attr( $label ) .'">';
3236                         }
3237
3238                         // Add the city to the value
3239                         $value[] = $zone['city'];
3240
3241                         $display = $zone['t_city'];
3242                         if ( !empty( $zone['subcity'] ) ) {
3243                                 // Add the subcity to the value
3244                                 $value[] = $zone['subcity'];
3245                                 $display .= ' - ' . $zone['t_subcity'];
3246                         }
3247                 }
3248
3249                 // Build the value
3250                 $value = join( '/', $value );
3251                 $selected = '';
3252                 if ( $value === $selected_zone ) {
3253                         $selected = 'selected="selected" ';
3254                 }
3255                 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $value ) . '">' . esc_html( $display ) . "</option>";
3256
3257                 // Close continent optgroup
3258                 if ( !empty( $zone['city'] ) && ( !isset($zonen[$key + 1]) || (isset( $zonen[$key + 1] ) && $zonen[$key + 1]['continent'] !== $zone['continent']) ) ) {
3259                         $structure[] = '</optgroup>';
3260                 }
3261         }
3262
3263         // Do UTC
3264         $structure[] = '<optgroup label="'. esc_attr__( 'UTC' ) .'">';
3265         $selected = '';
3266         if ( 'UTC' === $selected_zone )
3267                 $selected = 'selected="selected" ';
3268         $structure[] = '<option ' . $selected . 'value="' . esc_attr( 'UTC' ) . '">' . __('UTC') . '</option>';
3269         $structure[] = '</optgroup>';
3270
3271         // Do manual UTC offsets
3272         $structure[] = '<optgroup label="'. esc_attr__( 'Manual Offsets' ) .'">';
3273         $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,
3274                 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);
3275         foreach ( $offset_range as $offset ) {
3276                 if ( 0 <= $offset )
3277                         $offset_name = '+' . $offset;
3278                 else
3279                         $offset_name = (string) $offset;
3280
3281                 $offset_value = $offset_name;
3282                 $offset_name = str_replace(array('.25','.5','.75'), array(':15',':30',':45'), $offset_name);
3283                 $offset_name = 'UTC' . $offset_name;
3284                 $offset_value = 'UTC' . $offset_value;
3285                 $selected = '';
3286                 if ( $offset_value === $selected_zone )
3287                         $selected = 'selected="selected" ';
3288                 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $offset_value ) . '">' . esc_html( $offset_name ) . "</option>";
3289
3290         }
3291         $structure[] = '</optgroup>';
3292
3293         return join( "\n", $structure );
3294 }
3295
3296 /**
3297  * Strip close comment and close php tags from file headers used by WP.
3298  * See http://core.trac.wordpress.org/ticket/8497
3299  *
3300  * @since 2.8.0
3301  *
3302  * @param string $str
3303  * @return string
3304  */
3305 function _cleanup_header_comment($str) {
3306         return trim(preg_replace("/\s*(?:\*\/|\?>).*/", '', $str));
3307 }
3308
3309 /**
3310  * Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.
3311  *
3312  * @since 2.9.0
3313  */
3314 function wp_scheduled_delete() {
3315         global $wpdb;
3316
3317         $delete_timestamp = time() - (60*60*24*EMPTY_TRASH_DAYS);
3318
3319         $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);
3320
3321         foreach ( (array) $posts_to_delete as $post ) {
3322                 $post_id = (int) $post['post_id'];
3323                 if ( !$post_id )
3324                         continue;
3325
3326                 $del_post = get_post($post_id);
3327
3328                 if ( !$del_post || 'trash' != $del_post->post_status ) {
3329                         delete_post_meta($post_id, '_wp_trash_meta_status');
3330                         delete_post_meta($post_id, '_wp_trash_meta_time');
3331                 } else {
3332                         wp_delete_post($post_id);
3333                 }
3334         }
3335
3336         $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);
3337
3338         foreach ( (array) $comments_to_delete as $comment ) {
3339                 $comment_id = (int) $comment['comment_id'];
3340                 if ( !$comment_id )
3341                         continue;
3342
3343                 $del_comment = get_comment($comment_id);
3344
3345                 if ( !$del_comment || 'trash' != $del_comment->comment_approved ) {
3346                         delete_comment_meta($comment_id, '_wp_trash_meta_time');
3347                         delete_comment_meta($comment_id, '_wp_trash_meta_status');
3348                 } else {
3349                         wp_delete_comment($comment_id);
3350                 }
3351         }
3352 }
3353
3354 /**
3355  * Retrieve metadata from a file.
3356  *
3357  * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
3358  * Each piece of metadata must be on its own line. Fields can not span multiple
3359  * lines, the value will get cut at the end of the first line.
3360  *
3361  * If the file data is not within that first 8kiB, then the author should correct
3362  * their plugin file and move the data headers to the top.
3363  *
3364  * @see http://codex.wordpress.org/File_Header
3365  *
3366  * @since 2.9.0
3367  * @param string $file Path to the file
3368  * @param array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name')
3369  * @param string $context If specified adds filter hook "extra_{$context}_headers"
3370  */
3371 function get_file_data( $file, $default_headers, $context = '' ) {
3372         // We don't need to write to the file, so just open for reading.
3373         $fp = fopen( $file, 'r' );
3374
3375         // Pull only the first 8kiB of the file in.
3376         $file_data = fread( $fp, 8192 );
3377
3378         // PHP will close file handle, but we are good citizens.
3379         fclose( $fp );
3380
3381         // Make sure we catch CR-only line endings.
3382         $file_data = str_replace( "\r", "\n", $file_data );
3383
3384         if ( $context && $extra_headers = apply_filters( "extra_{$context}_headers", array() ) ) {
3385                 $extra_headers = array_combine( $extra_headers, $extra_headers ); // keys equal values
3386                 $all_headers = array_merge( $extra_headers, (array) $default_headers );
3387         } else {
3388                 $all_headers = $default_headers;
3389         }
3390
3391         foreach ( $all_headers as $field => $regex ) {
3392                 if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] )
3393                         $all_headers[ $field ] = _cleanup_header_comment( $match[1] );
3394                 else
3395                         $all_headers[ $field ] = '';
3396         }
3397
3398         return $all_headers;
3399 }
3400
3401 /**
3402  * Used internally to tidy up the search terms.
3403  *
3404  * @access private
3405  * @since 2.9.0
3406  *
3407  * @param string $t
3408  * @return string
3409  */
3410 function _search_terms_tidy($t) {
3411         return trim($t, "\"'\n\r ");
3412 }
3413
3414 /**
3415  * Returns true.
3416  *
3417  * Useful for returning true to filters easily.
3418  *
3419  * @since 3.0.0
3420  * @see __return_false()
3421  * @return bool true
3422  */
3423 function __return_true() {
3424         return true;
3425 }
3426
3427 /**
3428  * Returns false.
3429  *
3430  * Useful for returning false to filters easily.
3431  *
3432  * @since 3.0.0
3433  * @see __return_true()
3434  * @return bool false
3435  */
3436 function __return_false() {
3437         return false;
3438 }
3439
3440 /**
3441  * Returns 0.
3442  *
3443  * Useful for returning 0 to filters easily.
3444  *
3445  * @since 3.0.0
3446  * @see __return_zero()
3447  * @return int 0
3448  */
3449 function __return_zero() {
3450         return 0;
3451 }
3452
3453 /**
3454  * Returns an empty array.
3455  *
3456  * Useful for returning an empty array to filters easily.
3457  *
3458  * @since 3.0.0
3459  * @see __return_zero()
3460  * @return array Empty array
3461  */
3462 function __return_empty_array() {
3463         return array();
3464 }
3465
3466 /**
3467  * Returns null.
3468  *
3469  * Useful for returning null to filters easily.
3470  *
3471  * @since 3.4.0
3472  * @return null
3473  */
3474 function __return_null() {
3475         return null;
3476 }
3477
3478 /**
3479  * Send a HTTP header to disable content type sniffing in browsers which support it.
3480  *
3481  * @link http://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx
3482  * @link http://src.chromium.org/viewvc/chrome?view=rev&revision=6985
3483  *
3484  * @since 3.0.0
3485  * @return none
3486  */
3487 function send_nosniff_header() {
3488         @header( 'X-Content-Type-Options: nosniff' );
3489 }
3490
3491 /**
3492  * Returns a MySQL expression for selecting the week number based on the start_of_week option.
3493  *
3494  * @internal
3495  * @since 3.0.0
3496  * @param string $column
3497  * @return string
3498  */
3499 function _wp_mysql_week( $column ) {
3500         switch ( $start_of_week = (int) get_option( 'start_of_week' ) ) {
3501         default :
3502         case 0 :
3503                 return "WEEK( $column, 0 )";
3504         case 1 :
3505                 return "WEEK( $column, 1 )";
3506         case 2 :
3507         case 3 :
3508         case 4 :
3509         case 5 :
3510         case 6 :
3511                 return "WEEK( DATE_SUB( $column, INTERVAL $start_of_week DAY ), 0 )";
3512         }
3513 }
3514
3515 /**
3516  * Finds hierarchy loops using a callback function that maps object IDs to parent IDs.
3517  *
3518  * @since 3.1.0
3519  * @access private
3520  *
3521  * @param callback $callback function that accepts ( ID, $callback_args ) and outputs parent_ID
3522  * @param int $start The ID to start the loop check at
3523  * @param int $start_parent the parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback
3524  * @param array $callback_args optional additional arguments to send to $callback
3525  * @return array IDs of all members of loop
3526  */
3527 function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) {
3528         $override = is_null( $start_parent ) ? array() : array( $start => $start_parent );
3529
3530         if ( !$arbitrary_loop_member = wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override, $callback_args ) )
3531                 return array();
3532
3533         return wp_find_hierarchy_loop_tortoise_hare( $callback, $arbitrary_loop_member, $override, $callback_args, true );
3534 }
3535
3536 /**
3537  * Uses the "The Tortoise and the Hare" algorithm to detect loops.
3538  *
3539  * For every step of the algorithm, the hare takes two steps and the tortoise one.
3540  * If the hare ever laps the tortoise, there must be a loop.
3541  *
3542  * @since 3.1.0
3543  * @access private
3544  *
3545  * @param callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID
3546  * @param int $start The ID to start the loop check at
3547  * @param array $override an array of ( ID => parent_ID, ... ) to use instead of $callback
3548  * @param array $callback_args optional additional arguments to send to $callback
3549  * @param bool $_return_loop Return loop members or just detect presence of loop?
3550  *             Only set to true if you already know the given $start is part of a loop
3551  *             (otherwise the returned array might include branches)
3552  * @return mixed scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop
3553  */
3554 function wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override = array(), $callback_args = array(), $_return_loop = false ) {
3555         $tortoise = $hare = $evanescent_hare = $start;
3556         $return = array();
3557
3558         // Set evanescent_hare to one past hare
3559         // Increment hare two steps
3560         while (
3561                 $tortoise
3562         &&
3563                 ( $evanescent_hare = isset( $override[$hare] ) ? $override[$hare] : call_user_func_array( $callback, array_merge( array( $hare ), $callback_args ) ) )
3564         &&
3565                 ( $hare = isset( $override[$evanescent_hare] ) ? $override[$evanescent_hare] : call_user_func_array( $callback, array_merge( array( $evanescent_hare ), $callback_args ) ) )
3566         ) {
3567                 if ( $_return_loop )
3568                         $return[$tortoise] = $return[$evanescent_hare] = $return[$hare] = true;
3569
3570                 // tortoise got lapped - must be a loop
3571                 if ( $tortoise == $evanescent_hare || $tortoise == $hare )
3572                         return $_return_loop ? $return : $tortoise;
3573
3574                 // Increment tortoise by one step
3575                 $tortoise = isset( $override[$tortoise] ) ? $override[$tortoise] : call_user_func_array( $callback, array_merge( array( $tortoise ), $callback_args ) );
3576         }
3577
3578         return false;
3579 }
3580
3581 /**
3582  * Send a HTTP header to limit rendering of pages to same origin iframes.
3583  *
3584  * @link https://developer.mozilla.org/en/the_x-frame-options_response_header
3585  *
3586  * @since 3.1.3
3587  * @return none
3588  */
3589 function send_frame_options_header() {
3590         @header( 'X-Frame-Options: SAMEORIGIN' );
3591 }
3592
3593 /**
3594  * Retrieve a list of protocols to allow in HTML attributes.
3595  *
3596  * @since 3.3.0
3597  * @see wp_kses()
3598  * @see esc_url()
3599  *
3600  * @return array Array of allowed protocols
3601  */
3602 function wp_allowed_protocols() {
3603         static $protocols;
3604
3605         if ( empty( $protocols ) ) {
3606                 $protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn' );
3607                 $protocols = apply_filters( 'kses_allowed_protocols', $protocols );
3608         }
3609
3610         return $protocols;
3611 }
3612
3613 /**
3614  * Return a comma separated string of functions that have been called to get to the current point in code.
3615  *
3616  * @link http://core.trac.wordpress.org/ticket/19589
3617  * @since 3.4
3618  *
3619  * @param string $ignore_class A class to ignore all function calls within - useful when you want to just give info about the callee
3620  * @param int $skip_frames A number of stack frames to skip - useful for unwinding back to the source of the issue
3621  * @param bool $pretty Whether or not you want a comma separated string or raw array returned
3622  * @return string|array Either a string containing a reversed comma separated trace or an array of individual calls.
3623  */
3624 function wp_debug_backtrace_summary( $ignore_class = null, $skip_frames = 0, $pretty = true ) {
3625         $trace  = debug_backtrace( false );
3626         $caller = array();
3627         $check_class = ! is_null( $ignore_class );
3628         $skip_frames++; // skip this function
3629
3630         foreach ( $trace as $call ) {
3631                 if ( $skip_frames > 0 ) {
3632                         $skip_frames--;
3633                 } elseif ( isset( $call['class'] ) ) {
3634                         if ( $check_class && $ignore_class == $call['class'] )
3635                                 continue; // Filter out calls
3636
3637                         $caller[] = "{$call['class']}{$call['type']}{$call['function']}";
3638                 } else {
3639                         if ( in_array( $call['function'], array( 'do_action', 'apply_filters' ) ) ) {
3640                                 $caller[] = "{$call['function']}('{$call['args'][0]}')";
3641                         } elseif ( in_array( $call['function'], array( 'include', 'include_once', 'require', 'require_once' ) ) ) {
3642                                 $caller[] = $call['function'] . "('" . str_replace( array( WP_CONTENT_DIR, ABSPATH ) , '', $call['args'][0] ) . "')";
3643                         } else {
3644                                 $caller[] = $call['function'];
3645                         }
3646                 }
3647         }
3648         if ( $pretty )
3649                 return join( ', ', array_reverse( $caller ) );
3650         else
3651                 return $caller;
3652 }
3653
3654 /**
3655  * Retrieve ids that are not already present in the cache
3656  *
3657  * @since 3.4.0
3658  *
3659  * @param array $object_ids ID list
3660  * @param string $cache_key The cache bucket to check against
3661  *
3662  * @return array
3663  */
3664 function _get_non_cached_ids( $object_ids, $cache_key ) {
3665         $clean = array();
3666         foreach ( $object_ids as $id ) {
3667                 $id = (int) $id;
3668                 if ( !wp_cache_get( $id, $cache_key ) ) {
3669                         $clean[] = $id;
3670                 }
3671         }
3672
3673         return $clean;
3674 }
3675
3676 /**
3677  * Test if the current device has the capability to upload files.
3678  *
3679  * @since 3.4.0
3680  * @access private
3681  *
3682  * @return bool true|false
3683  */
3684 function _device_can_upload() {
3685         if ( ! wp_is_mobile() )
3686                 return true;
3687
3688         $ua = $_SERVER['HTTP_USER_AGENT'];
3689
3690         if ( strpos($ua, 'iPhone') !== false
3691                 || strpos($ua, 'iPad') !== false
3692                 || strpos($ua, 'iPod') !== false ) {
3693                         return false;
3694         } else {
3695                 return true;
3696         }
3697 }
3698