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