UtLpQEcW

1<?php
2/**
3* Main WordPress API
4*
5* @package WordPress
6*/
7
8require( 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*/
26function mysql2date( $format, $date, $translate = true ) {
27if ( empty( $date ) )
28return false;
29
30if ( ‘G’ == $format )
31return strtotime( $date . ‘ +0000’ );
32
33$i = strtotime( $date );
34
35if ( ‘U’ == $format )
36return $i;
37
38if ( $translate )
39return date_i18n( $format, $i );
40else
41return 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*/
61function current_time( $type, $gmt = 0 ) {
62switch ( $type ) {
63case ‘mysql’:
64return ( $gmt ) ? gmdate( ‘Y-m-d H:i:s’ ) : gmdate( ‘Y-m-d H:i:s’, ( time() + ( get_option( ‘gmt_offset’ ) * HOUR_IN_SECONDS ) ) );
65case ‘timestamp’:
66return ( $gmt ) ? time() : time() + ( get_option( ‘gmt_offset’ ) * HOUR_IN_SECONDS );
67default:
68return ( $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*/
89function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
90global $wp_locale;
91$i = $unixtimestamp;
92
93if ( false === $i ) {
94if ( ! $gmt )
95$i = current_time( ‘timestamp’ );
96else
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
111if ( ( !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 );
130if ( preg_match( “/$timezone_formats_re/”, $dateformatstring ) ) {
131$timezone_string = get_option( ‘timezone_string’ );
132if ( $timezone_string ) {
133$timezone_object = timezone_open( $timezone_string );
134$date_object = date_create( null, $timezone_object );
135foreach ( $timezone_formats as $timezone_format ) {
136if ( 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 );
158return $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*/
172function wp_maybe_decline_date( $date ) {
173global $wp_locale;
174
175// i18n functions are not available in SHORTINIT mode
176if ( ! function_exists( ‘_x’ ) ) {
177return $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*/
183if ( ‘on’ === _x( ‘off’, ‘decline months names: on or off’ ) ) {
184// Match a format like ‘j F Y’ or ‘j. F’
185if ( @preg_match( ‘#^\d{1,2}\.? [^\d ]+#u’, $date ) ) {
186$months = $wp_locale->month;
187$months_genitive = $wp_locale->month_genitive;
188
189foreach ( $months as $key => $month ) {
190$months[ $key ] = ‘# ‘ . $month . ‘( |$)#u’;
191}
192
193foreach ( $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
204if ( ‘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
209return $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*/
223function number_format_i18n( $number, $decimals = 0 ) {
224global $wp_locale;
225
226if ( 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*/
239return 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*/
262function 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
271if ( 0 === $bytes ) {
272return number_format_i18n( 0, $decimals ) . ‘ B’;
273}
274
275foreach ( $quant as $unit => $mag ) {
276if ( doubleval( $bytes ) >= $mag ) {
277return number_format_i18n( $bytes / $mag, $decimals ) . ‘ ‘ . $unit;
278}
279}
280
281return 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*/
293function 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
309if ( !is_numeric($start_of_week) )
310$start_of_week = get_option( ‘start_of_week’ );
311
312if ( $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;
320return 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*/
331function maybe_unserialize( $original ) {
332if ( is_serialized( $original ) ) // don’t attempt to unserialize data that wasn’t serialized going in
333return @unserialize( $original );
334return $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*/
349function is_serialized( $data, $strict = true ) {
350// if it isn’t a string, it isn’t serialized.
351if ( ! is_string( $data ) ) {
352return false;
353}
354$data = trim( $data );
355if ( ‘N;’ == $data ) {
356return true;
357}
358if ( strlen( $data ) < 4 ) {
359return false;
360}
361if ( ‘:’ !== $data[1] ) {
362return false;
363}
364if ( $strict ) {
365$lastc = substr( $data, -1 );
366if ( ‘;’ !== $lastc && ‘}’ !== $lastc ) {
367return false;
368}
369} else {
370$semicolon = strpos( $data, ‘;’ );
371$brace = strpos( $data, ‘}’ );
372// Either ; or } must exist.
373if ( false === $semicolon && false === $brace )
374return false;
375// But neither must be in the first X characters.
376if ( false !== $semicolon && $semicolon < 3 )
377return false;
378if ( false !== $brace && $brace < 4 )
379return false;
380}
381$token = $data[0];
382switch ( $token ) {
383case ‘s’ :
384if ( $strict ) {
385if ( ‘”‘ !== substr( $data, -2, 1 ) ) {
386return false;
387}
388} elseif ( false === strpos( $data, ‘”‘ ) ) {
389return false;
390}
391// or else fall through
392case ‘a’ :
393case ‘O’ :
394return (bool) preg_match( “/^{$token}:[0-9]+:/s”, $data );
395case ‘b’ :
396case ‘i’ :
397case ‘d’ :
398$end = $strict ? ‘$’ : ”;
399return (bool) preg_match( “/^{$token}:[0-9.E-]+;$end/”, $data );
400}
401return 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*/
412function is_serialized_string( $data ) {
413// if it isn’t a string, it isn’t a serialized string.
414if ( ! is_string( $data ) ) {
415return false;
416}
417$data = trim( $data );
418if ( strlen( $data ) < 4 ) {
419return false;
420} elseif ( ‘:’ !== $data[1] ) {
421return false;
422} elseif ( ‘;’ !== substr( $data, -1 ) ) {
423return false;
424} elseif ( $data[0] !== ‘s’ ) {
425return false;
426} elseif ( ‘”‘ !== substr( $data, -2, 1 ) ) {
427return false;
428} else {
429return 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*/
441function maybe_serialize( $data ) {
442if ( is_array( $data ) || is_object( $data ) )
443return 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.
448if ( is_serialized( $data, false ) )
449return serialize( $data );
450
451return $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*/
467function xmlrpc_getposttitle( $content ) {
468global $post_default_title;
469if ( preg_match( ‘/<title>(.+?)<\/title>/is’, $content, $matchtitle ) ) {
470$post_title = $matchtitle[1];
471} else {
472$post_title = $post_default_title;
473}
474return $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*/
491function xmlrpc_getpostcategory( $content ) {
492global $post_default_category;
493if ( 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}
499return $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*/
510function xmlrpc_removepostdata( $content ) {
511$content = preg_replace( ‘/<title>(.+?)<\/title>/si’, ”, $content );
512$content = preg_replace( ‘/<category>(.+?)<\/category>/si’, ”, $content );
513$content = trim( $content );
514return $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*/
525function wp_extract_urls( $content ) {
526preg_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
545return 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*/
562function do_enclose( $content, $post_ID ) {
563global $wpdb;
564
565//TODO: Tidy this ghetto code up and make the debug code optional
566include_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
574foreach ( $pung as $link_test ) {
575if ( ! 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 ) . ‘%’) );
577foreach ( $mids as $mid )
578delete_metadata_by_mid( ‘post’, $mid );
579}
580}
581
582foreach ( (array) $post_links_temp as $link_test ) {
583if ( !in_array( $link_test, $pung ) ) { // If we haven’t pung it already
584$test = @parse_url( $link_test );
585if ( false === $test )
586continue;
587if ( isset( $test[‘query’] ) )
588$post_links[] = $link_test;
589elseif ( 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
607foreach ( (array) $post_links as $url ) {
608if ( $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
610if ( $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 );
618if ( false !== $url_parts ) {
619$extension = pathinfo( $url_parts[‘path’], PATHINFO_EXTENSION );
620if ( !empty( $extension ) ) {
621foreach ( wp_get_mime_types() as $exts => $mime ) {
622if ( preg_match( ‘!^(‘ . $exts . ‘)$!i’, $extension ) ) {
623$type = $mime;
624break;
625}
626}
627}
628}
629
630if ( in_array( substr( $type, 0, strpos( $type, “/” ) ), $allowed_types ) ) {
631add_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*/
647function wp_get_http_headers( $url, $deprecated = false ) {
648if ( !empty( $deprecated ) )
649_deprecated_argument( __FUNCTION__, ‘2.7.0’ );
650
651$response = wp_safe_remote_head( $url );
652
653if ( is_wp_error( $response ) )
654return false;
655
656return 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*/
670function is_new_day() {
671global $currentday, $previousday;
672if ( $currentday != $previousday )
673return 1;
674else
675return 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*/
693function build_query( $data ) {
694return _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*/
715function _http_build_query( $data, $prefix = null, $sep = null, $key = ”, $urlencode = true ) {
716$ret = array();
717
718foreach ( (array) $data as $k => $v ) {
719if ( $urlencode)
720$k = urlencode($k);
721if ( is_int($k) && $prefix != null )
722$k = $prefix.$k;
723if ( !empty($key) )
724$k = $key . ‘%5B’ . $k . ‘%5D’;
725if ( $v === null )
726continue;
727elseif ( $v === false )
728$v = ‘0’;
729
730if ( is_array($v) || is_object($v) )
731array_push($ret,_http_build_query($v, ”, $sep, $k, $urlencode));
732elseif ( $urlencode )
733array_push($ret, $k.’=’.urlencode($v));
734else
735array_push($ret, $k.’=’.$v);
736}
737
738if ( null === $sep )
739$sep = ini_get(‘arg_separator.output’);
740
741return 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*/
779function add_query_arg() {
780$args = func_get_args();
781if ( is_array( $args[0] ) ) {
782if ( count( $args ) < 2 || false === $args[1] )
783$uri = $_SERVER[‘REQUEST_URI’];
784else
785$uri = $args[1];
786} else {
787if ( count( $args ) < 3 || false === $args[2] )
788$uri = $_SERVER[‘REQUEST_URI’];
789else
790$uri = $args[2];
791}
792
793if ( $frag = strstr( $uri, ‘#’ ) )
794$uri = substr( $uri, 0, -strlen( $frag ) );
795else
796$frag = ”;
797
798if ( 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
808if ( strpos( $uri, ‘?’ ) !== false ) {
809list( $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
819wp_parse_str( $query, $qs );
820$qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
821if ( is_array( $args[0] ) ) {
822foreach ( $args[0] as $k => $v ) {
823$qs[ $k ] = $v;
824}
825} else {
826$qs[ $args[0] ] = $args[1];
827}
828
829foreach ( $qs as $k => $v ) {
830if ( $v === false )
831unset( $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, ‘?’ );
839return $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*/
851function remove_query_arg( $key, $query = false ) {
852if ( is_array( $key ) ) { // removing multiple keys
853foreach ( $key as $k )
854$query = add_query_arg( $k, false, $query );
855return $query;
856}
857return 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*/
867function 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*/
901return 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*/
912function add_magic_quotes( $array ) {
913foreach ( (array) $array as $k => $v ) {
914if ( is_array( $v ) ) {
915$array[$k] = add_magic_quotes( $v );
916} else {
917$array[$k] = addslashes( $v );
918}
919}
920return $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*/
933function wp_remote_fopen( $uri ) {
934$parsed_url = @parse_url( $uri );
935
936if ( !$parsed_url || !is_array( $parsed_url ) )
937return false;
938
939$options = array();
940$options[‘timeout’] = 10;
941
942$response = wp_safe_remote_get( $uri, $options );
943
944if ( is_wp_error( $response ) )
945return false;
946
947return 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*/
961function wp( $query_vars = ” ) {
962global $wp, $wp_query, $wp_the_query;
963$wp->main( $query_vars );
964
965if ( !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*/
979function get_status_header_desc( $code ) {
980global $wp_header_to_desc;
981
982$code = absint( $code );
983
984if ( !isset( $wp_header_to_desc ) ) {
985$wp_header_to_desc = array(
986100 => ‘Continue’,
987101 => ‘Switching Protocols’,
988102 => ‘Processing’,
989
990200 => ‘OK’,
991201 => ‘Created’,
992202 => ‘Accepted’,
993203 => ‘Non-Authoritative Information’,
994204 => ‘No Content’,
995205 => ‘Reset Content’,
996206 => ‘Partial Content’,
997207 => ‘Multi-Status’,
998226 => ‘IM Used’,
999
1000300 => ‘Multiple Choices’,
1001301 => ‘Moved Permanently’,
1002302 => ‘Found’,
1003303 => ‘See Other’,
1004304 => ‘Not Modified’,
1005305 => ‘Use Proxy’,
1006306 => ‘Reserved’,
1007307 => ‘Temporary Redirect’,
1008308 => ‘Permanent Redirect’,
1009
1010400 => ‘Bad Request’,
1011401 => ‘Unauthorized’,
1012402 => ‘Payment Required’,
1013403 => ‘Forbidden’,
1014404 => ‘Not Found’,
1015405 => ‘Method Not Allowed’,
1016406 => ‘Not Acceptable’,
1017407 => ‘Proxy Authentication Required’,
1018408 => ‘Request Timeout’,
1019409 => ‘Conflict’,
1020410 => ‘Gone’,
1021411 => ‘Length Required’,
1022412 => ‘Precondition Failed’,
1023413 => ‘Request Entity Too Large’,
1024414 => ‘Request-URI Too Long’,
1025415 => ‘Unsupported Media Type’,
1026416 => ‘Requested Range Not Satisfiable’,
1027417 => ‘Expectation Failed’,
1028418 => ‘I\’m a teapot’,
1029421 => ‘Misdirected Request’,
1030422 => ‘Unprocessable Entity’,
1031423 => ‘Locked’,
1032424 => ‘Failed Dependency’,
1033426 => ‘Upgrade Required’,
1034428 => ‘Precondition Required’,
1035429 => ‘Too Many Requests’,
1036431 => ‘Request Header Fields Too Large’,
1037451 => ‘Unavailable For Legal Reasons’,
1038
1039500 => ‘Internal Server Error’,
1040501 => ‘Not Implemented’,
1041502 => ‘Bad Gateway’,
1042503 => ‘Service Unavailable’,
1043504 => ‘Gateway Timeout’,
1044505 => ‘HTTP Version Not Supported’,
1045506 => ‘Variant Also Negotiates’,
1046507 => ‘Insufficient Storage’,
1047510 => ‘Not Extended’,
1048511 => ‘Network Authentication Required’,
1049);
1050}
1051
1052if ( isset( $wp_header_to_desc[$code] ) )
1053return $wp_header_to_desc[$code];
1054else
1055return ”;
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*/
1069function status_header( $code, $description = ” ) {
1070if ( ! $description ) {
1071$description = get_status_header_desc( $code );
1072}
1073
1074if ( empty( $description ) ) {
1075return;
1076}
1077
1078$protocol = wp_get_server_protocol();
1079$status_header = “$protocol $code $description”;
1080if ( 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*/
1107function 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
1113if ( 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;
1131return $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*/
1145function nocache_headers() {
1146$headers = wp_get_nocache_headers();
1147
1148unset( $headers[‘Last-Modified’] );
1149
1150// In PHP 5.3+, make sure we are not sending a Last-Modified header.
1151if ( 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
1156foreach ( headers_list() as $header ) {
1157if ( 0 === stripos( $header, ‘Last-Modified’ ) ) {
1158$headers[‘Last-Modified’] = ”;
1159break;
1160}
1161}
1162}
1163
1164foreach ( $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*/
1173function cache_javascript_headers() {
1174$expiresOffset = 10 * DAY_IN_SECONDS;
1175
1176header( “Content-Type: text/javascript; charset=” . get_bloginfo( ‘charset’ ) );
1177header( “Vary: Accept-Encoding” ); // Handle proxies
1178header( “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*/
1190function get_num_queries() {
1191global $wpdb;
1192return $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*/
1205function bool_from_yn( $yn ) {
1206return ( 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*/
1221function do_feed() {
1222global $wp_query;
1223
1224$feed = get_query_var( ‘feed’ );
1225
1226// Remove the pad, if present.
1227$feed = preg_replace( ‘/^_+/’, ”, $feed );
1228
1229if ( $feed == ” || $feed == ‘feed’ )
1230$feed = get_default_feed();
1231
1232if ( ! has_action( “do_feed_{$feed}” ) ) {
1233wp_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*/
1248do_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*/
1258function do_feed_rdf() {
1259load_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*/
1269function do_feed_rss() {
1270load_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*/
1282function do_feed_rss2( $for_comments ) {
1283if ( $for_comments )
1284load_template( ABSPATH . WPINC . ‘/feed-rss2-comments.php’ );
1285else
1286load_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*/
1298function do_feed_atom( $for_comments ) {
1299if ($for_comments)
1300load_template( ABSPATH . WPINC . ‘/feed-atom-comments.php’);
1301else
1302load_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*/
1313function do_robots() {
1314header( ‘Content-Type: text/plain; charset=utf-8’ );
1315
1316/**
1317* Fires when displaying the robots.txt file.
1318*
1319* @since 2.1.0
1320*/
1321do_action( ‘do_robotstxt’ );
1322
1323$output = “User-agent: *\n”;
1324$public = get_option( ‘blog_public’ );
1325if ( ‘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*/
1342echo 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*/
1360function is_blog_installed() {
1361global $wpdb;
1362
1363/*
1364* Check cache first. If options table goes away and we have true
1365* cached, oh well.
1366*/
1367if ( wp_cache_get( ‘is_blog_installed’ ) )
1368return true;
1369
1370$suppress = $wpdb->suppress_errors();
1371if ( ! wp_installing() ) {
1372$alloptions = wp_load_alloptions();
1373}
1374// If siteurl is not set to autoload, check it specifically
1375if ( !isset( $alloptions[‘siteurl’] ) )
1376$installed = $wpdb->get_var( “SELECT option_value FROM $wpdb->options WHERE option_name = ‘siteurl'” );
1377else
1378$installed = $alloptions[‘siteurl’];
1379$wpdb->suppress_errors( $suppress );
1380
1381$installed = !empty( $installed );
1382wp_cache_set( ‘is_blog_installed’, $installed );
1383
1384if ( $installed )
1385return true;
1386
1387// If visiting repair.php, return true and let it take over.
1388if ( defined( ‘WP_REPAIRING’ ) )
1389return 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();
1399foreach ( $wp_tables as $table ) {
1400// The existence of custom user tables shouldn’t suggest an insane state or prevent a clean install.
1401if ( defined( ‘CUSTOM_USER_TABLE’ ) && CUSTOM_USER_TABLE == $table )
1402continue;
1403if ( defined( ‘CUSTOM_USER_META_TABLE’ ) && CUSTOM_USER_META_TABLE == $table )
1404continue;
1405
1406if ( ! $wpdb->get_results( “DESCRIBE $table;” ) )
1407continue;
1408
1409// One or more tables exist. We are insane.
1410
1411wp_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’ );
1415dead_db();
1416}
1417
1418$wpdb->suppress_errors( $suppress );
1419
1420wp_cache_set( ‘is_blog_installed’, false );
1421
1422return 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*/
1435function wp_nonce_url( $actionurl, $action = -1, $name = ‘_wpnonce’ ) {
1436$actionurl = str_replace( ‘&’, ‘&’, $actionurl );
1437return 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*/
1466function 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
1470if ( $referer )
1471$nonce_field .= wp_referer_field( false );
1472
1473if ( $echo )
1474echo $nonce_field;
1475
1476return $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*/
1490function wp_referer_field( $echo = true ) {
1491$referer_field = ‘<input type=”hidden” name=”_wp_http_referer” value=”‘. esc_attr( wp_unslash( $_SERVER[‘REQUEST_URI’] ) ) . ‘” />’;
1492
1493if ( $echo )
1494echo $referer_field;
1495return $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*/
1512function wp_original_referer_field( $echo = true, $jump_back_to = ‘current’ ) {
1513if ( ! $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 ) . ‘” />’;
1517if ( $echo )
1518echo $orig_referer_field;
1519return $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*/
1531function wp_get_referer() {
1532if ( ! function_exists( ‘wp_validate_redirect’ ) ) {
1533return false;
1534}
1535
1536$ref = wp_get_raw_referer();
1537
1538if ( $ref && $ref !== wp_unslash( $_SERVER[‘REQUEST_URI’] ) && $ref !== home_url() . wp_unslash( $_SERVER[‘REQUEST_URI’] ) ) {
1539return wp_validate_redirect( $ref, false );
1540}
1541
1542return 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*/
1554function wp_get_raw_referer() {
1555if ( ! empty( $_REQUEST[‘_wp_http_referer’] ) ) {
1556return wp_unslash( $_REQUEST[‘_wp_http_referer’] );
1557} else if ( ! empty( $_SERVER[‘HTTP_REFERER’] ) ) {
1558return wp_unslash( $_SERVER[‘HTTP_REFERER’] );
1559}
1560
1561return 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*/
1571function wp_get_original_referer() {
1572if ( ! empty( $_REQUEST[‘_wp_original_http_referer’] ) && function_exists( ‘wp_validate_redirect’ ) )
1573return wp_validate_redirect( wp_unslash( $_REQUEST[‘_wp_original_http_referer’] ), false );
1574return 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*/
1587function wp_mkdir_p( $target ) {
1588$wrapper = null;
1589
1590// Strip the protocol.
1591if ( wp_is_stream( $target ) ) {
1592list( $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.
1599if ( $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, ‘/’);
1608if ( empty($target) )
1609$target = ‘/’;
1610
1611if ( file_exists( $target ) )
1612return @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 );
1616while ( ‘.’ != $target_parent && ! is_dir( $target_parent ) ) {
1617$target_parent = dirname( $target_parent );
1618}
1619
1620// Get the permission bits.
1621if ( $stat = @stat( $target_parent ) ) {
1622$dir_perms = $stat[‘mode’] & 0007777;
1623} else {
1624$dir_perms = 0777;
1625}
1626
1627if ( @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*/
1633if ( $dir_perms != ( $dir_perms & ~umask() ) ) {
1634$folder_parts = explode( ‘/’, substr( $target, strlen( $target_parent ) + 1 ) );
1635for ( $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
1640return true;
1641}
1642
1643return 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*/
1656function 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*/
1661if ( realpath($path) == $path )
1662return true;
1663
1664if ( strlen($path) == 0 || $path[0] == ‘.’ )
1665return false;
1666
1667// Windows allows absolute paths like this.
1668if ( preg_match(‘#^[a-zA-Z]:\\\\#’, $path) )
1669return true;
1670
1671// A path starting with / or \ is absolute; anything else is relative.
1672return ( $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*/
1687function path_join( $base, $path ) {
1688if ( path_is_absolute($path) )
1689return $path;
1690
1691return 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*/
1709function wp_normalize_path( $path ) {
1710$path = str_replace( ‘\\’, ‘/’, $path );
1711$path = preg_replace( ‘|(?<=.)/+|’, ‘/’, $path );
1712if ( ‘:’ === substr( $path, 1, 1 ) ) {
1713$path = ucfirst( $path );
1714}
1715return $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*/
1734function get_temp_dir() {
1735static $temp = ”;
1736if ( defined(‘WP_TEMP_DIR’) )
1737return trailingslashit(WP_TEMP_DIR);
1738
1739if ( $temp )
1740return trailingslashit( $temp );
1741
1742if ( function_exists(‘sys_get_temp_dir’) ) {
1743$temp = sys_get_temp_dir();
1744if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
1745return trailingslashit( $temp );
1746}
1747
1748$temp = ini_get(‘upload_tmp_dir’);
1749if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
1750return trailingslashit( $temp );
1751
1752$temp = WP_CONTENT_DIR . ‘/’;
1753if ( is_dir( $temp ) && wp_is_writable( $temp ) )
1754return $temp;
1755
1756return ‘/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*/
1772function wp_is_writable( $path ) {
1773if ( ‘WIN’ === strtoupper( substr( PHP_OS, 0, 3 ) ) )
1774return win_is_writable( $path );
1775else
1776return @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*/
1795function win_is_writable( $path ) {
1796
1797if ( $path[strlen( $path ) – 1] == ‘/’ ) { // if it looks like a directory, check a random file within the directory
1798return 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
1800return 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’ );
1805if ( $f === false )
1806return false;
1807fclose( $f );
1808if ( $should_delete_tmp_file )
1809unlink( $path );
1810return 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*/
1826function wp_get_upload_dir() {
1827return 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*/
1866function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
1867static $cache = array(), $tested_paths = array();
1868
1869$key = sprintf( ‘%d-%s’, get_current_blog_id(), (string) $time );
1870
1871if ( $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
1885if ( $create_dir ) {
1886$path = $uploads[‘path’];
1887
1888if ( array_key_exists( $path, $tested_paths ) ) {
1889$uploads[‘error’] = $tested_paths[ $path ];
1890} else {
1891if ( ! wp_mkdir_p( $path ) ) {
1892if ( 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
1905return $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*/
1916function _wp_upload_dir( $time = null ) {
1917$siteurl = get_option( ‘siteurl’ );
1918$upload_path = trim( get_option( ‘upload_path’ ) );
1919
1920if ( 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
1929if ( !$url = get_option( ‘upload_url_path’ ) ) {
1930if ( empty($upload_path) || ( ‘wp-content/uploads’ == $upload_path ) || ( $upload_path == $dir ) )
1931$url = WP_CONTENT_URL . ‘/uploads’;
1932else
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*/
1940if ( 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)
1946if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( ‘MULTISITE’ ) ) ) {
1947
1948if ( ! 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
1958if ( defined( ‘MULTISITE’ ) )
1959$ms_dir = ‘/sites/’ . get_current_blog_id();
1960else
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
1981if ( defined( ‘BLOGUPLOADDIR’ ) )
1982$dir = untrailingslashit( BLOGUPLOADDIR );
1983else
1984$dir = ABSPATH . UPLOADS;
1985$url = trailingslashit( $siteurl ) . ‘files’;
1986}
1987}
1988
1989$basedir = $dir;
1990$baseurl = $url;
1991
1992$subdir = ”;
1993if ( get_option( ‘uploads_use_yearmonth_folders’ ) ) {
1994// Generate the yearly and monthly dirs
1995if ( !$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
2005return 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*/
2032function 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.
2042if ( $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*/
2049if ( $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.
2055if ( $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.
2060while ( 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*/
2077return apply_filters( ‘wp_unique_filename’, $filename2, $ext, $dir, $unique_filename_callback );
2078}
2079
2080while ( file_exists( $dir . “/$filename” ) ) {
2081if ( ” == “$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 */
2090return 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*/
2116function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
2117if ( !empty( $deprecated ) )
2118_deprecated_argument( __FUNCTION__, ‘2.0.0’ );
2119
2120if ( empty( $name ) )
2121return array( ‘error’ => __( ‘Empty filename’ ) );
2122
2123$wp_filetype = wp_check_filetype( $name );
2124if ( ! $wp_filetype[‘ext’] && ! current_user_can( ‘unfiltered_upload’ ) )
2125return array( ‘error’ => __( ‘Invalid file type’ ) );
2126
2127$upload = wp_upload_dir( $time );
2128
2129if ( $upload[‘error’] !== false )
2130return $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 ) );
2143if ( !is_array( $upload_bits_error ) ) {
2144$upload[ ‘error’ ] = $upload_bits_error;
2145return $upload;
2146}
2147
2148$filename = wp_unique_filename( $upload[‘path’], $name );
2149
2150$new_file = $upload[‘path’] . “/$filename”;
2151if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
2152if ( 0 === strpos( $upload[‘basedir’], ABSPATH ) )
2153$error_path = str_replace( ABSPATH, ”, $upload[‘basedir’] ) . $upload[‘subdir’];
2154else
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 );
2158return array( ‘error’ => $message );
2159}
2160
2161$ifp = @ fopen( $new_file, ‘wb’ );
2162if ( ! $ifp )
2163return array( ‘error’ => sprintf( __( ‘Could not write file %s’ ), $new_file ) );
2164
2165@fwrite( $ifp, $bits );
2166fclose( $ifp );
2167clearstatcache();
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 );
2174clearstatcache();
2175
2176// Compute the URL
2177$url = $upload[‘url’] . “/$filename”;
2178
2179/** This filter is documented in wp-admin/includes/file.php */
2180return 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*/
2191function wp_ext2type( $ext ) {
2192$ext = strtolower( $ext );
2193
2194$ext2type = wp_get_ext_types();
2195foreach ( $ext2type as $type => $exts )
2196if ( in_array( $ext, $exts ) )
2197return $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*/
2211function wp_check_filetype( $filename, $mimes = null ) {
2212if ( empty($mimes) )
2213$mimes = get_allowed_mime_types();
2214$type = false;
2215$ext = false;
2216
2217foreach ( $mimes as $ext_preg => $mime_match ) {
2218$ext_preg = ‘!\.(‘ . $ext_preg . ‘)$!i’;
2219if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
2220$type = $mime_match;
2221$ext = $ext_matches[1];
2222break;
2223}
2224}
2225
2226return 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*/
2248function 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
2257if ( ! file_exists( $file ) ) {
2258return compact( ‘ext’, ‘type’, ‘proper_filename’ );
2259}
2260
2261// Validate image types.
2262if ( $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
2267if ( ! $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
2286if ( ! empty( $mime_to_ext[ $real_mime ] ) ) {
2287$filename_parts = explode( ‘.’, $filename );
2288array_pop( $filename_parts );
2289$filename_parts[] = $mime_to_ext[ $real_mime ];
2290$new_filename = implode( ‘.’, $filename_parts );
2291
2292if ( $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 );
2307finfo_close( $finfo );
2308
2309// If the extension does not match the file’s real type, return false.
2310if ( $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*/
2327return 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*/
2340function 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*/
2346try {
2347if ( 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
2359return $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*/
2370function 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*/
2382return 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*/
2492function 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*/
2504return 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*/
2526function get_allowed_mime_types( $user = null ) {
2527$t = wp_get_mime_types();
2528
2529unset( $t[‘swf’], $t[‘exe’] );
2530if ( function_exists( ‘current_user_can’ ) )
2531$unfiltered = $user ? user_can( $user, ‘unfiltered_html’ ) : current_user_can( ‘unfiltered_html’ );
2532
2533if ( empty( $unfiltered ) ) {
2534unset( $t[‘htm|html’], $t[‘js’] );
2535}
2536
2537/**
2538* Filters list of allowed mime types and file extensions.
2539*
2540* @since 2.0.0
2541*
2542* @param array $t Mime types keyed by the file extension regex corresponding to
2543* those types. ‘swf’ and ‘exe’ removed from full list. ‘htm|html’ also
2544* removed depending on ‘$user’ capabilities.
2545* @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user).
2546*/
2547return apply_filters( ‘upload_mimes’, $t, $user );
2548}
2549
2550/**
2551* Display “Are You Sure” message to confirm the action being taken.
2552*
2553* If the action has the nonce explain message, then it will be displayed
2554* along with the “Are you sure?” message.
2555*
2556* @since 2.0.4
2557*
2558* @param string $action The nonce action.
2559*/
2560function wp_nonce_ays( $action ) {
2561if ( ‘log-out’ == $action ) {
2562$html = sprintf( __( ‘You are attempting to log out of %s’ ), get_bloginfo( ‘name’ ) ) . ‘</p><p>’;
2563$redirect_to = isset( $_REQUEST[‘redirect_to’] ) ? $_REQUEST[‘redirect_to’] : ”;
2564$html .= sprintf( __( “Do you really want to <a href=’%s’>log out</a>?”), wp_logout_url( $redirect_to ) );
2565} else {
2566$html = __( ‘Are you sure you want to do this?’ );
2567if ( wp_get_referer() )
2568$html .= “</p><p><a href='” . esc_url( remove_query_arg( ‘updated’, wp_get_referer() ) ) . “‘>” . __( ‘Please try again.’ ) . “</a>”;
2569}
2570
2571wp_die( $html, __( ‘WordPress Failure Notice’ ), 403 );
2572}
2573
2574/**
2575* Kill WordPress execution and display HTML message with error message.
2576*
2577* This function complements the die() PHP function. The difference is that
2578* HTML will be displayed to the user. It is recommended to use this function
2579* only when the execution should not continue any further. It is not recommended
2580* to call this function very often, and try to handle as many errors as possible
2581* silently or more gracefully.
2582*
2583* As a shorthand, the desired HTTP response code may be passed as an integer to
2584* the $title parameter (the default title would apply) or the $args parameter.
2585*
2586* @since 2.0.4
2587* @since 4.1.0 The $title and $args parameters were changed to optionally accept
2588* an integer to be used as the response code.
2589*
2590* @param string|WP_Error $message Optional. Error message. If this is a WP_Error object,
2591* the error’s messages are used. Default empty.
2592* @param string|int $title Optional. Error title. If $message is a WP_Error object,
2593* error data with the key ‘title’ may be used to specify the title.
2594* If $title is an integer, then it is treated as the response
2595* code. Default empty.
2596* @param string|array|int $args {
2597* Optional. Arguments to control behavior. If $args is an integer, then it is treated
2598* as the response code. Default empty array.
2599*
2600* @type int $response The HTTP response code. Default 500.
2601* @type bool $back_link Whether to include a link to go back. Default false.
2602* @type string $text_direction The text direction. This is only useful internally, when WordPress
2603* is still loading and the site’s locale is not set up yet. Accepts ‘rtl’.
2604* Default is the value of is_rtl().
2605* }
2606*/
2607function wp_die( $message = ”, $title = ”, $args = array() ) {
2608
2609if ( is_int( $args ) ) {
2610$args = array( ‘response’ => $args );
2611} elseif ( is_int( $title ) ) {
2612$args = array( ‘response’ => $title );
2613$title = ”;
2614}
2615
2616if ( defined( ‘DOING_AJAX’ ) && DOING_AJAX ) {
2617/**
2618* Filters the callback for killing WordPress execution for Ajax requests.
2619*
2620* @since 3.4.0
2621*
2622* @param callable $function Callback function name.
2623*/
2624$function = apply_filters( ‘wp_die_ajax_handler’, ‘_ajax_wp_die_handler’ );
2625} elseif ( defined( ‘XMLRPC_REQUEST’ ) && XMLRPC_REQUEST ) {
2626/**
2627* Filters the callback for killing WordPress execution for XML-RPC requests.
2628*
2629* @since 3.4.0
2630*
2631* @param callable $function Callback function name.
2632*/
2633$function = apply_filters( ‘wp_die_xmlrpc_handler’, ‘_xmlrpc_wp_die_handler’ );
2634} else {
2635/**
2636* Filters the callback for killing WordPress execution for all non-Ajax, non-XML-RPC requests.
2637*
2638* @since 3.0.0
2639*
2640* @param callable $function Callback function name.
2641*/
2642$function = apply_filters( ‘wp_die_handler’, ‘_default_wp_die_handler’ );
2643}
2644
2645call_user_func( $function, $message, $title, $args );
2646}
2647
2648/**
2649* Kills WordPress execution and display HTML message with error message.
2650*
2651* This is the default handler for wp_die if you want a custom one for your
2652* site then you can overload using the {@see ‘wp_die_handler’} filter in wp_die().
2653*
2654* @since 3.0.0
2655* @access private
2656*
2657* @param string $message Error message.
2658* @param string $title Optional. Error title. Default empty.
2659* @param string|array $args Optional. Arguments to control behavior. Default empty array.
2660*/
2661function _default_wp_die_handler( $message, $title = ”, $args = array() ) {
2662$defaults = array( ‘response’ => 500 );
2663$r = wp_parse_args($args, $defaults);
2664
2665$have_gettext = function_exists(‘__’);
2666
2667if ( function_exists( ‘is_wp_error’ ) && is_wp_error( $message ) ) {
2668if ( empty( $title ) ) {
2669$error_data = $message->get_error_data();
2670if ( is_array( $error_data ) && isset( $error_data[‘title’] ) )
2671$title = $error_data[‘title’];
2672}
2673$errors = $message->get_error_messages();
2674switch ( count( $errors ) ) {
2675case 0 :
2676$message = ”;
2677break;
2678case 1 :
2679$message = “<p>{$errors[0]}</p>”;
2680break;
2681default :
2682$message = “<ul>\n\t\t<li>” . join( “</li>\n\t\t<li>”, $errors ) . “</li>\n\t</ul>”;
2683break;
2684}
2685} elseif ( is_string( $message ) ) {
2686$message = “<p>$message</p>”;
2687}
2688
2689if ( isset( $r[‘back_link’] ) && $r[‘back_link’] ) {
2690$back_text = $have_gettext? __(‘« Back’) : ‘« Back’;
2691$message .= “\n<p><a href=’javascript:history.back()’>$back_text</a></p>”;
2692}
2693
2694if ( ! did_action( ‘admin_head’ ) ) :
2695if ( !headers_sent() ) {
2696status_header( $r[‘response’] );
2697nocache_headers();
2698header( ‘Content-Type: text/html; charset=utf-8’ );
2699}
2700
2701if ( empty($title) )
2702$title = $have_gettext ? __(‘WordPress › Error’) : ‘WordPress › Error’;
2703
2704$text_direction = ‘ltr’;
2705if ( isset($r[‘text_direction’]) && ‘rtl’ == $r[‘text_direction’] )
2706$text_direction = ‘rtl’;
2707elseif ( function_exists( ‘is_rtl’ ) && is_rtl() )
2708$text_direction = ‘rtl’;
2709?>
2710<!DOCTYPE html>
2711<!– 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
2712–>
2713<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'”; ?>>
2714<head>
2715<meta http-equiv=”Content-Type” content=”text/html; charset=utf-8″ />
2716<meta name=”viewport” content=”width=device-width”>
2717<?php
2718if ( function_exists( ‘wp_no_robots’ ) ) {
2719wp_no_robots();
2720}
2721?>
2722<title><?php echo $title ?></title>
2723<style type=”text/css”>
2724html {
2725background: #f1f1f1;
2726}
2727body {
2728background: #fff;
2729color: #444;
2730font-family: -apple-system, BlinkMacSystemFont, “Segoe UI”, Roboto, Oxygen-Sans, Ubuntu, Cantarell, “Helvetica Neue”, sans-serif;
2731margin: 2em auto;
2732padding: 1em 2em;
2733max-width: 700px;
2734-webkit-box-shadow: 0 1px 3px rgba(0,0,0,0.13);
2735box-shadow: 0 1px 3px rgba(0,0,0,0.13);
2736}
2737h1 {
2738border-bottom: 1px solid #dadada;
2739clear: both;
2740color: #666;
2741font-size: 24px;
2742margin: 30px 0 0 0;
2743padding: 0;
2744padding-bottom: 7px;
2745}
2746#error-page {
2747margin-top: 50px;
2748}
2749#error-page p {
2750font-size: 14px;
2751line-height: 1.5;
2752margin: 25px 0 20px;
2753}
2754#error-page code {
2755font-family: Consolas, Monaco, monospace;
2756}
2757ul li {
2758margin-bottom: 10px;
2759font-size: 14px ;
2760}
2761a {
2762color: #0073aa;
2763}
2764a:hover,
2765a:active {
2766color: #00a0d2;
2767}
2768a:focus {
2769color: #124964;
2770-webkit-box-shadow:
27710 0 0 1px #5b9dd9,
27720 0 2px 1px rgba(30, 140, 190, .8);
2773box-shadow:
27740 0 0 1px #5b9dd9,
27750 0 2px 1px rgba(30, 140, 190, .8);
2776outline: none;
2777}
2778.button {
2779background: #f7f7f7;
2780border: 1px solid #ccc;
2781color: #555;
2782display: inline-block;
2783text-decoration: none;
2784font-size: 13px;
2785line-height: 26px;
2786height: 28px;
2787margin: 0;
2788padding: 0 10px 1px;
2789cursor: pointer;
2790-webkit-border-radius: 3px;
2791-webkit-appearance: none;
2792border-radius: 3px;
2793white-space: nowrap;
2794-webkit-box-sizing: border-box;
2795-moz-box-sizing: border-box;
2796box-sizing: border-box;
2797
2798-webkit-box-shadow: 0 1px 0 #ccc;
2799box-shadow: 0 1px 0 #ccc;
2800vertical-align: top;
2801}
2802
2803.button.button-large {
2804height: 30px;
2805line-height: 28px;
2806padding: 0 12px 2px;
2807}
2808
2809.button:hover,
2810.button:focus {
2811background: #fafafa;
2812border-color: #999;
2813color: #23282d;
2814}
2815
2816.button:focus {
2817border-color: #5b9dd9;
2818-webkit-box-shadow: 0 0 3px rgba( 0, 115, 170, .8 );
2819box-shadow: 0 0 3px rgba( 0, 115, 170, .8 );
2820outline: none;
2821}
2822
2823.button:active {
2824background: #eee;
2825border-color: #999;
2826-webkit-box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
2827box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
2828-webkit-transform: translateY(1px);
2829-ms-transform: translateY(1px);
2830transform: translateY(1px);
2831}
2832
2833<?php
2834if ( ‘rtl’ == $text_direction ) {
2835echo ‘body { font-family: Tahoma, Arial; }’;
2836}
2837?>
2838</style>
2839</head>
2840<body id=”error-page”>
2841<?php endif; // ! did_action( ‘admin_head’ ) ?>
2842<?php echo $message; ?>
2843</body>
2844</html>
2845<?php
2846die();
2847}
2848
2849/**
2850* Kill WordPress execution and display XML message with error message.
2851*
2852* This is the handler for wp_die when processing XMLRPC requests.
2853*
2854* @since 3.2.0
2855* @access private
2856*
2857* @global wp_xmlrpc_server $wp_xmlrpc_server
2858*
2859* @param string $message Error message.
2860* @param string $title Optional. Error title. Default empty.
2861* @param string|array $args Optional. Arguments to control behavior. Default empty array.
2862*/
2863function _xmlrpc_wp_die_handler( $message, $title = ”, $args = array() ) {
2864global $wp_xmlrpc_server;
2865$defaults = array( ‘response’ => 500 );
2866
2867$r = wp_parse_args($args, $defaults);
2868
2869if ( $wp_xmlrpc_server ) {
2870$error = new IXR_Error( $r[‘response’] , $message);
2871$wp_xmlrpc_server->output( $error->getXml() );
2872}
2873die();
2874}
2875
2876/**
2877* Kill WordPress ajax execution.
2878*
2879* This is the handler for wp_die when processing Ajax requests.
2880*
2881* @since 3.4.0
2882* @access private
2883*
2884* @param string $message Optional. Response to print. Default empty.
2885*/
2886function _ajax_wp_die_handler( $message = ” ) {
2887if ( is_scalar( $message ) )
2888die( (string) $message );
2889die( ‘0’ );
2890}
2891
2892/**
2893* Kill WordPress execution.
2894*
2895* This is the handler for wp_die when processing APP requests.
2896*
2897* @since 3.4.0
2898* @access private
2899*
2900* @param string $message Optional. Response to print. Default empty.
2901*/
2902function _scalar_wp_die_handler( $message = ” ) {
2903if ( is_scalar( $message ) )
2904die( (string) $message );
2905die();
2906}
2907
2908/**
2909* Encode a variable into JSON, with some sanity checks.
2910*
2911* @since 4.1.0
2912*
2913* @param mixed $data Variable (usually an array or object) to encode as JSON.
2914* @param int $options Optional. Options to be passed to json_encode(). Default 0.
2915* @param int $depth Optional. Maximum depth to walk through $data. Must be
2916* greater than 0. Default 512.
2917* @return string|false The JSON encoded string, or false if it cannot be encoded.
2918*/
2919function wp_json_encode( $data, $options = 0, $depth = 512 ) {
2920/*
2921* json_encode() has had extra params added over the years.
2922* $options was added in 5.3, and $depth in 5.5.
2923* We need to make sure we call it with the correct arguments.
2924*/
2925if ( version_compare( PHP_VERSION, ‘5.5’, ‘>=’ ) ) {
2926$args = array( $data, $options, $depth );
2927} elseif ( version_compare( PHP_VERSION, ‘5.3’, ‘>=’ ) ) {
2928$args = array( $data, $options );
2929} else {
2930$args = array( $data );
2931}
2932
2933// Prepare the data for JSON serialization.
2934$args[0] = _wp_json_prepare_data( $data );
2935
2936$json = @call_user_func_array( ‘json_encode’, $args );
2937
2938// If json_encode() was successful, no need to do more sanity checking.
2939// … unless we’re in an old version of PHP, and json_encode() returned
2940// a string containing ‘null’. Then we need to do more sanity checking.
2941if ( false !== $json && ( version_compare( PHP_VERSION, ‘5.5’, ‘>=’ ) || false === strpos( $json, ‘null’ ) ) ) {
2942return $json;
2943}
2944
2945try {
2946$args[0] = _wp_json_sanity_check( $data, $depth );
2947} catch ( Exception $e ) {
2948return false;
2949}
2950
2951return call_user_func_array( ‘json_encode’, $args );
2952}
2953
2954/**
2955* Perform sanity checks on data that shall be encoded to JSON.
2956*
2957* @ignore
2958* @since 4.1.0
2959* @access private
2960*
2961* @see wp_json_encode()
2962*
2963* @param mixed $data Variable (usually an array or object) to encode as JSON.
2964* @param int $depth Maximum depth to walk through $data. Must be greater than 0.
2965* @return mixed The sanitized data that shall be encoded to JSON.
2966*/
2967function _wp_json_sanity_check( $data, $depth ) {
2968if ( $depth < 0 ) {
2969throw new Exception( ‘Reached depth limit’ );
2970}
2971
2972if ( is_array( $data ) ) {
2973$output = array();
2974foreach ( $data as $id => $el ) {
2975// Don’t forget to sanitize the ID!
2976if ( is_string( $id ) ) {
2977$clean_id = _wp_json_convert_string( $id );
2978} else {
2979$clean_id = $id;
2980}
2981
2982// Check the element type, so that we’re only recursing if we really have to.
2983if ( is_array( $el ) || is_object( $el ) ) {
2984$output[ $clean_id ] = _wp_json_sanity_check( $el, $depth – 1 );
2985} elseif ( is_string( $el ) ) {
2986$output[ $clean_id ] = _wp_json_convert_string( $el );
2987} else {
2988$output[ $clean_id ] = $el;
2989}
2990}
2991} elseif ( is_object( $data ) ) {
2992$output = new stdClass;
2993foreach ( $data as $id => $el ) {
2994if ( is_string( $id ) ) {
2995$clean_id = _wp_json_convert_string( $id );
2996} else {
2997$clean_id = $id;
2998}
2999
3000if ( is_array( $el ) || is_object( $el ) ) {
3001$output->$clean_id = _wp_json_sanity_check( $el, $depth – 1 );
3002} elseif ( is_string( $el ) ) {
3003$output->$clean_id = _wp_json_convert_string( $el );
3004} else {
3005$output->$clean_id = $el;
3006}
3007}
3008} elseif ( is_string( $data ) ) {
3009return _wp_json_convert_string( $data );
3010} else {
3011return $data;
3012}
3013
3014return $output;
3015}
3016
3017/**
3018* Convert a string to UTF-8, so that it can be safely encoded to JSON.
3019*
3020* @ignore
3021* @since 4.1.0
3022* @access private
3023*
3024* @see _wp_json_sanity_check()
3025*
3026* @staticvar bool $use_mb
3027*
3028* @param string $string The string which is to be converted.
3029* @return string The checked string.
3030*/
3031function _wp_json_convert_string( $string ) {
3032static $use_mb = null;
3033if ( is_null( $use_mb ) ) {
3034$use_mb = function_exists( ‘mb_convert_encoding’ );
3035}
3036
3037if ( $use_mb ) {
3038$encoding = mb_detect_encoding( $string, mb_detect_order(), true );
3039if ( $encoding ) {
3040return mb_convert_encoding( $string, ‘UTF-8’, $encoding );
3041} else {
3042return mb_convert_encoding( $string, ‘UTF-8’, ‘UTF-8’ );
3043}
3044} else {
3045return wp_check_invalid_utf8( $string, true );
3046}
3047}
3048
3049/**
3050* Prepares response data to be serialized to JSON.
3051*
3052* This supports the JsonSerializable interface for PHP 5.2-5.3 as well.
3053*
3054* @ignore
3055* @since 4.4.0
3056* @access private
3057*
3058* @param mixed $data Native representation.
3059* @return bool|int|float|null|string|array Data ready for json_encode().
3060*/
3061function _wp_json_prepare_data( $data ) {
3062if ( ! defined( ‘WP_JSON_SERIALIZE_COMPATIBLE’ ) || WP_JSON_SERIALIZE_COMPATIBLE === false ) {
3063return $data;
3064}
3065
3066switch ( gettype( $data ) ) {
3067case ‘boolean’:
3068case ‘integer’:
3069case ‘double’:
3070case ‘string’:
3071case ‘NULL’:
3072// These values can be passed through.
3073return $data;
3074
3075case ‘array’:
3076// Arrays must be mapped in case they also return objects.
3077return array_map( ‘_wp_json_prepare_data’, $data );
3078
3079case ‘object’:
3080// If this is an incomplete object (__PHP_Incomplete_Class), bail.
3081if ( ! is_object( $data ) ) {
3082return null;
3083}
3084
3085if ( $data instanceof JsonSerializable ) {
3086$data = $data->jsonSerialize();
3087} else {
3088$data = get_object_vars( $data );
3089}
3090
3091// Now, pass the array (or whatever was returned from jsonSerialize through).
3092return _wp_json_prepare_data( $data );
3093
3094default:
3095return null;
3096}
3097}
3098
3099/**
3100* Send a JSON response back to an Ajax request.
3101*
3102* @since 3.5.0
3103*
3104* @param mixed $response Variable (usually an array or object) to encode as JSON,
3105* then print and die.
3106*/
3107function wp_send_json( $response ) {
3108@header( ‘Content-Type: application/json; charset=’ . get_option( ‘blog_charset’ ) );
3109echo wp_json_encode( $response );
3110if ( defined( ‘DOING_AJAX’ ) && DOING_AJAX )
3111wp_die();
3112else
3113die;
3114}
3115
3116/**
3117* Send a JSON response back to an Ajax request, indicating success.
3118*
3119* @since 3.5.0
3120*
3121* @param mixed $data Data to encode as JSON, then print and die.
3122*/
3123function wp_send_json_success( $data = null ) {
3124$response = array( ‘success’ => true );
3125
3126if ( isset( $data ) )
3127$response[‘data’] = $data;
3128
3129wp_send_json( $response );
3130}
3131
3132/**
3133* Send a JSON response back to an Ajax request, indicating failure.
3134*
3135* If the $data parameter is a WP_Error object, the errors
3136* within the object are processed and output as an array of error
3137* codes and corresponding messages. All other types are output
3138* without further processing.
3139*
3140* @since 3.5.0
3141* @since 4.1.0 The $data parameter is now processed if a WP_Error object is passed in.
3142*
3143* @param mixed $data Data to encode as JSON, then print and die.
3144*/
3145function wp_send_json_error( $data = null ) {
3146$response = array( ‘success’ => false );
3147
3148if ( isset( $data ) ) {
3149if ( is_wp_error( $data ) ) {
3150$result = array();
3151foreach ( $data->errors as $code => $messages ) {
3152foreach ( $messages as $message ) {
3153$result[] = array( ‘code’ => $code, ‘message’ => $message );
3154}
3155}
3156
3157$response[‘data’] = $result;
3158} else {
3159$response[‘data’] = $data;
3160}
3161}
3162
3163wp_send_json( $response );
3164}
3165
3166/**
3167* Checks that a JSONP callback is a valid JavaScript callback.
3168*
3169* Only allows alphanumeric characters and the dot character in callback
3170* function names. This helps to mitigate XSS attacks caused by directly
3171* outputting user input.
3172*
3173* @since 4.6.0
3174*
3175* @param string $callback Supplied JSONP callback function.
3176* @return bool True if valid callback, otherwise false.
3177*/
3178function wp_check_jsonp_callback( $callback ) {
3179if ( ! is_string( $callback ) ) {
3180return false;
3181}
3182
3183$jsonp_callback = preg_replace( ‘/[^\w\.]/’, ”, $callback, -1, $illegal_char_count );
3184
3185return 0 === $illegal_char_count;
3186}
3187
3188/**
3189* Retrieve the WordPress home page URL.
3190*
3191* If the constant named ‘WP_HOME’ exists, then it will be used and returned
3192* by the function. This can be used to counter the redirection on your local
3193* development environment.
3194*
3195* @since 2.2.0
3196* @access private
3197*
3198* @see WP_HOME
3199*
3200* @param string $url URL for the home location.
3201* @return string Homepage location.
3202*/
3203function _config_wp_home( $url = ” ) {
3204if ( defined( ‘WP_HOME’ ) )
3205return untrailingslashit( WP_HOME );
3206return $url;
3207}
3208
3209/**
3210* Retrieve the WordPress site URL.
3211*
3212* If the constant named ‘WP_SITEURL’ is defined, then the value in that
3213* constant will always be returned. This can be used for debugging a site
3214* on your localhost while not having to change the database to your URL.
3215*
3216* @since 2.2.0
3217* @access private
3218*
3219* @see WP_SITEURL
3220*
3221* @param string $url URL to set the WordPress site location.
3222* @return string The WordPress Site URL.
3223*/
3224function _config_wp_siteurl( $url = ” ) {
3225if ( defined( ‘WP_SITEURL’ ) )
3226return untrailingslashit( WP_SITEURL );
3227return $url;
3228}
3229
3230/**
3231* Set the localized direction for MCE plugin.
3232*
3233* Will only set the direction to ‘rtl’, if the WordPress locale has
3234* the text direction set to ‘rtl’.
3235*
3236* Fills in the ‘directionality’ setting, enables the ‘directionality’
3237* plugin, and adds the ‘ltr’ button to ‘toolbar1’, formerly
3238* ‘theme_advanced_buttons1’ array keys. These keys are then returned
3239* in the $mce_init (TinyMCE settings) array.
3240*
3241* @since 2.1.0
3242* @access private
3243*
3244* @param array $mce_init MCE settings array.
3245* @return array Direction set for ‘rtl’, if needed by locale.
3246*/
3247function _mce_set_direction( $mce_init ) {
3248if ( is_rtl() ) {
3249$mce_init[‘directionality’] = ‘rtl’;
3250$mce_init[‘rtl_ui’] = true;
3251
3252if ( ! empty( $mce_init[‘plugins’] ) && strpos( $mce_init[‘plugins’], ‘directionality’ ) === false ) {
3253$mce_init[‘plugins’] .= ‘,directionality’;
3254}
3255
3256if ( ! empty( $mce_init[‘toolbar1’] ) && ! preg_match( ‘/\bltr\b/’, $mce_init[‘toolbar1’] ) ) {
3257$mce_init[‘toolbar1’] .= ‘,ltr’;
3258}
3259}
3260
3261return $mce_init;
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*/
3286function smilies_init() {
3287global $wpsmiliestrans, $wp_smiliessearch;
3288
3289// don’t bother setting up smilies if they are disabled
3290if ( !get_option( ‘use_smilies’ ) )
3291return;
3292
3293if ( !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
3343if (count($wpsmiliestrans) == 0) {
3344return;
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*/
3352krsort($wpsmiliestrans);
3353
3354$spaces = wp_spaces_regexp();
3355
3356// Begin first “subpattern”
3357$wp_smiliessearch = ‘/(?<=’ . $spaces . ‘|^)’;
3358
3359$subchar = ”;
3360foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
3361$firstchar = substr($smiley, 0, 1);
3362$rest = substr($smiley, 1);
3363
3364// new subpattern?
3365if ($firstchar != $subchar) {
3366if ($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*/
3394function wp_parse_args( $args, $defaults = ” ) {
3395if ( is_object( $args ) )
3396$r = get_object_vars( $args );
3397elseif ( is_array( $args ) )
3398$r =& $args;
3399else
3400wp_parse_str( $args, $r );
3401
3402if ( is_array( $defaults ) )
3403return array_merge( $defaults, $r );
3404return $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*/
3415function wp_parse_id_list( $list ) {
3416if ( !is_array($list) )
3417$list = preg_split(‘/[\s,]+/’, $list);
3418
3419return 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*/
3431function wp_array_slice_assoc( $array, $keys ) {
3432$slice = array();
3433foreach ( $keys as $key )
3434if ( isset( $array[ $key ] ) )
3435$slice[ $key ] = $array[ $key ];
3436
3437return $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*/
3448function wp_is_numeric_array( $data ) {
3449if ( ! is_array( $data ) ) {
3450return false;
3451}
3452
3453$keys = array_keys( $data );
3454$string_keys = array_filter( $keys, ‘is_string’ );
3455return 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*/
3474function wp_filter_object_list( $list, $args = array(), $operator = ‘and’, $field = false ) {
3475if ( ! is_array( $list ) )
3476return array();
3477
3478$list = wp_list_filter( $list, $args, $operator );
3479
3480if ( $field )
3481$list = wp_list_pluck( $list, $field );
3482
3483return $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*/
3500function wp_list_filter( $list, $args = array(), $operator = ‘AND’ ) {
3501if ( ! is_array( $list ) )
3502return array();
3503
3504if ( empty( $args ) )
3505return $list;
3506
3507$operator = strtoupper( $operator );
3508$count = count( $args );
3509$filtered = array();
3510
3511foreach ( $list as $key => $obj ) {
3512$to_match = (array) $obj;
3513
3514$matched = 0;
3515foreach ( $args as $m_key => $m_value ) {
3516if ( array_key_exists( $m_key, $to_match ) && $m_value == $to_match[ $m_key ] )
3517$matched++;
3518}
3519
3520if ( ( ‘AND’ == $operator && $matched == $count )
3521|| ( ‘OR’ == $operator && $matched > 0 )
3522|| ( ‘NOT’ == $operator && 0 == $matched ) ) {
3523$filtered[$key] = $obj;
3524}
3525}
3526
3527return $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*/
3547function wp_list_pluck( $list, $field, $index_key = null ) {
3548if ( ! $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*/
3553foreach ( $list as $key => $value ) {
3554if ( is_object( $value ) ) {
3555$list[ $key ] = $value->$field;
3556} else {
3557$list[ $key ] = $value[ $field ];
3558}
3559}
3560return $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();
3568foreach ( $list as $value ) {
3569if ( is_object( $value ) ) {
3570if ( isset( $value->$index_key ) ) {
3571$newlist[ $value->$index_key ] = $value->$field;
3572} else {
3573$newlist[] = $value->$field;
3574}
3575} else {
3576if ( isset( $value[ $index_key ] ) ) {
3577$newlist[ $value[ $index_key ] ] = $value[ $field ];
3578} else {
3579$newlist[] = $value[ $field ];
3580}
3581}
3582}
3583
3584return $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*/
3595function 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*/
3607if ( ! apply_filters( ‘load_default_widgets’, true ) ) {
3608return;
3609}
3610
3611require_once( ABSPATH . WPINC . ‘/default-widgets.php’ );
3612
3613add_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*/
3623function wp_widgets_add_menu() {
3624global $submenu;
3625
3626if ( ! current_theme_supports( ‘widgets’ ) )
3627return;
3628
3629$submenu[‘themes.php’][7] = array( __( ‘Widgets’ ), ‘edit_theme_options’, ‘widgets.php’ );
3630ksort( $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*/
3640function wp_ob_end_flush_all() {
3641$levels = ob_get_level();
3642for ($i=0; $i<$levels; $i++)
3643ob_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*/
3664function dead_db() {
3665global $wpdb;
3666
3667wp_load_translations_early();
3668
3669// Load custom DB error template, if present.
3670if ( file_exists( WP_CONTENT_DIR . ‘/db-error.php’ ) ) {
3671require_once( WP_CONTENT_DIR . ‘/db-error.php’ );
3672die();
3673}
3674
3675// If installing or in the admin, provide the verbose message.
3676if ( wp_installing() || defined( ‘WP_ADMIN’ ) )
3677wp_die($wpdb->error);
3678
3679// Otherwise, be terse.
3680status_header( 500 );
3681nocache_headers();
3682header( ‘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
3696die();
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*/
3707function absint( $maybeint ) {
3708return 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* @param string $replacement Optional. The function that should have been called. Default null.
3728*/
3729function _deprecated_function( $function, $version, $replacement = null ) {
3730
3731/**
3732* Fires when a deprecated function is called.
3733*
3734* @since 2.5.0
3735*
3736* @param string $function The function that was called.
3737* @param string $replacement The function that should have been called.
3738* @param string $version The version of WordPress that deprecated the function.
3739*/
3740do_action( ‘deprecated_function_run’, $function, $replacement, $version );
3741
3742/**
3743* Filters whether to trigger an error for deprecated functions.
3744*
3745* @since 2.5.0
3746*
3747* @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
3748*/
3749if ( WP_DEBUG && apply_filters( ‘deprecated_function_trigger_error’, true ) ) {
3750if ( function_exists( ‘__’ ) ) {
3751if ( ! is_null( $replacement ) )
3752trigger_error( sprintf( __(‘%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’), $function, $version, $replacement ) );
3753else
3754trigger_error( sprintf( __(‘%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.’), $function, $version ) );
3755} else {
3756if ( ! is_null( $replacement ) )
3757trigger_error( sprintf( ‘%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’, $function, $version, $replacement ) );
3758else
3759trigger_error( sprintf( ‘%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.’, $function, $version ) );
3760}
3761}
3762}
3763
3764/**
3765* Marks a constructor as deprecated and informs when it has been used.
3766*
3767* Similar to _deprecated_function(), but with different strings. Used to
3768* remove PHP4 style constructors.
3769*
3770* The current behavior is to trigger a user error if WP_DEBUG is true.
3771*
3772* This function is to be used in every PHP4 style constructor method that is deprecated.
3773*
3774* @since 4.3.0
3775* @since 4.5.0 Added the $parent_class parameter.
3776*
3777* @access private
3778*
3779* @param string $class The class containing the deprecated constructor.
3780* @param string $version The version of WordPress that deprecated the function.
3781* @param string $parent_class Optional. The parent class calling the deprecated constructor.
3782* Default empty string.
3783*/
3784function _deprecated_constructor( $class, $version, $parent_class = ” ) {
3785
3786/**
3787* Fires when a deprecated constructor is called.
3788*
3789* @since 4.3.0
3790* @since 4.5.0 Added the $parent_class parameter.
3791*
3792* @param string $class The class containing the deprecated constructor.
3793* @param string $version The version of WordPress that deprecated the function.
3794* @param string $parent_class The parent class calling the deprecated constructor.
3795*/
3796do_action( ‘deprecated_constructor_run’, $class, $version, $parent_class );
3797
3798/**
3799* Filters whether to trigger an error for deprecated functions.
3800*
3801* WP_DEBUG must be true in addition to the filter evaluating to true.
3802*
3803* @since 4.3.0
3804*
3805* @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
3806*/
3807if ( WP_DEBUG && apply_filters( ‘deprecated_constructor_trigger_error’, true ) ) {
3808if ( function_exists( ‘__’ ) ) {
3809if ( ! empty( $parent_class ) ) {
3810/* translators: 1: PHP class name, 2: PHP parent class name, 3: version number, 4: __construct() method */
3811trigger_error( sprintf( __( ‘The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.’ ),
3812$class, $parent_class, $version, ‘<pre>__construct()</pre>’ ) );
3813} else {
3814/* translators: 1: PHP class name, 2: version number, 3: __construct() method */
3815trigger_error( sprintf( __( ‘The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’ ),
3816$class, $version, ‘<pre>__construct()</pre>’ ) );
3817}
3818} else {
3819if ( ! empty( $parent_class ) ) {
3820trigger_error( sprintf( ‘The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.’,
3821$class, $parent_class, $version, ‘<pre>__construct()</pre>’ ) );
3822} else {
3823trigger_error( sprintf( ‘The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’,
3824$class, $version, ‘<pre>__construct()</pre>’ ) );
3825}
3826}
3827}
3828
3829}
3830
3831/**
3832* Mark a file as deprecated and inform when it has been used.
3833*
3834* There is a hook {@see ‘deprecated_file_included’} that will be called that can be used
3835* to get the backtrace up to what file and function included the deprecated
3836* file.
3837*
3838* The current behavior is to trigger a user error if WP_DEBUG is true.
3839*
3840* This function is to be used in every file that is deprecated.
3841*
3842* @since 2.5.0
3843* @access private
3844*
3845* @param string $file The file that was included.
3846* @param string $version The version of WordPress that deprecated the file.
3847* @param string $replacement Optional. The file that should have been included based on ABSPATH.
3848* Default null.
3849* @param string $message Optional. A message regarding the change. Default empty.
3850*/
3851function _deprecated_file( $file, $version, $replacement = null, $message = ” ) {
3852
3853/**
3854* Fires when a deprecated file is called.
3855*
3856* @since 2.5.0
3857*
3858* @param string $file The file that was called.
3859* @param string $replacement The file that should have been included based on ABSPATH.
3860* @param string $version The version of WordPress that deprecated the file.
3861* @param string $message A message regarding the change.
3862*/
3863do_action( ‘deprecated_file_included’, $file, $replacement, $version, $message );
3864
3865/**
3866* Filters whether to trigger an error for deprecated files.
3867*
3868* @since 2.5.0
3869*
3870* @param bool $trigger Whether to trigger the error for deprecated files. Default true.
3871*/
3872if ( WP_DEBUG && apply_filters( ‘deprecated_file_trigger_error’, true ) ) {
3873$message = empty( $message ) ? ” : ‘ ‘ . $message;
3874if ( function_exists( ‘__’ ) ) {
3875if ( ! is_null( $replacement ) )
3876trigger_error( sprintf( __(‘%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’), $file, $version, $replacement ) . $message );
3877else
3878trigger_error( sprintf( __(‘%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.’), $file, $version ) . $message );
3879} else {
3880if ( ! is_null( $replacement ) )
3881trigger_error( sprintf( ‘%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’, $file, $version, $replacement ) . $message );
3882else
3883trigger_error( sprintf( ‘%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.’, $file, $version ) . $message );
3884}
3885}
3886}
3887/**
3888* Mark a function argument as deprecated and inform when it has been used.
3889*
3890* This function is to be used whenever a deprecated function argument is used.
3891* Before this function is called, the argument must be checked for whether it was
3892* used by comparing it to its default value or evaluating whether it is empty.
3893* For example:
3894*
3895* if ( ! empty( $deprecated ) ) {
3896* _deprecated_argument( __FUNCTION__, ‘3.0.0’ );
3897* }
3898*
3899*
3900* There is a hook deprecated_argument_run that will be called that can be used
3901* to get the backtrace up to what file and function used the deprecated
3902* argument.
3903*
3904* The current behavior is to trigger a user error if WP_DEBUG is true.
3905*
3906* @since 3.0.0
3907* @access private
3908*
3909* @param string $function The function that was called.
3910* @param string $version The version of WordPress that deprecated the argument used.
3911* @param string $message Optional. A message regarding the change. Default null.
3912*/
3913function _deprecated_argument( $function, $version, $message = null ) {
3914
3915/**
3916* Fires when a deprecated argument is called.
3917*
3918* @since 3.0.0
3919*
3920* @param string $function The function that was called.
3921* @param string $message A message regarding the change.
3922* @param string $version The version of WordPress that deprecated the argument used.
3923*/
3924do_action( ‘deprecated_argument_run’, $function, $message, $version );
3925
3926/**
3927* Filters whether to trigger an error for deprecated arguments.
3928*
3929* @since 3.0.0
3930*
3931* @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
3932*/
3933if ( WP_DEBUG && apply_filters( ‘deprecated_argument_trigger_error’, true ) ) {
3934if ( function_exists( ‘__’ ) ) {
3935if ( ! is_null( $message ) )
3936trigger_error( sprintf( __(‘%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s’), $function, $version, $message ) );
3937else
3938trigger_error( sprintf( __(‘%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.’), $function, $version ) );
3939} else {
3940if ( ! is_null( $message ) )
3941trigger_error( sprintf( ‘%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s’, $function, $version, $message ) );
3942else
3943trigger_error( sprintf( ‘%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.’, $function, $version ) );
3944}
3945}
3946}
3947
3948/**
3949* Marks a deprecated action or filter hook as deprecated and throws a notice.
3950*
3951* Use the {@see ‘deprecated_hook_run’} action to get the backtrace describing where
3952* the deprecated hook was called.
3953*
3954* Default behavior is to trigger a user error if WP_DEBUG is true.
3955*
3956* This function is called by the do_action_deprecated() and apply_filters_deprecated()
3957* functions, and so generally does not need to be called directly.
3958*
3959* @since 4.6.0
3960* @access private
3961*
3962* @param string $hook The hook that was used.
3963* @param string $version The version of WordPress that deprecated the hook.
3964* @param string $replacement Optional. The hook that should have been used.
3965* @param string $message Optional. A message regarding the change.
3966*/
3967function _deprecated_hook( $hook, $version, $replacement = null, $message = null ) {
3968/**
3969* Fires when a deprecated hook is called.
3970*
3971* @since 4.6.0
3972*
3973* @param string $hook The hook that was called.
3974* @param string $replacement The hook that should be used as a replacement.
3975* @param string $version The version of WordPress that deprecated the argument used.
3976* @param string $message A message regarding the change.
3977*/
3978do_action( ‘deprecated_hook_run’, $hook, $replacement, $version, $message );
3979
3980/**
3981* Filters whether to trigger deprecated hook errors.
3982*
3983* @since 4.6.0
3984*
3985* @param bool $trigger Whether to trigger deprecated hook errors. Requires
3986* WP_DEBUG to be defined true.
3987*/
3988if ( WP_DEBUG && apply_filters( ‘deprecated_hook_trigger_error’, true ) ) {
3989$message = empty( $message ) ? ” : ‘ ‘ . $message;
3990if ( ! is_null( $replacement ) ) {
3991trigger_error( sprintf( __( ‘%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.’ ), $hook, $version, $replacement ) . $message );
3992} else {
3993trigger_error( sprintf( __( ‘%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.’ ), $hook, $version ) . $message );
3994}
3995}
3996}
3997
3998/**
3999* Mark something as being incorrectly called.
4000*
4001* There is a hook {@see ‘doing_it_wrong_run’} that will be called that can be used
4002* to get the backtrace up to what file and function called the deprecated
4003* function.
4004*
4005* The current behavior is to trigger a user error if WP_DEBUG is true.
4006*
4007* @since 3.1.0
4008* @access private
4009*
4010* @param string $function The function that was called.
4011* @param string $message A message explaining what has been done incorrectly.
4012* @param string $version The version of WordPress where the message was added.
4013*/
4014function _doing_it_wrong( $function, $message, $version ) {
4015
4016/**
4017* Fires when the given function is being used incorrectly.
4018*
4019* @since 3.1.0
4020*
4021* @param string $function The function that was called.
4022* @param string $message A message explaining what has been done incorrectly.
4023* @param string $version The version of WordPress where the message was added.
4024*/
4025do_action( ‘doing_it_wrong_run’, $function, $message, $version );
4026
4027/**
4028* Filters whether to trigger an error for _doing_it_wrong() calls.
4029*
4030* @since 3.1.0
4031*
4032* @param bool $trigger Whether to trigger the error for _doing_it_wrong() calls. Default true.
4033*/
4034if ( WP_DEBUG && apply_filters( ‘doing_it_wrong_trigger_error’, true ) ) {
4035if ( function_exists( ‘__’ ) ) {
4036$version = is_null( $version ) ? ” : sprintf( __( ‘(This message was added in version %s.)’ ), $version );
4037/* translators: %s: Codex URL */
4038$message .= ‘ ‘ . sprintf( __( ‘Please see <a href=”%s”>Debugging in WordPress</a> for more information.’ ),
4039__( ‘https://codex.wordpress.org/Debugging_in_WordPress’ )
4040);
4041trigger_error( sprintf( __( ‘%1$s was called <strong>incorrectly</strong>. %2$s %3$s’ ), $function, $message, $version ) );
4042} else {
4043$version = is_null( $version ) ? ” : sprintf( ‘(This message was added in version %s.)’, $version );
4044$message .= sprintf( ‘ Please see <a href=”%s”>Debugging in WordPress</a> for more information.’,
4045‘https://codex.wordpress.org/Debugging_in_WordPress’
4046);
4047trigger_error( sprintf( ‘%1$s was called <strong>incorrectly</strong>. %2$s %3$s’, $function, $message, $version ) );
4048}
4049}
4050}
4051
4052/**
4053* Is the server running earlier than 1.5.0 version of lighttpd?
4054*
4055* @since 2.5.0
4056*
4057* @return bool Whether the server is running lighttpd < 1.5.0.
4058*/
4059function is_lighttpd_before_150() {
4060$server_parts = explode( ‘/’, isset( $_SERVER[‘SERVER_SOFTWARE’] )? $_SERVER[‘SERVER_SOFTWARE’] : ” );
4061$server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : ”;
4062return ‘lighttpd’ == $server_parts[0] && -1 == version_compare( $server_parts[1], ‘1.5.0’ );
4063}
4064
4065/**
4066* Does the specified module exist in the Apache config?
4067*
4068* @since 2.5.0
4069*
4070* @global bool $is_apache
4071*
4072* @param string $mod The module, e.g. mod_rewrite.
4073* @param bool $default Optional. The default return value if the module is not found. Default false.
4074* @return bool Whether the specified module is loaded.
4075*/
4076function apache_mod_loaded($mod, $default = false) {
4077global $is_apache;
4078
4079if ( !$is_apache )
4080return false;
4081
4082if ( function_exists( ‘apache_get_modules’ ) ) {
4083$mods = apache_get_modules();
4084if ( in_array($mod, $mods) )
4085return true;
4086} elseif ( function_exists( ‘phpinfo’ ) && false === strpos( ini_get( ‘disable_functions’ ), ‘phpinfo’ ) ) {
4087ob_start();
4088phpinfo(8);
4089$phpinfo = ob_get_clean();
4090if ( false !== strpos($phpinfo, $mod) )
4091return true;
4092}
4093return $default;
4094}
4095
4096/**
4097* Check if IIS 7+ supports pretty permalinks.
4098*
4099* @since 2.8.0
4100*
4101* @global bool $is_iis7
4102*
4103* @return bool Whether IIS7 supports permalinks.
4104*/
4105function iis7_supports_permalinks() {
4106global $is_iis7;
4107
4108$supports_permalinks = false;
4109if ( $is_iis7 ) {
4110/* First we check if the DOMDocument class exists. If it does not exist, then we cannot
4111* easily update the xml configuration file, hence we just bail out and tell user that
4112* pretty permalinks cannot be used.
4113*
4114* Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
4115* URL Rewrite 1.1 is loaded it always sets a server variable called ‘IIS_UrlRewriteModule’.
4116* Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
4117* via ISAPI then pretty permalinks will not work.
4118*/
4119$supports_permalinks = class_exists( ‘DOMDocument’, false ) && isset($_SERVER[‘IIS_UrlRewriteModule’]) && ( PHP_SAPI == ‘cgi-fcgi’ );
4120}
4121
4122/**
4123* Filters whether IIS 7+ supports pretty permalinks.
4124*
4125* @since 2.8.0
4126*
4127* @param bool $supports_permalinks Whether IIS7 supports permalinks. Default false.
4128*/
4129return apply_filters( ‘iis7_supports_permalinks’, $supports_permalinks );
4130}
4131
4132/**
4133* File validates against allowed set of defined rules.
4134*
4135* A return value of ‘1’ means that the $file contains either ‘..’ or ‘./’. A
4136* return value of ‘2’ means that the $file contains ‘:’ after the first
4137* character. A return value of ‘3’ means that the file is not in the allowed
4138* files list.
4139*
4140* @since 1.2.0
4141*
4142* @param string $file File path.
4143* @param array $allowed_files List of allowed files.
4144* @return int 0 means nothing is wrong, greater than 0 means something was wrong.
4145*/
4146function validate_file( $file, $allowed_files = ” ) {
4147if ( false !== strpos( $file, ‘..’ ) )
4148return 1;
4149
4150if ( false !== strpos( $file, ‘./’ ) )
4151return 1;
4152
4153if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files ) )
4154return 3;
4155
4156if (‘:’ == substr( $file, 1, 1 ) )
4157return 2;
4158
4159return 0;
4160}
4161
4162/**
4163* Whether to force SSL used for the Administration Screens.
4164*
4165* @since 2.6.0
4166*
4167* @staticvar bool $forced
4168*
4169* @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
4170* @return bool True if forced, false if not forced.
4171*/
4172function force_ssl_admin( $force = null ) {
4173static $forced = false;
4174
4175if ( !is_null( $force ) ) {
4176$old_forced = $forced;
4177$forced = $force;
4178return $old_forced;
4179}
4180
4181return $forced;
4182}
4183
4184/**
4185* Guess the URL for the site.
4186*
4187* Will remove wp-admin links to retrieve only return URLs not in the wp-admin
4188* directory.
4189*
4190* @since 2.6.0
4191*
4192* @return string The guessed URL.
4193*/
4194function wp_guess_url() {
4195if ( defined(‘WP_SITEURL’) && ” != WP_SITEURL ) {
4196$url = WP_SITEURL;
4197} else {
4198$abspath_fix = str_replace( ‘\\’, ‘/’, ABSPATH );
4199$script_filename_dir = dirname( $_SERVER[‘SCRIPT_FILENAME’] );
4200
4201// The request is for the admin
4202if ( strpos( $_SERVER[‘REQUEST_URI’], ‘wp-admin’ ) !== false || strpos( $_SERVER[‘REQUEST_URI’], ‘wp-login.php’ ) !== false ) {
4203$path = preg_replace( ‘#/(wp-admin/.*|wp-login.php)#i’, ”, $_SERVER[‘REQUEST_URI’] );
4204
4205// The request is for a file in ABSPATH
4206} elseif ( $script_filename_dir . ‘/’ == $abspath_fix ) {
4207// Strip off any file/query params in the path
4208$path = preg_replace( ‘#/[^/]*$#i’, ”, $_SERVER[‘PHP_SELF’] );
4209
4210} else {
4211if ( false !== strpos( $_SERVER[‘SCRIPT_FILENAME’], $abspath_fix ) ) {
4212// Request is hitting a file inside ABSPATH
4213$directory = str_replace( ABSPATH, ”, $script_filename_dir );
4214// Strip off the sub directory, and any file/query params
4215$path = preg_replace( ‘#/’ . preg_quote( $directory, ‘#’ ) . ‘/[^/]*$#i’, ” , $_SERVER[‘REQUEST_URI’] );
4216} elseif ( false !== strpos( $abspath_fix, $script_filename_dir ) ) {
4217// Request is hitting a file above ABSPATH
4218$subdirectory = substr( $abspath_fix, strpos( $abspath_fix, $script_filename_dir ) + strlen( $script_filename_dir ) );
4219// Strip off any file/query params from the path, appending the sub directory to the install
4220$path = preg_replace( ‘#/[^/]*$#i’, ” , $_SERVER[‘REQUEST_URI’] ) . $subdirectory;
4221} else {
4222$path = $_SERVER[‘REQUEST_URI’];
4223}
4224}
4225
4226$schema = is_ssl() ? ‘https://’ : ‘http://’; // set_url_scheme() is not defined yet
4227$url = $schema . $_SERVER[‘HTTP_HOST’] . $path;
4228}
4229
4230return rtrim($url, ‘/’);
4231}
4232
4233/**
4234* Temporarily suspend cache additions.
4235*
4236* Stops more data being added to the cache, but still allows cache retrieval.
4237* This is useful for actions, such as imports, when a lot of data would otherwise
4238* be almost uselessly added to the cache.
4239*
4240* Suspension lasts for a single page load at most. Remember to call this
4241* function again if you wish to re-enable cache adds earlier.
4242*
4243* @since 3.3.0
4244*
4245* @staticvar bool $_suspend
4246*
4247* @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
4248* @return bool The current suspend setting
4249*/
4250function wp_suspend_cache_addition( $suspend = null ) {
4251static $_suspend = false;
4252
4253if ( is_bool( $suspend ) )
4254$_suspend = $suspend;
4255
4256return $_suspend;
4257}
4258
4259/**
4260* Suspend cache invalidation.
4261*
4262* Turns cache invalidation on and off. Useful during imports where you don’t wont to do
4263* invalidations every time a post is inserted. Callers must be sure that what they are
4264* doing won’t lead to an inconsistent cache when invalidation is suspended.
4265*
4266* @since 2.7.0
4267*
4268* @global bool $_wp_suspend_cache_invalidation
4269*
4270* @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true.
4271* @return bool The current suspend setting.
4272*/
4273function wp_suspend_cache_invalidation( $suspend = true ) {
4274global $_wp_suspend_cache_invalidation;
4275
4276$current_suspend = $_wp_suspend_cache_invalidation;
4277$_wp_suspend_cache_invalidation = $suspend;
4278return $current_suspend;
4279}
4280
4281/**
4282* Determine whether a site is the main site of the current network.
4283*
4284* @since 3.0.0
4285*
4286* @global object $current_site
4287*
4288* @param int $site_id Optional. Site ID to test. Defaults to current site.
4289* @return bool True if $site_id is the main site of the network, or if not
4290* running Multisite.
4291*/
4292function is_main_site( $site_id = null ) {
4293// This is the current network’s information; ‘site’ is old terminology.
4294global $current_site;
4295
4296if ( ! is_multisite() )
4297return true;
4298
4299if ( ! $site_id )
4300$site_id = get_current_blog_id();
4301
4302return (int) $site_id === (int) $current_site->blog_id;
4303}
4304
4305/**
4306* Determine whether a network is the main network of the Multisite install.
4307*
4308* @since 3.7.0
4309*
4310* @param int $network_id Optional. Network ID to test. Defaults to current network.
4311* @return bool True if $network_id is the main network, or if not running Multisite.
4312*/
4313function is_main_network( $network_id = null ) {
4314if ( ! is_multisite() ) {
4315return true;
4316}
4317
4318$current_network_id = (int) get_current_site()->id;
4319
4320if ( null === $network_id ) {
4321$network_id = $current_network_id;
4322}
4323
4324$network_id = (int) $network_id;
4325
4326return ( $network_id === get_main_network_id() );
4327}
4328
4329/**
4330* Get the main network ID.
4331*
4332* @since 4.3.0
4333*
4334* @global wpdb $wpdb WordPress database abstraction object.
4335*
4336* @return int The ID of the main network.
4337*/
4338function get_main_network_id() {
4339global $wpdb;
4340
4341if ( ! is_multisite() ) {
4342return 1;
4343}
4344
4345$current_site = get_current_site();
4346
4347if ( defined( ‘PRIMARY_NETWORK_ID’ ) ) {
4348$main_network_id = PRIMARY_NETWORK_ID;
4349} elseif ( isset( $current_site->id ) && 1 === (int) $current_site->id ) {
4350// If the current network has an ID of 1, assume it is the main network.
4351$main_network_id = 1;
4352} else {
4353$main_network_id = wp_cache_get( ‘primary_network_id’, ‘site-options’ );
4354
4355if ( false === $main_network_id ) {
4356$main_network_id = (int) $wpdb->get_var( “SELECT id FROM {$wpdb->site} ORDER BY id LIMIT 1” );
4357wp_cache_add( ‘primary_network_id’, $main_network_id, ‘site-options’ );
4358}
4359}
4360
4361/**
4362* Filters the main network ID.
4363*
4364* @since 4.3.0
4365*
4366* @param int $main_network_id The ID of the main network.
4367*/
4368return (int) apply_filters( ‘get_main_network_id’, $main_network_id );
4369}
4370
4371/**
4372* Determine whether global terms are enabled.
4373*
4374* @since 3.0.0
4375*
4376* @staticvar bool $global_terms
4377*
4378* @return bool True if multisite and global terms enabled.
4379*/
4380function global_terms_enabled() {
4381if ( ! is_multisite() )
4382return false;
4383
4384static $global_terms = null;
4385if ( is_null( $global_terms ) ) {
4386
4387/**
4388* Filters whether global terms are enabled.
4389*
4390* Passing a non-null value to the filter will effectively short-circuit the function,
4391* returning the value of the ‘global_terms_enabled’ site option instead.
4392*
4393* @since 3.0.0
4394*
4395* @param null $enabled Whether global terms are enabled.
4396*/
4397$filter = apply_filters( ‘global_terms_enabled’, null );
4398if ( ! is_null( $filter ) )
4399$global_terms = (bool) $filter;
4400else
4401$global_terms = (bool) get_site_option( ‘global_terms_enabled’, false );
4402}
4403return $global_terms;
4404}
4405
4406/**
4407* gmt_offset modification for smart timezone handling.
4408*
4409* Overrides the gmt_offset option if we have a timezone_string available.
4410*
4411* @since 2.8.0
4412*
4413* @return float|false Timezone GMT offset, false otherwise.
4414*/
4415function wp_timezone_override_offset() {
4416if ( !$timezone_string = get_option( ‘timezone_string’ ) ) {
4417return false;
4418}
4419
4420$timezone_object = timezone_open( $timezone_string );
4421$datetime_object = date_create();
4422if ( false === $timezone_object || false === $datetime_object ) {
4423return false;
4424}
4425return round( timezone_offset_get( $timezone_object, $datetime_object ) / HOUR_IN_SECONDS, 2 );
4426}
4427
4428/**
4429* Sort-helper for timezones.
4430*
4431* @since 2.9.0
4432* @access private
4433*
4434* @param array $a
4435* @param array $b
4436* @return int
4437*/
4438function _wp_timezone_choice_usort_callback( $a, $b ) {
4439// Don’t use translated versions of Etc
4440if ( ‘Etc’ === $a[‘continent’] && ‘Etc’ === $b[‘continent’] ) {
4441// Make the order of these more like the old dropdown
4442if ( ‘GMT+’ === substr( $a[‘city’], 0, 4 ) && ‘GMT+’ === substr( $b[‘city’], 0, 4 ) ) {
4443return -1 * ( strnatcasecmp( $a[‘city’], $b[‘city’] ) );
4444}
4445if ( ‘UTC’ === $a[‘city’] ) {
4446if ( ‘GMT+’ === substr( $b[‘city’], 0, 4 ) ) {
4447return 1;
4448}
4449return -1;
4450}
4451if ( ‘UTC’ === $b[‘city’] ) {
4452if ( ‘GMT+’ === substr( $a[‘city’], 0, 4 ) ) {
4453return -1;
4454}
4455return 1;
4456}
4457return strnatcasecmp( $a[‘city’], $b[‘city’] );
4458}
4459if ( $a[‘t_continent’] == $b[‘t_continent’] ) {
4460if ( $a[‘t_city’] == $b[‘t_city’] ) {
4461return strnatcasecmp( $a[‘t_subcity’], $b[‘t_subcity’] );
4462}
4463return strnatcasecmp( $a[‘t_city’], $b[‘t_city’] );
4464} else {
4465// Force Etc to the bottom of the list
4466if ( ‘Etc’ === $a[‘continent’] ) {
4467return 1;
4468}
4469if ( ‘Etc’ === $b[‘continent’] ) {
4470return -1;
4471}
4472return strnatcasecmp( $a[‘t_continent’], $b[‘t_continent’] );
4473}
4474}
4475
4476/**
4477* Gives a nicely-formatted list of timezone strings.
4478*
4479* @since 2.9.0
4480*
4481* @staticvar bool $mo_loaded
4482*
4483* @param string $selected_zone Selected timezone.
4484* @return string
4485*/
4486function wp_timezone_choice( $selected_zone ) {
4487static $mo_loaded = false;
4488
4489$continents = array( ‘Africa’, ‘America’, ‘Antarctica’, ‘Arctic’, ‘Asia’, ‘Atlantic’, ‘Australia’, ‘Europe’, ‘Indian’, ‘Pacific’);
4490
4491// Load translations for continents and cities
4492if ( !$mo_loaded ) {
4493$locale = get_locale();
4494$mofile = WP_LANG_DIR . ‘/continents-cities-‘ . $locale . ‘.mo’;
4495load_textdomain( ‘continents-cities’, $mofile );
4496$mo_loaded = true;
4497}
4498
4499$zonen = array();
4500foreach ( timezone_identifiers_list() as $zone ) {
4501$zone = explode( ‘/’, $zone );
4502if ( !in_array( $zone[0], $continents ) ) {
4503continue;
4504}
4505
4506// This determines what gets set and translated – we don’t translate Etc/* strings here, they are done later
4507$exists = array(
45080 => ( isset( $zone[0] ) && $zone[0] ),
45091 => ( isset( $zone[1] ) && $zone[1] ),
45102 => ( isset( $zone[2] ) && $zone[2] ),
4511);
4512$exists[3] = ( $exists[0] && ‘Etc’ !== $zone[0] );
4513$exists[4] = ( $exists[1] && $exists[3] );
4514$exists[5] = ( $exists[2] && $exists[3] );
4515
4516$zonen[] = array(
4517‘continent’ => ( $exists[0] ? $zone[0] : ” ),
4518‘city’ => ( $exists[1] ? $zone[1] : ” ),
4519‘subcity’ => ( $exists[2] ? $zone[2] : ” ),
4520‘t_continent’ => ( $exists[3] ? translate( str_replace( ‘_’, ‘ ‘, $zone[0] ), ‘continents-cities’ ) : ” ),
4521‘t_city’ => ( $exists[4] ? translate( str_replace( ‘_’, ‘ ‘, $zone[1] ), ‘continents-cities’ ) : ” ),
4522‘t_subcity’ => ( $exists[5] ? translate( str_replace( ‘_’, ‘ ‘, $zone[2] ), ‘continents-cities’ ) : ” )
4523);
4524}
4525usort( $zonen, ‘_wp_timezone_choice_usort_callback’ );
4526
4527$structure = array();
4528
4529if ( empty( $selected_zone ) ) {
4530$structure[] = ‘<option selected=”selected” value=””>’ . __( ‘Select a city’ ) . ‘</option>’;
4531}
4532
4533foreach ( $zonen as $key => $zone ) {
4534// Build value in an array to join later
4535$value = array( $zone[‘continent’] );
4536
4537if ( empty( $zone[‘city’] ) ) {
4538// It’s at the continent level (generally won’t happen)
4539$display = $zone[‘t_continent’];
4540} else {
4541// It’s inside a continent group
4542
4543// Continent optgroup
4544if ( !isset( $zonen[$key – 1] ) || $zonen[$key – 1][‘continent’] !== $zone[‘continent’] ) {
4545$label = $zone[‘t_continent’];
4546$structure[] = ‘<optgroup label=”‘. esc_attr( $label ) .'”>’;
4547}
4548
4549// Add the city to the value
4550$value[] = $zone[‘city’];
4551
4552$display = $zone[‘t_city’];
4553if ( !empty( $zone[‘subcity’] ) ) {
4554// Add the subcity to the value
4555$value[] = $zone[‘subcity’];
4556$display .= ‘ – ‘ . $zone[‘t_subcity’];
4557}
4558}
4559
4560// Build the value
4561$value = join( ‘/’, $value );
4562$selected = ”;
4563if ( $value === $selected_zone ) {
4564$selected = ‘selected=”selected” ‘;
4565}
4566$structure[] = ‘<option ‘ . $selected . ‘value=”‘ . esc_attr( $value ) . ‘”>’ . esc_html( $display ) . “</option>”;
4567
4568// Close continent optgroup
4569if ( !empty( $zone[‘city’] ) && ( !isset($zonen[$key + 1]) || (isset( $zonen[$key + 1] ) && $zonen[$key + 1][‘continent’] !== $zone[‘continent’]) ) ) {
4570$structure[] = ‘</optgroup>’;
4571}
4572}
4573
4574// Do UTC
4575$structure[] = ‘<optgroup label=”‘. esc_attr__( ‘UTC’ ) .'”>’;
4576$selected = ”;
4577if ( ‘UTC’ === $selected_zone )
4578$selected = ‘selected=”selected” ‘;
4579$structure[] = ‘<option ‘ . $selected . ‘value=”‘ . esc_attr( ‘UTC’ ) . ‘”>’ . __(‘UTC’) . ‘</option>’;
4580$structure[] = ‘</optgroup>’;
4581
4582// Do manual UTC offsets
4583$structure[] = ‘<optgroup label=”‘. esc_attr__( ‘Manual Offsets’ ) .'”>’;
4584$offset_range = array (-12, -11.5, -11, -10.5, -10, -9.5, -9, -8.5, -8, -7.5, -7, -6.5, -6, -5.5, -5, -4.5, -4, -3.5, -3, -2.5, -2, -1.5, -1, -0.5,
45850, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 5.75, 6, 6.5, 7, 7.5, 8, 8.5, 8.75, 9, 9.5, 10, 10.5, 11, 11.5, 12, 12.75, 13, 13.75, 14);
4586foreach ( $offset_range as $offset ) {
4587if ( 0 <= $offset )
4588$offset_name = ‘+’ . $offset;
4589else
4590$offset_name = (string) $offset;
4591
4592$offset_value = $offset_name;
4593$offset_name = str_replace(array(‘.25′,’.5′,’.75′), array(‘:15′,’:30′,’:45′), $offset_name);
4594$offset_name = ‘UTC’ . $offset_name;
4595$offset_value = ‘UTC’ . $offset_value;
4596$selected = ”;
4597if ( $offset_value === $selected_zone )
4598$selected = ‘selected=”selected” ‘;
4599$structure[] = ‘<option ‘ . $selected . ‘value=”‘ . esc_attr( $offset_value ) . ‘”>’ . esc_html( $offset_name ) . “</option>”;
4600
4601}
4602$structure[] = ‘</optgroup>’;
4603
4604return join( “\n”, $structure );
4605}
4606
4607/**
4608* Strip close comment and close php tags from file headers used by WP.
4609*
4610* @since 2.8.0
4611* @access private
4612*
4613* @see https://core.trac.wordpress.org/ticket/8497
4614*
4615* @param string $str Header comment to clean up.
4616* @return string
4617*/
4618function _cleanup_header_comment( $str ) {
4619return trim(preg_replace(“/\s*(?:\*\/|\?>).*/”, ”, $str));
4620}
4621
4622/**
4623* Permanently delete comments or posts of any type that have held a status
4624* of ‘trash’ for the number of days defined in EMPTY_TRASH_DAYS.
4625*
4626* The default value of EMPTY_TRASH_DAYS is 30 (days).
4627*
4628* @since 2.9.0
4629*
4630* @global wpdb $wpdb WordPress database abstraction object.
4631*/
4632function wp_scheduled_delete() {
4633global $wpdb;
4634
4635$delete_timestamp = time() – ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS );
4636
4637$posts_to_delete = $wpdb->get_results($wpdb->prepare(“SELECT post_id FROM $wpdb->postmeta WHERE meta_key = ‘_wp_trash_meta_time’ AND meta_value < ‘%d'”, $delete_timestamp), ARRAY_A);
4638
4639foreach ( (array) $posts_to_delete as $post ) {
4640$post_id = (int) $post[‘post_id’];
4641if ( !$post_id )
4642continue;
4643
4644$del_post = get_post($post_id);
4645
4646if ( !$del_post || ‘trash’ != $del_post->post_status ) {
4647delete_post_meta($post_id, ‘_wp_trash_meta_status’);
4648delete_post_meta($post_id, ‘_wp_trash_meta_time’);
4649} else {
4650wp_delete_post($post_id);
4651}
4652}
4653
4654$comments_to_delete = $wpdb->get_results($wpdb->prepare(“SELECT comment_id FROM $wpdb->commentmeta WHERE meta_key = ‘_wp_trash_meta_time’ AND meta_value < ‘%d'”, $delete_timestamp), ARRAY_A);
4655
4656foreach ( (array) $comments_to_delete as $comment ) {
4657$comment_id = (int) $comment[‘comment_id’];
4658if ( !$comment_id )
4659continue;
4660
4661$del_comment = get_comment($comment_id);
4662
4663if ( !$del_comment || ‘trash’ != $del_comment->comment_approved ) {
4664delete_comment_meta($comment_id, ‘_wp_trash_meta_time’);
4665delete_comment_meta($comment_id, ‘_wp_trash_meta_status’);
4666} else {
4667wp_delete_comment( $del_comment );
4668}
4669}
4670}
4671
4672/**
4673* Retrieve metadata from a file.
4674*
4675* Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
4676* Each piece of metadata must be on its own line. Fields can not span multiple
4677* lines, the value will get cut at the end of the first line.
4678*
4679* If the file data is not within that first 8kiB, then the author should correct
4680* their plugin file and move the data headers to the top.
4681*
4682* @link https://codex.wordpress.org/File_Header
4683*
4684* @since 2.9.0
4685*
4686* @param string $file Path to the file.
4687* @param array $default_headers List of headers, in the format array(‘HeaderKey’ => ‘Header Name’).
4688* @param string $context Optional. If specified adds filter hook {@see ‘extra_$context_headers’}.
4689* Default empty.
4690* @return array Array of file headers in HeaderKey => Header Value format.
4691*/
4692function get_file_data( $file, $default_headers, $context = ” ) {
4693// We don’t need to write to the file, so just open for reading.
4694$fp = fopen( $file, ‘r’ );
4695
4696// Pull only the first 8kiB of the file in.
4697$file_data = fread( $fp, 8192 );
4698
4699// PHP will close file handle, but we are good citizens.
4700fclose( $fp );
4701
4702// Make sure we catch CR-only line endings.
4703$file_data = str_replace( “\r”, “\n”, $file_data );
4704
4705/**
4706* Filters extra file headers by context.
4707*
4708* The dynamic portion of the hook name, $context, refers to
4709* the context where extra headers might be loaded.
4710*
4711* @since 2.9.0
4712*
4713* @param array $extra_context_headers Empty array by default.
4714*/
4715if ( $context && $extra_headers = apply_filters( “extra_{$context}_headers”, array() ) ) {
4716$extra_headers = array_combine( $extra_headers, $extra_headers ); // keys equal values
4717$all_headers = array_merge( $extra_headers, (array) $default_headers );
4718} else {
4719$all_headers = $default_headers;
4720}
4721
4722foreach ( $all_headers as $field => $regex ) {
4723if ( preg_match( ‘/^[ \t\/*#@]*’ . preg_quote( $regex, ‘/’ ) . ‘:(.*)$/mi’, $file_data, $match ) && $match[1] )
4724$all_headers[ $field ] = _cleanup_header_comment( $match[1] );
4725else
4726$all_headers[ $field ] = ”;
4727}
4728
4729return $all_headers;
4730}
4731
4732/**
4733* Returns true.
4734*
4735* Useful for returning true to filters easily.
4736*
4737* @since 3.0.0
4738*
4739* @see __return_false()
4740*
4741* @return true True.
4742*/
4743function __return_true() {
4744return true;
4745}
4746
4747/**
4748* Returns false.
4749*
4750* Useful for returning false to filters easily.
4751*
4752* @since 3.0.0
4753*
4754* @see __return_true()
4755*
4756* @return false False.
4757*/
4758function __return_false() {
4759return false;
4760}
4761
4762/**
4763* Returns 0.
4764*
4765* Useful for returning 0 to filters easily.
4766*
4767* @since 3.0.0
4768*
4769* @return int 0.
4770*/
4771function __return_zero() {
4772return 0;
4773}
4774
4775/**
4776* Returns an empty array.
4777*
4778* Useful for returning an empty array to filters easily.
4779*
4780* @since 3.0.0
4781*
4782* @return array Empty array.
4783*/
4784function __return_empty_array() {
4785return array();
4786}
4787
4788/**
4789* Returns null.
4790*
4791* Useful for returning null to filters easily.
4792*
4793* @since 3.4.0
4794*
4795* @return null Null value.
4796*/
4797function __return_null() {
4798return null;
4799}
4800
4801/**
4802* Returns an empty string.
4803*
4804* Useful for returning an empty string to filters easily.
4805*
4806* @since 3.7.0
4807*
4808* @see __return_null()
4809*
4810* @return string Empty string.
4811*/
4812function __return_empty_string() {
4813return ”;
4814}
4815
4816/**
4817* Send a HTTP header to disable content type sniffing in browsers which support it.
4818*
4819* @since 3.0.0
4820*
4821* @see https://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx
4822* @see https://src.chromium.org/viewvc/chrome?view=rev&revision=6985
4823*/
4824function send_nosniff_header() {
4825@header( ‘X-Content-Type-Options: nosniff’ );
4826}
4827
4828/**
4829* Return a MySQL expression for selecting the week number based on the start_of_week option.
4830*
4831* @ignore
4832* @since 3.0.0
4833*
4834* @param string $column Database column.
4835* @return string SQL clause.
4836*/
4837function _wp_mysql_week( $column ) {
4838switch ( $start_of_week = (int) get_option( ‘start_of_week’ ) ) {
4839case 1 :
4840return “WEEK( $column, 1 )”;
4841case 2 :
4842case 3 :
4843case 4 :
4844case 5 :
4845case 6 :
4846return “WEEK( DATE_SUB( $column, INTERVAL $start_of_week DAY ), 0 )”;
4847case 0 :
4848default :
4849return “WEEK( $column, 0 )”;
4850}
4851}
4852
4853/**
4854* Find hierarchy loops using a callback function that maps object IDs to parent IDs.
4855*
4856* @since 3.1.0
4857* @access private
4858*
4859* @param callable $callback Function that accepts ( ID, $callback_args ) and outputs parent_ID.
4860* @param int $start The ID to start the loop check at.
4861* @param int $start_parent The parent_ID of $start to use instead of calling $callback( $start ).
4862* Use null to always use $callback
4863* @param array $callback_args Optional. Additional arguments to send to $callback.
4864* @return array IDs of all members of loop.
4865*/
4866function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) {
4867$override = is_null( $start_parent ) ? array() : array( $start => $start_parent );
4868
4869if ( !$arbitrary_loop_member = wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override, $callback_args ) )
4870return array();
4871
4872return wp_find_hierarchy_loop_tortoise_hare( $callback, $arbitrary_loop_member, $override, $callback_args, true );
4873}
4874
4875/**
4876* Use the “The Tortoise and the Hare” algorithm to detect loops.
4877*
4878* For every step of the algorithm, the hare takes two steps and the tortoise one.
4879* If the hare ever laps the tortoise, there must be a loop.
4880*
4881* @since 3.1.0
4882* @access private
4883*
4884* @param callable $callback Function that accepts ( ID, callback_arg, … ) and outputs parent_ID.
4885* @param int $start The ID to start the loop check at.
4886* @param array $override Optional. An array of ( ID => parent_ID, … ) to use instead of $callback.
4887* Default empty array.
4888* @param array $callback_args Optional. Additional arguments to send to $callback. Default empty array.
4889* @param bool $_return_loop Optional. Return loop members or just detect presence of loop? Only set
4890* to true if you already know the given $start is part of a loop (otherwise
4891* the returned array might include branches). Default false.
4892* @return mixed Scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if
4893* $_return_loop
4894*/
4895function wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override = array(), $callback_args = array(), $_return_loop = false ) {
4896$tortoise = $hare = $evanescent_hare = $start;
4897$return = array();
4898
4899// Set evanescent_hare to one past hare
4900// Increment hare two steps
4901while (
4902$tortoise
4903&&
4904( $evanescent_hare = isset( $override[$hare] ) ? $override[$hare] : call_user_func_array( $callback, array_merge( array( $hare ), $callback_args ) ) )
4905&&
4906( $hare = isset( $override[$evanescent_hare] ) ? $override[$evanescent_hare] : call_user_func_array( $callback, array_merge( array( $evanescent_hare ), $callback_args ) ) )
4907) {
4908if ( $_return_loop )
4909$return[$tortoise] = $return[$evanescent_hare] = $return[$hare] = true;
4910
4911// tortoise got lapped – must be a loop
4912if ( $tortoise == $evanescent_hare || $tortoise == $hare )
4913return $_return_loop ? $return : $tortoise;
4914
4915// Increment tortoise by one step
4916$tortoise = isset( $override[$tortoise] ) ? $override[$tortoise] : call_user_func_array( $callback, array_merge( array( $tortoise ), $callback_args ) );
4917}
4918
4919return false;
4920}
4921
4922/**
4923* Send a HTTP header to limit rendering of pages to same origin iframes.
4924*
4925* @since 3.1.3
4926*
4927* @see https://developer.mozilla.org/en/the_x-frame-options_response_header
4928*/
4929function send_frame_options_header() {
4930@header( ‘X-Frame-Options: SAMEORIGIN’ );
4931}
4932
4933/**
4934* Retrieve a list of protocols to allow in HTML attributes.
4935*
4936* @since 3.3.0
4937* @since 4.3.0 Added ‘webcal’ to the protocols array.
4938*
4939* @see wp_kses()
4940* @see esc_url()
4941*
4942* @staticvar array $protocols
4943*
4944* @return array Array of allowed protocols. Defaults to an array containing ‘http’, ‘https’,
4945* ‘ftp’, ‘ftps’, ‘mailto’, ‘news’, ‘irc’, ‘gopher’, ‘nntp’, ‘feed’, ‘telnet’,
4946* ‘mms’, ‘rtsp’, ‘svn’, ‘tel’, ‘fax’, ‘xmpp’, and ‘webcal’.
4947*/
4948function wp_allowed_protocols() {
4949static $protocols = array();
4950
4951if ( empty( $protocols ) ) {
4952$protocols = array( ‘http’, ‘https’, ‘ftp’, ‘ftps’, ‘mailto’, ‘news’, ‘irc’, ‘gopher’, ‘nntp’, ‘feed’, ‘telnet’, ‘mms’, ‘rtsp’, ‘svn’, ‘tel’, ‘fax’, ‘xmpp’, ‘webcal’ );
4953
4954/**
4955* Filters the list of protocols allowed in HTML attributes.
4956*
4957* @since 3.0.0
4958*
4959* @param array $protocols Array of allowed protocols e.g. ‘http’, ‘ftp’, ‘tel’, and more.
4960*/
4961$protocols = apply_filters( ‘kses_allowed_protocols’, $protocols );
4962}
4963
4964return $protocols;
4965}
4966
4967/**
4968* Return a comma-separated string of functions that have been called to get
4969* to the current point in code.
4970*
4971* @since 3.4.0
4972*
4973* @see https://core.trac.wordpress.org/ticket/19589
4974*
4975* @param string $ignore_class Optional. A class to ignore all function calls within – useful
4976* when you want to just give info about the callee. Default null.
4977* @param int $skip_frames Optional. A number of stack frames to skip – useful for unwinding
4978* back to the source of the issue. Default 0.
4979* @param bool $pretty Optional. Whether or not you want a comma separated string or raw
4980* array returned. Default true.
4981* @return string|array Either a string containing a reversed comma separated trace or an array
4982* of individual calls.
4983*/
4984function wp_debug_backtrace_summary( $ignore_class = null, $skip_frames = 0, $pretty = true ) {
4985if ( version_compare( PHP_VERSION, ‘5.2.5’, ‘>=’ ) )
4986$trace = debug_backtrace( false );
4987else
4988$trace = debug_backtrace();
4989
4990$caller = array();
4991$check_class = ! is_null( $ignore_class );
4992$skip_frames++; // skip this function
4993
4994foreach ( $trace as $call ) {
4995if ( $skip_frames > 0 ) {
4996$skip_frames–;
4997} elseif ( isset( $call[‘class’] ) ) {
4998if ( $check_class && $ignore_class == $call[‘class’] )
4999continue; // Filter out calls
5000
5001$caller[] = “{$call[‘class’]}{$call[‘type’]}{$call[‘function’]}”;
5002} else {
5003if ( in_array( $call[‘function’], array( ‘do_action’, ‘apply_filters’ ) ) ) {
5004$caller[] = “{$call[‘function’]}(‘{$call[‘args’][0]}’)”;
5005} elseif ( in_array( $call[‘function’], array( ‘include’, ‘include_once’, ‘require’, ‘require_once’ ) ) ) {
5006$caller[] = $call[‘function’] . “(‘” . str_replace( array( WP_CONTENT_DIR, ABSPATH ) , ”, $call[‘args’][0] ) . “‘)”;
5007} else {
5008$caller[] = $call[‘function’];
5009}
5010}
5011}
5012if ( $pretty )
5013return join( ‘, ‘, array_reverse( $caller ) );
5014else
5015return $caller;
5016}
5017
5018/**
5019* Retrieve ids that are not already present in the cache.
5020*
5021* @since 3.4.0
5022* @access private
5023*
5024* @param array $object_ids ID list.
5025* @param string $cache_key The cache bucket to check against.
5026*
5027* @return array List of ids not present in the cache.
5028*/
5029function _get_non_cached_ids( $object_ids, $cache_key ) {
5030$clean = array();
5031foreach ( $object_ids as $id ) {
5032$id = (int) $id;
5033if ( !wp_cache_get( $id, $cache_key ) ) {
5034$clean[] = $id;
5035}
5036}
5037
5038return $clean;
5039}
5040
5041/**
5042* Test if the current device has the capability to upload files.
5043*
5044* @since 3.4.0
5045* @access private
5046*
5047* @return bool Whether the device is able to upload files.
5048*/
5049function _device_can_upload() {
5050if ( ! wp_is_mobile() )
5051return true;
5052
5053$ua = $_SERVER[‘HTTP_USER_AGENT’];
5054
5055if ( strpos($ua, ‘iPhone’) !== false
5056|| strpos($ua, ‘iPad’) !== false
5057|| strpos($ua, ‘iPod’) !== false ) {
5058return preg_match( ‘#OS ([\d_]+) like Mac OS X#’, $ua, $version ) && version_compare( $version[1], ‘6’, ‘>=’ );
5059}
5060
5061return true;
5062}
5063
5064/**
5065* Test if a given path is a stream URL
5066*
5067* @param string $path The resource path or URL.
5068* @return bool True if the path is a stream URL.
5069*/
5070function wp_is_stream( $path ) {
5071$wrappers = stream_get_wrappers();
5072$wrappers_re = ‘(‘ . join(‘|’, $wrappers) . ‘)’;
5073
5074return preg_match( “!^$wrappers_re://!”, $path ) === 1;
5075}
5076
5077/**
5078* Test if the supplied date is valid for the Gregorian calendar.
5079*
5080* @since 3.5.0
5081*
5082* @see checkdate()
5083*
5084* @param int $month Month number.
5085* @param int $day Day number.
5086* @param int $year Year number.
5087* @param string $source_date The date to filter.
5088* @return bool True if valid date, false if not valid date.
5089*/
5090function wp_checkdate( $month, $day, $year, $source_date ) {
5091/**
5092* Filters whether the given date is valid for the Gregorian calendar.
5093*
5094* @since 3.5.0
5095*
5096* @param bool $checkdate Whether the given date is valid.
5097* @param string $source_date Date to check.
5098*/
5099return apply_filters( ‘wp_checkdate’, checkdate( $month, $day, $year ), $source_date );
5100}
5101
5102/**
5103* Load the auth check for monitoring whether the user is still logged in.
5104*
5105* Can be disabled with remove_action( ‘admin_enqueue_scripts’, ‘wp_auth_check_load’ );
5106*
5107* This is disabled for certain screens where a login screen could cause an
5108* inconvenient interruption. A filter called {@see ‘wp_auth_check_load’} can be used
5109* for fine-grained control.
5110*
5111* @since 3.6.0
5112*/
5113function wp_auth_check_load() {
5114if ( ! is_admin() && ! is_user_logged_in() )
5115return;
5116
5117if ( defined( ‘IFRAME_REQUEST’ ) )
5118return;
5119
5120$screen = get_current_screen();
5121$hidden = array( ‘update’, ‘update-network’, ‘update-core’, ‘update-core-network’, ‘upgrade’, ‘upgrade-network’, ‘network’ );
5122$show = ! in_array( $screen->id, $hidden );
5123
5124/**
5125* Filters whether to load the authentication check.
5126*
5127* Passing a falsey value to the filter will effectively short-circuit
5128* loading the authentication check.
5129*
5130* @since 3.6.0
5131*
5132* @param bool $show Whether to load the authentication check.
5133* @param WP_Screen $screen The current screen object.
5134*/
5135if ( apply_filters( ‘wp_auth_check_load’, $show, $screen ) ) {
5136wp_enqueue_style( ‘wp-auth-check’ );
5137wp_enqueue_script( ‘wp-auth-check’ );
5138
5139add_action( ‘admin_print_footer_scripts’, ‘wp_auth_check_html’, 5 );
5140add_action( ‘wp_print_footer_scripts’, ‘wp_auth_check_html’, 5 );
5141}
5142}
5143
5144/**
5145* Output the HTML that shows the wp-login dialog when the user is no longer logged in.
5146*
5147* @since 3.6.0
5148*/
5149function wp_auth_check_html() {
5150$login_url = wp_login_url();
5151$current_domain = ( is_ssl() ? ‘https://’ : ‘http://’ ) . $_SERVER[‘HTTP_HOST’];
5152$same_domain = ( strpos( $login_url, $current_domain ) === 0 );
5153
5154/**
5155* Filters whether the authentication check originated at the same domain.
5156*
5157* @since 3.6.0
5158*
5159* @param bool $same_domain Whether the authentication check originated at the same domain.
5160*/
5161$same_domain = apply_filters( ‘wp_auth_check_same_domain’, $same_domain );
5162$wrap_class = $same_domain ? ‘hidden’ : ‘hidden fallback’;
5163
5164?>
5165<div id=”wp-auth-check-wrap” class=”<?php echo $wrap_class; ?>”>
5166<div id=”wp-auth-check-bg”></div>
5167<div id=”wp-auth-check”>
5168<button type=”button” class=”wp-auth-check-close button-link”><span class=”screen-reader-text”><?php _e( ‘Close dialog’ ); ?></span></button>
5169<?php
5170
5171if ( $same_domain ) {
5172?>
5173<div id=”wp-auth-check-form” class=”loading” data-src=”<?php echo esc_url( add_query_arg( array( ‘interim-login’ => 1 ), $login_url ) ); ?>”></div>
5174<?php
5175}
5176
5177?>
5178<div class=”wp-auth-fallback”>
5179<p><b class=”wp-auth-fallback-expired” tabindex=”0″><?php _e(‘Session expired’); ?></b></p>
5180<p><a href=”<?php echo esc_url( $login_url ); ?>” target=”_blank”><?php _e(‘Please log in again.’); ?></a>
5181<?php _e(‘The login page will open in a new window. After logging in you can close it and return to this page.’); ?></p>
5182</div>
5183</div>
5184</div>
5185<?php
5186}
5187
5188/**
5189* Check whether a user is still logged in, for the heartbeat.
5190*
5191* Send a result that shows a log-in box if the user is no longer logged in,
5192* or if their cookie is within the grace period.
5193*
5194* @since 3.6.0
5195*
5196* @global int $login_grace_period
5197*
5198* @param array $response The Heartbeat response.
5199* @return array $response The Heartbeat response with ‘wp-auth-check’ value set.
5200*/
5201function wp_auth_check( $response ) {
5202$response[‘wp-auth-check’] = is_user_logged_in() && empty( $GLOBALS[‘login_grace_period’] );
5203return $response;
5204}
5205
5206/**
5207* Return RegEx body to liberally match an opening HTML tag.
5208*
5209* Matches an opening HTML tag that:
5210* 1. Is self-closing or
5211* 2. Has no body but has a closing tag of the same name or
5212* 3. Contains a body and a closing tag of the same name
5213*
5214* Note: this RegEx does not balance inner tags and does not attempt
5215* to produce valid HTML
5216*
5217* @since 3.6.0
5218*
5219* @param string $tag An HTML tag name. Example: ‘video’.
5220* @return string Tag RegEx.
5221*/
5222function get_tag_regex( $tag ) {
5223if ( empty( $tag ) )
5224return;
5225return sprintf( ‘<%1$s[^<]*(?:>[\s\S]*<\/%1$s>|\s*\/>)’, tag_escape( $tag ) );
5226}
5227
5228/**
5229* Retrieve a canonical form of the provided charset appropriate for passing to PHP
5230* functions such as htmlspecialchars() and charset html attributes.
5231*
5232* @since 3.6.0
5233* @access private
5234*
5235* @see https://core.trac.wordpress.org/ticket/23688
5236*
5237* @param string $charset A charset name.
5238* @return string The canonical form of the charset.
5239*/
5240function _canonical_charset( $charset ) {
5241if ( ‘UTF-8’ === $charset || ‘utf-8’ === $charset || ‘utf8’ === $charset ||
5242‘UTF8’ === $charset )
5243return ‘UTF-8’;
5244
5245if ( ‘ISO-8859-1’ === $charset || ‘iso-8859-1’ === $charset ||
5246‘iso8859-1’ === $charset || ‘ISO8859-1’ === $charset )
5247return ‘ISO-8859-1’;
5248
5249return $charset;
5250}
5251
5252/**
5253* Set the mbstring internal encoding to a binary safe encoding when func_overload
5254* is enabled.
5255*
5256* When mbstring.func_overload is in use for multi-byte encodings, the results from
5257* strlen() and similar functions respect the utf8 characters, causing binary data
5258* to return incorrect lengths.
5259*
5260* This function overrides the mbstring encoding to a binary-safe encoding, and
5261* resets it to the users expected encoding afterwards through the
5262* reset_mbstring_encoding function.
5263*
5264* It is safe to recursively call this function, however each
5265* mbstring_binary_safe_encoding() call must be followed up with an equal number
5266* of reset_mbstring_encoding() calls.
5267*
5268* @since 3.7.0
5269*
5270* @see reset_mbstring_encoding()
5271*
5272* @staticvar array $encodings
5273* @staticvar bool $overloaded
5274*
5275* @param bool $reset Optional. Whether to reset the encoding back to a previously-set encoding.
5276* Default false.
5277*/
5278function mbstring_binary_safe_encoding( $reset = false ) {
5279static $encodings = array();
5280static $overloaded = null;
5281
5282if ( is_null( $overloaded ) )
5283$overloaded = function_exists( ‘mb_internal_encoding’ ) && ( ini_get( ‘mbstring.func_overload’ ) & 2 );
5284
5285if ( false === $overloaded )
5286return;
5287
5288if ( ! $reset ) {
5289$encoding = mb_internal_encoding();
5290array_push( $encodings, $encoding );
5291mb_internal_encoding( ‘ISO-8859-1’ );
5292}
5293
5294if ( $reset && $encodings ) {
5295$encoding = array_pop( $encodings );
5296mb_internal_encoding( $encoding );
5297}
5298}
5299
5300/**
5301* Reset the mbstring internal encoding to a users previously set encoding.
5302*
5303* @see mbstring_binary_safe_encoding()
5304*
5305* @since 3.7.0
5306*/
5307function reset_mbstring_encoding() {
5308mbstring_binary_safe_encoding( true );
5309}
5310
5311/**
5312* Filter/validate a variable as a boolean.
5313*
5314* Alternative to filter_var( $var, FILTER_VALIDATE_BOOLEAN ).
5315*
5316* @since 4.0.0
5317*
5318* @param mixed $var Boolean value to validate.
5319* @return bool Whether the value is validated.
5320*/
5321function wp_validate_boolean( $var ) {
5322if ( is_bool( $var ) ) {
5323return $var;
5324}
5325
5326if ( is_string( $var ) && ‘false’ === strtolower( $var ) ) {
5327return false;
5328}
5329
5330return (bool) $var;
5331}
5332
5333/**
5334* Delete a file
5335*
5336* @since 4.2.0
5337*
5338* @param string $file The path to the file to delete.
5339*/
5340function wp_delete_file( $file ) {
5341/**
5342* Filters the path of the file to delete.
5343*
5344* @since 2.1.0
5345*
5346* @param string $medium Path to the file to delete.
5347*/
5348$delete = apply_filters( ‘wp_delete_file’, $file );
5349if ( ! empty( $delete ) ) {
5350@unlink( $delete );
5351}
5352}
5353
5354/**
5355* Outputs a small JS snippet on preview tabs/windows to remove window.name on unload.
5356*
5357* This prevents reusing the same tab for a preview when the user has navigated away.
5358*
5359* @since 4.3.0
5360*/
5361function wp_post_preview_js() {
5362global $post;
5363
5364if ( ! is_preview() || empty( $post ) ) {
5365return;
5366}
5367
5368// Has to match the window name used in post_submit_meta_box()
5369$name = ‘wp-preview-‘ . (int) $post->ID;
5370
5371?>
5372<script>
5373( function() {
5374var query = document.location.search;
5375
5376if ( query && query.indexOf( ‘preview=true’ ) !== -1 ) {
5377window.name = ‘<?php echo $name; ?>’;
5378}
5379
5380if ( window.addEventListener ) {
5381window.addEventListener( ‘unload’, function() { window.name = ”; }, false );
5382}
5383}());
5384</script>
5385<?php
5386}
5387
5388/**
5389* Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601/RFC3339.
5390*
5391* Explicitly strips timezones, as datetimes are not saved with any timezone
5392* information. Including any information on the offset could be misleading.
5393*
5394* @since 4.4.0
5395*
5396* @param string $date_string Date string to parse and format.
5397* @return string Date formatted for ISO8601/RFC3339.
5398*/
5399function mysql_to_rfc3339( $date_string ) {
5400$formatted = mysql2date( ‘c’, $date_string, false );
5401
5402// Strip timezone information
5403return preg_replace( ‘/(?:Z|[+-]\d{2}(?::\d{2})?)$/’, ”, $formatted );
5404}
5405
5406/**
5407* Attempts to raise the PHP memory limit for memory intensive processes.
5408*
5409* Only allows raising the existing limit and prevents lowering it.
5410*
5411* @since 4.6.0
5412*
5413* @param string $context Optional. Context in which the function is called. Accepts either ‘admin’,
5414* ‘image’, or an arbitrary other context. If an arbitrary context is passed,
5415* the similarly arbitrary {@see ‘{$context}_memory_limit’} filter will be
5416* invoked. Default ‘admin’.
5417* @return bool|int|string The limit that was set or false on failure.
5418*/
5419function wp_raise_memory_limit( $context = ‘admin’ ) {
5420// Exit early if the limit cannot be changed.
5421if ( false === wp_is_ini_value_changeable( ‘memory_limit’ ) ) {
5422return false;
5423}
5424
5425$current_limit = @ini_get( ‘memory_limit’ );
5426$current_limit_int = wp_convert_hr_to_bytes( $current_limit );
5427
5428if ( -1 === $current_limit_int ) {
5429return false;
5430}
5431
5432$wp_max_limit = WP_MAX_MEMORY_LIMIT;
5433$wp_max_limit_int = wp_convert_hr_to_bytes( $wp_max_limit );
5434$filtered_limit = $wp_max_limit;
5435
5436switch ( $context ) {
5437case ‘admin’:
5438/**
5439* Filters the maximum memory limit available for administration screens.
5440*
5441* This only applies to administrators, who may require more memory for tasks
5442* like updates. Memory limits when processing images (uploaded or edited by
5443* users of any role) are handled separately.
5444*
5445* The WP_MAX_MEMORY_LIMIT constant specifically defines the maximum memory
5446* limit available when in the administration back end. The default is 256M
5447* (256 megabytes of memory) or the original memory_limit php.ini value if
5448* this is higher.
5449*
5450* @since 3.0.0
5451* @since 4.6.0 The default now takes the original memory_limit into account.
5452*
5453* @param int|string $filtered_limit The maximum WordPress memory limit. Accepts an integer
5454* (bytes), or a shorthand string notation, such as ‘256M’.
5455*/
5456$filtered_limit = apply_filters( ‘admin_memory_limit’, $filtered_limit );
5457break;
5458
5459case ‘image’:
5460/**
5461* Filters the memory limit allocated for image manipulation.
5462*
5463* @since 3.5.0
5464* @since 4.6.0 The default now takes the original memory_limit into account.
5465*
5466* @param int|string $filtered_limit Maximum memory limit to allocate for images.
5467* Default WP_MAX_MEMORY_LIMIT or the original
5468* php.ini memory_limit, whichever is higher.
5469* Accepts an integer (bytes), or a shorthand string
5470* notation, such as ‘256M’.
5471*/
5472$filtered_limit = apply_filters( ‘image_memory_limit’, $filtered_limit );
5473break;
5474
5475default:
5476/**
5477* Filters the memory limit allocated for arbitrary contexts.
5478*
5479* The dynamic portion of the hook name, $context, refers to an arbitrary
5480* context passed on calling the function. This allows for plugins to define
5481* their own contexts for raising the memory limit.
5482*
5483* @since 4.6.0
5484*
5485* @param int|string $filtered_limit Maximum memory limit to allocate for images.
5486* Default ‘256M’ or the original php.ini memory_limit,
5487* whichever is higher. Accepts an integer (bytes), or a
5488* shorthand string notation, such as ‘256M’.
5489*/
5490$filtered_limit = apply_filters( “{$context}_memory_limit”, $filtered_limit );
5491break;
5492}
5493
5494$filtered_limit_int = wp_convert_hr_to_bytes( $filtered_limit );
5495
5496if ( -1 === $filtered_limit_int || ( $filtered_limit_int > $wp_max_limit_int && $filtered_limit_int > $current_limit_int ) ) {
5497if ( false !== @ini_set( ‘memory_limit’, $filtered_limit ) ) {
5498return $filtered_limit;
5499} else {
5500return false;
5501}
5502} elseif ( -1 === $wp_max_limit_int || $wp_max_limit_int > $current_limit_int ) {
5503if ( false !== @ini_set( ‘memory_limit’, $wp_max_limit ) ) {
5504return $wp_max_limit;
5505} else {
5506return false;
5507}
5508}
5509
5510return false;
5511}