8 require( ABSPATH . WPINC . '/option.php' );
11 * Convert given date string into a different format.
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.
16 * If $translate is true then the given date and format string will
17 * be passed to date_i18n() for translation.
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.
26 function mysql2date( $format, $date, $translate = true ) {
31 return strtotime( $date . ' +0000' );
33 $i = strtotime( $date );
39 return date_i18n( $format, $i );
41 return date( $format, $i );
45 * Retrieve the current time based on specified type.
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').
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.
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.
61 function current_time( $type, $gmt = 0 ) {
64 return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) ) );
66 return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
68 return ( $gmt ) ? date( $type ) : date( $type, time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );
73 * Retrieve the date in localized format, based on timestamp.
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.
81 * @param string $dateformatstring Format to display the date.
82 * @param bool|int $unixtimestamp Optional. Unix timestamp. Default false.
83 * @param bool $gmt Optional. Whether to use GMT timezone. Default false.
85 * @return string The date, translated if locale specifies it.
87 function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
93 $i = current_time( 'timestamp' );
96 // we should not let date() interfere with our
97 // specially computed timestamp
102 * Store original value for language with untypical grammars.
103 * See https://core.trac.wordpress.org/ticket/9396
105 $req_format = $dateformatstring;
107 $datefunc = $gmt? 'gmdate' : 'date';
109 if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
110 $datemonth = $wp_locale->get_month( $datefunc( 'm', $i ) );
111 $datemonth_abbrev = $wp_locale->get_month_abbrev( $datemonth );
112 $dateweekday = $wp_locale->get_weekday( $datefunc( 'w', $i ) );
113 $dateweekday_abbrev = $wp_locale->get_weekday_abbrev( $dateweekday );
114 $datemeridiem = $wp_locale->get_meridiem( $datefunc( 'a', $i ) );
115 $datemeridiem_capital = $wp_locale->get_meridiem( $datefunc( 'A', $i ) );
116 $dateformatstring = ' '.$dateformatstring;
117 $dateformatstring = preg_replace( "/([^\\\])D/", "\\1" . backslashit( $dateweekday_abbrev ), $dateformatstring );
118 $dateformatstring = preg_replace( "/([^\\\])F/", "\\1" . backslashit( $datemonth ), $dateformatstring );
119 $dateformatstring = preg_replace( "/([^\\\])l/", "\\1" . backslashit( $dateweekday ), $dateformatstring );
120 $dateformatstring = preg_replace( "/([^\\\])M/", "\\1" . backslashit( $datemonth_abbrev ), $dateformatstring );
121 $dateformatstring = preg_replace( "/([^\\\])a/", "\\1" . backslashit( $datemeridiem ), $dateformatstring );
122 $dateformatstring = preg_replace( "/([^\\\])A/", "\\1" . backslashit( $datemeridiem_capital ), $dateformatstring );
124 $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
126 $timezone_formats = array( 'P', 'I', 'O', 'T', 'Z', 'e' );
127 $timezone_formats_re = implode( '|', $timezone_formats );
128 if ( preg_match( "/$timezone_formats_re/", $dateformatstring ) ) {
129 $timezone_string = get_option( 'timezone_string' );
130 if ( $timezone_string ) {
131 $timezone_object = timezone_open( $timezone_string );
132 $date_object = date_create( null, $timezone_object );
133 foreach( $timezone_formats as $timezone_format ) {
134 if ( false !== strpos( $dateformatstring, $timezone_format ) ) {
135 $formatted = date_format( $date_object, $timezone_format );
136 $dateformatstring = ' '.$dateformatstring;
137 $dateformatstring = preg_replace( "/([^\\\])$timezone_format/", "\\1" . backslashit( $formatted ), $dateformatstring );
138 $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
143 $j = @$datefunc( $dateformatstring, $i );
146 * Filter the date formatted based on the locale.
150 * @param string $j Formatted date string.
151 * @param string $req_format Format to display the date.
152 * @param int $i Unix timestamp.
153 * @param bool $gmt Whether to convert to GMT for time. Default false.
155 $j = apply_filters( 'date_i18n', $j, $req_format, $i, $gmt );
160 * Convert integer number to format based on the locale.
164 * @param int $number The number to convert based on locale.
165 * @param int $decimals Optional. Precision of the number of decimal places. Default 0.
166 * @return string Converted number in string format.
168 function number_format_i18n( $number, $decimals = 0 ) {
170 $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
173 * Filter the number formatted based on the locale.
177 * @param string $formatted Converted number in string format.
179 return apply_filters( 'number_format_i18n', $formatted );
183 * Convert number of bytes largest unit bytes will fit into.
185 * It is easier to read 1kB than 1024 bytes and 1MB than 1048576 bytes. Converts
186 * number of bytes to human readable number by taking the number of that unit
187 * that the bytes will go into it. Supports TB value.
189 * Please note that integers in PHP are limited to 32 bits, unless they are on
190 * 64 bit architecture, then they have 64 bit size. If you need to place the
191 * larger size then what PHP integer type will hold, then use a string. It will
192 * be converted to a double, which should always have 64 bit length.
194 * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
198 * @param int|string $bytes Number of bytes. Note max integer size for integers.
199 * @param int $decimals Optional. Precision of number of decimal places. Default 0.
200 * @return string|false False on failure. Number string on success.
202 function size_format( $bytes, $decimals = 0 ) {
204 // ========================= Origin ====
205 'TB' => 1099511627776, // pow( 1024, 4)
206 'GB' => 1073741824, // pow( 1024, 3)
207 'MB' => 1048576, // pow( 1024, 2)
208 'kB' => 1024, // pow( 1024, 1)
209 'B ' => 1, // pow( 1024, 0)
211 foreach ( $quant as $unit => $mag )
212 if ( doubleval($bytes) >= $mag )
213 return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
219 * Get the week start and end from the datetime or date string from MySQL.
223 * @param string $mysqlstring Date or datetime field type from MySQL.
224 * @param int|string $start_of_week Optional. Start of the week as an integer. Default empty string.
225 * @return array Keys are 'start' and 'end'.
227 function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
228 // MySQL string year.
229 $my = substr( $mysqlstring, 0, 4 );
231 // MySQL string month.
232 $mm = substr( $mysqlstring, 8, 2 );
235 $md = substr( $mysqlstring, 5, 2 );
237 // The timestamp for MySQL string day.
238 $day = mktime( 0, 0, 0, $md, $mm, $my );
240 // The day of the week from the timestamp.
241 $weekday = date( 'w', $day );
243 if ( !is_numeric($start_of_week) )
244 $start_of_week = get_option( 'start_of_week' );
246 if ( $weekday < $start_of_week )
249 // The most recent week start day on or before $day.
250 $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week );
252 // $start + 7 days - 1 second.
253 $end = $start + 7 * DAY_IN_SECONDS - 1;
254 return compact( 'start', 'end' );
258 * Unserialize value only if it was serialized.
262 * @param string $original Maybe unserialized original, if is needed.
263 * @return mixed Unserialized data can be any type.
265 function maybe_unserialize( $original ) {
266 if ( is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
267 return @unserialize( $original );
272 * Check value to find if it was serialized.
274 * If $data is not an string, then returned value will always be false.
275 * Serialized data is always a string.
279 * @param string $data Value to check to see if was serialized.
280 * @param bool $strict Optional. Whether to be strict about the end of the string. Default true.
281 * @return bool False if not serialized and true if it was.
283 function is_serialized( $data, $strict = true ) {
284 // if it isn't a string, it isn't serialized.
285 if ( ! is_string( $data ) ) {
288 $data = trim( $data );
289 if ( 'N;' == $data ) {
292 if ( strlen( $data ) < 4 ) {
295 if ( ':' !== $data[1] ) {
299 $lastc = substr( $data, -1 );
300 if ( ';' !== $lastc && '}' !== $lastc ) {
304 $semicolon = strpos( $data, ';' );
305 $brace = strpos( $data, '}' );
306 // Either ; or } must exist.
307 if ( false === $semicolon && false === $brace )
309 // But neither must be in the first X characters.
310 if ( false !== $semicolon && $semicolon < 3 )
312 if ( false !== $brace && $brace < 4 )
319 if ( '"' !== substr( $data, -2, 1 ) ) {
322 } elseif ( false === strpos( $data, '"' ) ) {
325 // or else fall through
328 return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
332 $end = $strict ? '$' : '';
333 return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data );
339 * Check whether serialized data is of string type.
343 * @param string $data Serialized data.
344 * @return bool False if not a serialized string, true if it is.
346 function is_serialized_string( $data ) {
347 // if it isn't a string, it isn't a serialized string.
348 if ( ! is_string( $data ) ) {
351 $data = trim( $data );
352 if ( strlen( $data ) < 4 ) {
354 } elseif ( ':' !== $data[1] ) {
356 } elseif ( ';' !== substr( $data, -1 ) ) {
358 } elseif ( $data[0] !== 's' ) {
360 } elseif ( '"' !== substr( $data, -2, 1 ) ) {
368 * Serialize data, if needed.
372 * @param string|array|object $data Data that might be serialized.
373 * @return mixed A scalar data
375 function maybe_serialize( $data ) {
376 if ( is_array( $data ) || is_object( $data ) )
377 return serialize( $data );
379 // Double serialization is required for backward compatibility.
380 // See https://core.trac.wordpress.org/ticket/12930
381 if ( is_serialized( $data, false ) )
382 return serialize( $data );
388 * Retrieve post title from XMLRPC XML.
390 * If the title element is not part of the XML, then the default post title from
391 * the $post_default_title will be used instead.
395 * @global string $post_default_title Default XML-RPC post title.
397 * @param string $content XMLRPC XML Request content
398 * @return string Post title
400 function xmlrpc_getposttitle( $content ) {
401 global $post_default_title;
402 if ( preg_match( '/<title>(.+?)<\/title>/is', $content, $matchtitle ) ) {
403 $post_title = $matchtitle[1];
405 $post_title = $post_default_title;
411 * Retrieve the post category or categories from XMLRPC XML.
413 * If the category element is not found, then the default post category will be
414 * used. The return type then would be what $post_default_category. If the
415 * category is found, then it will always be an array.
419 * @global string $post_default_category Default XML-RPC post category.
421 * @param string $content XMLRPC XML Request content
422 * @return string|array List of categories or category name.
424 function xmlrpc_getpostcategory( $content ) {
425 global $post_default_category;
426 if ( preg_match( '/<category>(.+?)<\/category>/is', $content, $matchcat ) ) {
427 $post_category = trim( $matchcat[1], ',' );
428 $post_category = explode( ',', $post_category );
430 $post_category = $post_default_category;
432 return $post_category;
436 * XMLRPC XML content without title and category elements.
440 * @param string $content XML-RPC XML Request content.
441 * @return string XMLRPC XML Request content without title and category elements.
443 function xmlrpc_removepostdata( $content ) {
444 $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
445 $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
446 $content = trim( $content );
451 * Use RegEx to extract URLs from arbitrary content.
455 * @param string $content Content to extract URLs from.
456 * @return array URLs found in passed string.
458 function wp_extract_urls( $content ) {
461 . "(?:([\w-]+:)?//?)"
467 . "[^`!()\[\]{};:'\".,<>«»“”‘’\s]|"
476 $post_links = array_unique( array_map( 'html_entity_decode', $post_links[2] ) );
478 return array_values( $post_links );
482 * Check content for video and audio links to add as enclosures.
484 * Will not add enclosures that have already been added and will
485 * remove enclosures that are no longer in the post. This is called as
486 * pingbacks and trackbacks.
492 * @param string $content Post Content.
493 * @param int $post_ID Post ID.
495 function do_enclose( $content, $post_ID ) {
498 //TODO: Tidy this ghetto code up and make the debug code optional
499 include_once( ABSPATH . WPINC . '/class-IXR.php' );
501 $post_links = array();
503 $pung = get_enclosed( $post_ID );
505 $post_links_temp = wp_extract_urls( $content );
507 foreach ( $pung as $link_test ) {
508 if ( ! in_array( $link_test, $post_links_temp ) ) { // link no longer in post
509 $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 ) . '%') );
510 foreach ( $mids as $mid )
511 delete_metadata_by_mid( 'post', $mid );
515 foreach ( (array) $post_links_temp as $link_test ) {
516 if ( !in_array( $link_test, $pung ) ) { // If we haven't pung it already
517 $test = @parse_url( $link_test );
518 if ( false === $test )
520 if ( isset( $test['query'] ) )
521 $post_links[] = $link_test;
522 elseif ( isset($test['path']) && ( $test['path'] != '/' ) && ($test['path'] != '' ) )
523 $post_links[] = $link_test;
527 foreach ( (array) $post_links as $url ) {
528 if ( $url != '' && !$wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post_ID, $wpdb->esc_like( $url ) . '%' ) ) ) {
530 if ( $headers = wp_get_http_headers( $url) ) {
531 $len = isset( $headers['content-length'] ) ? (int) $headers['content-length'] : 0;
532 $type = isset( $headers['content-type'] ) ? $headers['content-type'] : '';
533 $allowed_types = array( 'video', 'audio' );
535 // Check to see if we can figure out the mime type from
537 $url_parts = @parse_url( $url );
538 if ( false !== $url_parts ) {
539 $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );
540 if ( !empty( $extension ) ) {
541 foreach ( wp_get_mime_types() as $exts => $mime ) {
542 if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
550 if ( in_array( substr( $type, 0, strpos( $type, "/" ) ), $allowed_types ) ) {
551 add_post_meta( $post_ID, 'enclosure', "$url\n$len\n$mime\n" );
559 * Perform a HTTP HEAD or GET request.
561 * If $file_path is a writable filename, this will do a GET request and write
562 * the file to that path.
566 * @param string $url URL to fetch.
567 * @param string|bool $file_path Optional. File path to write request to. Default false.
568 * @param int $red Optional. The number of Redirects followed, Upon 5 being hit,
569 * returns false. Default 1.
570 * @return bool|string False on failure and string of headers if HEAD request.
572 function wp_get_http( $url, $file_path = false, $red = 1 ) {
573 @set_time_limit( 60 );
579 $options['redirection'] = 5;
581 if ( false == $file_path )
582 $options['method'] = 'HEAD';
584 $options['method'] = 'GET';
586 $response = wp_safe_remote_request( $url, $options );
588 if ( is_wp_error( $response ) )
591 $headers = wp_remote_retrieve_headers( $response );
592 $headers['response'] = wp_remote_retrieve_response_code( $response );
594 // WP_HTTP no longer follows redirects for HEAD requests.
595 if ( 'HEAD' == $options['method'] && in_array($headers['response'], array(301, 302)) && isset( $headers['location'] ) ) {
596 return wp_get_http( $headers['location'], $file_path, ++$red );
599 if ( false == $file_path )
602 // GET request - write it to the supplied filename
603 $out_fp = fopen($file_path, 'w');
607 fwrite( $out_fp, wp_remote_retrieve_body( $response ) );
615 * Retrieve HTTP Headers from URL.
619 * @param string $url URL to retrieve HTTP headers from.
620 * @param bool $deprecated Not Used.
621 * @return bool|string False on failure, headers on success.
623 function wp_get_http_headers( $url, $deprecated = false ) {
624 if ( !empty( $deprecated ) )
625 _deprecated_argument( __FUNCTION__, '2.7' );
627 $response = wp_safe_remote_head( $url );
629 if ( is_wp_error( $response ) )
632 return wp_remote_retrieve_headers( $response );
636 * Whether the publish date of the current post in the loop is different from the
637 * publish date of the previous post in the loop.
641 * @global string $currentday The day of the current post in the loop.
642 * @global string $previousday The day of the previous post in the loop.
644 * @return int 1 when new day, 0 if not a new day.
646 function is_new_day() {
647 global $currentday, $previousday;
648 if ( $currentday != $previousday )
655 * Build URL query based on an associative and, or indexed array.
657 * This is a convenient function for easily building url queries. It sets the
658 * separator to '&' and uses _http_build_query() function.
662 * @see _http_build_query() Used to build the query
663 * @see http://us2.php.net/manual/en/function.http-build-query.php for more on what
664 * http_build_query() does.
666 * @param array $data URL-encode key/value pairs.
667 * @return string URL-encoded string.
669 function build_query( $data ) {
670 return _http_build_query( $data, null, '&', '', false );
674 * From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
679 * @see http://us1.php.net/manual/en/function.http-build-query.php
681 * @param array|object $data An array or object of data. Converted to array.
682 * @param string $prefix Optional. Numeric index. If set, start parameter numbering with it.
684 * @param string $sep Optional. Argument separator; defaults to 'arg_separator.output'.
686 * @param string $key Optional. Used to prefix key name. Default empty.
687 * @param bool $urlencode Optional. Whether to use urlencode() in the result. Default true.
689 * @return string The query string.
691 function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urlencode = true ) {
694 foreach ( (array) $data as $k => $v ) {
697 if ( is_int($k) && $prefix != null )
700 $k = $key . '%5B' . $k . '%5D';
703 elseif ( $v === FALSE )
706 if ( is_array($v) || is_object($v) )
707 array_push($ret,_http_build_query($v, '', $sep, $k, $urlencode));
708 elseif ( $urlencode )
709 array_push($ret, $k.'='.urlencode($v));
711 array_push($ret, $k.'='.$v);
715 $sep = ini_get('arg_separator.output');
717 return implode($sep, $ret);
721 * Retrieve a modified URL query string.
723 * You can rebuild the URL and append a new query variable to the URL query by
724 * using this function. You can also retrieve the full URL with query data.
726 * Adding a single key & value or an associative array. Setting a key value to
727 * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER
728 * value. Additional values provided are expected to be encoded appropriately
729 * with urlencode() or rawurlencode().
733 * @param string|array $param1 Either newkey or an associative_array.
734 * @param string $param2 Either newvalue or oldquery or URI.
735 * @param string $param3 Optional. Old query or URI.
736 * @return string New URL query string.
738 function add_query_arg() {
739 $args = func_get_args();
740 if ( is_array( $args[0] ) ) {
741 if ( count( $args ) < 2 || false === $args[1] )
742 $uri = $_SERVER['REQUEST_URI'];
746 if ( count( $args ) < 3 || false === $args[2] )
747 $uri = $_SERVER['REQUEST_URI'];
752 if ( $frag = strstr( $uri, '#' ) )
753 $uri = substr( $uri, 0, -strlen( $frag ) );
757 if ( 0 === stripos( $uri, 'http://' ) ) {
758 $protocol = 'http://';
759 $uri = substr( $uri, 7 );
760 } elseif ( 0 === stripos( $uri, 'https://' ) ) {
761 $protocol = 'https://';
762 $uri = substr( $uri, 8 );
767 if ( strpos( $uri, '?' ) !== false ) {
768 list( $base, $query ) = explode( '?', $uri, 2 );
770 } elseif ( $protocol || strpos( $uri, '=' ) === false ) {
778 wp_parse_str( $query, $qs );
779 $qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
780 if ( is_array( $args[0] ) ) {
782 $qs = array_merge( $qs, $kayvees );
784 $qs[ $args[0] ] = $args[1];
787 foreach ( $qs as $k => $v ) {
792 $ret = build_query( $qs );
793 $ret = trim( $ret, '?' );
794 $ret = preg_replace( '#=(&|$)#', '$1', $ret );
795 $ret = $protocol . $base . $ret . $frag;
796 $ret = rtrim( $ret, '?' );
801 * Removes an item or list from the query string.
805 * @param string|array $key Query key or keys to remove.
806 * @param bool|string $query Optional. When false uses the $_SERVER value. Default false.
807 * @return string New URL query string.
809 function remove_query_arg( $key, $query = false ) {
810 if ( is_array( $key ) ) { // removing multiple keys
811 foreach ( $key as $k )
812 $query = add_query_arg( $k, false, $query );
815 return add_query_arg( $key, false, $query );
819 * Walks the array while sanitizing the contents.
823 * @param array $array Array to walk while sanitizing contents.
824 * @return array Sanitized $array.
826 function add_magic_quotes( $array ) {
827 foreach ( (array) $array as $k => $v ) {
828 if ( is_array( $v ) ) {
829 $array[$k] = add_magic_quotes( $v );
831 $array[$k] = addslashes( $v );
838 * HTTP request for URI to retrieve content.
842 * @see wp_safe_remote_get()
844 * @param string $uri URI/URL of web page to retrieve.
845 * @return false|string HTTP content. False on failure.
847 function wp_remote_fopen( $uri ) {
848 $parsed_url = @parse_url( $uri );
850 if ( !$parsed_url || !is_array( $parsed_url ) )
854 $options['timeout'] = 10;
856 $response = wp_safe_remote_get( $uri, $options );
858 if ( is_wp_error( $response ) )
861 return wp_remote_retrieve_body( $response );
865 * Set up the WordPress query.
869 * @param string $query_vars Default WP_Query arguments.
871 function wp( $query_vars = '' ) {
872 global $wp, $wp_query, $wp_the_query;
873 $wp->main( $query_vars );
875 if ( !isset($wp_the_query) )
876 $wp_the_query = $wp_query;
880 * Retrieve the description for the HTTP status.
884 * @param int $code HTTP status code.
885 * @return string Empty string if not found, or description if found.
887 function get_status_header_desc( $code ) {
888 global $wp_header_to_desc;
890 $code = absint( $code );
892 if ( !isset( $wp_header_to_desc ) ) {
893 $wp_header_to_desc = array(
895 101 => 'Switching Protocols',
901 203 => 'Non-Authoritative Information',
903 205 => 'Reset Content',
904 206 => 'Partial Content',
905 207 => 'Multi-Status',
908 300 => 'Multiple Choices',
909 301 => 'Moved Permanently',
912 304 => 'Not Modified',
915 307 => 'Temporary Redirect',
917 400 => 'Bad Request',
918 401 => 'Unauthorized',
919 402 => 'Payment Required',
922 405 => 'Method Not Allowed',
923 406 => 'Not Acceptable',
924 407 => 'Proxy Authentication Required',
925 408 => 'Request Timeout',
928 411 => 'Length Required',
929 412 => 'Precondition Failed',
930 413 => 'Request Entity Too Large',
931 414 => 'Request-URI Too Long',
932 415 => 'Unsupported Media Type',
933 416 => 'Requested Range Not Satisfiable',
934 417 => 'Expectation Failed',
935 418 => 'I\'m a teapot',
936 422 => 'Unprocessable Entity',
938 424 => 'Failed Dependency',
939 426 => 'Upgrade Required',
940 428 => 'Precondition Required',
941 429 => 'Too Many Requests',
942 431 => 'Request Header Fields Too Large',
944 500 => 'Internal Server Error',
945 501 => 'Not Implemented',
946 502 => 'Bad Gateway',
947 503 => 'Service Unavailable',
948 504 => 'Gateway Timeout',
949 505 => 'HTTP Version Not Supported',
950 506 => 'Variant Also Negotiates',
951 507 => 'Insufficient Storage',
952 510 => 'Not Extended',
953 511 => 'Network Authentication Required',
957 if ( isset( $wp_header_to_desc[$code] ) )
958 return $wp_header_to_desc[$code];
964 * Set HTTP status header.
968 * @see get_status_header_desc()
970 * @param int $code HTTP status code.
972 function status_header( $code ) {
973 $description = get_status_header_desc( $code );
975 if ( empty( $description ) )
978 $protocol = $_SERVER['SERVER_PROTOCOL'];
979 if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
980 $protocol = 'HTTP/1.0';
981 $status_header = "$protocol $code $description";
982 if ( function_exists( 'apply_filters' ) )
985 * Filter an HTTP status header.
989 * @param string $status_header HTTP status header.
990 * @param int $code HTTP status code.
991 * @param string $description Description for the status code.
992 * @param string $protocol Server protocol.
994 $status_header = apply_filters( 'status_header', $status_header, $code, $description, $protocol );
996 @header( $status_header, true, $code );
1000 * Get the header information to prevent caching.
1002 * The several different headers cover the different ways cache prevention
1003 * is handled by different browsers
1007 * @return array The associative array of header names and field values.
1009 function wp_get_nocache_headers() {
1011 'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
1012 'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
1013 'Pragma' => 'no-cache',
1016 if ( function_exists('apply_filters') ) {
1018 * Filter the cache-controlling headers.
1022 * @see wp_get_nocache_headers()
1024 * @param array $headers {
1025 * Header names and field values.
1027 * @type string $Expires Expires header.
1028 * @type string $Cache-Control Cache-Control header.
1029 * @type string $Pragma Pragma header.
1032 $headers = (array) apply_filters( 'nocache_headers', $headers );
1034 $headers['Last-Modified'] = false;
1039 * Set the headers to prevent caching for the different browsers.
1041 * Different browsers support different nocache headers, so several
1042 * headers must be sent so that all of them get the point that no
1043 * caching should occur.
1047 * @see wp_get_nocache_headers()
1049 function nocache_headers() {
1050 $headers = wp_get_nocache_headers();
1052 unset( $headers['Last-Modified'] );
1054 // In PHP 5.3+, make sure we are not sending a Last-Modified header.
1055 if ( function_exists( 'header_remove' ) ) {
1056 @header_remove( 'Last-Modified' );
1058 // In PHP 5.2, send an empty Last-Modified header, but only as a
1059 // last resort to override a header already sent. #WP23021
1060 foreach ( headers_list() as $header ) {
1061 if ( 0 === stripos( $header, 'Last-Modified' ) ) {
1062 $headers['Last-Modified'] = '';
1068 foreach( $headers as $name => $field_value )
1069 @header("{$name}: {$field_value}");
1073 * Set the headers for caching for 10 days with JavaScript content type.
1077 function cache_javascript_headers() {
1078 $expiresOffset = 10 * DAY_IN_SECONDS;
1080 header( "Content-Type: text/javascript; charset=" . get_bloginfo( 'charset' ) );
1081 header( "Vary: Accept-Encoding" ); // Handle proxies
1082 header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $expiresOffset ) . " GMT" );
1086 * Retrieve the number of database queries during the WordPress execution.
1090 * @global wpdb $wpdb WordPress database abstraction object.
1092 * @return int Number of database queries.
1094 function get_num_queries() {
1096 return $wpdb->num_queries;
1100 * Whether input is yes or no.
1102 * Must be 'y' to be true.
1106 * @param string $yn Character string containing either 'y' (yes) or 'n' (no).
1107 * @return bool True if yes, false on anything else.
1109 function bool_from_yn( $yn ) {
1110 return ( strtolower( $yn ) == 'y' );
1114 * Load the feed template from the use of an action hook.
1116 * If the feed action does not have a hook, then the function will die with a
1117 * message telling the visitor that the feed is not valid.
1119 * It is better to only have one hook for each feed.
1123 * @uses $wp_query Used to tell if the use a comment feed.
1125 function do_feed() {
1128 $feed = get_query_var( 'feed' );
1130 // Remove the pad, if present.
1131 $feed = preg_replace( '/^_+/', '', $feed );
1133 if ( $feed == '' || $feed == 'feed' )
1134 $feed = get_default_feed();
1136 $hook = 'do_feed_' . $feed;
1137 if ( ! has_action( $hook ) )
1138 wp_die( __( 'ERROR: This is not a valid feed template.' ), '', array( 'response' => 404 ) );
1141 * Fires once the given feed is loaded.
1143 * The dynamic hook name, $hook, refers to the feed name.
1147 * @param bool $is_comment_feed Whether the feed is a comment feed.
1149 do_action( $hook, $wp_query->is_comment_feed );
1153 * Load the RDF RSS 0.91 Feed template.
1157 * @see load_template()
1159 function do_feed_rdf() {
1160 load_template( ABSPATH . WPINC . '/feed-rdf.php' );
1164 * Load the RSS 1.0 Feed Template.
1168 * @see load_template()
1170 function do_feed_rss() {
1171 load_template( ABSPATH . WPINC . '/feed-rss.php' );
1175 * Load either the RSS2 comment feed or the RSS2 posts feed.
1179 * @see load_template()
1181 * @param bool $for_comments True for the comment feed, false for normal feed.
1183 function do_feed_rss2( $for_comments ) {
1184 if ( $for_comments )
1185 load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' );
1187 load_template( ABSPATH . WPINC . '/feed-rss2.php' );
1191 * Load either Atom comment feed or Atom posts feed.
1195 * @see load_template()
1197 * @param bool $for_comments True for the comment feed, false for normal feed.
1199 function do_feed_atom( $for_comments ) {
1201 load_template( ABSPATH . WPINC . '/feed-atom-comments.php');
1203 load_template( ABSPATH . WPINC . '/feed-atom.php' );
1207 * Display the robots.txt file content.
1209 * The echo content should be with usage of the permalinks or for creating the
1214 function do_robots() {
1215 header( 'Content-Type: text/plain; charset=utf-8' );
1218 * Fires when displaying the robots.txt file.
1222 do_action( 'do_robotstxt' );
1224 $output = "User-agent: *\n";
1225 $public = get_option( 'blog_public' );
1226 if ( '0' == $public ) {
1227 $output .= "Disallow: /\n";
1229 $site_url = parse_url( site_url() );
1230 $path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : '';
1231 $output .= "Disallow: $path/wp-admin/\n";
1235 * Filter the robots.txt output.
1239 * @param string $output Robots.txt output.
1240 * @param bool $public Whether the site is considered "public".
1242 echo apply_filters( 'robots_txt', $output, $public );
1246 * Test whether blog is already installed.
1248 * The cache will be checked first. If you have a cache plugin, which saves
1249 * the cache values, then this will work. If you use the default WordPress
1250 * cache, and the database goes away, then you might have problems.
1252 * Checks for the 'siteurl' option for whether WordPress is installed.
1256 * @global wpdb $wpdb WordPress database abstraction object.
1258 * @return bool Whether the blog is already installed.
1260 function is_blog_installed() {
1264 * Check cache first. If options table goes away and we have true
1267 if ( wp_cache_get( 'is_blog_installed' ) )
1270 $suppress = $wpdb->suppress_errors();
1271 if ( ! defined( 'WP_INSTALLING' ) ) {
1272 $alloptions = wp_load_alloptions();
1274 // If siteurl is not set to autoload, check it specifically
1275 if ( !isset( $alloptions['siteurl'] ) )
1276 $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
1278 $installed = $alloptions['siteurl'];
1279 $wpdb->suppress_errors( $suppress );
1281 $installed = !empty( $installed );
1282 wp_cache_set( 'is_blog_installed', $installed );
1287 // If visiting repair.php, return true and let it take over.
1288 if ( defined( 'WP_REPAIRING' ) )
1291 $suppress = $wpdb->suppress_errors();
1294 * Loop over the WP tables. If none exist, then scratch install is allowed.
1295 * If one or more exist, suggest table repair since we got here because the
1296 * options table could not be accessed.
1298 $wp_tables = $wpdb->tables();
1299 foreach ( $wp_tables as $table ) {
1300 // The existence of custom user tables shouldn't suggest an insane state or prevent a clean install.
1301 if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table )
1303 if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table )
1306 if ( ! $wpdb->get_results( "DESCRIBE $table;" ) )
1309 // One or more tables exist. We are insane.
1311 wp_load_translations_early();
1313 // Die with a DB error.
1314 $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' );
1318 $wpdb->suppress_errors( $suppress );
1320 wp_cache_set( 'is_blog_installed', false );
1326 * Retrieve URL with nonce added to URL query.
1330 * @param string $actionurl URL to add nonce action.
1331 * @param int|string $action Optional. Nonce action name. Default -1.
1332 * @param string $name Optional. Nonce name. Default '_wpnonce'.
1333 * @return string Escaped URL with nonce action added.
1335 function wp_nonce_url( $actionurl, $action = -1, $name = '_wpnonce' ) {
1336 $actionurl = str_replace( '&', '&', $actionurl );
1337 return esc_html( add_query_arg( $name, wp_create_nonce( $action ), $actionurl ) );
1341 * Retrieve or display nonce hidden field for forms.
1343 * The nonce field is used to validate that the contents of the form came from
1344 * the location on the current site and not somewhere else. The nonce does not
1345 * offer absolute protection, but should protect against most cases. It is very
1346 * important to use nonce field in forms.
1348 * The $action and $name are optional, but if you want to have better security,
1349 * it is strongly suggested to set those two parameters. It is easier to just
1350 * call the function without any parameters, because validation of the nonce
1351 * doesn't require any parameters, but since crackers know what the default is
1352 * it won't be difficult for them to find a way around your nonce and cause
1355 * The input name will be whatever $name value you gave. The input value will be
1356 * the nonce creation value.
1360 * @param int|string $action Optional. Action name. Default -1.
1361 * @param string $name Optional. Nonce name. Default '_wpnonce'.
1362 * @param bool $referer Optional. Whether to set the referer field for validation. Default true.
1363 * @param bool $echo Optional. Whether to display or return hidden form field. Default true.
1364 * @return string Nonce field HTML markup.
1366 function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
1367 $name = esc_attr( $name );
1368 $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
1371 $nonce_field .= wp_referer_field( false );
1376 return $nonce_field;
1380 * Retrieve or display referer hidden field for forms.
1382 * The referer link is the current Request URI from the server super global. The
1383 * input name is '_wp_http_referer', in case you wanted to check manually.
1387 * @param bool $echo Optional. Whether to echo or return the referer field. Default true.
1388 * @return string Referer field HTML markup.
1390 function wp_referer_field( $echo = true ) {
1391 $referer_field = '<input type="hidden" name="_wp_http_referer" value="'. esc_attr( wp_unslash( $_SERVER['REQUEST_URI'] ) ) . '" />';
1394 echo $referer_field;
1395 return $referer_field;
1399 * Retrieve or display original referer hidden field for forms.
1401 * The input name is '_wp_original_http_referer' and will be either the same
1402 * value of wp_referer_field(), if that was posted already or it will be the
1403 * current page, if it doesn't exist.
1407 * @param bool $echo Optional. Whether to echo the original http referer. Default true.
1408 * @param string $jump_back_to Optional. Can be 'previous' or page you want to jump back to.
1409 * Default 'current'.
1410 * @return string Original referer field.
1412 function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
1413 if ( ! $ref = wp_get_original_referer() ) {
1414 $ref = 'previous' == $jump_back_to ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] );
1416 $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( $ref ) . '" />';
1418 echo $orig_referer_field;
1419 return $orig_referer_field;
1423 * Retrieve referer from '_wp_http_referer' or HTTP referer.
1425 * If it's the same as the current request URL, will return false.
1429 * @return false|string False on failure. Referer URL on success.
1431 function wp_get_referer() {
1432 if ( ! function_exists( 'wp_validate_redirect' ) )
1435 if ( ! empty( $_REQUEST['_wp_http_referer'] ) )
1436 $ref = wp_unslash( $_REQUEST['_wp_http_referer'] );
1437 else if ( ! empty( $_SERVER['HTTP_REFERER'] ) )
1438 $ref = wp_unslash( $_SERVER['HTTP_REFERER'] );
1440 if ( $ref && $ref !== wp_unslash( $_SERVER['REQUEST_URI'] ) )
1441 return wp_validate_redirect( $ref, false );
1446 * Retrieve original referer that was posted, if it exists.
1450 * @return string|false False if no original referer or original referer if set.
1452 function wp_get_original_referer() {
1453 if ( ! empty( $_REQUEST['_wp_original_http_referer'] ) && function_exists( 'wp_validate_redirect' ) )
1454 return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false );
1459 * Recursive directory creation based on full path.
1461 * Will attempt to set permissions on folders.
1465 * @param string $target Full path to attempt to create.
1466 * @return bool Whether the path was created. True if path already exists.
1468 function wp_mkdir_p( $target ) {
1471 // Strip the protocol.
1472 if( wp_is_stream( $target ) ) {
1473 list( $wrapper, $target ) = explode( '://', $target, 2 );
1476 // From php.net/mkdir user contributed notes.
1477 $target = str_replace( '//', '/', $target );
1479 // Put the wrapper back on the target.
1480 if( $wrapper !== null ) {
1481 $target = $wrapper . '://' . $target;
1485 * Safe mode fails with a trailing slash under certain PHP versions.
1486 * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
1488 $target = rtrim($target, '/');
1489 if ( empty($target) )
1492 if ( file_exists( $target ) )
1493 return @is_dir( $target );
1495 // We need to find the permissions of the parent folder that exists and inherit that.
1496 $target_parent = dirname( $target );
1497 while ( '.' != $target_parent && ! is_dir( $target_parent ) ) {
1498 $target_parent = dirname( $target_parent );
1501 // Get the permission bits.
1502 if ( $stat = @stat( $target_parent ) ) {
1503 $dir_perms = $stat['mode'] & 0007777;
1508 if ( @mkdir( $target, $dir_perms, true ) ) {
1511 * If a umask is set that modifies $dir_perms, we'll have to re-set
1512 * the $dir_perms correctly with chmod()
1514 if ( $dir_perms != ( $dir_perms & ~umask() ) ) {
1515 $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) );
1516 for ( $i = 1; $i <= count( $folder_parts ); $i++ ) {
1517 @chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms );
1528 * Test if a give filesystem path is absolute.
1530 * For example, '/foo/bar', or 'c:\windows'.
1534 * @param string $path File path.
1535 * @return bool True if path is absolute, false is not absolute.
1537 function path_is_absolute( $path ) {
1539 * This is definitive if true but fails if $path does not exist or contains
1542 if ( realpath($path) == $path )
1545 if ( strlen($path) == 0 || $path[0] == '.' )
1548 // Windows allows absolute paths like this.
1549 if ( preg_match('#^[a-zA-Z]:\\\\#', $path) )
1552 // A path starting with / or \ is absolute; anything else is relative.
1553 return ( $path[0] == '/' || $path[0] == '\\' );
1557 * Join two filesystem paths together.
1559 * For example, 'give me $path relative to $base'. If the $path is absolute,
1560 * then it the full path is returned.
1564 * @param string $base Base path.
1565 * @param string $path Path relative to $base.
1566 * @return string The path with the base or absolute path.
1568 function path_join( $base, $path ) {
1569 if ( path_is_absolute($path) )
1572 return rtrim($base, '/') . '/' . ltrim($path, '/');
1576 * Normalize a filesystem path.
1578 * Replaces backslashes with forward slashes for Windows systems, and ensures
1579 * no duplicate slashes exist.
1583 * @param string $path Path to normalize.
1584 * @return string Normalized path.
1586 function wp_normalize_path( $path ) {
1587 $path = str_replace( '\\', '/', $path );
1588 $path = preg_replace( '|/+|','/', $path );
1593 * Determine a writable directory for temporary files.
1595 * Function's preference is the return value of sys_get_temp_dir(),
1596 * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR,
1597 * before finally defaulting to /tmp/
1599 * In the event that this function does not find a writable location,
1600 * It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file.
1604 * @return string Writable temporary directory.
1606 function get_temp_dir() {
1608 if ( defined('WP_TEMP_DIR') )
1609 return trailingslashit(WP_TEMP_DIR);
1612 return trailingslashit( $temp );
1614 if ( function_exists('sys_get_temp_dir') ) {
1615 $temp = sys_get_temp_dir();
1616 if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
1617 return trailingslashit( $temp );
1620 $temp = ini_get('upload_tmp_dir');
1621 if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
1622 return trailingslashit( $temp );
1624 $temp = WP_CONTENT_DIR . '/';
1625 if ( is_dir( $temp ) && wp_is_writable( $temp ) )
1633 * Determine if a directory is writable.
1635 * This function is used to work around certain ACL issues in PHP primarily
1636 * affecting Windows Servers.
1640 * @see win_is_writable()
1642 * @param string $path Path to check for write-ability.
1643 * @return bool Whether the path is writable.
1645 function wp_is_writable( $path ) {
1646 if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) )
1647 return win_is_writable( $path );
1649 return @is_writable( $path );
1653 * Workaround for Windows bug in is_writable() function
1655 * PHP has issues with Windows ACL's for determine if a
1656 * directory is writable or not, this works around them by
1657 * checking the ability to open files rather than relying
1658 * upon PHP to interprate the OS ACL.
1662 * @see http://bugs.php.net/bug.php?id=27609
1663 * @see http://bugs.php.net/bug.php?id=30931
1665 * @param string $path Windows path to check for write-ability.
1666 * @return bool Whether the path is writable.
1668 function win_is_writable( $path ) {
1670 if ( $path[strlen( $path ) - 1] == '/' ) // if it looks like a directory, check a random file within the directory
1671 return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp');
1672 else if ( is_dir( $path ) ) // If it's a directory (and not a file) check a random file within the directory
1673 return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
1675 // check tmp file for read/write capabilities
1676 $should_delete_tmp_file = !file_exists( $path );
1677 $f = @fopen( $path, 'a' );
1681 if ( $should_delete_tmp_file )
1687 * Get an array containing the current upload directory's path and url.
1689 * Checks the 'upload_path' option, which should be from the web root folder,
1690 * and if it isn't empty it will be used. If it is empty, then the path will be
1691 * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
1692 * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
1694 * The upload URL path is set either by the 'upload_url_path' option or by using
1695 * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
1697 * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
1698 * the administration settings panel), then the time will be used. The format
1699 * will be year first and then month.
1701 * If the path couldn't be created, then an error will be returned with the key
1702 * 'error' containing the error message. The error suggests that the parent
1703 * directory is not writable by the server.
1705 * On success, the returned array will have many indices:
1706 * 'path' - base directory and sub directory or full path to upload directory.
1707 * 'url' - base url and sub directory or absolute URL to upload directory.
1708 * 'subdir' - sub directory if uploads use year/month folders option is on.
1709 * 'basedir' - path without subdir.
1710 * 'baseurl' - URL path without subdir.
1711 * 'error' - set to false.
1715 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
1716 * @return array See above for description.
1718 function wp_upload_dir( $time = null ) {
1719 $siteurl = get_option( 'siteurl' );
1720 $upload_path = trim( get_option( 'upload_path' ) );
1722 if ( empty( $upload_path ) || 'wp-content/uploads' == $upload_path ) {
1723 $dir = WP_CONTENT_DIR . '/uploads';
1724 } elseif ( 0 !== strpos( $upload_path, ABSPATH ) ) {
1725 // $dir is absolute, $upload_path is (maybe) relative to ABSPATH
1726 $dir = path_join( ABSPATH, $upload_path );
1728 $dir = $upload_path;
1731 if ( !$url = get_option( 'upload_url_path' ) ) {
1732 if ( empty($upload_path) || ( 'wp-content/uploads' == $upload_path ) || ( $upload_path == $dir ) )
1733 $url = WP_CONTENT_URL . '/uploads';
1735 $url = trailingslashit( $siteurl ) . $upload_path;
1739 * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
1740 * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
1742 if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {
1743 $dir = ABSPATH . UPLOADS;
1744 $url = trailingslashit( $siteurl ) . UPLOADS;
1747 // If multisite (and if not the main site in a post-MU network)
1748 if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) {
1750 if ( ! get_site_option( 'ms_files_rewriting' ) ) {
1752 * If ms-files rewriting is disabled (networks created post-3.5), it is fairly
1753 * straightforward: Append sites/%d if we're not on the main site (for post-MU
1754 * networks). (The extra directory prevents a four-digit ID from conflicting with
1755 * a year-based directory for the main site. But if a MU-era network has disabled
1756 * ms-files rewriting manually, they don't need the extra directory, as they never
1757 * had wp-content/uploads for the main site.)
1760 if ( defined( 'MULTISITE' ) )
1761 $ms_dir = '/sites/' . get_current_blog_id();
1763 $ms_dir = '/' . get_current_blog_id();
1768 } elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {
1770 * Handle the old-form ms-files.php rewriting if the network still has that enabled.
1771 * When ms-files rewriting is enabled, then we only listen to UPLOADS when:
1772 * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used
1774 * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect
1775 * the original blog ID.
1777 * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
1778 * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
1779 * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
1780 * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
1783 if ( defined( 'BLOGUPLOADDIR' ) )
1784 $dir = untrailingslashit( BLOGUPLOADDIR );
1786 $dir = ABSPATH . UPLOADS;
1787 $url = trailingslashit( $siteurl ) . 'files';
1795 if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
1796 // Generate the yearly and monthly dirs
1798 $time = current_time( 'mysql' );
1799 $y = substr( $time, 0, 4 );
1800 $m = substr( $time, 5, 2 );
1808 * Filter the uploads directory data.
1812 * @param array $uploads Array of upload directory data with keys of 'path',
1813 * 'url', 'subdir, 'basedir', and 'error'.
1815 $uploads = apply_filters( 'upload_dir',
1819 'subdir' => $subdir,
1820 'basedir' => $basedir,
1821 'baseurl' => $baseurl,
1825 // Make sure we have an uploads directory.
1826 if ( ! wp_mkdir_p( $uploads['path'] ) ) {
1827 if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
1828 $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
1830 $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
1832 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path );
1833 $uploads['error'] = $message;
1840 * Get a filename that is sanitized and unique for the given directory.
1842 * If the filename is not unique, then a number will be added to the filename
1843 * before the extension, and will continue adding numbers until the filename is
1846 * The callback is passed three parameters, the first one is the directory, the
1847 * second is the filename, and the third is the extension.
1851 * @param string $dir Directory.
1852 * @param string $filename File name.
1853 * @param callback $unique_filename_callback Callback. Default null.
1854 * @return string New filename, if given wasn't unique.
1856 function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
1857 // Sanitize the file name before we begin processing.
1858 $filename = sanitize_file_name($filename);
1860 // Separate the filename into a name and extension.
1861 $info = pathinfo($filename);
1862 $ext = !empty($info['extension']) ? '.' . $info['extension'] : '';
1863 $name = basename($filename, $ext);
1865 // Edge case: if file is named '.ext', treat as an empty name.
1866 if ( $name === $ext )
1870 * Increment the file number until we have a unique file to save in $dir.
1871 * Use callback if supplied.
1873 if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
1874 $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
1878 // Change '.ext' to lower case.
1879 if ( $ext && strtolower($ext) != $ext ) {
1880 $ext2 = strtolower($ext);
1881 $filename2 = preg_replace( '|' . preg_quote($ext) . '$|', $ext2, $filename );
1883 // Check for both lower and upper case extension or image sub-sizes may be overwritten.
1884 while ( file_exists($dir . "/$filename") || file_exists($dir . "/$filename2") ) {
1885 $new_number = $number + 1;
1886 $filename = str_replace( "$number$ext", "$new_number$ext", $filename );
1887 $filename2 = str_replace( "$number$ext2", "$new_number$ext2", $filename2 );
1888 $number = $new_number;
1893 while ( file_exists( $dir . "/$filename" ) ) {
1894 if ( '' == "$number$ext" )
1895 $filename = $filename . ++$number . $ext;
1897 $filename = str_replace( "$number$ext", ++$number . $ext, $filename );
1905 * Create a file in the upload folder with given content.
1907 * If there is an error, then the key 'error' will exist with the error message.
1908 * If success, then the key 'file' will have the unique file path, the 'url' key
1909 * will have the link to the new file. and the 'error' key will be set to false.
1911 * This function will not move an uploaded file to the upload folder. It will
1912 * create a new file with the content in $bits parameter. If you move the upload
1913 * file, read the content of the uploaded file, and then you can give the
1914 * filename and content to this function, which will add it to the upload
1917 * The permissions will be set on the new file automatically by this function.
1921 * @param string $name Filename.
1922 * @param null|string $deprecated Never used. Set to null.
1923 * @param mixed $bits File content
1924 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
1927 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
1928 if ( !empty( $deprecated ) )
1929 _deprecated_argument( __FUNCTION__, '2.0' );
1931 if ( empty( $name ) )
1932 return array( 'error' => __( 'Empty filename' ) );
1934 $wp_filetype = wp_check_filetype( $name );
1935 if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) )
1936 return array( 'error' => __( 'Invalid file type' ) );
1938 $upload = wp_upload_dir( $time );
1940 if ( $upload['error'] !== false )
1944 * Filter whether to treat the upload bits as an error.
1946 * Passing a non-array to the filter will effectively short-circuit preparing
1947 * the upload bits, returning that value instead.
1951 * @param mixed $upload_bits_error An array of upload bits data, or a non-array error to return.
1953 $upload_bits_error = apply_filters( 'wp_upload_bits', array( 'name' => $name, 'bits' => $bits, 'time' => $time ) );
1954 if ( !is_array( $upload_bits_error ) ) {
1955 $upload[ 'error' ] = $upload_bits_error;
1959 $filename = wp_unique_filename( $upload['path'], $name );
1961 $new_file = $upload['path'] . "/$filename";
1962 if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
1963 if ( 0 === strpos( $upload['basedir'], ABSPATH ) )
1964 $error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir'];
1966 $error_path = basename( $upload['basedir'] ) . $upload['subdir'];
1968 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path );
1969 return array( 'error' => $message );
1972 $ifp = @ fopen( $new_file, 'wb' );
1974 return array( 'error' => sprintf( __( 'Could not write file %s' ), $new_file ) );
1976 @fwrite( $ifp, $bits );
1980 // Set correct file permissions
1981 $stat = @ stat( dirname( $new_file ) );
1982 $perms = $stat['mode'] & 0007777;
1983 $perms = $perms & 0000666;
1984 @ chmod( $new_file, $perms );
1988 $url = $upload['url'] . "/$filename";
1990 return array( 'file' => $new_file, 'url' => $url, 'error' => false );
1994 * Retrieve the file type based on the extension name.
1998 * @param string $ext The extension to search.
1999 * @return string|null The file type, example: audio, video, document, spreadsheet, etc.
2000 * Null if not found.
2002 function wp_ext2type( $ext ) {
2003 $ext = strtolower( $ext );
2006 * Filter file type based on the extension name.
2010 * @see wp_ext2type()
2012 * @param array $ext2type Multi-dimensional array with extensions for a default set
2015 $ext2type = apply_filters( 'ext2type', array(
2016 'image' => array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'bmp', 'tif', 'tiff', 'ico' ),
2017 'audio' => array( 'aac', 'ac3', 'aif', 'aiff', 'm3a', 'm4a', 'm4b', 'mka', 'mp1', 'mp2', 'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
2018 'video' => array( '3g2', '3gp', '3gpp', 'asf', 'avi', 'divx', 'dv', 'flv', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt', 'rm', 'vob', 'wmv' ),
2019 'document' => array( 'doc', 'docx', 'docm', 'dotm', 'odt', 'pages', 'pdf', 'xps', 'oxps', 'rtf', 'wp', 'wpd', 'psd' ),
2020 'spreadsheet' => array( 'numbers', 'ods', 'xls', 'xlsx', 'xlsm', 'xlsb' ),
2021 'interactive' => array( 'swf', 'key', 'ppt', 'pptx', 'pptm', 'pps', 'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ),
2022 'text' => array( 'asc', 'csv', 'tsv', 'txt' ),
2023 'archive' => array( 'bz2', 'cab', 'dmg', 'gz', 'rar', 'sea', 'sit', 'sqx', 'tar', 'tgz', 'zip', '7z' ),
2024 'code' => array( 'css', 'htm', 'html', 'php', 'js' ),
2027 foreach ( $ext2type as $type => $exts )
2028 if ( in_array( $ext, $exts ) )
2035 * Retrieve the file type from the file name.
2037 * You can optionally define the mime array, if needed.
2041 * @param string $filename File name or path.
2042 * @param array $mimes Optional. Key is the file extension with value as the mime type.
2043 * @return array Values with extension first and mime type.
2045 function wp_check_filetype( $filename, $mimes = null ) {
2046 if ( empty($mimes) )
2047 $mimes = get_allowed_mime_types();
2051 foreach ( $mimes as $ext_preg => $mime_match ) {
2052 $ext_preg = '!\.(' . $ext_preg . ')(\?.*)?$!i';
2053 if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
2054 $type = $mime_match;
2055 $ext = $ext_matches[1];
2060 return compact( 'ext', 'type' );
2064 * Attempt to determine the real file type of a file.
2066 * If unable to, the file name extension will be used to determine type.
2068 * If it's determined that the extension does not match the file's real type,
2069 * then the "proper_filename" value will be set with a proper filename and extension.
2071 * Currently this function only supports validating images known to getimagesize().
2075 * @param string $file Full path to the file.
2076 * @param string $filename The name of the file (may differ from $file due to $file being
2077 * in a tmp directory).
2078 * @param array $mimes Optional. Key is the file extension with value as the mime type.
2079 * @return array Values for the extension, MIME, and either a corrected filename or false
2080 * if original $filename is valid.
2082 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
2084 $proper_filename = false;
2086 // Do basic extension validation and MIME mapping
2087 $wp_filetype = wp_check_filetype( $filename, $mimes );
2088 $ext = $wp_filetype['ext'];
2089 $type = $wp_filetype['type'];
2091 // We can't do any further validation without a file to work with
2092 if ( ! file_exists( $file ) ) {
2093 return compact( 'ext', 'type', 'proper_filename' );
2096 // We're able to validate images using GD
2097 if ( $type && 0 === strpos( $type, 'image/' ) && function_exists('getimagesize') ) {
2099 // Attempt to figure out what type of image it actually is
2100 $imgstats = @getimagesize( $file );
2102 // If getimagesize() knows what kind of image it really is and if the real MIME doesn't match the claimed MIME
2103 if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
2105 * Filter the list mapping image mime types to their respective extensions.
2109 * @param array $mime_to_ext Array of image mime types and their matching extensions.
2111 $mime_to_ext = apply_filters( 'getimagesize_mimes_to_exts', array(
2112 'image/jpeg' => 'jpg',
2113 'image/png' => 'png',
2114 'image/gif' => 'gif',
2115 'image/bmp' => 'bmp',
2116 'image/tiff' => 'tif',
2119 // Replace whatever is after the last period in the filename with the correct extension
2120 if ( ! empty( $mime_to_ext[ $imgstats['mime'] ] ) ) {
2121 $filename_parts = explode( '.', $filename );
2122 array_pop( $filename_parts );
2123 $filename_parts[] = $mime_to_ext[ $imgstats['mime'] ];
2124 $new_filename = implode( '.', $filename_parts );
2126 if ( $new_filename != $filename ) {
2127 $proper_filename = $new_filename; // Mark that it changed
2129 // Redefine the extension / MIME
2130 $wp_filetype = wp_check_filetype( $new_filename, $mimes );
2131 $ext = $wp_filetype['ext'];
2132 $type = $wp_filetype['type'];
2138 * Filter the "real" file type of the given file.
2142 * @param array $wp_check_filetype_and_ext File data array containing 'ext', 'type', and
2143 * 'proper_filename' keys.
2144 * @param string $file Full path to the file.
2145 * @param string $filename The name of the file (may differ from $file due to
2146 * $file being in a tmp directory).
2147 * @param array $mimes Key is the file extension with value as the mime type.
2149 return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes );
2153 * Retrieve list of mime types and file extensions.
2157 * @return array Array of mime types keyed by the file extension regex corresponding to those types.
2159 function wp_get_mime_types() {
2161 * Filter the list of mime types and file extensions.
2163 * This filter should be used to add, not remove, mime types. To remove
2164 * mime types, use the 'upload_mimes' filter.
2168 * @param array $wp_get_mime_types Mime types keyed by the file extension regex
2169 * corresponding to those types.
2171 return apply_filters( 'mime_types', array(
2173 'jpg|jpeg|jpe' => 'image/jpeg',
2174 'gif' => 'image/gif',
2175 'png' => 'image/png',
2176 'bmp' => 'image/bmp',
2177 'tif|tiff' => 'image/tiff',
2178 'ico' => 'image/x-icon',
2180 'asf|asx' => 'video/x-ms-asf',
2181 'wmv' => 'video/x-ms-wmv',
2182 'wmx' => 'video/x-ms-wmx',
2183 'wm' => 'video/x-ms-wm',
2184 'avi' => 'video/avi',
2185 'divx' => 'video/divx',
2186 'flv' => 'video/x-flv',
2187 'mov|qt' => 'video/quicktime',
2188 'mpeg|mpg|mpe' => 'video/mpeg',
2189 'mp4|m4v' => 'video/mp4',
2190 'ogv' => 'video/ogg',
2191 'webm' => 'video/webm',
2192 'mkv' => 'video/x-matroska',
2193 '3gp|3gpp' => 'video/3gpp', // Can also be audio
2194 '3g2|3gp2' => 'video/3gpp2', // Can also be audio
2196 'txt|asc|c|cc|h|srt' => 'text/plain',
2197 'csv' => 'text/csv',
2198 'tsv' => 'text/tab-separated-values',
2199 'ics' => 'text/calendar',
2200 'rtx' => 'text/richtext',
2201 'css' => 'text/css',
2202 'htm|html' => 'text/html',
2203 'vtt' => 'text/vtt',
2204 'dfxp' => 'application/ttaf+xml',
2206 'mp3|m4a|m4b' => 'audio/mpeg',
2207 'ra|ram' => 'audio/x-realaudio',
2208 'wav' => 'audio/wav',
2209 'ogg|oga' => 'audio/ogg',
2210 'mid|midi' => 'audio/midi',
2211 'wma' => 'audio/x-ms-wma',
2212 'wax' => 'audio/x-ms-wax',
2213 'mka' => 'audio/x-matroska',
2214 // Misc application formats.
2215 'rtf' => 'application/rtf',
2216 'js' => 'application/javascript',
2217 'pdf' => 'application/pdf',
2218 'swf' => 'application/x-shockwave-flash',
2219 'class' => 'application/java',
2220 'tar' => 'application/x-tar',
2221 'zip' => 'application/zip',
2222 'gz|gzip' => 'application/x-gzip',
2223 'rar' => 'application/rar',
2224 '7z' => 'application/x-7z-compressed',
2225 'exe' => 'application/x-msdownload',
2226 'psd' => 'application/octet-stream',
2227 // MS Office formats.
2228 'doc' => 'application/msword',
2229 'pot|pps|ppt' => 'application/vnd.ms-powerpoint',
2230 'wri' => 'application/vnd.ms-write',
2231 'xla|xls|xlt|xlw' => 'application/vnd.ms-excel',
2232 'mdb' => 'application/vnd.ms-access',
2233 'mpp' => 'application/vnd.ms-project',
2234 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
2235 'docm' => 'application/vnd.ms-word.document.macroEnabled.12',
2236 'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
2237 'dotm' => 'application/vnd.ms-word.template.macroEnabled.12',
2238 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
2239 'xlsm' => 'application/vnd.ms-excel.sheet.macroEnabled.12',
2240 'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
2241 'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
2242 'xltm' => 'application/vnd.ms-excel.template.macroEnabled.12',
2243 'xlam' => 'application/vnd.ms-excel.addin.macroEnabled.12',
2244 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
2245 'pptm' => 'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
2246 'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
2247 'ppsm' => 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
2248 'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template',
2249 'potm' => 'application/vnd.ms-powerpoint.template.macroEnabled.12',
2250 'ppam' => 'application/vnd.ms-powerpoint.addin.macroEnabled.12',
2251 'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
2252 'sldm' => 'application/vnd.ms-powerpoint.slide.macroEnabled.12',
2253 'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
2254 'oxps' => 'application/oxps',
2255 'xps' => 'application/vnd.ms-xpsdocument',
2256 // OpenOffice formats.
2257 'odt' => 'application/vnd.oasis.opendocument.text',
2258 'odp' => 'application/vnd.oasis.opendocument.presentation',
2259 'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
2260 'odg' => 'application/vnd.oasis.opendocument.graphics',
2261 'odc' => 'application/vnd.oasis.opendocument.chart',
2262 'odb' => 'application/vnd.oasis.opendocument.database',
2263 'odf' => 'application/vnd.oasis.opendocument.formula',
2264 // WordPerfect formats.
2265 'wp|wpd' => 'application/wordperfect',
2267 'key' => 'application/vnd.apple.keynote',
2268 'numbers' => 'application/vnd.apple.numbers',
2269 'pages' => 'application/vnd.apple.pages',
2273 * Retrieve list of allowed mime types and file extensions.
2277 * @param int|WP_User $user Optional. User to check. Defaults to current user.
2278 * @return array Array of mime types keyed by the file extension regex corresponding
2281 function get_allowed_mime_types( $user = null ) {
2282 $t = wp_get_mime_types();
2284 unset( $t['swf'], $t['exe'] );
2285 if ( function_exists( 'current_user_can' ) )
2286 $unfiltered = $user ? user_can( $user, 'unfiltered_html' ) : current_user_can( 'unfiltered_html' );
2288 if ( empty( $unfiltered ) )
2289 unset( $t['htm|html'] );
2292 * Filter list of allowed mime types and file extensions.
2296 * @param array $t Mime types keyed by the file extension regex corresponding to
2297 * those types. 'swf' and 'exe' removed from full list. 'htm|html' also
2298 * removed depending on '$user' capabilities.
2299 * @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user).
2301 return apply_filters( 'upload_mimes', $t, $user );
2305 * Display "Are You Sure" message to confirm the action being taken.
2307 * If the action has the nonce explain message, then it will be displayed
2308 * along with the "Are you sure?" message.
2312 * @param string $action The nonce action.
2314 function wp_nonce_ays( $action ) {
2315 if ( 'log-out' == $action ) {
2316 $html = sprintf( __( 'You are attempting to log out of %s' ), get_bloginfo( 'name' ) ) . '</p><p>';
2317 $redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
2318 $html .= sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url( $redirect_to ) );
2320 $html = __( 'Are you sure you want to do this?' );
2321 if ( wp_get_referer() )
2322 $html .= "</p><p><a href='" . esc_url( remove_query_arg( 'updated', wp_get_referer() ) ) . "'>" . __( 'Please try again.' ) . "</a>";
2325 wp_die( $html, __( 'WordPress Failure Notice' ), 403 );
2329 * Kill WordPress execution and display HTML message with error message.
2331 * This function complements the `die()` PHP function. The difference is that
2332 * HTML will be displayed to the user. It is recommended to use this function
2333 * only when the execution should not continue any further. It is not recommended
2334 * to call this function very often, and try to handle as many errors as possible
2335 * silently or more gracefully.
2337 * As a shorthand, the desired HTTP response code may be passed as an integer to
2338 * the `$title` parameter (the default title would apply) or the `$args` parameter.
2341 * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept
2342 * an integer to be used as the response code.
2344 * @param string|WP_Error $message Optional. Error message. If this is a {@see WP_Error} object,
2345 * the error's messages are used. Default empty.
2346 * @param string|int $title Optional. Error title. If `$message` is a `WP_Error` object,
2347 * error data with the key 'title' may be used to specify the title.
2348 * If `$title` is an integer, then it is treated as the response
2349 * code. Default empty.
2350 * @param string|array|int $args {
2351 * Optional. Arguments to control behavior. If `$args` is an integer, then it is treated
2352 * as the response code. Default empty array.
2354 * @type int $response The HTTP response code. Default 500.
2355 * @type bool $back_link Whether to include a link to go back. Default false.
2356 * @type string $text_direction The text direction. This is only useful internally, when WordPress
2357 * is still loading and the site's locale is not set up yet. Accepts 'rtl'.
2358 * Default is the value of {@see is_rtl()}.
2361 function wp_die( $message = '', $title = '', $args = array() ) {
2363 if ( is_int( $args ) ) {
2364 $args = array( 'response' => $args );
2365 } elseif ( is_int( $title ) ) {
2366 $args = array( 'response' => $title );
2370 if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
2372 * Filter callback for killing WordPress execution for AJAX requests.
2376 * @param callback $function Callback function name.
2378 $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
2379 } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
2381 * Filter callback for killing WordPress execution for XML-RPC requests.
2385 * @param callback $function Callback function name.
2387 $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
2390 * Filter callback for killing WordPress execution for all non-AJAX, non-XML-RPC requests.
2394 * @param callback $function Callback function name.
2396 $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
2399 call_user_func( $function, $message, $title, $args );
2403 * Kill WordPress execution and display HTML message with error message.
2405 * This is the default handler for wp_die if you want a custom one for your
2406 * site then you can overload using the wp_die_handler filter in wp_die
2411 * @param string $message Error message.
2412 * @param string $title Optional. Error title. Default empty.
2413 * @param string|array $args Optional. Arguments to control behavior. Default empty array.
2415 function _default_wp_die_handler( $message, $title = '', $args = array() ) {
2416 $defaults = array( 'response' => 500 );
2417 $r = wp_parse_args($args, $defaults);
2419 $have_gettext = function_exists('__');
2421 if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
2422 if ( empty( $title ) ) {
2423 $error_data = $message->get_error_data();
2424 if ( is_array( $error_data ) && isset( $error_data['title'] ) )
2425 $title = $error_data['title'];
2427 $errors = $message->get_error_messages();
2428 switch ( count( $errors ) ) {
2433 $message = "<p>{$errors[0]}</p>";
2436 $message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
2439 } elseif ( is_string( $message ) ) {
2440 $message = "<p>$message</p>";
2443 if ( isset( $r['back_link'] ) && $r['back_link'] ) {
2444 $back_text = $have_gettext? __('« Back') : '« Back';
2445 $message .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";
2448 if ( ! did_action( 'admin_head' ) ) :
2449 if ( !headers_sent() ) {
2450 status_header( $r['response'] );
2452 header( 'Content-Type: text/html; charset=utf-8' );
2455 if ( empty($title) )
2456 $title = $have_gettext ? __('WordPress › Error') : 'WordPress › Error';
2458 $text_direction = 'ltr';
2459 if ( isset($r['text_direction']) && 'rtl' == $r['text_direction'] )
2460 $text_direction = 'rtl';
2461 elseif ( function_exists( 'is_rtl' ) && is_rtl() )
2462 $text_direction = 'rtl';
2465 <!-- 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
2467 <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'"; ?>>
2469 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2470 <title><?php echo $title ?></title>
2471 <style type="text/css">
2473 background: #f1f1f1;
2478 font-family: "Open Sans", sans-serif;
2482 -webkit-box-shadow: 0 1px 3px rgba(0,0,0,0.13);
2483 box-shadow: 0 1px 3px rgba(0,0,0,0.13);
2486 border-bottom: 1px solid #dadada;
2489 font: 24px "Open Sans", sans-serif;
2492 padding-bottom: 7px;
2500 margin: 25px 0 20px;
2503 font-family: Consolas, Monaco, monospace;
2506 margin-bottom: 10px;
2511 text-decoration: none;
2517 background: #f7f7f7;
2518 border: 1px solid #cccccc;
2520 display: inline-block;
2521 text-decoration: none;
2526 padding: 0 10px 1px;
2528 -webkit-border-radius: 3px;
2529 -webkit-appearance: none;
2531 white-space: nowrap;
2532 -webkit-box-sizing: border-box;
2533 -moz-box-sizing: border-box;
2534 box-sizing: border-box;
2536 -webkit-box-shadow: inset 0 1px 0 #fff, 0 1px 0 rgba(0,0,0,.08);
2537 box-shadow: inset 0 1px 0 #fff, 0 1px 0 rgba(0,0,0,.08);
2538 vertical-align: top;
2541 .button.button-large {
2549 background: #fafafa;
2555 -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,.2);
2556 box-shadow: 1px 1px 1px rgba(0,0,0,.2);
2563 -webkit-box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
2564 box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
2567 <?php if ( 'rtl' == $text_direction ) : ?>
2568 body { font-family: Tahoma, Arial; }
2572 <body id="error-page">
2573 <?php endif; // ! did_action( 'admin_head' ) ?>
2574 <?php echo $message; ?>
2582 * Kill WordPress execution and display XML message with error message.
2584 * This is the handler for wp_die when processing XMLRPC requests.
2589 * @param string $message Error message.
2590 * @param string $title Optional. Error title. Default empty.
2591 * @param string|array $args Optional. Arguments to control behavior. Default empty array.
2593 function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
2594 global $wp_xmlrpc_server;
2595 $defaults = array( 'response' => 500 );
2597 $r = wp_parse_args($args, $defaults);
2599 if ( $wp_xmlrpc_server ) {
2600 $error = new IXR_Error( $r['response'] , $message);
2601 $wp_xmlrpc_server->output( $error->getXml() );
2607 * Kill WordPress ajax execution.
2609 * This is the handler for wp_die when processing Ajax requests.
2614 * @param string $message Optional. Response to print. Default empty.
2616 function _ajax_wp_die_handler( $message = '' ) {
2617 if ( is_scalar( $message ) )
2618 die( (string) $message );
2623 * Kill WordPress execution.
2625 * This is the handler for wp_die when processing APP requests.
2630 * @param string $message Optional. Response to print. Default empty.
2632 function _scalar_wp_die_handler( $message = '' ) {
2633 if ( is_scalar( $message ) )
2634 die( (string) $message );
2639 * Encode a variable into JSON, with some sanity checks.
2643 * @param mixed $data Variable (usually an array or object) to encode as JSON.
2644 * @param int $options Optional. Options to be passed to json_encode(). Default 0.
2645 * @param int $depth Optional. Maximum depth to walk through $data. Must be
2646 * greater than 0. Default 512.
2647 * @return bool|string The JSON encoded string, or false if it cannot be encoded.
2649 function wp_json_encode( $data, $options = 0, $depth = 512 ) {
2651 * json_encode() has had extra params added over the years.
2652 * $options was added in 5.3, and $depth in 5.5.
2653 * We need to make sure we call it with the correct arguments.
2655 if ( version_compare( PHP_VERSION, '5.5', '>=' ) ) {
2656 $args = array( $data, $options, $depth );
2657 } elseif ( version_compare( PHP_VERSION, '5.3', '>=' ) ) {
2658 $args = array( $data, $options );
2660 $args = array( $data );
2663 $json = call_user_func_array( 'json_encode', $args );
2665 // If json_encode() was successful, no need to do more sanity checking.
2666 // ... unless we're in an old version of PHP, and json_encode() returned
2667 // a string containing 'null'. Then we need to do more sanity checking.
2668 if ( false !== $json && ( version_compare( PHP_VERSION, '5.5', '>=' ) || false === strpos( $json, 'null' ) ) ) {
2673 $args[0] = _wp_json_sanity_check( $data, $depth );
2674 } catch ( Exception $e ) {
2678 return call_user_func_array( 'json_encode', $args );
2682 * Perform sanity checks on data that shall be encoded to JSON.
2684 * @see wp_json_encode()
2690 * @param mixed $data Variable (usually an array or object) to encode as JSON.
2691 * @param int $depth Maximum depth to walk through $data. Must be greater than 0.
2692 * @return mixed The sanitized data that shall be encoded to JSON.
2694 function _wp_json_sanity_check( $data, $depth ) {
2696 throw new Exception( 'Reached depth limit' );
2699 if ( is_array( $data ) ) {
2701 foreach ( $data as $id => $el ) {
2702 // Don't forget to sanitize the ID!
2703 if ( is_string( $id ) ) {
2704 $clean_id = _wp_json_convert_string( $id );
2709 // Check the element type, so that we're only recursing if we really have to.
2710 if ( is_array( $el ) || is_object( $el ) ) {
2711 $output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 );
2712 } elseif ( is_string( $el ) ) {
2713 $output[ $clean_id ] = _wp_json_convert_string( $el );
2715 $output[ $clean_id ] = $el;
2718 } elseif ( is_object( $data ) ) {
2719 $output = new stdClass;
2720 foreach ( $data as $id => $el ) {
2721 if ( is_string( $id ) ) {
2722 $clean_id = _wp_json_convert_string( $id );
2727 if ( is_array( $el ) || is_object( $el ) ) {
2728 $output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 );
2729 } elseif ( is_string( $el ) ) {
2730 $output->$clean_id = _wp_json_convert_string( $el );
2732 $output->$clean_id = $el;
2735 } elseif ( is_string( $data ) ) {
2736 return _wp_json_convert_string( $data );
2745 * Convert a string to UTF-8, so that it can be safely encoded to JSON.
2747 * @see _wp_json_sanity_check()
2753 * @param string $string The string which is to be converted.
2754 * @return string The checked string.
2756 function _wp_json_convert_string( $string ) {
2757 static $use_mb = null;
2758 if ( is_null( $use_mb ) ) {
2759 $use_mb = function_exists( 'mb_convert_encoding' );
2763 $encoding = mb_detect_encoding( $string, mb_detect_order(), true );
2765 return mb_convert_encoding( $string, 'UTF-8', $encoding );
2767 return mb_convert_encoding( $string, 'UTF-8', 'UTF-8' );
2770 return wp_check_invalid_utf8( $string, true );
2775 * Send a JSON response back to an Ajax request.
2779 * @param mixed $response Variable (usually an array or object) to encode as JSON,
2780 * then print and die.
2782 function wp_send_json( $response ) {
2783 @header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
2784 echo wp_json_encode( $response );
2785 if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
2792 * Send a JSON response back to an Ajax request, indicating success.
2796 * @param mixed $data Data to encode as JSON, then print and die.
2798 function wp_send_json_success( $data = null ) {
2799 $response = array( 'success' => true );
2801 if ( isset( $data ) )
2802 $response['data'] = $data;
2804 wp_send_json( $response );
2808 * Send a JSON response back to an Ajax request, indicating failure.
2810 * If the `$data` parameter is a {@see WP_Error} object, the errors
2811 * within the object are processed and output as an array of error
2812 * codes and corresponding messages. All other types are output
2813 * without further processing.
2816 * @since 4.1.0 The `$data` parameter is now processed if a {@see WP_Error}
2817 * object is passed in.
2819 * @param mixed $data Data to encode as JSON, then print and die.
2821 function wp_send_json_error( $data = null ) {
2822 $response = array( 'success' => false );
2824 if ( isset( $data ) ) {
2825 if ( is_wp_error( $data ) ) {
2827 foreach ( $data->errors as $code => $messages ) {
2828 foreach ( $messages as $message ) {
2829 $result[] = array( 'code' => $code, 'message' => $message );
2833 $response['data'] = $result;
2835 $response['data'] = $data;
2839 wp_send_json( $response );
2843 * Retrieve the WordPress home page URL.
2845 * If the constant named 'WP_HOME' exists, then it will be used and returned
2846 * by the function. This can be used to counter the redirection on your local
2847 * development environment.
2854 * @param string $url URL for the home location.
2855 * @return string Homepage location.
2857 function _config_wp_home( $url = '' ) {
2858 if ( defined( 'WP_HOME' ) )
2859 return untrailingslashit( WP_HOME );
2864 * Retrieve the WordPress site URL.
2866 * If the constant named 'WP_SITEURL' is defined, then the value in that
2867 * constant will always be returned. This can be used for debugging a site
2868 * on your localhost while not having to change the database to your URL.
2875 * @param string $url URL to set the WordPress site location.
2876 * @return string The WordPress Site URL.
2878 function _config_wp_siteurl( $url = '' ) {
2879 if ( defined( 'WP_SITEURL' ) )
2880 return untrailingslashit( WP_SITEURL );
2885 * Set the localized direction for MCE plugin.
2887 * Will only set the direction to 'rtl', if the WordPress locale has
2888 * the text direction set to 'rtl'.
2890 * Fills in the 'directionality' setting, enables the 'directionality'
2891 * plugin, and adds the 'ltr' button to 'toolbar1', formerly
2892 * 'theme_advanced_buttons1' array keys. These keys are then returned
2893 * in the $input (TinyMCE settings) array.
2898 * @param array $input MCE settings array.
2899 * @return array Direction set for 'rtl', if needed by locale.
2901 function _mce_set_direction( $input ) {
2903 $input['directionality'] = 'rtl';
2904 $input['plugins'] .= ',directionality';
2905 $input['toolbar1'] .= ',ltr';
2913 * Convert smiley code to the icon graphic file equivalent.
2915 * You can turn off smilies, by going to the write setting screen and unchecking
2916 * the box, or by setting 'use_smilies' option to false or removing the option.
2918 * Plugins may override the default smiley list by setting the $wpsmiliestrans
2919 * to an array, with the key the code the blogger types in and the value the
2922 * The $wp_smiliessearch global is for the regular expression and is set each
2923 * time the function is called.
2925 * The full list of smilies can be found in the function and won't be listed in
2926 * the description. Probably should create a Codex page for it, so that it is
2929 * @global array $wpsmiliestrans
2930 * @global array $wp_smiliessearch
2934 function smilies_init() {
2935 global $wpsmiliestrans, $wp_smiliessearch;
2937 // don't bother setting up smilies if they are disabled
2938 if ( !get_option( 'use_smilies' ) )
2941 if ( !isset( $wpsmiliestrans ) ) {
2942 $wpsmiliestrans = array(
2943 ':mrgreen:' => 'icon_mrgreen.gif',
2944 ':neutral:' => 'icon_neutral.gif',
2945 ':twisted:' => 'icon_twisted.gif',
2946 ':arrow:' => 'icon_arrow.gif',
2947 ':shock:' => 'icon_eek.gif',
2948 ':smile:' => 'icon_smile.gif',
2949 ':???:' => 'icon_confused.gif',
2950 ':cool:' => 'icon_cool.gif',
2951 ':evil:' => 'icon_evil.gif',
2952 ':grin:' => 'icon_biggrin.gif',
2953 ':idea:' => 'icon_idea.gif',
2954 ':oops:' => 'icon_redface.gif',
2955 ':razz:' => 'icon_razz.gif',
2956 ':roll:' => 'icon_rolleyes.gif',
2957 ':wink:' => 'icon_wink.gif',
2958 ':cry:' => 'icon_cry.gif',
2959 ':eek:' => 'icon_surprised.gif',
2960 ':lol:' => 'icon_lol.gif',
2961 ':mad:' => 'icon_mad.gif',
2962 ':sad:' => 'icon_sad.gif',
2963 '8-)' => 'icon_cool.gif',
2964 '8-O' => 'icon_eek.gif',
2965 ':-(' => 'icon_sad.gif',
2966 ':-)' => 'icon_smile.gif',
2967 ':-?' => 'icon_confused.gif',
2968 ':-D' => 'icon_biggrin.gif',
2969 ':-P' => 'icon_razz.gif',
2970 ':-o' => 'icon_surprised.gif',
2971 ':-x' => 'icon_mad.gif',
2972 ':-|' => 'icon_neutral.gif',
2973 ';-)' => 'icon_wink.gif',
2974 // This one transformation breaks regular text with frequency.
2975 // '8)' => 'icon_cool.gif',
2976 '8O' => 'icon_eek.gif',
2977 ':(' => 'icon_sad.gif',
2978 ':)' => 'icon_smile.gif',
2979 ':?' => 'icon_confused.gif',
2980 ':D' => 'icon_biggrin.gif',
2981 ':P' => 'icon_razz.gif',
2982 ':o' => 'icon_surprised.gif',
2983 ':x' => 'icon_mad.gif',
2984 ':|' => 'icon_neutral.gif',
2985 ';)' => 'icon_wink.gif',
2986 ':!:' => 'icon_exclaim.gif',
2987 ':?:' => 'icon_question.gif',
2991 if (count($wpsmiliestrans) == 0) {
2996 * NOTE: we sort the smilies in reverse key order. This is to make sure
2997 * we match the longest possible smilie (:???: vs :?) as the regular
2998 * expression used below is first-match
3000 krsort($wpsmiliestrans);
3002 $spaces = wp_spaces_regexp();
3004 // Begin first "subpattern"
3005 $wp_smiliessearch = '/(?<=' . $spaces . '|^)';
3008 foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
3009 $firstchar = substr($smiley, 0, 1);
3010 $rest = substr($smiley, 1);
3013 if ($firstchar != $subchar) {
3014 if ($subchar != '') {
3015 $wp_smiliessearch .= ')(?=' . $spaces . '|$)'; // End previous "subpattern"
3016 $wp_smiliessearch .= '|(?<=' . $spaces . '|^)'; // Begin another "subpattern"
3018 $subchar = $firstchar;
3019 $wp_smiliessearch .= preg_quote($firstchar, '/') . '(?:';
3021 $wp_smiliessearch .= '|';
3023 $wp_smiliessearch .= preg_quote($rest, '/');
3026 $wp_smiliessearch .= ')(?=' . $spaces . '|$)/m';
3031 * Merge user defined arguments into defaults array.
3033 * This function is used throughout WordPress to allow for both string or array
3034 * to be merged into another array.
3038 * @param string|array $args Value to merge with $defaults
3039 * @param array $defaults Optional. Array that serves as the defaults. Default empty.
3040 * @return array Merged user defined values with defaults.
3042 function wp_parse_args( $args, $defaults = '' ) {
3043 if ( is_object( $args ) )
3044 $r = get_object_vars( $args );
3045 elseif ( is_array( $args ) )
3048 wp_parse_str( $args, $r );
3050 if ( is_array( $defaults ) )
3051 return array_merge( $defaults, $r );
3056 * Clean up an array, comma- or space-separated list of IDs.
3060 * @param array|string $list List of ids.
3061 * @return array Sanitized array of IDs.
3063 function wp_parse_id_list( $list ) {
3064 if ( !is_array($list) )
3065 $list = preg_split('/[\s,]+/', $list);
3067 return array_unique(array_map('absint', $list));
3071 * Extract a slice of an array, given a list of keys.
3075 * @param array $array The original array.
3076 * @param array $keys The list of keys.
3077 * @return array The array slice.
3079 function wp_array_slice_assoc( $array, $keys ) {
3081 foreach ( $keys as $key )
3082 if ( isset( $array[ $key ] ) )
3083 $slice[ $key ] = $array[ $key ];
3089 * Filters a list of objects, based on a set of key => value arguments.
3093 * @param array $list An array of objects to filter
3094 * @param array $args Optional. An array of key => value arguments to match
3095 * against each object. Default empty array.
3096 * @param string $operator Optional. The logical operation to perform. 'or' means
3097 * only one element from the array needs to match; 'and'
3098 * means all elements must match. Default 'and'.
3099 * @param bool|string $field A field from the object to place instead of the entire object.
3101 * @return array A list of objects or object fields.
3103 function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
3104 if ( ! is_array( $list ) )
3107 $list = wp_list_filter( $list, $args, $operator );
3110 $list = wp_list_pluck( $list, $field );
3116 * Filters a list of objects, based on a set of key => value arguments.
3120 * @param array $list An array of objects to filter.
3121 * @param array $args Optional. An array of key => value arguments to match
3122 * against each object. Default empty array.
3123 * @param string $operator Optional. The logical operation to perform. 'AND' means
3124 * all elements from the array must match. 'OR' means only
3125 * one element needs to match. 'NOT' means no elements may
3126 * match. Default 'AND'.
3127 * @return array Array of found values.
3129 function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
3130 if ( ! is_array( $list ) )
3133 if ( empty( $args ) )
3136 $operator = strtoupper( $operator );
3137 $count = count( $args );
3138 $filtered = array();
3140 foreach ( $list as $key => $obj ) {
3141 $to_match = (array) $obj;
3144 foreach ( $args as $m_key => $m_value ) {
3145 if ( array_key_exists( $m_key, $to_match ) && $m_value == $to_match[ $m_key ] )
3149 if ( ( 'AND' == $operator && $matched == $count )
3150 || ( 'OR' == $operator && $matched > 0 )
3151 || ( 'NOT' == $operator && 0 == $matched ) ) {
3152 $filtered[$key] = $obj;
3160 * Pluck a certain field out of each object in a list.
3162 * This has the same functionality and prototype of
3163 * array_column() (PHP 5.5) but also supports objects.
3166 * @since 4.0.0 $index_key parameter added.
3168 * @param array $list List of objects or arrays
3169 * @param int|string $field Field from the object to place instead of the entire object
3170 * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
3172 * @return array Array of found values. If $index_key is set, an array of found values with keys
3173 * corresponding to $index_key.
3175 function wp_list_pluck( $list, $field, $index_key = null ) {
3176 if ( ! $index_key ) {
3178 * This is simple. Could at some point wrap array_column()
3179 * if we knew we had an array of arrays.
3181 foreach ( $list as $key => $value ) {
3182 if ( is_object( $value ) ) {
3183 $list[ $key ] = $value->$field;
3185 $list[ $key ] = $value[ $field ];
3192 * When index_key is not set for a particular item, push the value
3193 * to the end of the stack. This is how array_column() behaves.
3196 foreach ( $list as $value ) {
3197 if ( is_object( $value ) ) {
3198 if ( isset( $value->$index_key ) ) {
3199 $newlist[ $value->$index_key ] = $value->$field;
3201 $newlist[] = $value->$field;
3204 if ( isset( $value[ $index_key ] ) ) {
3205 $newlist[ $value[ $index_key ] ] = $value[ $field ];
3207 $newlist[] = $value[ $field ];
3216 * Determines if Widgets library should be loaded.
3218 * Checks to make sure that the widgets library hasn't already been loaded.
3219 * If it hasn't, then it will load the widgets library and run an action hook.
3223 function wp_maybe_load_widgets() {
3225 * Filter whether to load the Widgets library.
3227 * Passing a falsey value to the filter will effectively short-circuit
3228 * the Widgets library from loading.
3232 * @param bool $wp_maybe_load_widgets Whether to load the Widgets library.
3235 if ( ! apply_filters( 'load_default_widgets', true ) ) {
3239 require_once( ABSPATH . WPINC . '/default-widgets.php' );
3241 add_action( '_admin_menu', 'wp_widgets_add_menu' );
3245 * Append the Widgets menu to the themes main menu.
3249 function wp_widgets_add_menu() {
3252 if ( ! current_theme_supports( 'widgets' ) )
3255 $submenu['themes.php'][7] = array( __( 'Widgets' ), 'edit_theme_options', 'widgets.php' );
3256 ksort( $submenu['themes.php'], SORT_NUMERIC );
3260 * Flush all output buffers for PHP 5.2.
3262 * Make sure all output buffers are flushed before our singletons are destroyed.
3266 function wp_ob_end_flush_all() {
3267 $levels = ob_get_level();
3268 for ($i=0; $i<$levels; $i++)
3273 * Load custom DB error or display WordPress DB error.
3275 * If a file exists in the wp-content directory named db-error.php, then it will
3276 * be loaded instead of displaying the WordPress DB error. If it is not found,
3277 * then the WordPress DB error will be displayed instead.
3279 * The WordPress DB error sets the HTTP status header to 500 to try to prevent
3280 * search engines from caching the message. Custom DB messages should do the
3283 * This function was backported to WordPress 2.3.2, but originally was added
3284 * in WordPress 2.5.0.
3288 * @global wpdb $wpdb WordPress database abstraction object.
3290 function dead_db() {
3293 wp_load_translations_early();
3295 // Load custom DB error template, if present.
3296 if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
3297 require_once( WP_CONTENT_DIR . '/db-error.php' );
3301 // If installing or in the admin, provide the verbose message.
3302 if ( defined('WP_INSTALLING') || defined('WP_ADMIN') )
3303 wp_die($wpdb->error);
3305 // Otherwise, be terse.
3306 status_header( 500 );
3308 header( 'Content-Type: text/html; charset=utf-8' );
3311 <html xmlns="http://www.w3.org/1999/xhtml"<?php if ( is_rtl() ) echo ' dir="rtl"'; ?>>
3313 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
3314 <title><?php _e( 'Database Error' ); ?></title>
3318 <h1><?php _e( 'Error establishing a database connection' ); ?></h1>
3326 * Convert a value to non-negative integer.
3330 * @param mixed $maybeint Data you wish to have converted to a non-negative integer.
3331 * @return int A non-negative integer.
3333 function absint( $maybeint ) {
3334 return abs( intval( $maybeint ) );
3338 * Mark a function as deprecated and inform when it has been used.
3340 * There is a hook deprecated_function_run that will be called that can be used
3341 * to get the backtrace up to what file and function called the deprecated
3344 * The current behavior is to trigger a user error if WP_DEBUG is true.
3346 * This function is to be used in every function that is deprecated.
3351 * @param string $function The function that was called.
3352 * @param string $version The version of WordPress that deprecated the function.
3353 * @param string $replacement Optional. The function that should have been called. Default null.
3355 function _deprecated_function( $function, $version, $replacement = null ) {
3358 * Fires when a deprecated function is called.
3362 * @param string $function The function that was called.
3363 * @param string $replacement The function that should have been called.
3364 * @param string $version The version of WordPress that deprecated the function.
3366 do_action( 'deprecated_function_run', $function, $replacement, $version );
3369 * Filter whether to trigger an error for deprecated functions.
3373 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
3375 if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
3376 if ( function_exists( '__' ) ) {
3377 if ( ! is_null( $replacement ) )
3378 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
3380 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
3382 if ( ! is_null( $replacement ) )
3383 trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $function, $version, $replacement ) );
3385 trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $function, $version ) );
3391 * Mark a file as deprecated and inform when it has been used.
3393 * There is a hook deprecated_file_included that will be called that can be used
3394 * to get the backtrace up to what file and function included the deprecated
3397 * The current behavior is to trigger a user error if WP_DEBUG is true.
3399 * This function is to be used in every file that is deprecated.
3404 * @param string $file The file that was included.
3405 * @param string $version The version of WordPress that deprecated the file.
3406 * @param string $replacement Optional. The file that should have been included based on ABSPATH.
3408 * @param string $message Optional. A message regarding the change. Default empty.
3410 function _deprecated_file( $file, $version, $replacement = null, $message = '' ) {
3413 * Fires when a deprecated file is called.
3417 * @param string $file The file that was called.
3418 * @param string $replacement The file that should have been included based on ABSPATH.
3419 * @param string $version The version of WordPress that deprecated the file.
3420 * @param string $message A message regarding the change.
3422 do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
3425 * Filter whether to trigger an error for deprecated files.
3429 * @param bool $trigger Whether to trigger the error for deprecated files. Default true.
3431 if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
3432 $message = empty( $message ) ? '' : ' ' . $message;
3433 if ( function_exists( '__' ) ) {
3434 if ( ! is_null( $replacement ) )
3435 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) . $message );
3437 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) . $message );
3439 if ( ! is_null( $replacement ) )
3440 trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $file, $version, $replacement ) . $message );
3442 trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $file, $version ) . $message );
3447 * Mark a function argument as deprecated and inform when it has been used.
3449 * This function is to be used whenever a deprecated function argument is used.
3450 * Before this function is called, the argument must be checked for whether it was
3451 * used by comparing it to its default value or evaluating whether it is empty.
3454 * if ( ! empty( $deprecated ) ) {
3455 * _deprecated_argument( __FUNCTION__, '3.0' );
3459 * There is a hook deprecated_argument_run that will be called that can be used
3460 * to get the backtrace up to what file and function used the deprecated
3463 * The current behavior is to trigger a user error if WP_DEBUG is true.
3468 * @param string $function The function that was called.
3469 * @param string $version The version of WordPress that deprecated the argument used.
3470 * @param string $message Optional. A message regarding the change. Default null.
3472 function _deprecated_argument( $function, $version, $message = null ) {
3475 * Fires when a deprecated argument is called.
3479 * @param string $function The function that was called.
3480 * @param string $message A message regarding the change.
3481 * @param string $version The version of WordPress that deprecated the argument used.
3483 do_action( 'deprecated_argument_run', $function, $message, $version );
3486 * Filter whether to trigger an error for deprecated arguments.
3490 * @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
3492 if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
3493 if ( function_exists( '__' ) ) {
3494 if ( ! is_null( $message ) )
3495 trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s'), $function, $version, $message ) );
3497 trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
3499 if ( ! is_null( $message ) )
3500 trigger_error( sprintf( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s', $function, $version, $message ) );
3502 trigger_error( sprintf( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.', $function, $version ) );
3508 * Mark something as being incorrectly called.
3510 * There is a hook doing_it_wrong_run that will be called that can be used
3511 * to get the backtrace up to what file and function called the deprecated
3514 * The current behavior is to trigger a user error if WP_DEBUG is true.
3519 * @param string $function The function that was called.
3520 * @param string $message A message explaining what has been done incorrectly.
3521 * @param string $version The version of WordPress where the message was added.
3523 function _doing_it_wrong( $function, $message, $version ) {
3526 * Fires when the given function is being used incorrectly.
3530 * @param string $function The function that was called.
3531 * @param string $message A message explaining what has been done incorrectly.
3532 * @param string $version The version of WordPress where the message was added.
3534 do_action( 'doing_it_wrong_run', $function, $message, $version );
3537 * Filter whether to trigger an error for _doing_it_wrong() calls.
3541 * @param bool $trigger Whether to trigger the error for _doing_it_wrong() calls. Default true.
3543 if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true ) ) {
3544 if ( function_exists( '__' ) ) {
3545 $version = is_null( $version ) ? '' : sprintf( __( '(This message was added in version %s.)' ), $version );
3546 $message .= ' ' . __( 'Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.' );
3547 trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) );
3549 $version = is_null( $version ) ? '' : sprintf( '(This message was added in version %s.)', $version );
3550 $message .= ' Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.';
3551 trigger_error( sprintf( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s', $function, $message, $version ) );
3557 * Is the server running earlier than 1.5.0 version of lighttpd?
3561 * @return bool Whether the server is running lighttpd < 1.5.0.
3563 function is_lighttpd_before_150() {
3564 $server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] )? $_SERVER['SERVER_SOFTWARE'] : '' );
3565 $server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : '';
3566 return 'lighttpd' == $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' );
3570 * Does the specified module exist in the Apache config?
3574 * @param string $mod The module, e.g. mod_rewrite.
3575 * @param bool $default Optional. The default return value if the module is not found. Default false.
3576 * @return bool Whether the specified module is loaded.
3578 function apache_mod_loaded($mod, $default = false) {
3584 if ( function_exists( 'apache_get_modules' ) ) {
3585 $mods = apache_get_modules();
3586 if ( in_array($mod, $mods) )
3588 } elseif ( function_exists( 'phpinfo' ) && false === strpos( ini_get( 'disable_functions' ), 'phpinfo' ) ) {
3591 $phpinfo = ob_get_clean();
3592 if ( false !== strpos($phpinfo, $mod) )
3599 * Check if IIS 7+ supports pretty permalinks.
3603 * @return bool Whether IIS7 supports permalinks.
3605 function iis7_supports_permalinks() {
3608 $supports_permalinks = false;
3610 /* First we check if the DOMDocument class exists. If it does not exist, then we cannot
3611 * easily update the xml configuration file, hence we just bail out and tell user that
3612 * pretty permalinks cannot be used.
3614 * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
3615 * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
3616 * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
3617 * via ISAPI then pretty permalinks will not work.
3619 $supports_permalinks = class_exists('DOMDocument') && isset($_SERVER['IIS_UrlRewriteModule']) && ( php_sapi_name() == 'cgi-fcgi' );
3623 * Filter whether IIS 7+ supports pretty permalinks.
3627 * @param bool $supports_permalinks Whether IIS7 supports permalinks. Default false.
3629 return apply_filters( 'iis7_supports_permalinks', $supports_permalinks );
3633 * File validates against allowed set of defined rules.
3635 * A return value of '1' means that the $file contains either '..' or './'. A
3636 * return value of '2' means that the $file contains ':' after the first
3637 * character. A return value of '3' means that the file is not in the allowed
3642 * @param string $file File path.
3643 * @param array $allowed_files List of allowed files.
3644 * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
3646 function validate_file( $file, $allowed_files = '' ) {
3647 if ( false !== strpos( $file, '..' ) )
3650 if ( false !== strpos( $file, './' ) )
3653 if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files ) )
3656 if (':' == substr( $file, 1, 1 ) )
3663 * Determine if SSL is used.
3667 * @return bool True if SSL, false if not used.
3670 if ( isset($_SERVER['HTTPS']) ) {
3671 if ( 'on' == strtolower($_SERVER['HTTPS']) )
3673 if ( '1' == $_SERVER['HTTPS'] )
3675 } elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
3682 * Whether SSL login should be forced.
3686 * @see force_ssl_admin()
3688 * @param string|bool $force Optional Whether to force SSL login. Default null.
3689 * @return bool True if forced, false if not forced.
3691 function force_ssl_login( $force = null ) {
3692 return force_ssl_admin( $force );
3696 * Whether to force SSL used for the Administration Screens.
3700 * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
3701 * @return bool True if forced, false if not forced.
3703 function force_ssl_admin( $force = null ) {
3704 static $forced = false;
3706 if ( !is_null( $force ) ) {
3707 $old_forced = $forced;