X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..aaf6ab9705b7f76e8b7d3a69f6fd52c173b6b3b8:/wp-includes/functions.php
diff --git a/wp-includes/functions.php b/wp-includes/functions.php
index c07069c1..01045f03 100644
--- a/wp-includes/functions.php
+++ b/wp-includes/functions.php
@@ -1,634 +1,806 @@
month) && !empty($wp_locale->weekday) && $translate ) {
- $datemonth = $wp_locale->get_month(date('m', $i));
- $datemonth_abbrev = $wp_locale->get_month_abbrev($datemonth);
- $dateweekday = $wp_locale->get_weekday(date('w', $i));
- $dateweekday_abbrev = $wp_locale->get_weekday_abbrev($dateweekday);
- $datemeridiem = $wp_locale->get_meridiem(date('a', $i));
- $datemeridiem_capital = $wp_locale->get_meridiem(date('A', $i));
- $dateformatstring = ' '.$dateformatstring;
- $dateformatstring = preg_replace("/([^\\\])D/", "\\1".backslashit($dateweekday_abbrev), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])F/", "\\1".backslashit($datemonth), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])l/", "\\1".backslashit($dateweekday), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])M/", "\\1".backslashit($datemonth_abbrev), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])a/", "\\1".backslashit($datemeridiem), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])A/", "\\1".backslashit($datemeridiem_capital), $dateformatstring);
+ if ( 'U' == $format )
+ return $i;
- $dateformatstring = substr($dateformatstring, 1, strlen($dateformatstring)-1);
- }
- $j = @date($dateformatstring, $i);
- if ( !$j ) {
- // for debug purposes
- // echo $i." ".$mysqlstring;
- }
- return $j;
+ if ( $translate )
+ return date_i18n( $format, $i );
+ else
+ return date( $format, $i );
}
-function current_time($type, $gmt = 0) {
- switch ($type) {
+/**
+ * Retrieve the current time based on specified type.
+ *
+ * The 'mysql' type will return the time in the format for MySQL DATETIME field.
+ * The 'timestamp' type will return the current timestamp.
+ * Other strings will be interpreted as PHP date formats (e.g. 'Y-m-d').
+ *
+ * If $gmt is set to either '1' or 'true', then both types will use GMT time.
+ * if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
+ *
+ * @since 1.0.0
+ *
+ * @param string $type Type of time to retrieve. Accepts 'mysql', 'timestamp', or PHP date
+ * format string (e.g. 'Y-m-d').
+ * @param int|bool $gmt Optional. Whether to use GMT timezone. Default false.
+ * @return int|string Integer if $type is 'timestamp', string otherwise.
+ */
+function current_time( $type, $gmt = 0 ) {
+ switch ( $type ) {
case 'mysql':
- if ( $gmt ) $d = gmdate('Y-m-d H:i:s');
- else $d = gmdate('Y-m-d H:i:s', (time() + (get_option('gmt_offset') * 3600)));
- return $d;
- break;
+ return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) ) );
case 'timestamp':
- if ( $gmt ) $d = time();
- else $d = time() + (get_option('gmt_offset') * 3600);
- return $d;
- break;
+ return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
+ default:
+ return ( $gmt ) ? date( $type ) : date( $type, time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );
}
}
-function date_i18n($dateformatstring, $unixtimestamp) {
+/**
+ * Retrieve the date in localized format, based on timestamp.
+ *
+ * If the locale specifies the locale month and weekday, then the locale will
+ * take over the format for the date. If it isn't, then the date format string
+ * will be used instead.
+ *
+ * @since 0.71
+ *
+ * @global WP_Locale $wp_locale
+ *
+ * @param string $dateformatstring Format to display the date.
+ * @param bool|int $unixtimestamp Optional. Unix timestamp. Default false.
+ * @param bool $gmt Optional. Whether to use GMT timezone. Default false.
+ *
+ * @return string The date, translated if locale specifies it.
+ */
+function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
global $wp_locale;
$i = $unixtimestamp;
- if ( (!empty($wp_locale->month)) && (!empty($wp_locale->weekday)) ) {
- $datemonth = $wp_locale->get_month(date('m', $i));
- $datemonth_abbrev = $wp_locale->get_month_abbrev($datemonth);
- $dateweekday = $wp_locale->get_weekday(date('w', $i));
- $dateweekday_abbrev = $wp_locale->get_weekday_abbrev($dateweekday);
- $datemeridiem = $wp_locale->get_meridiem(date('a', $i));
- $datemeridiem_capital = $wp_locale->get_meridiem(date('A', $i));
- $dateformatstring = ' '.$dateformatstring;
- $dateformatstring = preg_replace("/([^\\\])D/", "\\1".backslashit($dateweekday_abbrev), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])F/", "\\1".backslashit($datemonth), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])l/", "\\1".backslashit($dateweekday), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])M/", "\\1".backslashit($datemonth_abbrev), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])a/", "\\1".backslashit($datemeridiem), $dateformatstring);
- $dateformatstring = preg_replace("/([^\\\])A/", "\\1".backslashit($datemeridiem_capital), $dateformatstring);
- $dateformatstring = substr($dateformatstring, 1, strlen($dateformatstring)-1);
+ if ( false === $i ) {
+ $i = current_time( 'timestamp', $gmt );
+ }
+
+ /*
+ * Store original value for language with untypical grammars.
+ * See https://core.trac.wordpress.org/ticket/9396
+ */
+ $req_format = $dateformatstring;
+
+ if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
+ $datemonth = $wp_locale->get_month( date( 'm', $i ) );
+ $datemonth_abbrev = $wp_locale->get_month_abbrev( $datemonth );
+ $dateweekday = $wp_locale->get_weekday( date( 'w', $i ) );
+ $dateweekday_abbrev = $wp_locale->get_weekday_abbrev( $dateweekday );
+ $datemeridiem = $wp_locale->get_meridiem( date( 'a', $i ) );
+ $datemeridiem_capital = $wp_locale->get_meridiem( date( 'A', $i ) );
+ $dateformatstring = ' '.$dateformatstring;
+ $dateformatstring = preg_replace( "/([^\\\])D/", "\\1" . backslashit( $dateweekday_abbrev ), $dateformatstring );
+ $dateformatstring = preg_replace( "/([^\\\])F/", "\\1" . backslashit( $datemonth ), $dateformatstring );
+ $dateformatstring = preg_replace( "/([^\\\])l/", "\\1" . backslashit( $dateweekday ), $dateformatstring );
+ $dateformatstring = preg_replace( "/([^\\\])M/", "\\1" . backslashit( $datemonth_abbrev ), $dateformatstring );
+ $dateformatstring = preg_replace( "/([^\\\])a/", "\\1" . backslashit( $datemeridiem ), $dateformatstring );
+ $dateformatstring = preg_replace( "/([^\\\])A/", "\\1" . backslashit( $datemeridiem_capital ), $dateformatstring );
+
+ $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
+ }
+ $timezone_formats = array( 'P', 'I', 'O', 'T', 'Z', 'e' );
+ $timezone_formats_re = implode( '|', $timezone_formats );
+ if ( preg_match( "/$timezone_formats_re/", $dateformatstring ) ) {
+ $timezone_string = get_option( 'timezone_string' );
+ if ( $timezone_string ) {
+ $timezone_object = timezone_open( $timezone_string );
+ $date_object = date_create( null, $timezone_object );
+ foreach ( $timezone_formats as $timezone_format ) {
+ if ( false !== strpos( $dateformatstring, $timezone_format ) ) {
+ $formatted = date_format( $date_object, $timezone_format );
+ $dateformatstring = ' '.$dateformatstring;
+ $dateformatstring = preg_replace( "/([^\\\])$timezone_format/", "\\1" . backslashit( $formatted ), $dateformatstring );
+ $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
+ }
+ }
+ }
}
- $j = @date($dateformatstring, $i);
+ $j = @date( $dateformatstring, $i );
+
+ /**
+ * Filters the date formatted based on the locale.
+ *
+ * @since 2.8.0
+ *
+ * @param string $j Formatted date string.
+ * @param string $req_format Format to display the date.
+ * @param int $i Unix timestamp.
+ * @param bool $gmt Whether to convert to GMT for time. Default false.
+ */
+ $j = apply_filters( 'date_i18n', $j, $req_format, $i, $gmt );
return $j;
}
-function number_format_i18n($number, $decimals = null) {
+/**
+ * Determines if the date should be declined.
+ *
+ * If the locale specifies that month names require a genitive case in certain
+ * formats (like 'j F Y'), the month name will be replaced with a correct form.
+ *
+ * @since 4.4.0
+ *
+ * @param string $date Formatted date string.
+ * @return string The date, declined if locale specifies it.
+ */
+function wp_maybe_decline_date( $date ) {
global $wp_locale;
- // let the user override the precision only
- $decimals = is_null($decimals)? $wp_locale->number_format['decimals'] : intval($decimals);
-
- return number_format($number, $decimals, $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep']);
-}
-
-function size_format($bytes, $decimals = null) {
- // technically the correct unit names for powers of 1024 are KiB, MiB etc
- // see http://en.wikipedia.org/wiki/Byte
- $quant = array(
- 'TB' => pow(1024, 4),
- 'GB' => pow(1024, 3),
- 'MB' => pow(1024, 2),
- 'kB' => pow(1024, 1),
- 'B' => pow(1024, 0),
- );
-
- foreach ($quant as $unit => $mag)
- if ( intval($bytes) >= $mag )
- return number_format_i18n($bytes / $mag, $decimals) . ' ' . $unit;
-}
-function get_weekstartend($mysqlstring, $start_of_week) {
- $my = substr($mysqlstring,0,4);
- $mm = substr($mysqlstring,8,2);
- $md = substr($mysqlstring,5,2);
- $day = mktime(0,0,0, $md, $mm, $my);
- $weekday = date('w',$day);
- $i = 86400;
+ // i18n functions are not available in SHORTINIT mode
+ if ( ! function_exists( '_x' ) ) {
+ return $date;
+ }
- if ( $weekday < get_option('start_of_week') )
- $weekday = 7 - (get_option('start_of_week') - $weekday);
+ /* translators: If months in your language require a genitive case,
+ * translate this to 'on'. Do not translate into your own language.
+ */
+ if ( 'on' === _x( 'off', 'decline months names: on or off' ) ) {
+ // Match a format like 'j F Y' or 'j. F'
+ if ( @preg_match( '#^\d{1,2}\.? [^\d ]+#u', $date ) ) {
+ $months = $wp_locale->month;
+ $months_genitive = $wp_locale->month_genitive;
+
+ foreach ( $months as $key => $month ) {
+ $months[ $key ] = '# ' . $month . '( |$)#u';
+ }
- while ($weekday > get_option('start_of_week')) {
- $weekday = date('w',$day);
- if ( $weekday < get_option('start_of_week') )
- $weekday = 7 - (get_option('start_of_week') - $weekday);
+ foreach ( $months_genitive as $key => $month ) {
+ $months_genitive[ $key ] = ' ' . $month . '$1';
+ }
- $day = $day - 86400;
- $i = 0;
+ $date = preg_replace( $months, $months_genitive, $date );
+ }
}
- $week['start'] = $day + 86400 - $i;
- // $week['end'] = $day - $i + 691199;
- $week['end'] = $week['start'] + 604799;
- return $week;
-}
-function maybe_unserialize($original) {
- if ( is_serialized($original) ) // don't attempt to unserialize data that wasn't serialized going in
- if ( false !== $gm = @ unserialize($original) )
- return $gm;
- return $original;
-}
+ // Used for locale-specific rules
+ $locale = get_locale();
-function is_serialized($data) {
- // if it isn't a string, it isn't serialized
- if ( !is_string($data) )
- return false;
- $data = trim($data);
- if ( 'N;' == $data )
- return true;
- if ( !preg_match('/^([adObis]):/', $data, $badions) )
- return false;
- switch ( $badions[1] ) :
- case 'a' :
- case 'O' :
- case 's' :
- if ( preg_match("/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data) )
- return true;
- break;
- case 'b' :
- case 'i' :
- case 'd' :
- if ( preg_match("/^{$badions[1]}:[0-9.E-]+;\$/", $data) )
- return true;
- break;
- endswitch;
- return false;
-}
+ if ( 'ca' === $locale ) {
+ // " de abril| de agost| de octubre..." -> " d'abril| d'agost| d'octubre..."
+ $date = preg_replace( '# de ([ao])#i', " d'\\1", $date );
+ }
-function is_serialized_string($data) {
- // if it isn't a string, it isn't a serialized string
- if ( !is_string($data) )
- return false;
- $data = trim($data);
- if ( preg_match('/^s:[0-9]+:.*;$/s',$data) ) // this should fetch all serialized strings
- return true;
- return false;
+ return $date;
}
-/* Options functions */
-
-// expects $setting to already be SQL-escaped
-function get_option($setting) {
- global $wpdb;
-
- // Allow plugins to short-circuit options.
- $pre = apply_filters( 'pre_option_' . $setting, false );
- if ( false !== $pre )
- return $pre;
-
- // prevent non-existent options from triggering multiple queries
- $notoptions = wp_cache_get('notoptions', 'options');
- if ( isset($notoptions[$setting]) )
- return false;
-
- $alloptions = wp_load_alloptions();
+/**
+ * Convert float number to format based on the locale.
+ *
+ * @since 2.3.0
+ *
+ * @global WP_Locale $wp_locale
+ *
+ * @param float $number The number to convert based on locale.
+ * @param int $decimals Optional. Precision of the number of decimal places. Default 0.
+ * @return string Converted number in string format.
+ */
+function number_format_i18n( $number, $decimals = 0 ) {
+ global $wp_locale;
- if ( isset($alloptions[$setting]) ) {
- $value = $alloptions[$setting];
+ if ( isset( $wp_locale ) ) {
+ $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
} else {
- $value = wp_cache_get($setting, 'options');
-
- if ( false === $value ) {
- if ( defined('WP_INSTALLING') )
- $show = $wpdb->hide_errors();
- $row = $wpdb->get_row("SELECT option_value FROM $wpdb->options WHERE option_name = '$setting' LIMIT 1");
- if ( defined('WP_INSTALLING') )
- $wpdb->show_errors($show);
-
- if( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
- $value = $row->option_value;
- wp_cache_add($setting, $value, 'options');
- } else { // option does not exist, so we must cache its non-existence
- $notoptions[$setting] = true;
- wp_cache_set('notoptions', $notoptions, 'options');
- return false;
- }
- }
+ $formatted = number_format( $number, absint( $decimals ) );
}
- // If home is not set use siteurl.
- if ( 'home' == $setting && '' == $value )
- return get_option('siteurl');
-
- if ( in_array($setting, array('siteurl', 'home', 'category_base', 'tag_base')) )
- $value = untrailingslashit($value);
-
- return apply_filters( 'option_' . $setting, maybe_unserialize($value) );
-}
-
-function wp_protect_special_option($option) {
- $protected = array('alloptions', 'notoptions');
- if ( in_array($option, $protected) )
- die(sprintf(__('%s is a protected WP option and may not be modified'), wp_specialchars($option)));
+ /**
+ * Filters the number formatted based on the locale.
+ *
+ * @since 2.8.0
+ *
+ * @param string $formatted Converted number in string format.
+ */
+ return apply_filters( 'number_format_i18n', $formatted );
}
-function form_option($option) {
- echo attribute_escape(get_option($option));
-}
+/**
+ * Convert number of bytes largest unit bytes will fit into.
+ *
+ * It is easier to read 1 KB than 1024 bytes and 1 MB than 1048576 bytes. Converts
+ * number of bytes to human readable number by taking the number of that unit
+ * that the bytes will go into it. Supports TB value.
+ *
+ * Please note that integers in PHP are limited to 32 bits, unless they are on
+ * 64 bit architecture, then they have 64 bit size. If you need to place the
+ * larger size then what PHP integer type will hold, then use a string. It will
+ * be converted to a double, which should always have 64 bit length.
+ *
+ * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
+ *
+ * @since 2.3.0
+ *
+ * @param int|string $bytes Number of bytes. Note max integer size for integers.
+ * @param int $decimals Optional. Precision of number of decimal places. Default 0.
+ * @return string|false False on failure. Number string on success.
+ */
+function size_format( $bytes, $decimals = 0 ) {
+ $quant = array(
+ 'TB' => TB_IN_BYTES,
+ 'GB' => GB_IN_BYTES,
+ 'MB' => MB_IN_BYTES,
+ 'KB' => KB_IN_BYTES,
+ 'B' => 1,
+ );
-function get_alloptions() {
- global $wpdb, $wp_queries;
- $show = $wpdb->hide_errors();
- if ( !$options = $wpdb->get_results("SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'") ) {
- $options = $wpdb->get_results("SELECT option_name, option_value FROM $wpdb->options");
+ if ( 0 === $bytes ) {
+ return number_format_i18n( 0, $decimals ) . ' B';
}
- $wpdb->show_errors($show);
- foreach ($options as $option) {
- // "When trying to design a foolproof system,
- // never underestimate the ingenuity of the fools :)" -- Dougal
- if ( 'siteurl' == $option->option_name )
- $option->option_value = preg_replace('|/+$|', '', $option->option_value);
- if ( 'home' == $option->option_name )
- $option->option_value = preg_replace('|/+$|', '', $option->option_value);
- if ( 'category_base' == $option->option_name )
- $option->option_value = preg_replace('|/+$|', '', $option->option_value);
- $value = maybe_unserialize($option->option_value);
- $all_options->{$option->option_name} = apply_filters('pre_option_' . $option->option_name, $value);
+ foreach ( $quant as $unit => $mag ) {
+ if ( doubleval( $bytes ) >= $mag ) {
+ return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
+ }
}
- return apply_filters('all_options', $all_options);
-}
-function wp_load_alloptions() {
- global $wpdb;
+ return false;
+}
- $alloptions = wp_cache_get('alloptions', 'options');
+/**
+ * Get the week start and end from the datetime or date string from MySQL.
+ *
+ * @since 0.71
+ *
+ * @param string $mysqlstring Date or datetime field type from MySQL.
+ * @param int|string $start_of_week Optional. Start of the week as an integer. Default empty string.
+ * @return array Keys are 'start' and 'end'.
+ */
+function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
+ // MySQL string year.
+ $my = substr( $mysqlstring, 0, 4 );
- if ( !$alloptions ) {
- $show = $wpdb->hide_errors();
- if ( !$alloptions_db = $wpdb->get_results("SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'") )
- $alloptions_db = $wpdb->get_results("SELECT option_name, option_value FROM $wpdb->options");
- $wpdb->show_errors($show);
- $alloptions = array();
- foreach ( (array) $alloptions_db as $o )
- $alloptions[$o->option_name] = $o->option_value;
- wp_cache_add('alloptions', $alloptions, 'options');
- }
- return $alloptions;
-}
+ // MySQL string month.
+ $mm = substr( $mysqlstring, 8, 2 );
-// expects $option_name to NOT be SQL-escaped
-function update_option($option_name, $newvalue) {
- global $wpdb;
+ // MySQL string day.
+ $md = substr( $mysqlstring, 5, 2 );
- wp_protect_special_option($option_name);
+ // The timestamp for MySQL string day.
+ $day = mktime( 0, 0, 0, $md, $mm, $my );
- $safe_option_name = $wpdb->escape($option_name);
- $newvalue = sanitize_option($option_name, $newvalue);
+ // The day of the week from the timestamp.
+ $weekday = date( 'w', $day );
- if ( is_string($newvalue) )
- $newvalue = trim($newvalue);
+ if ( !is_numeric($start_of_week) )
+ $start_of_week = get_option( 'start_of_week' );
- // If the new and old values are the same, no need to update.
- $oldvalue = get_option($safe_option_name);
- if ( $newvalue === $oldvalue ) {
- return false;
- }
+ if ( $weekday < $start_of_week )
+ $weekday += 7;
- if ( false === $oldvalue ) {
- add_option($option_name, $newvalue);
- return true;
- }
+ // The most recent week start day on or before $day.
+ $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week );
- $notoptions = wp_cache_get('notoptions', 'options');
- if ( is_array($notoptions) && isset($notoptions[$option_name]) ) {
- unset($notoptions[$option_name]);
- wp_cache_set('notoptions', $notoptions, 'options');
- }
+ // $start + 1 week - 1 second.
+ $end = $start + WEEK_IN_SECONDS - 1;
+ return compact( 'start', 'end' );
+}
- $_newvalue = $newvalue;
- $newvalue = maybe_serialize($newvalue);
+/**
+ * Unserialize value only if it was serialized.
+ *
+ * @since 2.0.0
+ *
+ * @param string $original Maybe unserialized original, if is needed.
+ * @return mixed Unserialized data can be any type.
+ */
+function maybe_unserialize( $original ) {
+ if ( is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
+ return @unserialize( $original );
+ return $original;
+}
- $alloptions = wp_load_alloptions();
- if ( isset($alloptions[$option_name]) ) {
- $alloptions[$option_name] = $newvalue;
- wp_cache_set('alloptions', $alloptions, 'options');
- } else {
- wp_cache_set($option_name, $newvalue, 'options');
+/**
+ * Check value to find if it was serialized.
+ *
+ * If $data is not an string, then returned value will always be false.
+ * Serialized data is always a string.
+ *
+ * @since 2.0.5
+ *
+ * @param string $data Value to check to see if was serialized.
+ * @param bool $strict Optional. Whether to be strict about the end of the string. Default true.
+ * @return bool False if not serialized and true if it was.
+ */
+function is_serialized( $data, $strict = true ) {
+ // if it isn't a string, it isn't serialized.
+ if ( ! is_string( $data ) ) {
+ return false;
}
-
- $newvalue = $wpdb->escape($newvalue);
- $option_name = $wpdb->escape($option_name);
- $wpdb->query("UPDATE $wpdb->options SET option_value = '$newvalue' WHERE option_name = '$option_name'");
- if ( $wpdb->rows_affected == 1 ) {
- do_action("update_option_{$option_name}", $oldvalue, $_newvalue);
+ $data = trim( $data );
+ if ( 'N;' == $data ) {
return true;
}
- return false;
-}
-
-// thx Alex Stapleton, http://alex.vort-x.net/blog/
-// expects $name to NOT be SQL-escaped
-function add_option($name, $value = '', $deprecated = '', $autoload = 'yes') {
- global $wpdb;
-
- wp_protect_special_option($name);
- $safe_name = $wpdb->escape($name);
-
- // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query
- $notoptions = wp_cache_get('notoptions', 'options');
- if ( !is_array($notoptions) || !isset($notoptions[$name]) )
- if ( false !== get_option($safe_name) )
- return;
-
- $value = maybe_serialize($value);
- $autoload = ( 'no' === $autoload ) ? 'no' : 'yes';
-
- if ( 'yes' == $autoload ) {
- $alloptions = wp_load_alloptions();
- $alloptions[$name] = $value;
- wp_cache_set('alloptions', $alloptions, 'options');
- } else {
- wp_cache_set($name, $value, 'options');
+ if ( strlen( $data ) < 4 ) {
+ return false;
}
-
- // This option exists now
- $notoptions = wp_cache_get('notoptions', 'options'); // yes, again... we need it to be fresh
- if ( is_array($notoptions) && isset($notoptions[$name]) ) {
- unset($notoptions[$name]);
- wp_cache_set('notoptions', $notoptions, 'options');
+ if ( ':' !== $data[1] ) {
+ return false;
}
-
- $name = $wpdb->escape($name);
- $value = $wpdb->escape($value);
- $wpdb->query("INSERT INTO $wpdb->options (option_name, option_value, autoload) VALUES ('$name', '$value', '$autoload')");
-
- return;
-}
-
-function delete_option($name) {
- global $wpdb;
-
- wp_protect_special_option($name);
-
- // Get the ID, if no ID then return
- $option = $wpdb->get_row("SELECT option_id, autoload FROM $wpdb->options WHERE option_name = '$name'");
- if ( !$option->option_id ) return false;
- $wpdb->query("DELETE FROM $wpdb->options WHERE option_name = '$name'");
- if ( 'yes' == $option->autoload ) {
- $alloptions = wp_load_alloptions();
- if ( isset($alloptions[$name]) ) {
- unset($alloptions[$name]);
- wp_cache_set('alloptions', $alloptions, 'options');
+ if ( $strict ) {
+ $lastc = substr( $data, -1 );
+ if ( ';' !== $lastc && '}' !== $lastc ) {
+ return false;
}
} else {
- wp_cache_delete($name, 'options');
+ $semicolon = strpos( $data, ';' );
+ $brace = strpos( $data, '}' );
+ // Either ; or } must exist.
+ if ( false === $semicolon && false === $brace )
+ return false;
+ // But neither must be in the first X characters.
+ if ( false !== $semicolon && $semicolon < 3 )
+ return false;
+ if ( false !== $brace && $brace < 4 )
+ return false;
}
- return true;
-}
-
-function maybe_serialize($data) {
- if ( is_string($data) )
- $data = trim($data);
- elseif ( is_array($data) || is_object($data) )
- return serialize($data);
- if ( is_serialized($data) )
- return serialize($data);
- return $data;
+ $token = $data[0];
+ switch ( $token ) {
+ case 's' :
+ if ( $strict ) {
+ if ( '"' !== substr( $data, -2, 1 ) ) {
+ return false;
+ }
+ } elseif ( false === strpos( $data, '"' ) ) {
+ return false;
+ }
+ // or else fall through
+ case 'a' :
+ case 'O' :
+ return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
+ case 'b' :
+ case 'i' :
+ case 'd' :
+ $end = $strict ? '$' : '';
+ return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data );
+ }
+ return false;
}
-function gzip_compression() {
- if ( !get_option( 'gzipcompression' ) ) {
+/**
+ * Check whether serialized data is of string type.
+ *
+ * @since 2.0.5
+ *
+ * @param string $data Serialized data.
+ * @return bool False if not a serialized string, true if it is.
+ */
+function is_serialized_string( $data ) {
+ // if it isn't a string, it isn't a serialized string.
+ if ( ! is_string( $data ) ) {
return false;
}
-
- if ( ( ini_get( 'zlib.output_compression' ) == 'On' || ini_get( 'zlib.output_compression_level' ) > 0 ) || ini_get( 'output_handler' ) == 'ob_gzhandler' ) {
+ $data = trim( $data );
+ if ( strlen( $data ) < 4 ) {
return false;
- }
-
- if ( extension_loaded( 'zlib' ) ) {
- ob_start( 'ob_gzhandler' );
+ } elseif ( ':' !== $data[1] ) {
+ return false;
+ } elseif ( ';' !== substr( $data, -1 ) ) {
+ return false;
+ } elseif ( $data[0] !== 's' ) {
+ return false;
+ } elseif ( '"' !== substr( $data, -2, 1 ) ) {
+ return false;
+ } else {
+ return true;
}
}
-function make_url_footnote($content) {
- preg_match_all('/(.+?)<\/a>/', $content, $matches);
- $j = 0;
- for ($i=0; $i(.+?)<\/title>/is', $content, $matchtitle) ) {
- $post_title = $matchtitle[0];
- $post_title = preg_replace('//si', '', $post_title);
- $post_title = preg_replace('/<\/title>/si', '', $post_title);
+ if ( preg_match( '/(.+?)<\/title>/is', $content, $matchtitle ) ) {
+ $post_title = $matchtitle[1];
} else {
$post_title = $post_default_title;
}
return $post_title;
}
-function xmlrpc_getpostcategory($content) {
+/**
+ * Retrieve the post category or categories from XMLRPC XML.
+ *
+ * If the category element is not found, then the default post category will be
+ * used. The return type then would be what $post_default_category. If the
+ * category is found, then it will always be an array.
+ *
+ * @since 0.71
+ *
+ * @global string $post_default_category Default XML-RPC post category.
+ *
+ * @param string $content XMLRPC XML Request content
+ * @return string|array List of categories or category name.
+ */
+function xmlrpc_getpostcategory( $content ) {
global $post_default_category;
- if ( preg_match('/(.+?)<\/category>/is', $content, $matchcat) ) {
- $post_category = trim($matchcat[1], ',');
- $post_category = explode(',', $post_category);
+ if ( preg_match( '/(.+?)<\/category>/is', $content, $matchcat ) ) {
+ $post_category = trim( $matchcat[1], ',' );
+ $post_category = explode( ',', $post_category );
} else {
$post_category = $post_default_category;
}
return $post_category;
}
-function xmlrpc_removepostdata($content) {
- $content = preg_replace('/(.+?)<\/title>/si', '', $content);
- $content = preg_replace('/(.+?)<\/category>/si', '', $content);
- $content = trim($content);
+/**
+ * XMLRPC XML content without title and category elements.
+ *
+ * @since 0.71
+ *
+ * @param string $content XML-RPC XML Request content.
+ * @return string XMLRPC XML Request content without title and category elements.
+ */
+function xmlrpc_removepostdata( $content ) {
+ $content = preg_replace( '/(.+?)<\/title>/si', '', $content );
+ $content = preg_replace( '/(.+?)<\/category>/si', '', $content );
+ $content = trim( $content );
return $content;
}
-function debug_fopen($filename, $mode) {
- global $debug;
- if ( $debug == 1 ) {
- $fp = fopen($filename, $mode);
- return $fp;
- } else {
- return false;
- }
-}
+/**
+ * Use RegEx to extract URLs from arbitrary content.
+ *
+ * @since 3.7.0
+ *
+ * @param string $content Content to extract URLs from.
+ * @return array URLs found in passed string.
+ */
+function wp_extract_urls( $content ) {
+ preg_match_all(
+ "#([\"']?)("
+ . "(?:([\w-]+:)?//?)"
+ . "[^\s()<>]+"
+ . "[.]"
+ . "(?:"
+ . "\([\w\d]+\)|"
+ . "(?:"
+ . "[^`!()\[\]{};:'\".,<>«»ââââ\s]|"
+ . "(?:[:]\d+)?/?"
+ . ")+"
+ . ")"
+ . ")\\1#",
+ $content,
+ $post_links
+ );
-function debug_fwrite($fp, $string) {
- global $debug;
- if ( $debug == 1 ) {
- fwrite($fp, $string);
- }
-}
+ $post_links = array_unique( array_map( 'html_entity_decode', $post_links[2] ) );
-function debug_fclose($fp) {
- global $debug;
- if ( $debug == 1 ) {
- fclose($fp);
- }
+ return array_values( $post_links );
}
+/**
+ * Check content for video and audio links to add as enclosures.
+ *
+ * Will not add enclosures that have already been added and will
+ * remove enclosures that are no longer in the post. This is called as
+ * pingbacks and trackbacks.
+ *
+ * @since 1.5.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $content Post Content.
+ * @param int $post_ID Post ID.
+ */
function do_enclose( $content, $post_ID ) {
- global $wp_version, $wpdb;
- include_once (ABSPATH . WPINC . '/class-IXR.php');
+ global $wpdb;
+
+ //TODO: Tidy this ghetto code up and make the debug code optional
+ include_once( ABSPATH . WPINC . '/class-IXR.php' );
- $log = debug_fopen(ABSPATH . 'enclosures.log', 'a');
$post_links = array();
- debug_fwrite($log, 'BEGIN '.date('YmdHis', time())."\n");
$pung = get_enclosed( $post_ID );
- $ltrs = '\w';
- $gunk = '/#~:.?+=&%@!\-';
- $punc = '.:?\-';
- $any = $ltrs . $gunk . $punc;
+ $post_links_temp = wp_extract_urls( $content );
- preg_match_all("{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp);
-
- debug_fwrite($log, 'Post contents:');
- debug_fwrite($log, $content."\n");
+ foreach ( $pung as $link_test ) {
+ if ( ! in_array( $link_test, $post_links_temp ) ) { // link no longer in post
+ $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 ) . '%') );
+ foreach ( $mids as $mid )
+ delete_metadata_by_mid( 'post', $mid );
+ }
+ }
- foreach($post_links_temp[0] as $link_test) :
- if ( !in_array($link_test, $pung) ) : // If we haven't pung it already
- $test = parse_url($link_test);
- if ( isset($test['query']) )
+ foreach ( (array) $post_links_temp as $link_test ) {
+ if ( !in_array( $link_test, $pung ) ) { // If we haven't pung it already
+ $test = @parse_url( $link_test );
+ if ( false === $test )
+ continue;
+ if ( isset( $test['query'] ) )
$post_links[] = $link_test;
- elseif (($test['path'] != '/') && ($test['path'] != ''))
+ elseif ( isset($test['path']) && ( $test['path'] != '/' ) && ($test['path'] != '' ) )
$post_links[] = $link_test;
- endif;
- endforeach;
+ }
+ }
+
+ /**
+ * Filters the list of enclosure links before querying the database.
+ *
+ * Allows for the addition and/or removal of potential enclosures to save
+ * to postmeta before checking the database for existing enclosures.
+ *
+ * @since 4.4.0
+ *
+ * @param array $post_links An array of enclosure links.
+ * @param int $post_ID Post ID.
+ */
+ $post_links = apply_filters( 'enclosure_links', $post_links, $post_ID );
+
+ foreach ( (array) $post_links as $url ) {
+ 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 ) . '%' ) ) ) {
- foreach ($post_links as $url) :
- if ( $url != '' && !$wpdb->get_var("SELECT post_id FROM $wpdb->postmeta WHERE post_id = '$post_ID' AND meta_key = 'enclosure' AND meta_value LIKE ('$url%')") ) {
if ( $headers = wp_get_http_headers( $url) ) {
- $len = (int) $headers['content-length'];
- $type = $wpdb->escape( $headers['content-type'] );
+ $len = isset( $headers['content-length'] ) ? (int) $headers['content-length'] : 0;
+ $type = isset( $headers['content-type'] ) ? $headers['content-type'] : '';
$allowed_types = array( 'video', 'audio' );
+
+ // Check to see if we can figure out the mime type from
+ // the extension
+ $url_parts = @parse_url( $url );
+ if ( false !== $url_parts ) {
+ $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );
+ if ( !empty( $extension ) ) {
+ foreach ( wp_get_mime_types() as $exts => $mime ) {
+ if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
+ $type = $mime;
+ break;
+ }
+ }
+ }
+ }
+
if ( in_array( substr( $type, 0, strpos( $type, "/" ) ), $allowed_types ) ) {
- $meta_value = "$url\n$len\n$type\n";
- $wpdb->query( "INSERT INTO `$wpdb->postmeta` ( `post_id` , `meta_key` , `meta_value` )
- VALUES ( '$post_ID', 'enclosure' , '$meta_value')" );
+ add_post_meta( $post_ID, 'enclosure', "$url\n$len\n$mime\n" );
}
}
}
- endforeach;
+ }
}
-function wp_get_http_headers( $url, $red = 1 ) {
- global $wp_version;
- @set_time_limit( 60 );
-
- if ( $red > 5 )
- return false;
-
- $parts = parse_url( $url );
- $file = $parts['path'] . ($parts['query'] ? '?'.$parts['query'] : '');
- $host = $parts['host'];
- if ( !isset( $parts['port'] ) )
- $parts['port'] = 80;
-
- $head = "HEAD $file HTTP/1.1\r\nHOST: $host\r\nUser-Agent: WordPress/" . $wp_version . "\r\n\r\n";
-
- $fp = @fsockopen($host, $parts['port'], $err_num, $err_msg, 3);
- if ( !$fp )
+/**
+ * Retrieve HTTP Headers from URL.
+ *
+ * @since 1.5.1
+ *
+ * @param string $url URL to retrieve HTTP headers from.
+ * @param bool $deprecated Not Used.
+ * @return bool|string False on failure, headers on success.
+ */
+function wp_get_http_headers( $url, $deprecated = false ) {
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '2.7.0' );
+
+ $response = wp_safe_remote_head( $url );
+
+ if ( is_wp_error( $response ) )
return false;
- $response = '';
- fputs( $fp, $head );
- while ( !feof( $fp ) && strpos( $response, "\r\n\r\n" ) == false )
- $response .= fgets( $fp, 2048 );
- fclose( $fp );
- preg_match_all('/(.*?): (.*)\r/', $response, $matches);
- $count = count($matches[1]);
- for ( $i = 0; $i < $count; $i++) {
- $key = strtolower($matches[1][$i]);
- $headers["$key"] = $matches[2][$i];
- }
-
- preg_match('/.*([0-9]{3}).*/', $response, $return);
- $headers['response'] = $return[1]; // HTTP response code eg 204, 200, 404
-
- $code = $headers['response'];
- if ( ('302' == $code || '301' == $code) && isset($headers['location']) )
- return wp_get_http_headers( $headers['location'], ++$red );
-
- return $headers;
+ return wp_remote_retrieve_headers( $response );
}
+/**
+ * Whether the publish date of the current post in the loop is different from the
+ * publish date of the previous post in the loop.
+ *
+ * @since 0.71
+ *
+ * @global string $currentday The day of the current post in the loop.
+ * @global string $previousday The day of the previous post in the loop.
+ *
+ * @return int 1 when new day, 0 if not a new day.
+ */
function is_new_day() {
- global $day, $previousday;
- if ( $day != $previousday ) {
- return(1);
- } else {
- return(0);
- }
+ global $currentday, $previousday;
+ if ( $currentday != $previousday )
+ return 1;
+ else
+ return 0;
}
-function build_query($data) {
- return _http_build_query($data, NULL, '&', '', false);
+/**
+ * Build URL query based on an associative and, or indexed array.
+ *
+ * This is a convenient function for easily building url queries. It sets the
+ * separator to '&' and uses _http_build_query() function.
+ *
+ * @since 2.3.0
+ *
+ * @see _http_build_query() Used to build the query
+ * @link https://secure.php.net/manual/en/function.http-build-query.php for more on what
+ * http_build_query() does.
+ *
+ * @param array $data URL-encode key/value pairs.
+ * @return string URL-encoded string.
+ */
+function build_query( $data ) {
+ return _http_build_query( $data, null, '&', '', false );
}
-/*
-add_query_arg: Returns a modified querystring by adding
-a single key & value or an associative array.
-Setting a key value to emptystring removes the key.
-Omitting oldquery_or_uri uses the $_SERVER value.
+/**
+ * From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
+ *
+ * @since 3.2.0
+ * @access private
+ *
+ * @see https://secure.php.net/manual/en/function.http-build-query.php
+ *
+ * @param array|object $data An array or object of data. Converted to array.
+ * @param string $prefix Optional. Numeric index. If set, start parameter numbering with it.
+ * Default null.
+ * @param string $sep Optional. Argument separator; defaults to 'arg_separator.output'.
+ * Default null.
+ * @param string $key Optional. Used to prefix key name. Default empty.
+ * @param bool $urlencode Optional. Whether to use urlencode() in the result. Default true.
+ *
+ * @return string The query string.
+ */
+function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urlencode = true ) {
+ $ret = array();
+
+ foreach ( (array) $data as $k => $v ) {
+ if ( $urlencode)
+ $k = urlencode($k);
+ if ( is_int($k) && $prefix != null )
+ $k = $prefix.$k;
+ if ( !empty($key) )
+ $k = $key . '%5B' . $k . '%5D';
+ if ( $v === null )
+ continue;
+ elseif ( $v === false )
+ $v = '0';
+
+ if ( is_array($v) || is_object($v) )
+ array_push($ret,_http_build_query($v, '', $sep, $k, $urlencode));
+ elseif ( $urlencode )
+ array_push($ret, $k.'='.urlencode($v));
+ else
+ array_push($ret, $k.'='.$v);
+ }
+
+ if ( null === $sep )
+ $sep = ini_get('arg_separator.output');
+
+ return implode($sep, $ret);
+}
-Parameters:
-add_query_arg(newkey, newvalue, oldquery_or_uri) or
-add_query_arg(associative_array, oldquery_or_uri)
-*/
+/**
+ * Retrieves a modified URL query string.
+ *
+ * You can rebuild the URL and append query variables to the URL query by using this function.
+ * There are two ways to use this function; either a single key and value, or an associative array.
+ *
+ * Using a single key and value:
+ *
+ * add_query_arg( 'key', 'value', 'http://example.com' );
+ *
+ * Using an associative array:
+ *
+ * add_query_arg( array(
+ * 'key1' => 'value1',
+ * 'key2' => 'value2',
+ * ), 'http://example.com' );
+ *
+ * Omitting the URL from either use results in the current URL being used
+ * (the value of `$_SERVER['REQUEST_URI']`).
+ *
+ * Values are expected to be encoded appropriately with urlencode() or rawurlencode().
+ *
+ * Setting any query variable's value to boolean false removes the key (see remove_query_arg()).
+ *
+ * Important: The return value of add_query_arg() is not escaped by default. Output should be
+ * late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting
+ * (XSS) attacks.
+ *
+ * @since 1.5.0
+ *
+ * @param string|array $key Either a query variable key, or an associative array of query variables.
+ * @param string $value Optional. Either a query variable value, or a URL to act upon.
+ * @param string $url Optional. A URL to act upon.
+ * @return string New URL query string (unescaped).
+ */
function add_query_arg() {
- $ret = '';
- if ( is_array(func_get_arg(0)) ) {
- if ( @func_num_args() < 2 || false === @func_get_arg(1) )
+ $args = func_get_args();
+ if ( is_array( $args[0] ) ) {
+ if ( count( $args ) < 2 || false === $args[1] )
$uri = $_SERVER['REQUEST_URI'];
else
- $uri = @func_get_arg(1);
+ $uri = $args[1];
} else {
- if ( @func_num_args() < 3 || false === @func_get_arg(2) )
+ if ( count( $args ) < 3 || false === $args[2] )
$uri = $_SERVER['REQUEST_URI'];
else
- $uri = @func_get_arg(2);
+ $uri = $args[2];
}
- if ( $frag = strstr($uri, '#') )
- $uri = substr($uri, 0, -strlen($frag));
+ if ( $frag = strstr( $uri, '#' ) )
+ $uri = substr( $uri, 0, -strlen( $frag ) );
else
$frag = '';
- if ( preg_match('|^https?://|i', $uri, $matches) ) {
- $protocol = $matches[0];
- $uri = substr($uri, strlen($protocol));
+ if ( 0 === stripos( $uri, 'http://' ) ) {
+ $protocol = 'http://';
+ $uri = substr( $uri, 7 );
+ } elseif ( 0 === stripos( $uri, 'https://' ) ) {
+ $protocol = 'https://';
+ $uri = substr( $uri, 8 );
} else {
$protocol = '';
}
- if (strpos($uri, '?') !== false) {
- $parts = explode('?', $uri, 2);
- if ( 1 == count($parts) ) {
- $base = '?';
- $query = $parts[0];
- } else {
- $base = $parts[0] . '?';
- $query = $parts[1];
- }
- } elseif (!empty($protocol) || strpos($uri, '=') === false ) {
+ if ( strpos( $uri, '?' ) !== false ) {
+ list( $base, $query ) = explode( '?', $uri, 2 );
+ $base .= '?';
+ } elseif ( $protocol || strpos( $uri, '=' ) === false ) {
$base = $uri . '?';
$query = '';
} else {
@@ -636,113 +808,176 @@ function add_query_arg() {
$query = $uri;
}
- wp_parse_str($query, $qs);
- $qs = urlencode_deep($qs); // this re-URL-encodes things that were already in the query string
- if ( is_array(func_get_arg(0)) ) {
- $kayvees = func_get_arg(0);
- $qs = array_merge($qs, $kayvees);
+ wp_parse_str( $query, $qs );
+ $qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
+ if ( is_array( $args[0] ) ) {
+ foreach ( $args[0] as $k => $v ) {
+ $qs[ $k ] = $v;
+ }
} else {
- $qs[func_get_arg(0)] = func_get_arg(1);
+ $qs[ $args[0] ] = $args[1];
}
foreach ( $qs as $k => $v ) {
if ( $v === false )
- unset($qs[$k]);
+ unset( $qs[$k] );
}
- $ret = build_query($qs);
- $ret = trim($ret, '?');
- $ret = preg_replace('#=(&|$)#', '$1', $ret);
+ $ret = build_query( $qs );
+ $ret = trim( $ret, '?' );
+ $ret = preg_replace( '#=(&|$)#', '$1', $ret );
$ret = $protocol . $base . $ret . $frag;
- $ret = rtrim($ret, '?');
+ $ret = rtrim( $ret, '?' );
return $ret;
}
-/*
-remove_query_arg: Returns a modified querystring by removing
-a single key or an array of keys.
-Omitting oldquery_or_uri uses the $_SERVER value.
-
-Parameters:
-remove_query_arg(removekey, [oldquery_or_uri]) or
-remove_query_arg(removekeyarray, [oldquery_or_uri])
-*/
-
-function remove_query_arg($key, $query=FALSE) {
- if ( is_array($key) ) { // removing multiple keys
- foreach ( (array) $key as $k )
- $query = add_query_arg($k, FALSE, $query);
+/**
+ * Removes an item or items from a query string.
+ *
+ * @since 1.5.0
+ *
+ * @param string|array $key Query key or keys to remove.
+ * @param bool|string $query Optional. When false uses the current URL. Default false.
+ * @return string New URL query string.
+ */
+function remove_query_arg( $key, $query = false ) {
+ if ( is_array( $key ) ) { // removing multiple keys
+ foreach ( $key as $k )
+ $query = add_query_arg( $k, false, $query );
return $query;
}
- return add_query_arg($key, FALSE, $query);
+ return add_query_arg( $key, false, $query );
}
-function add_magic_quotes($array) {
- global $wpdb;
+/**
+ * Returns an array of single-use query variable names that can be removed from a URL.
+ *
+ * @since 4.4.0
+ *
+ * @return array An array of parameters to remove from the URL.
+ */
+function wp_removable_query_args() {
+ $removable_query_args = array(
+ 'activate',
+ 'activated',
+ 'approved',
+ 'deactivate',
+ 'deleted',
+ 'disabled',
+ 'enabled',
+ 'error',
+ 'hotkeys_highlight_first',
+ 'hotkeys_highlight_last',
+ 'locked',
+ 'message',
+ 'same',
+ 'saved',
+ 'settings-updated',
+ 'skipped',
+ 'spammed',
+ 'trashed',
+ 'unspammed',
+ 'untrashed',
+ 'update',
+ 'updated',
+ 'wp-post-new-reload',
+ );
+
+ /**
+ * Filters the list of query variables to remove.
+ *
+ * @since 4.2.0
+ *
+ * @param array $removable_query_args An array of query variables to remove from a URL.
+ */
+ return apply_filters( 'removable_query_args', $removable_query_args );
+}
- foreach ($array as $k => $v) {
- if ( is_array($v) ) {
- $array[$k] = add_magic_quotes($v);
+/**
+ * Walks the array while sanitizing the contents.
+ *
+ * @since 0.71
+ *
+ * @param array $array Array to walk while sanitizing contents.
+ * @return array Sanitized $array.
+ */
+function add_magic_quotes( $array ) {
+ foreach ( (array) $array as $k => $v ) {
+ if ( is_array( $v ) ) {
+ $array[$k] = add_magic_quotes( $v );
} else {
- $array[$k] = $wpdb->escape($v);
+ $array[$k] = addslashes( $v );
}
}
return $array;
}
+/**
+ * HTTP request for URI to retrieve content.
+ *
+ * @since 1.5.1
+ *
+ * @see wp_safe_remote_get()
+ *
+ * @param string $uri URI/URL of web page to retrieve.
+ * @return false|string HTTP content. False on failure.
+ */
function wp_remote_fopen( $uri ) {
- $timeout = 10;
- $parsed_url = @parse_url($uri);
+ $parsed_url = @parse_url( $uri );
- if ( !$parsed_url || !is_array($parsed_url) )
+ if ( !$parsed_url || !is_array( $parsed_url ) )
return false;
- if ( !isset($parsed_url['scheme']) || !in_array($parsed_url['scheme'], array('http','https')) )
- $uri = 'http://' . $uri;
+ $options = array();
+ $options['timeout'] = 10;
- if ( ini_get('allow_url_fopen') ) {
- $fp = @fopen( $uri, 'r' );
- if ( !$fp )
- return false;
+ $response = wp_safe_remote_get( $uri, $options );
- //stream_set_timeout($fp, $timeout); // Requires php 4.3
- $linea = '';
- while( $remote_read = fread($fp, 4096) )
- $linea .= $remote_read;
- fclose($fp);
- return $linea;
- } else if ( function_exists('curl_init') ) {
- $handle = curl_init();
- curl_setopt ($handle, CURLOPT_URL, $uri);
- curl_setopt ($handle, CURLOPT_CONNECTTIMEOUT, 1);
- curl_setopt ($handle, CURLOPT_RETURNTRANSFER, 1);
- curl_setopt ($handle, CURLOPT_TIMEOUT, $timeout);
- $buffer = curl_exec($handle);
- curl_close($handle);
- return $buffer;
- } else {
+ if ( is_wp_error( $response ) )
return false;
- }
+
+ return wp_remote_retrieve_body( $response );
}
-function wp($query_vars = '') {
+/**
+ * Set up the WordPress query.
+ *
+ * @since 2.0.0
+ *
+ * @global WP $wp_locale
+ * @global WP_Query $wp_query
+ * @global WP_Query $wp_the_query
+ *
+ * @param string|array $query_vars Default WP_Query arguments.
+ */
+function wp( $query_vars = '' ) {
global $wp, $wp_query, $wp_the_query;
+ $wp->main( $query_vars );
- $wp->main($query_vars);
-
- if( !isset($wp_the_query) )
+ if ( !isset($wp_the_query) )
$wp_the_query = $wp_query;
}
+/**
+ * Retrieve the description for the HTTP status.
+ *
+ * @since 2.3.0
+ *
+ * @global array $wp_header_to_desc
+ *
+ * @param int $code HTTP status code.
+ * @return string Empty string if not found, or description if found.
+ */
function get_status_header_desc( $code ) {
global $wp_header_to_desc;
- $code = (int) $code;
+ $code = absint( $code );
- if ( !isset($wp_header_to_desc) ) {
+ if ( !isset( $wp_header_to_desc ) ) {
$wp_header_to_desc = array(
100 => 'Continue',
101 => 'Switching Protocols',
+ 102 => 'Processing',
200 => 'OK',
201 => 'Created',
@@ -751,6 +986,8 @@ function get_status_header_desc( $code ) {
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
+ 207 => 'Multi-Status',
+ 226 => 'IM Used',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
@@ -758,10 +995,13 @@ function get_status_header_desc( $code ) {
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
+ 306 => 'Reserved',
307 => 'Temporary Redirect',
+ 308 => 'Permanent Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
+ 402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
@@ -777,449 +1017,1695 @@ function get_status_header_desc( $code ) {
415 => 'Unsupported Media Type',
416 => 'Requested Range Not Satisfiable',
417 => 'Expectation Failed',
+ 418 => 'I\'m a teapot',
+ 421 => 'Misdirected Request',
+ 422 => 'Unprocessable Entity',
+ 423 => 'Locked',
+ 424 => 'Failed Dependency',
+ 426 => 'Upgrade Required',
+ 428 => 'Precondition Required',
+ 429 => 'Too Many Requests',
+ 431 => 'Request Header Fields Too Large',
+ 451 => 'Unavailable For Legal Reasons',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
- 505 => 'HTTP Version Not Supported'
+ 505 => 'HTTP Version Not Supported',
+ 506 => 'Variant Also Negotiates',
+ 507 => 'Insufficient Storage',
+ 510 => 'Not Extended',
+ 511 => 'Network Authentication Required',
);
}
- if ( isset( $wp_header_to_desc[$code] ) ) {
+ if ( isset( $wp_header_to_desc[$code] ) )
return $wp_header_to_desc[$code];
- } else {
+ else
return '';
- }
}
-function status_header( $header ) {
- $text = get_status_header_desc( $header );
+/**
+ * Set HTTP status header.
+ *
+ * @since 2.0.0
+ * @since 4.4.0 Added the `$description` parameter.
+ *
+ * @see get_status_header_desc()
+ *
+ * @param int $code HTTP status code.
+ * @param string $description Optional. A custom description for the HTTP status.
+ */
+function status_header( $code, $description = '' ) {
+ if ( ! $description ) {
+ $description = get_status_header_desc( $code );
+ }
- if ( empty( $text ) )
- return false;
+ if ( empty( $description ) ) {
+ return;
+ }
- $protocol = $_SERVER["SERVER_PROTOCOL"];
- if ( ('HTTP/1.1' != $protocol) && ('HTTP/1.0' != $protocol) )
- $protocol = 'HTTP/1.0';
- $status_header = "$protocol $header $text";
- if ( function_exists('apply_filters') )
- $status_header = apply_filters('status_header', $status_header, $header, $text, $protocol);
+ $protocol = wp_get_server_protocol();
+ $status_header = "$protocol $code $description";
+ if ( function_exists( 'apply_filters' ) )
+
+ /**
+ * Filters an HTTP status header.
+ *
+ * @since 2.2.0
+ *
+ * @param string $status_header HTTP status header.
+ * @param int $code HTTP status code.
+ * @param string $description Description for the status code.
+ * @param string $protocol Server protocol.
+ */
+ $status_header = apply_filters( 'status_header', $status_header, $code, $description, $protocol );
+
+ @header( $status_header, true, $code );
+}
- if ( version_compare( phpversion(), '4.3.0', '>=' ) ) {
- return @header( $status_header, true, $header );
- } else {
- return @header( $status_header );
+/**
+ * Get the header information to prevent caching.
+ *
+ * The several different headers cover the different ways cache prevention
+ * is handled by different browsers
+ *
+ * @since 2.8.0
+ *
+ * @return array The associative array of header names and field values.
+ */
+function wp_get_nocache_headers() {
+ $headers = array(
+ 'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
+ 'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
+ );
+
+ if ( function_exists('apply_filters') ) {
+ /**
+ * Filters the cache-controlling headers.
+ *
+ * @since 2.8.0
+ *
+ * @see wp_get_nocache_headers()
+ *
+ * @param array $headers {
+ * Header names and field values.
+ *
+ * @type string $Expires Expires header.
+ * @type string $Cache-Control Cache-Control header.
+ * }
+ */
+ $headers = (array) apply_filters( 'nocache_headers', $headers );
}
+ $headers['Last-Modified'] = false;
+ return $headers;
}
+/**
+ * Set the headers to prevent caching for the different browsers.
+ *
+ * Different browsers support different nocache headers, so several
+ * headers must be sent so that all of them get the point that no
+ * caching should occur.
+ *
+ * @since 2.0.0
+ *
+ * @see wp_get_nocache_headers()
+ */
function nocache_headers() {
- @ header('Expires: Wed, 11 Jan 1984 05:00:00 GMT');
- @ header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
- @ header('Cache-Control: no-cache, must-revalidate, max-age=0');
- @ header('Pragma: no-cache');
+ $headers = wp_get_nocache_headers();
+
+ unset( $headers['Last-Modified'] );
+
+ // In PHP 5.3+, make sure we are not sending a Last-Modified header.
+ if ( function_exists( 'header_remove' ) ) {
+ @header_remove( 'Last-Modified' );
+ } else {
+ // In PHP 5.2, send an empty Last-Modified header, but only as a
+ // last resort to override a header already sent. #WP23021
+ foreach ( headers_list() as $header ) {
+ if ( 0 === stripos( $header, 'Last-Modified' ) ) {
+ $headers['Last-Modified'] = '';
+ break;
+ }
+ }
+ }
+
+ foreach ( $headers as $name => $field_value )
+ @header("{$name}: {$field_value}");
}
+/**
+ * Set the headers for caching for 10 days with JavaScript content type.
+ *
+ * @since 2.1.0
+ */
function cache_javascript_headers() {
- $expiresOffset = 864000; // 10 days
- header("Content-Type: text/javascript; charset=" . get_bloginfo('charset'));
- header("Vary: Accept-Encoding"); // Handle proxies
- header("Expires: " . gmdate("D, d M Y H:i:s", time() + $expiresOffset) . " GMT");
+ $expiresOffset = 10 * DAY_IN_SECONDS;
+
+ header( "Content-Type: text/javascript; charset=" . get_bloginfo( 'charset' ) );
+ header( "Vary: Accept-Encoding" ); // Handle proxies
+ header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $expiresOffset ) . " GMT" );
}
+/**
+ * Retrieve the number of database queries during the WordPress execution.
+ *
+ * @since 2.0.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @return int Number of database queries.
+ */
function get_num_queries() {
global $wpdb;
return $wpdb->num_queries;
}
+/**
+ * Whether input is yes or no.
+ *
+ * Must be 'y' to be true.
+ *
+ * @since 1.0.0
+ *
+ * @param string $yn Character string containing either 'y' (yes) or 'n' (no).
+ * @return bool True if yes, false on anything else.
+ */
function bool_from_yn( $yn ) {
return ( strtolower( $yn ) == 'y' );
}
+/**
+ * Load the feed template from the use of an action hook.
+ *
+ * If the feed action does not have a hook, then the function will die with a
+ * message telling the visitor that the feed is not valid.
+ *
+ * It is better to only have one hook for each feed.
+ *
+ * @since 2.1.0
+ *
+ * @global WP_Query $wp_query Used to tell if the use a comment feed.
+ */
function do_feed() {
global $wp_query;
- $feed = get_query_var('feed');
+ // Determine if we are looking at the main comment feed
+ $is_main_comments_feed = ( $wp_query->is_comment_feed() && ! $wp_query->is_singular() );
+
+ /*
+ * Check the queried object for the existence of posts if it is not a feed for an archive,
+ * search result, or main comments. By checking for the absense of posts we can prevent rendering the feed
+ * templates at invalid endpoints. e.g.) /wp-content/plugins/feed/
+ */
+ if ( ! $wp_query->have_posts() && ! ( $wp_query->is_archive() || $wp_query->is_search() || $is_main_comments_feed ) ) {
+ wp_die( __( 'ERROR: This is not a valid feed.' ), '', array( 'response' => 404 ) );
+ }
+
+ $feed = get_query_var( 'feed' );
// Remove the pad, if present.
- $feed = preg_replace('/^_+/', '', $feed);
+ $feed = preg_replace( '/^_+/', '', $feed );
if ( $feed == '' || $feed == 'feed' )
- $feed = 'rss2';
+ $feed = get_default_feed();
+
+ if ( ! has_action( "do_feed_{$feed}" ) ) {
+ wp_die( __( 'ERROR: This is not a valid feed template.' ), '', array( 'response' => 404 ) );
+ }
- $hook = 'do_feed_' . $feed;
- do_action($hook, $wp_query->is_comment_feed);
+ /**
+ * Fires once the given feed is loaded.
+ *
+ * The dynamic portion of the hook name, `$feed`, refers to the feed template name.
+ * Possible values include: 'rdf', 'rss', 'rss2', and 'atom'.
+ *
+ * @since 2.1.0
+ * @since 4.4.0 The `$feed` parameter was added.
+ *
+ * @param bool $is_comment_feed Whether the feed is a comment feed.
+ * @param string $feed The feed name.
+ */
+ do_action( "do_feed_{$feed}", $wp_query->is_comment_feed, $feed );
}
+/**
+ * Load the RDF RSS 0.91 Feed template.
+ *
+ * @since 2.1.0
+ *
+ * @see load_template()
+ */
function do_feed_rdf() {
- load_template(ABSPATH . WPINC . '/feed-rdf.php');
+ load_template( ABSPATH . WPINC . '/feed-rdf.php' );
}
+/**
+ * Load the RSS 1.0 Feed Template.
+ *
+ * @since 2.1.0
+ *
+ * @see load_template()
+ */
function do_feed_rss() {
- load_template(ABSPATH . WPINC . '/feed-rss.php');
+ load_template( ABSPATH . WPINC . '/feed-rss.php' );
}
-function do_feed_rss2($for_comments) {
- if ( $for_comments ) {
- load_template(ABSPATH . WPINC . '/feed-rss2-comments.php');
- } else {
- load_template(ABSPATH . WPINC . '/feed-rss2.php');
- }
+/**
+ * Load either the RSS2 comment feed or the RSS2 posts feed.
+ *
+ * @since 2.1.0
+ *
+ * @see load_template()
+ *
+ * @param bool $for_comments True for the comment feed, false for normal feed.
+ */
+function do_feed_rss2( $for_comments ) {
+ if ( $for_comments )
+ load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' );
+ else
+ load_template( ABSPATH . WPINC . '/feed-rss2.php' );
}
-function do_feed_atom($for_comments) {
- if ($for_comments) {
- load_template(ABSPATH . WPINC . '/feed-atom-comments.php');
- } else {
- load_template(ABSPATH . WPINC . '/feed-atom.php');
- }
+/**
+ * Load either Atom comment feed or Atom posts feed.
+ *
+ * @since 2.1.0
+ *
+ * @see load_template()
+ *
+ * @param bool $for_comments True for the comment feed, false for normal feed.
+ */
+function do_feed_atom( $for_comments ) {
+ if ($for_comments)
+ load_template( ABSPATH . WPINC . '/feed-atom-comments.php');
+ else
+ load_template( ABSPATH . WPINC . '/feed-atom.php' );
}
+/**
+ * Display the robots.txt file content.
+ *
+ * The echo content should be with usage of the permalinks or for creating the
+ * robots.txt file.
+ *
+ * @since 2.1.0
+ */
function do_robots() {
- header('Content-Type: text/plain; charset=utf-8');
-
- do_action('do_robotstxt');
-
- if ( '0' == get_option('blog_public') ) {
- echo "User-agent: *\n";
- echo "Disallow: /\n";
+ header( 'Content-Type: text/plain; charset=utf-8' );
+
+ /**
+ * Fires when displaying the robots.txt file.
+ *
+ * @since 2.1.0
+ */
+ do_action( 'do_robotstxt' );
+
+ $output = "User-agent: *\n";
+ $public = get_option( 'blog_public' );
+ if ( '0' == $public ) {
+ $output .= "Disallow: /\n";
} else {
- echo "User-agent: *\n";
- echo "Disallow:\n";
+ $site_url = parse_url( site_url() );
+ $path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : '';
+ $output .= "Disallow: $path/wp-admin/\n";
+ $output .= "Allow: $path/wp-admin/admin-ajax.php\n";
}
+
+ /**
+ * Filters the robots.txt output.
+ *
+ * @since 3.0.0
+ *
+ * @param string $output Robots.txt output.
+ * @param bool $public Whether the site is considered "public".
+ */
+ echo apply_filters( 'robots_txt', $output, $public );
}
+/**
+ * Test whether WordPress is already installed.
+ *
+ * The cache will be checked first. If you have a cache plugin, which saves
+ * the cache values, then this will work. If you use the default WordPress
+ * cache, and the database goes away, then you might have problems.
+ *
+ * Checks for the 'siteurl' option for whether WordPress is installed.
+ *
+ * @since 2.1.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @return bool Whether the site is already installed.
+ */
function is_blog_installed() {
global $wpdb;
- $show = $wpdb->hide_errors();
- $installed = $wpdb->get_var("SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'");
- $wpdb->show_errors($show);
- $install_status = !empty( $installed ) ? TRUE : FALSE;
- return $install_status;
-}
+ /*
+ * Check cache first. If options table goes away and we have true
+ * cached, oh well.
+ */
+ if ( wp_cache_get( 'is_blog_installed' ) )
+ return true;
-function wp_nonce_url($actionurl, $action = -1) {
- $actionurl = str_replace('&', '&', $actionurl);
- return wp_specialchars(add_query_arg('_wpnonce', wp_create_nonce($action), $actionurl));
-}
+ $suppress = $wpdb->suppress_errors();
+ if ( ! wp_installing() ) {
+ $alloptions = wp_load_alloptions();
+ }
+ // If siteurl is not set to autoload, check it specifically
+ if ( !isset( $alloptions['siteurl'] ) )
+ $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
+ else
+ $installed = $alloptions['siteurl'];
+ $wpdb->suppress_errors( $suppress );
-function wp_nonce_field($action = -1, $name = "_wpnonce", $referer = true) {
- $name = attribute_escape($name);
- echo ' ';
- if ( $referer )
- wp_referer_field();
-}
+ $installed = !empty( $installed );
+ wp_cache_set( 'is_blog_installed', $installed );
-function wp_referer_field() {
- $ref = attribute_escape($_SERVER['REQUEST_URI']);
- echo ' ';
- if ( wp_get_original_referer() ) {
- $original_ref = attribute_escape(stripslashes(wp_get_original_referer()));
- echo ' ';
+ if ( $installed )
+ return true;
+
+ // If visiting repair.php, return true and let it take over.
+ if ( defined( 'WP_REPAIRING' ) )
+ return true;
+
+ $suppress = $wpdb->suppress_errors();
+
+ /*
+ * Loop over the WP tables. If none exist, then scratch install is allowed.
+ * If one or more exist, suggest table repair since we got here because the
+ * options table could not be accessed.
+ */
+ $wp_tables = $wpdb->tables();
+ foreach ( $wp_tables as $table ) {
+ // The existence of custom user tables shouldn't suggest an insane state or prevent a clean install.
+ if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table )
+ continue;
+ if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table )
+ continue;
+
+ if ( ! $wpdb->get_results( "DESCRIBE $table;" ) )
+ continue;
+
+ // One or more tables exist. We are insane.
+
+ wp_load_translations_early();
+
+ // Die with a DB error.
+ $wpdb->error = sprintf(
+ /* translators: %s: database repair URL */
+ __( 'One or more database tables are unavailable. The database may need to be repaired .' ),
+ 'maint/repair.php?referrer=is_blog_installed'
+ );
+
+ dead_db();
}
-}
-function wp_original_referer_field() {
- echo ' ';
-}
+ $wpdb->suppress_errors( $suppress );
+
+ wp_cache_set( 'is_blog_installed', false );
-function wp_get_referer() {
- foreach ( array($_REQUEST['_wp_http_referer'], $_SERVER['HTTP_REFERER']) as $ref )
- if ( !empty($ref) )
- return $ref;
return false;
}
-function wp_get_original_referer() {
- if ( !empty($_REQUEST['_wp_original_http_referer']) )
- return $_REQUEST['_wp_original_http_referer'];
- return false;
+/**
+ * Retrieve URL with nonce added to URL query.
+ *
+ * @since 2.0.4
+ *
+ * @param string $actionurl URL to add nonce action.
+ * @param int|string $action Optional. Nonce action name. Default -1.
+ * @param string $name Optional. Nonce name. Default '_wpnonce'.
+ * @return string Escaped URL with nonce action added.
+ */
+function wp_nonce_url( $actionurl, $action = -1, $name = '_wpnonce' ) {
+ $actionurl = str_replace( '&', '&', $actionurl );
+ return esc_html( add_query_arg( $name, wp_create_nonce( $action ), $actionurl ) );
}
-function wp_mkdir_p($target) {
- // from php.net/mkdir user contributed notes
- if (file_exists($target)) {
- if (! @ is_dir($target))
- return false;
- else
- return true;
- }
+/**
+ * Retrieve or display nonce hidden field for forms.
+ *
+ * The nonce field is used to validate that the contents of the form came from
+ * the location on the current site and not somewhere else. The nonce does not
+ * offer absolute protection, but should protect against most cases. It is very
+ * important to use nonce field in forms.
+ *
+ * The $action and $name are optional, but if you want to have better security,
+ * it is strongly suggested to set those two parameters. It is easier to just
+ * call the function without any parameters, because validation of the nonce
+ * doesn't require any parameters, but since crackers know what the default is
+ * it won't be difficult for them to find a way around your nonce and cause
+ * damage.
+ *
+ * The input name will be whatever $name value you gave. The input value will be
+ * the nonce creation value.
+ *
+ * @since 2.0.4
+ *
+ * @param int|string $action Optional. Action name. Default -1.
+ * @param string $name Optional. Nonce name. Default '_wpnonce'.
+ * @param bool $referer Optional. Whether to set the referer field for validation. Default true.
+ * @param bool $echo Optional. Whether to display or return hidden form field. Default true.
+ * @return string Nonce field HTML markup.
+ */
+function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
+ $name = esc_attr( $name );
+ $nonce_field = ' ';
- // Attempting to create the directory may clutter up our display.
- if (@ mkdir($target)) {
- $stat = @ stat(dirname($target));
- $dir_perms = $stat['mode'] & 0007777; // Get the permission bits.
- @ chmod($target, $dir_perms);
- return true;
- } else {
- if ( is_dir(dirname($target)) )
- return false;
- }
+ if ( $referer )
+ $nonce_field .= wp_referer_field( false );
- // If the above failed, attempt to create the parent node, then try again.
- if (wp_mkdir_p(dirname($target)))
- return wp_mkdir_p($target);
+ if ( $echo )
+ echo $nonce_field;
- return false;
+ return $nonce_field;
}
-// Returns an array containing the current upload directory's path and url, or an error message.
-function wp_upload_dir() {
- $siteurl = get_option('siteurl');
- //prepend ABSPATH to $dir and $siteurl to $url if they're not already there
- $path = str_replace(ABSPATH, '', trim(get_option('upload_path')));
- $dir = ABSPATH . $path;
- $url = trailingslashit($siteurl) . $path;
+/**
+ * Retrieve or display referer hidden field for forms.
+ *
+ * The referer link is the current Request URI from the server super global. The
+ * input name is '_wp_http_referer', in case you wanted to check manually.
+ *
+ * @since 2.0.4
+ *
+ * @param bool $echo Optional. Whether to echo or return the referer field. Default true.
+ * @return string Referer field HTML markup.
+ */
+function wp_referer_field( $echo = true ) {
+ $referer_field = ' ';
+
+ if ( $echo )
+ echo $referer_field;
+ return $referer_field;
+}
- if ( $dir == ABSPATH ) { //the option was empty
- $dir = ABSPATH . 'wp-content/uploads';
+/**
+ * Retrieve or display original referer hidden field for forms.
+ *
+ * The input name is '_wp_original_http_referer' and will be either the same
+ * value of wp_referer_field(), if that was posted already or it will be the
+ * current page, if it doesn't exist.
+ *
+ * @since 2.0.4
+ *
+ * @param bool $echo Optional. Whether to echo the original http referer. Default true.
+ * @param string $jump_back_to Optional. Can be 'previous' or page you want to jump back to.
+ * Default 'current'.
+ * @return string Original referer field.
+ */
+function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
+ if ( ! $ref = wp_get_original_referer() ) {
+ $ref = 'previous' == $jump_back_to ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] );
}
+ $orig_referer_field = ' ';
+ if ( $echo )
+ echo $orig_referer_field;
+ return $orig_referer_field;
+}
- if ( defined('UPLOADS') ) {
- $dir = ABSPATH . UPLOADS;
- $url = trailingslashit($siteurl) . UPLOADS;
+/**
+ * Retrieve referer from '_wp_http_referer' or HTTP referer.
+ *
+ * If it's the same as the current request URL, will return false.
+ *
+ * @since 2.0.4
+ *
+ * @return false|string False on failure. Referer URL on success.
+ */
+function wp_get_referer() {
+ if ( ! function_exists( 'wp_validate_redirect' ) ) {
+ return false;
}
- if ( get_option('uploads_use_yearmonth_folders')) {
- // Generate the yearly and monthly dirs
- $time = current_time( 'mysql' );
- $y = substr( $time, 0, 4 );
- $m = substr( $time, 5, 2 );
- $dir = $dir . "/$y/$m";
- $url = $url . "/$y/$m";
- }
+ $ref = wp_get_raw_referer();
- // Make sure we have an uploads dir
- if ( ! wp_mkdir_p( $dir ) ) {
- $message = sprintf(__('Unable to create directory %s. Is its parent directory writable by the server?'), $dir);
- return array('error' => $message);
+ if ( $ref && $ref !== wp_unslash( $_SERVER['REQUEST_URI'] ) && $ref !== home_url() . wp_unslash( $_SERVER['REQUEST_URI'] ) ) {
+ return wp_validate_redirect( $ref, false );
}
- $uploads = array('path' => $dir, 'url' => $url, 'error' => false);
- return apply_filters('upload_dir', $uploads);
+ return false;
}
-function wp_upload_bits($name, $type, $bits) {
- if ( empty($name) )
- return array('error' => __("Empty filename"));
+/**
+ * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
+ *
+ * Do not use for redirects, use wp_get_referer() instead.
+ *
+ * @since 4.5.0
+ *
+ * @return string|false Referer URL on success, false on failure.
+ */
+function wp_get_raw_referer() {
+ if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
+ return wp_unslash( $_REQUEST['_wp_http_referer'] );
+ } else if ( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
+ return wp_unslash( $_SERVER['HTTP_REFERER'] );
+ }
- $wp_filetype = wp_check_filetype($name);
- if ( !$wp_filetype['ext'] )
- return array('error' => __("Invalid file type"));
+ return false;
+}
- $upload = wp_upload_dir();
+/**
+ * Retrieve original referer that was posted, if it exists.
+ *
+ * @since 2.0.4
+ *
+ * @return string|false False if no original referer or original referer if set.
+ */
+function wp_get_original_referer() {
+ if ( ! empty( $_REQUEST['_wp_original_http_referer'] ) && function_exists( 'wp_validate_redirect' ) )
+ return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false );
+ return false;
+}
- if ( $upload['error'] !== false )
- return $upload;
+/**
+ * Recursive directory creation based on full path.
+ *
+ * Will attempt to set permissions on folders.
+ *
+ * @since 2.0.1
+ *
+ * @param string $target Full path to attempt to create.
+ * @return bool Whether the path was created. True if path already exists.
+ */
+function wp_mkdir_p( $target ) {
+ $wrapper = null;
+
+ // Strip the protocol.
+ if ( wp_is_stream( $target ) ) {
+ list( $wrapper, $target ) = explode( '://', $target, 2 );
+ }
+
+ // From php.net/mkdir user contributed notes.
+ $target = str_replace( '//', '/', $target );
+
+ // Put the wrapper back on the target.
+ if ( $wrapper !== null ) {
+ $target = $wrapper . '://' . $target;
+ }
+
+ /*
+ * Safe mode fails with a trailing slash under certain PHP versions.
+ * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
+ */
+ $target = rtrim($target, '/');
+ if ( empty($target) )
+ $target = '/';
+
+ if ( file_exists( $target ) )
+ return @is_dir( $target );
+
+ // We need to find the permissions of the parent folder that exists and inherit that.
+ $target_parent = dirname( $target );
+ while ( '.' != $target_parent && ! is_dir( $target_parent ) ) {
+ $target_parent = dirname( $target_parent );
+ }
+
+ // Get the permission bits.
+ if ( $stat = @stat( $target_parent ) ) {
+ $dir_perms = $stat['mode'] & 0007777;
+ } else {
+ $dir_perms = 0777;
+ }
+
+ if ( @mkdir( $target, $dir_perms, true ) ) {
+
+ /*
+ * If a umask is set that modifies $dir_perms, we'll have to re-set
+ * the $dir_perms correctly with chmod()
+ */
+ if ( $dir_perms != ( $dir_perms & ~umask() ) ) {
+ $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) );
+ for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) {
+ @chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms );
+ }
+ }
+
+ return true;
+ }
+
+ return false;
+}
+
+/**
+ * Test if a give filesystem path is absolute.
+ *
+ * For example, '/foo/bar', or 'c:\windows'.
+ *
+ * @since 2.5.0
+ *
+ * @param string $path File path.
+ * @return bool True if path is absolute, false is not absolute.
+ */
+function path_is_absolute( $path ) {
+ /*
+ * This is definitive if true but fails if $path does not exist or contains
+ * a symbolic link.
+ */
+ if ( realpath($path) == $path )
+ return true;
+
+ if ( strlen($path) == 0 || $path[0] == '.' )
+ return false;
+
+ // Windows allows absolute paths like this.
+ if ( preg_match('#^[a-zA-Z]:\\\\#', $path) )
+ return true;
+
+ // A path starting with / or \ is absolute; anything else is relative.
+ return ( $path[0] == '/' || $path[0] == '\\' );
+}
+
+/**
+ * Join two filesystem paths together.
+ *
+ * For example, 'give me $path relative to $base'. If the $path is absolute,
+ * then it the full path is returned.
+ *
+ * @since 2.5.0
+ *
+ * @param string $base Base path.
+ * @param string $path Path relative to $base.
+ * @return string The path with the base or absolute path.
+ */
+function path_join( $base, $path ) {
+ if ( path_is_absolute($path) )
+ return $path;
+
+ return rtrim($base, '/') . '/' . ltrim($path, '/');
+}
+
+/**
+ * Normalize a filesystem path.
+ *
+ * On windows systems, replaces backslashes with forward slashes
+ * and forces upper-case drive letters.
+ * Allows for two leading slashes for Windows network shares, but
+ * ensures that all other duplicate slashes are reduced to a single.
+ *
+ * @since 3.9.0
+ * @since 4.4.0 Ensures upper-case drive letters on Windows systems.
+ * @since 4.5.0 Allows for Windows network shares.
+ *
+ * @param string $path Path to normalize.
+ * @return string Normalized path.
+ */
+function wp_normalize_path( $path ) {
+ $path = str_replace( '\\', '/', $path );
+ $path = preg_replace( '|(?<=.)/+|', '/', $path );
+ if ( ':' === substr( $path, 1, 1 ) ) {
+ $path = ucfirst( $path );
+ }
+ return $path;
+}
- $number = '';
- $filename = $name;
- $path_parts = pathinfo($filename);
- $ext = $path_parts['extension'];
- if ( empty($ext) )
- $ext = '';
+/**
+ * Determine a writable directory for temporary files.
+ *
+ * Function's preference is the return value of sys_get_temp_dir(),
+ * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR,
+ * before finally defaulting to /tmp/
+ *
+ * In the event that this function does not find a writable location,
+ * It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file.
+ *
+ * @since 2.5.0
+ *
+ * @staticvar string $temp
+ *
+ * @return string Writable temporary directory.
+ */
+function get_temp_dir() {
+ static $temp = '';
+ if ( defined('WP_TEMP_DIR') )
+ return trailingslashit(WP_TEMP_DIR);
+
+ if ( $temp )
+ return trailingslashit( $temp );
+
+ if ( function_exists('sys_get_temp_dir') ) {
+ $temp = sys_get_temp_dir();
+ if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
+ return trailingslashit( $temp );
+ }
+
+ $temp = ini_get('upload_tmp_dir');
+ if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
+ return trailingslashit( $temp );
+
+ $temp = WP_CONTENT_DIR . '/';
+ if ( is_dir( $temp ) && wp_is_writable( $temp ) )
+ return $temp;
+
+ return '/tmp/';
+}
+
+/**
+ * Determine if a directory is writable.
+ *
+ * This function is used to work around certain ACL issues in PHP primarily
+ * affecting Windows Servers.
+ *
+ * @since 3.6.0
+ *
+ * @see win_is_writable()
+ *
+ * @param string $path Path to check for write-ability.
+ * @return bool Whether the path is writable.
+ */
+function wp_is_writable( $path ) {
+ if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) )
+ return win_is_writable( $path );
else
- $ext = ".$ext";
- while ( file_exists($upload['path'] . "/$filename") ) {
- if ( '' == "$number$ext" )
- $filename = $filename . ++$number . $ext;
+ return @is_writable( $path );
+}
+
+/**
+ * Workaround for Windows bug in is_writable() function
+ *
+ * PHP has issues with Windows ACL's for determine if a
+ * directory is writable or not, this works around them by
+ * checking the ability to open files rather than relying
+ * upon PHP to interprate the OS ACL.
+ *
+ * @since 2.8.0
+ *
+ * @see https://bugs.php.net/bug.php?id=27609
+ * @see https://bugs.php.net/bug.php?id=30931
+ *
+ * @param string $path Windows path to check for write-ability.
+ * @return bool Whether the path is writable.
+ */
+function win_is_writable( $path ) {
+
+ if ( $path[strlen( $path ) - 1] == '/' ) { // if it looks like a directory, check a random file within the directory
+ return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp');
+ } elseif ( is_dir( $path ) ) { // If it's a directory (and not a file) check a random file within the directory
+ return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
+ }
+ // check tmp file for read/write capabilities
+ $should_delete_tmp_file = !file_exists( $path );
+ $f = @fopen( $path, 'a' );
+ if ( $f === false )
+ return false;
+ fclose( $f );
+ if ( $should_delete_tmp_file )
+ unlink( $path );
+ return true;
+}
+
+/**
+ * Retrieves uploads directory information.
+ *
+ * Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory.
+ * Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases
+ * when not uploading files.
+ *
+ * @since 4.5.0
+ *
+ * @see wp_upload_dir()
+ *
+ * @return array See wp_upload_dir() for description.
+ */
+function wp_get_upload_dir() {
+ return wp_upload_dir( null, false );
+}
+
+/**
+ * Get an array containing the current upload directory's path and url.
+ *
+ * Checks the 'upload_path' option, which should be from the web root folder,
+ * and if it isn't empty it will be used. If it is empty, then the path will be
+ * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
+ * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
+ *
+ * The upload URL path is set either by the 'upload_url_path' option or by using
+ * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
+ *
+ * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
+ * the administration settings panel), then the time will be used. The format
+ * will be year first and then month.
+ *
+ * If the path couldn't be created, then an error will be returned with the key
+ * 'error' containing the error message. The error suggests that the parent
+ * directory is not writable by the server.
+ *
+ * On success, the returned array will have many indices:
+ * 'path' - base directory and sub directory or full path to upload directory.
+ * 'url' - base url and sub directory or absolute URL to upload directory.
+ * 'subdir' - sub directory if uploads use year/month folders option is on.
+ * 'basedir' - path without subdir.
+ * 'baseurl' - URL path without subdir.
+ * 'error' - false or error message.
+ *
+ * @since 2.0.0
+ * @uses _wp_upload_dir()
+ *
+ * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param bool $create_dir Optional. Whether to check and create the uploads directory.
+ * Default true for backward compatibility.
+ * @param bool $refresh_cache Optional. Whether to refresh the cache. Default false.
+ * @return array See above for description.
+ */
+function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
+ static $cache = array(), $tested_paths = array();
+
+ $key = sprintf( '%d-%s', get_current_blog_id(), (string) $time );
+
+ if ( $refresh_cache || empty( $cache[ $key ] ) ) {
+ $cache[ $key ] = _wp_upload_dir( $time );
+ }
+
+ /**
+ * Filters the uploads directory data.
+ *
+ * @since 2.0.0
+ *
+ * @param array $uploads Array of upload directory data with keys of 'path',
+ * 'url', 'subdir, 'basedir', and 'error'.
+ */
+ $uploads = apply_filters( 'upload_dir', $cache[ $key ] );
+
+ if ( $create_dir ) {
+ $path = $uploads['path'];
+
+ if ( array_key_exists( $path, $tested_paths ) ) {
+ $uploads['error'] = $tested_paths[ $path ];
+ } else {
+ if ( ! wp_mkdir_p( $path ) ) {
+ if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) {
+ $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
+ } else {
+ $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
+ }
+
+ $uploads['error'] = sprintf(
+ /* translators: %s: directory path */
+ __( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
+ esc_html( $error_path )
+ );
+ }
+
+ $tested_paths[ $path ] = $uploads['error'];
+ }
+ }
+
+ return $uploads;
+}
+
+/**
+ * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
+ *
+ * @access private
+ *
+ * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @return array See wp_upload_dir()
+ */
+function _wp_upload_dir( $time = null ) {
+ $siteurl = get_option( 'siteurl' );
+ $upload_path = trim( get_option( 'upload_path' ) );
+
+ if ( empty( $upload_path ) || 'wp-content/uploads' == $upload_path ) {
+ $dir = WP_CONTENT_DIR . '/uploads';
+ } elseif ( 0 !== strpos( $upload_path, ABSPATH ) ) {
+ // $dir is absolute, $upload_path is (maybe) relative to ABSPATH
+ $dir = path_join( ABSPATH, $upload_path );
+ } else {
+ $dir = $upload_path;
+ }
+
+ if ( !$url = get_option( 'upload_url_path' ) ) {
+ if ( empty($upload_path) || ( 'wp-content/uploads' == $upload_path ) || ( $upload_path == $dir ) )
+ $url = WP_CONTENT_URL . '/uploads';
else
- $filename = str_replace("$number$ext", ++$number . $ext, $filename);
+ $url = trailingslashit( $siteurl ) . $upload_path;
+ }
+
+ /*
+ * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
+ * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
+ */
+ if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {
+ $dir = ABSPATH . UPLOADS;
+ $url = trailingslashit( $siteurl ) . UPLOADS;
+ }
+
+ // If multisite (and if not the main site in a post-MU network)
+ if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) {
+
+ if ( ! get_site_option( 'ms_files_rewriting' ) ) {
+ /*
+ * If ms-files rewriting is disabled (networks created post-3.5), it is fairly
+ * straightforward: Append sites/%d if we're not on the main site (for post-MU
+ * networks). (The extra directory prevents a four-digit ID from conflicting with
+ * a year-based directory for the main site. But if a MU-era network has disabled
+ * ms-files rewriting manually, they don't need the extra directory, as they never
+ * had wp-content/uploads for the main site.)
+ */
+
+ if ( defined( 'MULTISITE' ) )
+ $ms_dir = '/sites/' . get_current_blog_id();
+ else
+ $ms_dir = '/' . get_current_blog_id();
+
+ $dir .= $ms_dir;
+ $url .= $ms_dir;
+
+ } elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {
+ /*
+ * Handle the old-form ms-files.php rewriting if the network still has that enabled.
+ * When ms-files rewriting is enabled, then we only listen to UPLOADS when:
+ * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used
+ * there, and
+ * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect
+ * the original blog ID.
+ *
+ * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
+ * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
+ * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
+ * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
+ */
+
+ if ( defined( 'BLOGUPLOADDIR' ) )
+ $dir = untrailingslashit( BLOGUPLOADDIR );
+ else
+ $dir = ABSPATH . UPLOADS;
+ $url = trailingslashit( $siteurl ) . 'files';
+ }
+ }
+
+ $basedir = $dir;
+ $baseurl = $url;
+
+ $subdir = '';
+ if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
+ // Generate the yearly and monthly dirs
+ if ( !$time )
+ $time = current_time( 'mysql' );
+ $y = substr( $time, 0, 4 );
+ $m = substr( $time, 5, 2 );
+ $subdir = "/$y/$m";
+ }
+
+ $dir .= $subdir;
+ $url .= $subdir;
+
+ return array(
+ 'path' => $dir,
+ 'url' => $url,
+ 'subdir' => $subdir,
+ 'basedir' => $basedir,
+ 'baseurl' => $baseurl,
+ 'error' => false,
+ );
+}
+
+/**
+ * Get a filename that is sanitized and unique for the given directory.
+ *
+ * If the filename is not unique, then a number will be added to the filename
+ * before the extension, and will continue adding numbers until the filename is
+ * unique.
+ *
+ * The callback is passed three parameters, the first one is the directory, the
+ * second is the filename, and the third is the extension.
+ *
+ * @since 2.5.0
+ *
+ * @param string $dir Directory.
+ * @param string $filename File name.
+ * @param callable $unique_filename_callback Callback. Default null.
+ * @return string New filename, if given wasn't unique.
+ */
+function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
+ // Sanitize the file name before we begin processing.
+ $filename = sanitize_file_name($filename);
+
+ // Separate the filename into a name and extension.
+ $ext = pathinfo( $filename, PATHINFO_EXTENSION );
+ $name = pathinfo( $filename, PATHINFO_BASENAME );
+ if ( $ext ) {
+ $ext = '.' . $ext;
+ }
+
+ // Edge case: if file is named '.ext', treat as an empty name.
+ if ( $name === $ext ) {
+ $name = '';
+ }
+
+ /*
+ * Increment the file number until we have a unique file to save in $dir.
+ * Use callback if supplied.
+ */
+ if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
+ $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
+ } else {
+ $number = '';
+
+ // Change '.ext' to lower case.
+ if ( $ext && strtolower($ext) != $ext ) {
+ $ext2 = strtolower($ext);
+ $filename2 = preg_replace( '|' . preg_quote($ext) . '$|', $ext2, $filename );
+
+ // Check for both lower and upper case extension or image sub-sizes may be overwritten.
+ while ( file_exists($dir . "/$filename") || file_exists($dir . "/$filename2") ) {
+ $new_number = $number + 1;
+ $filename = str_replace( array( "-$number$ext", "$number$ext" ), "-$new_number$ext", $filename );
+ $filename2 = str_replace( array( "-$number$ext2", "$number$ext2" ), "-$new_number$ext2", $filename2 );
+ $number = $new_number;
+ }
+
+ /**
+ * Filters the result when generating a unique file name.
+ *
+ * @since 4.5.0
+ *
+ * @param string $filename Unique file name.
+ * @param string $ext File extension, eg. ".png".
+ * @param string $dir Directory path.
+ * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
+ */
+ return apply_filters( 'wp_unique_filename', $filename2, $ext, $dir, $unique_filename_callback );
+ }
+
+ while ( file_exists( $dir . "/$filename" ) ) {
+ if ( '' == "$number$ext" ) {
+ $filename = "$filename-" . ++$number;
+ } else {
+ $filename = str_replace( array( "-$number$ext", "$number$ext" ), "-" . ++$number . $ext, $filename );
+ }
+ }
+ }
+
+ /** This filter is documented in wp-includes/functions.php */
+ return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback );
+}
+
+/**
+ * Create a file in the upload folder with given content.
+ *
+ * If there is an error, then the key 'error' will exist with the error message.
+ * If success, then the key 'file' will have the unique file path, the 'url' key
+ * will have the link to the new file. and the 'error' key will be set to false.
+ *
+ * This function will not move an uploaded file to the upload folder. It will
+ * create a new file with the content in $bits parameter. If you move the upload
+ * file, read the content of the uploaded file, and then you can give the
+ * filename and content to this function, which will add it to the upload
+ * folder.
+ *
+ * The permissions will be set on the new file automatically by this function.
+ *
+ * @since 2.0.0
+ *
+ * @param string $name Filename.
+ * @param null|string $deprecated Never used. Set to null.
+ * @param mixed $bits File content
+ * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @return array
+ */
+function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '2.0.0' );
+
+ if ( empty( $name ) )
+ return array( 'error' => __( 'Empty filename' ) );
+
+ $wp_filetype = wp_check_filetype( $name );
+ if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) )
+ return array( 'error' => __( 'Invalid file type' ) );
+
+ $upload = wp_upload_dir( $time );
+
+ if ( $upload['error'] !== false )
+ return $upload;
+
+ /**
+ * Filters whether to treat the upload bits as an error.
+ *
+ * Passing a non-array to the filter will effectively short-circuit preparing
+ * the upload bits, returning that value instead.
+ *
+ * @since 3.0.0
+ *
+ * @param mixed $upload_bits_error An array of upload bits data, or a non-array error to return.
+ */
+ $upload_bits_error = apply_filters( 'wp_upload_bits', array( 'name' => $name, 'bits' => $bits, 'time' => $time ) );
+ if ( !is_array( $upload_bits_error ) ) {
+ $upload[ 'error' ] = $upload_bits_error;
+ return $upload;
}
+ $filename = wp_unique_filename( $upload['path'], $name );
+
$new_file = $upload['path'] . "/$filename";
- if ( ! wp_mkdir_p( dirname($new_file) ) ) {
- $message = sprintf(__('Unable to create directory %s. Is its parent directory writable by the server?'), dirname($new_file));
- return array('error' => $message);
+ if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
+ if ( 0 === strpos( $upload['basedir'], ABSPATH ) )
+ $error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir'];
+ else
+ $error_path = basename( $upload['basedir'] ) . $upload['subdir'];
+
+ $message = sprintf(
+ /* translators: %s: directory path */
+ __( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
+ $error_path
+ );
+ return array( 'error' => $message );
}
- $ifp = @ fopen($new_file, 'wb');
+ $ifp = @ fopen( $new_file, 'wb' );
if ( ! $ifp )
- return array('error' => sprintf(__('Could not write file %s'), $new_file));
+ return array( 'error' => sprintf( __( 'Could not write file %s' ), $new_file ) );
+
+ @fwrite( $ifp, $bits );
+ fclose( $ifp );
+ clearstatcache();
- $success = @ fwrite($ifp, $bits);
- fclose($ifp);
// Set correct file permissions
- $stat = @ stat(dirname($new_file));
+ $stat = @ stat( dirname( $new_file ) );
$perms = $stat['mode'] & 0007777;
$perms = $perms & 0000666;
- @ chmod($new_file, $perms);
+ @ chmod( $new_file, $perms );
+ clearstatcache();
// Compute the URL
$url = $upload['url'] . "/$filename";
- return array('file' => $new_file, 'url' => $url, 'error' => false);
-}
-
-function wp_check_filetype($filename, $mimes = null) {
- // Accepted MIME types are set here as PCRE unless provided.
- $mimes = is_array($mimes) ? $mimes : apply_filters('upload_mimes', array (
- 'jpg|jpeg|jpe' => 'image/jpeg',
- 'gif' => 'image/gif',
- 'png' => 'image/png',
- 'bmp' => 'image/bmp',
- 'tif|tiff' => 'image/tiff',
- 'ico' => 'image/x-icon',
- 'asf|asx|wax|wmv|wmx' => 'video/asf',
- 'avi' => 'video/avi',
- 'mov|qt' => 'video/quicktime',
- 'mpeg|mpg|mpe' => 'video/mpeg',
- 'txt|c|cc|h' => 'text/plain',
- 'rtx' => 'text/richtext',
- 'css' => 'text/css',
- 'htm|html' => 'text/html',
- 'mp3|mp4' => 'audio/mpeg',
- 'ra|ram' => 'audio/x-realaudio',
- 'wav' => 'audio/wav',
- 'ogg' => 'audio/ogg',
- 'mid|midi' => 'audio/midi',
- 'wma' => 'audio/wma',
- 'rtf' => 'application/rtf',
- 'js' => 'application/javascript',
- 'pdf' => 'application/pdf',
- 'doc' => 'application/msword',
- 'pot|pps|ppt' => 'application/vnd.ms-powerpoint',
- 'wri' => 'application/vnd.ms-write',
- 'xla|xls|xlt|xlw' => 'application/vnd.ms-excel',
- 'mdb' => 'application/vnd.ms-access',
- 'mpp' => 'application/vnd.ms-project',
- 'swf' => 'application/x-shockwave-flash',
- 'class' => 'application/java',
- 'tar' => 'application/x-tar',
- 'zip' => 'application/zip',
- 'gz|gzip' => 'application/x-gzip',
- 'exe' => 'application/x-msdownload',
- // openoffice formats
- 'odt' => 'application/vnd.oasis.opendocument.text',
- 'odp' => 'application/vnd.oasis.opendocument.presentation',
- 'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
- 'odg' => 'application/vnd.oasis.opendocument.graphics',
- 'odc' => 'application/vnd.oasis.opendocument.chart',
- 'odb' => 'application/vnd.oasis.opendocument.database',
- 'odf' => 'application/vnd.oasis.opendocument.formula',
-
- ));
+ /** This filter is documented in wp-admin/includes/file.php */
+ return apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $wp_filetype['type'], 'error' => false ), 'sideload' );
+}
+
+/**
+ * Retrieve the file type based on the extension name.
+ *
+ * @since 2.5.0
+ *
+ * @param string $ext The extension to search.
+ * @return string|void The file type, example: audio, video, document, spreadsheet, etc.
+ */
+function wp_ext2type( $ext ) {
+ $ext = strtolower( $ext );
+
+ $ext2type = wp_get_ext_types();
+ foreach ( $ext2type as $type => $exts )
+ if ( in_array( $ext, $exts ) )
+ return $type;
+}
+/**
+ * Retrieve the file type from the file name.
+ *
+ * You can optionally define the mime array, if needed.
+ *
+ * @since 2.0.4
+ *
+ * @param string $filename File name or path.
+ * @param array $mimes Optional. Key is the file extension with value as the mime type.
+ * @return array Values with extension first and mime type.
+ */
+function wp_check_filetype( $filename, $mimes = null ) {
+ if ( empty($mimes) )
+ $mimes = get_allowed_mime_types();
$type = false;
$ext = false;
- foreach ($mimes as $ext_preg => $mime_match) {
+ foreach ( $mimes as $ext_preg => $mime_match ) {
$ext_preg = '!\.(' . $ext_preg . ')$!i';
- if ( preg_match($ext_preg, $filename, $ext_matches) ) {
+ if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
$type = $mime_match;
$ext = $ext_matches[1];
break;
}
}
- return compact('ext', 'type');
+ return compact( 'ext', 'type' );
}
-function wp_explain_nonce($action) {
- if ( $action !== -1 && preg_match('/([a-z]+)-([a-z]+)(_(.+))?/', $action, $matches) ) {
- $verb = $matches[1];
- $noun = $matches[2];
-
- $trans = array();
- $trans['update']['attachment'] = array(__('Are you sure you want to edit this attachment: "%s"?'), 'get_the_title');
-
- $trans['add']['category'] = array(__('Are you sure you want to add this category?'), false);
- $trans['delete']['category'] = array(__('Are you sure you want to delete this category: "%s"?'), 'get_catname');
- $trans['update']['category'] = array(__('Are you sure you want to edit this category: "%s"?'), 'get_catname');
+/**
+ * Attempt to determine the real file type of a file.
+ *
+ * If unable to, the file name extension will be used to determine type.
+ *
+ * If it's determined that the extension does not match the file's real type,
+ * then the "proper_filename" value will be set with a proper filename and extension.
+ *
+ * Currently this function only supports renaming images validated via wp_get_image_mime().
+ *
+ * @since 3.0.0
+ *
+ * @param string $file Full path to the file.
+ * @param string $filename The name of the file (may differ from $file due to $file being
+ * in a tmp directory).
+ * @param array $mimes Optional. Key is the file extension with value as the mime type.
+ * @return array Values for the extension, MIME, and either a corrected filename or false
+ * if original $filename is valid.
+ */
+function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
+ $proper_filename = false;
+
+ // Do basic extension validation and MIME mapping
+ $wp_filetype = wp_check_filetype( $filename, $mimes );
+ $ext = $wp_filetype['ext'];
+ $type = $wp_filetype['type'];
+
+ // We can't do any further validation without a file to work with
+ if ( ! file_exists( $file ) ) {
+ return compact( 'ext', 'type', 'proper_filename' );
+ }
- $trans['delete']['comment'] = array(__('Are you sure you want to delete this comment: "%s"?'), 'use_id');
- $trans['unapprove']['comment'] = array(__('Are you sure you want to unapprove this comment: "%s"?'), 'use_id');
- $trans['approve']['comment'] = array(__('Are you sure you want to approve this comment: "%s"?'), 'use_id');
- $trans['update']['comment'] = array(__('Are you sure you want to edit this comment: "%s"?'), 'use_id');
- $trans['bulk']['comments'] = array(__('Are you sure you want to bulk modify comments?'), false);
- $trans['moderate']['comments'] = array(__('Are you sure you want to moderate comments?'), false);
+ // Validate image types.
+ if ( $type && 0 === strpos( $type, 'image/' ) ) {
+
+ // Attempt to figure out what type of image it actually is
+ $real_mime = wp_get_image_mime( $file );
+
+ if ( ! $real_mime ) {
+ $type = $ext = false;
+ } elseif ( $real_mime != $type ) {
+ /**
+ * Filters the list mapping image mime types to their respective extensions.
+ *
+ * @since 3.0.0
+ *
+ * @param array $mime_to_ext Array of image mime types and their matching extensions.
+ */
+ $mime_to_ext = apply_filters( 'getimagesize_mimes_to_exts', array(
+ 'image/jpeg' => 'jpg',
+ 'image/png' => 'png',
+ 'image/gif' => 'gif',
+ 'image/bmp' => 'bmp',
+ 'image/tiff' => 'tif',
+ ) );
+
+ // Replace whatever is after the last period in the filename with the correct extension
+ if ( ! empty( $mime_to_ext[ $real_mime ] ) ) {
+ $filename_parts = explode( '.', $filename );
+ array_pop( $filename_parts );
+ $filename_parts[] = $mime_to_ext[ $real_mime ];
+ $new_filename = implode( '.', $filename_parts );
+
+ if ( $new_filename != $filename ) {
+ $proper_filename = $new_filename; // Mark that it changed
+ }
+ // Redefine the extension / MIME
+ $wp_filetype = wp_check_filetype( $new_filename, $mimes );
+ $ext = $wp_filetype['ext'];
+ $type = $wp_filetype['type'];
+ } else {
+ $type = $ext = false;
+ }
+ }
+ } elseif ( function_exists( 'finfo_file' ) ) {
+ // Use finfo_file if available to validate non-image files.
+ $finfo = finfo_open( FILEINFO_MIME_TYPE );
+ $real_mime = finfo_file( $finfo, $file );
+ finfo_close( $finfo );
+
+ // If the extension does not match the file's real type, return false.
+ if ( $real_mime !== $type ) {
+ $type = $ext = false;
+ }
+ }
- $trans['add']['bookmark'] = array(__('Are you sure you want to add this link?'), false);
- $trans['delete']['bookmark'] = array(__('Are you sure you want to delete this link: "%s"?'), 'use_id');
- $trans['update']['bookmark'] = array(__('Are you sure you want to edit this link: "%s"?'), 'use_id');
- $trans['bulk']['bookmarks'] = array(__('Are you sure you want to bulk modify links?'), false);
+ /**
+ * Filters the "real" file type of the given file.
+ *
+ * @since 3.0.0
+ *
+ * @param array $wp_check_filetype_and_ext File data array containing 'ext', 'type', and
+ * 'proper_filename' keys.
+ * @param string $file Full path to the file.
+ * @param string $filename The name of the file (may differ from $file due to
+ * $file being in a tmp directory).
+ * @param array $mimes Key is the file extension with value as the mime type.
+ */
+ return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes );
+}
- $trans['add']['page'] = array(__('Are you sure you want to add this page?'), false);
- $trans['delete']['page'] = array(__('Are you sure you want to delete this page: "%s"?'), 'get_the_title');
- $trans['update']['page'] = array(__('Are you sure you want to edit this page: "%s"?'), 'get_the_title');
+/**
+ * Returns the real mime type of an image file.
+ *
+ * This depends on exif_imagetype() or getimagesize() to determine real mime types.
+ *
+ * @since 4.7.1
+ *
+ * @param string $file Full path to the file.
+ * @return string|false The actual mime type or false if the type cannot be determined.
+ */
+function wp_get_image_mime( $file ) {
+ /*
+ * Use exif_imagetype() to check the mimetype if available or fall back to
+ * getimagesize() if exif isn't avaialbe. If either function throws an Exception
+ * we assume the file could not be validated.
+ */
+ try {
+ if ( is_callable( 'exif_imagetype' ) ) {
+ $mime = image_type_to_mime_type( exif_imagetype( $file ) );
+ } elseif ( function_exists( 'getimagesize' ) ) {
+ $imagesize = getimagesize( $file );
+ $mime = ( isset( $imagesize['mime'] ) ) ? $imagesize['mime'] : false;
+ } else {
+ $mime = false;
+ }
+ } catch ( Exception $e ) {
+ $mime = false;
+ }
- $trans['edit']['plugin'] = array(__('Are you sure you want to edit this plugin file: "%s"?'), 'use_id');
- $trans['activate']['plugin'] = array(__('Are you sure you want to activate this plugin: "%s"?'), 'use_id');
- $trans['deactivate']['plugin'] = array(__('Are you sure you want to deactivate this plugin: "%s"?'), 'use_id');
+ return $mime;
+}
- $trans['add']['post'] = array(__('Are you sure you want to add this post?'), false);
- $trans['delete']['post'] = array(__('Are you sure you want to delete this post: "%s"?'), 'get_the_title');
- $trans['update']['post'] = array(__('Are you sure you want to edit this post: "%s"?'), 'get_the_title');
+/**
+ * Retrieve list of mime types and file extensions.
+ *
+ * @since 3.5.0
+ * @since 4.2.0 Support was added for GIMP (xcf) files.
+ *
+ * @return array Array of mime types keyed by the file extension regex corresponding to those types.
+ */
+function wp_get_mime_types() {
+ /**
+ * Filters the list of mime types and file extensions.
+ *
+ * This filter should be used to add, not remove, mime types. To remove
+ * mime types, use the {@see 'upload_mimes'} filter.
+ *
+ * @since 3.5.0
+ *
+ * @param array $wp_get_mime_types Mime types keyed by the file extension regex
+ * corresponding to those types.
+ */
+ return apply_filters( 'mime_types', array(
+ // Image formats.
+ 'jpg|jpeg|jpe' => 'image/jpeg',
+ 'gif' => 'image/gif',
+ 'png' => 'image/png',
+ 'bmp' => 'image/bmp',
+ 'tiff|tif' => 'image/tiff',
+ 'ico' => 'image/x-icon',
+ // Video formats.
+ 'asf|asx' => 'video/x-ms-asf',
+ 'wmv' => 'video/x-ms-wmv',
+ 'wmx' => 'video/x-ms-wmx',
+ 'wm' => 'video/x-ms-wm',
+ 'avi' => 'video/avi',
+ 'divx' => 'video/divx',
+ 'flv' => 'video/x-flv',
+ 'mov|qt' => 'video/quicktime',
+ 'mpeg|mpg|mpe' => 'video/mpeg',
+ 'mp4|m4v' => 'video/mp4',
+ 'ogv' => 'video/ogg',
+ 'webm' => 'video/webm',
+ 'mkv' => 'video/x-matroska',
+ '3gp|3gpp' => 'video/3gpp', // Can also be audio
+ '3g2|3gp2' => 'video/3gpp2', // Can also be audio
+ // Text formats.
+ 'txt|asc|c|cc|h|srt' => 'text/plain',
+ 'csv' => 'text/csv',
+ 'tsv' => 'text/tab-separated-values',
+ 'ics' => 'text/calendar',
+ 'rtx' => 'text/richtext',
+ 'css' => 'text/css',
+ 'htm|html' => 'text/html',
+ 'vtt' => 'text/vtt',
+ 'dfxp' => 'application/ttaf+xml',
+ // Audio formats.
+ 'mp3|m4a|m4b' => 'audio/mpeg',
+ 'ra|ram' => 'audio/x-realaudio',
+ 'wav' => 'audio/wav',
+ 'ogg|oga' => 'audio/ogg',
+ 'mid|midi' => 'audio/midi',
+ 'wma' => 'audio/x-ms-wma',
+ 'wax' => 'audio/x-ms-wax',
+ 'mka' => 'audio/x-matroska',
+ // Misc application formats.
+ 'rtf' => 'application/rtf',
+ 'js' => 'application/javascript',
+ 'pdf' => 'application/pdf',
+ 'swf' => 'application/x-shockwave-flash',
+ 'class' => 'application/java',
+ 'tar' => 'application/x-tar',
+ 'zip' => 'application/zip',
+ 'gz|gzip' => 'application/x-gzip',
+ 'rar' => 'application/rar',
+ '7z' => 'application/x-7z-compressed',
+ 'exe' => 'application/x-msdownload',
+ 'psd' => 'application/octet-stream',
+ 'xcf' => 'application/octet-stream',
+ // MS Office formats.
+ 'doc' => 'application/msword',
+ 'pot|pps|ppt' => 'application/vnd.ms-powerpoint',
+ 'wri' => 'application/vnd.ms-write',
+ 'xla|xls|xlt|xlw' => 'application/vnd.ms-excel',
+ 'mdb' => 'application/vnd.ms-access',
+ 'mpp' => 'application/vnd.ms-project',
+ 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+ 'docm' => 'application/vnd.ms-word.document.macroEnabled.12',
+ 'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
+ 'dotm' => 'application/vnd.ms-word.template.macroEnabled.12',
+ 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+ 'xlsm' => 'application/vnd.ms-excel.sheet.macroEnabled.12',
+ 'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
+ 'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
+ 'xltm' => 'application/vnd.ms-excel.template.macroEnabled.12',
+ 'xlam' => 'application/vnd.ms-excel.addin.macroEnabled.12',
+ 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+ 'pptm' => 'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
+ 'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
+ 'ppsm' => 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
+ 'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template',
+ 'potm' => 'application/vnd.ms-powerpoint.template.macroEnabled.12',
+ 'ppam' => 'application/vnd.ms-powerpoint.addin.macroEnabled.12',
+ 'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
+ 'sldm' => 'application/vnd.ms-powerpoint.slide.macroEnabled.12',
+ 'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
+ 'oxps' => 'application/oxps',
+ 'xps' => 'application/vnd.ms-xpsdocument',
+ // OpenOffice formats.
+ 'odt' => 'application/vnd.oasis.opendocument.text',
+ 'odp' => 'application/vnd.oasis.opendocument.presentation',
+ 'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
+ 'odg' => 'application/vnd.oasis.opendocument.graphics',
+ 'odc' => 'application/vnd.oasis.opendocument.chart',
+ 'odb' => 'application/vnd.oasis.opendocument.database',
+ 'odf' => 'application/vnd.oasis.opendocument.formula',
+ // WordPerfect formats.
+ 'wp|wpd' => 'application/wordperfect',
+ // iWork formats.
+ 'key' => 'application/vnd.apple.keynote',
+ 'numbers' => 'application/vnd.apple.numbers',
+ 'pages' => 'application/vnd.apple.pages',
+ ) );
+}
- $trans['add']['user'] = array(__('Are you sure you want to add this user?'), false);
- $trans['delete']['users'] = array(__('Are you sure you want to delete users?'), false);
- $trans['bulk']['users'] = array(__('Are you sure you want to bulk modify users?'), false);
- $trans['update']['user'] = array(__('Are you sure you want to edit this user: "%s"?'), 'get_author_name');
- $trans['update']['profile'] = array(__('Are you sure you want to modify the profile for: "%s"?'), 'get_author_name');
+/**
+ * Retrieves the list of common file extensions and their types.
+ *
+ * @since 4.6.0
+ *
+ * @return array Array of file extensions types keyed by the type of file.
+ */
+function wp_get_ext_types() {
+
+ /**
+ * Filters file type based on the extension name.
+ *
+ * @since 2.5.0
+ *
+ * @see wp_ext2type()
+ *
+ * @param array $ext2type Multi-dimensional array with extensions for a default set
+ * of file types.
+ */
+ return apply_filters( 'ext2type', array(
+ 'image' => array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'bmp', 'tif', 'tiff', 'ico' ),
+ 'audio' => array( 'aac', 'ac3', 'aif', 'aiff', 'm3a', 'm4a', 'm4b', 'mka', 'mp1', 'mp2', 'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
+ 'video' => array( '3g2', '3gp', '3gpp', 'asf', 'avi', 'divx', 'dv', 'flv', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt', 'rm', 'vob', 'wmv' ),
+ 'document' => array( 'doc', 'docx', 'docm', 'dotm', 'odt', 'pages', 'pdf', 'xps', 'oxps', 'rtf', 'wp', 'wpd', 'psd', 'xcf' ),
+ 'spreadsheet' => array( 'numbers', 'ods', 'xls', 'xlsx', 'xlsm', 'xlsb' ),
+ 'interactive' => array( 'swf', 'key', 'ppt', 'pptx', 'pptm', 'pps', 'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ),
+ 'text' => array( 'asc', 'csv', 'tsv', 'txt' ),
+ 'archive' => array( 'bz2', 'cab', 'dmg', 'gz', 'rar', 'sea', 'sit', 'sqx', 'tar', 'tgz', 'zip', '7z' ),
+ 'code' => array( 'css', 'htm', 'html', 'php', 'js' ),
+ ) );
+}
- $trans['update']['options'] = array(__('Are you sure you want to edit your settings?'), false);
- $trans['update']['permalink'] = array(__('Are you sure you want to change your permalink structure to: %s?'), 'use_id');
- $trans['edit']['file'] = array(__('Are you sure you want to edit this file: "%s"?'), 'use_id');
- $trans['edit']['theme'] = array(__('Are you sure you want to edit this theme file: "%s"?'), 'use_id');
- $trans['switch']['theme'] = array(__('Are you sure you want to switch to this theme: "%s"?'), 'use_id');
+/**
+ * Retrieve list of allowed mime types and file extensions.
+ *
+ * @since 2.8.6
+ *
+ * @param int|WP_User $user Optional. User to check. Defaults to current user.
+ * @return array Array of mime types keyed by the file extension regex corresponding
+ * to those types.
+ */
+function get_allowed_mime_types( $user = null ) {
+ $t = wp_get_mime_types();
+
+ unset( $t['swf'], $t['exe'] );
+ if ( function_exists( 'current_user_can' ) )
+ $unfiltered = $user ? user_can( $user, 'unfiltered_html' ) : current_user_can( 'unfiltered_html' );
+
+ if ( empty( $unfiltered ) )
+ unset( $t['htm|html'] );
+
+ /**
+ * Filters list of allowed mime types and file extensions.
+ *
+ * @since 2.0.0
+ *
+ * @param array $t Mime types keyed by the file extension regex corresponding to
+ * those types. 'swf' and 'exe' removed from full list. 'htm|html' also
+ * removed depending on '$user' capabilities.
+ * @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user).
+ */
+ return apply_filters( 'upload_mimes', $t, $user );
+}
- if ( isset($trans[$verb][$noun]) ) {
- if ( !empty($trans[$verb][$noun][1]) ) {
- $lookup = $trans[$verb][$noun][1];
- $object = $matches[4];
- if ( 'use_id' != $lookup )
- $object = call_user_func($lookup, $object);
- return sprintf($trans[$verb][$noun][0], $object);
- } else {
- return $trans[$verb][$noun][0];
- }
+/**
+ * Display "Are You Sure" message to confirm the action being taken.
+ *
+ * If the action has the nonce explain message, then it will be displayed
+ * along with the "Are you sure?" message.
+ *
+ * @since 2.0.4
+ *
+ * @param string $action The nonce action.
+ */
+function wp_nonce_ays( $action ) {
+ if ( 'log-out' == $action ) {
+ $html = sprintf(
+ /* translators: %s: site name */
+ __( 'You are attempting to log out of %s' ),
+ get_bloginfo( 'name' )
+ );
+ $html .= '
';
+ $redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
+ $html .= sprintf(
+ /* translators: %s: logout URL */
+ __( 'Do you really want to log out ?' ),
+ wp_logout_url( $redirect_to )
+ );
+ } else {
+ $html = __( 'Are you sure you want to do this?' );
+ if ( wp_get_referer() ) {
+ $html .= '
';
+ $html .= sprintf( '%s ',
+ esc_url( remove_query_arg( 'updated', wp_get_referer() ) ),
+ __( 'Please try again.' )
+ );
}
}
- return apply_filters( 'explain_nonce_' . $verb . '-' . $noun, __('Are you sure you want to do this?'), $matches[4] );
+ wp_die( $html, __( 'WordPress Failure Notice' ), 403 );
}
-function wp_nonce_ays($action) {
- global $pagenow, $menu, $submenu, $parent_file, $submenu_file;
-
- $adminurl = get_option('siteurl') . '/wp-admin';
- if ( wp_get_referer() )
- $adminurl = clean_url(wp_get_referer());
+/**
+ * Kill WordPress execution and display HTML message with error message.
+ *
+ * This function complements the `die()` PHP function. The difference is that
+ * HTML will be displayed to the user. It is recommended to use this function
+ * only when the execution should not continue any further. It is not recommended
+ * to call this function very often, and try to handle as many errors as possible
+ * silently or more gracefully.
+ *
+ * As a shorthand, the desired HTTP response code may be passed as an integer to
+ * the `$title` parameter (the default title would apply) or the `$args` parameter.
+ *
+ * @since 2.0.4
+ * @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept
+ * an integer to be used as the response code.
+ *
+ * @param string|WP_Error $message Optional. Error message. If this is a WP_Error object,
+ * and not an Ajax or XML-RPC request, the error's messages are used.
+ * Default empty.
+ * @param string|int $title Optional. Error title. If `$message` is a `WP_Error` object,
+ * error data with the key 'title' may be used to specify the title.
+ * If `$title` is an integer, then it is treated as the response
+ * code. Default empty.
+ * @param string|array|int $args {
+ * Optional. Arguments to control behavior. If `$args` is an integer, then it is treated
+ * as the response code. Default empty array.
+ *
+ * @type int $response The HTTP response code. Default 200 for Ajax requests, 500 otherwise.
+ * @type bool $back_link Whether to include a link to go back. Default false.
+ * @type string $text_direction The text direction. This is only useful internally, when WordPress
+ * is still loading and the site's locale is not set up yet. Accepts 'rtl'.
+ * Default is the value of is_rtl().
+ * }
+ */
+function wp_die( $message = '', $title = '', $args = array() ) {
+
+ if ( is_int( $args ) ) {
+ $args = array( 'response' => $args );
+ } elseif ( is_int( $title ) ) {
+ $args = array( 'response' => $title );
+ $title = '';
+ }
- $title = __('WordPress Confirmation');
- // Remove extra layer of slashes.
- $_POST = stripslashes_deep($_POST );
- if ( $_POST ) {
- $q = http_build_query($_POST);
- $q = explode( ini_get('arg_separator.output'), $q);
- $html .= "\t
\n";
+ if ( wp_doing_ajax() ) {
+ /**
+ * Filters the callback for killing WordPress execution for Ajax requests.
+ *
+ * @since 3.4.0
+ *
+ * @param callable $function Callback function name.
+ */
+ $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
+ } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
+ /**
+ * Filters the callback for killing WordPress execution for XML-RPC requests.
+ *
+ * @since 3.4.0
+ *
+ * @param callable $function Callback function name.
+ */
+ $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
} else {
- $html .= "\t\n";
+ /**
+ * Filters the callback for killing WordPress execution for all non-Ajax, non-XML-RPC requests.
+ *
+ * @since 3.0.0
+ *
+ * @param callable $function Callback function name.
+ */
+ $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
}
- $html .= "