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