<?php
-
-function mysql2date($dateformatstring, $mysqlstring, $translate = true) {
+/**
+ * Main WordPress API
+ *
+ * @package WordPress
+ */
+
+/**
+ * Converts MySQL DATETIME field to user specified date format.
+ *
+ * If $dateformatstring has 'G' value, then gmmktime() function will be used to
+ * make the time. If $dateformatstring is set to 'U', then mktime() function
+ * will be used to make the time.
+ *
+ * The $translate will only be used, if it is set to true and it is by default
+ * and if the $wp_locale object has the month and weekday set.
+ *
+ * @since 0.71
+ *
+ * @param string $dateformatstring Either 'G', 'U', or php date format.
+ * @param string $mysqlstring Time from mysql DATETIME field.
+ * @param bool $translate Optional. Default is true. Will switch format to locale.
+ * @return string Date formated by $dateformatstring or locale (if available).
+ */
+function mysql2date( $dateformatstring, $mysqlstring, $translate = true ) {
global $wp_locale;
$m = $mysqlstring;
- if ( empty($m) ) {
+ if ( empty( $m ) )
return false;
+
+ if( 'G' == $dateformatstring ) {
+ return strtotime( $m . ' +0000' );
}
- $i = mktime(
- (int) substr( $m, 11, 2 ), (int) substr( $m, 14, 2 ), (int) substr( $m, 17, 2 ),
- (int) substr( $m, 5, 2 ), (int) substr( $m, 8, 2 ), (int) substr( $m, 0, 4 )
- );
+
+ $i = strtotime( $m );
if( 'U' == $dateformatstring )
return $i;
- if ( -1 == $i || false == $i )
- $i = 0;
-
- if ( !empty($wp_locale->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);
-
- $dateformatstring = substr($dateformatstring, 1, strlen($dateformatstring)-1);
- }
- $j = @date($dateformatstring, $i);
- if ( !$j ) {
- // for debug purposes
- // echo $i." ".$mysqlstring;
- }
- return $j;
-}
-
-function current_time($type, $gmt = 0) {
- switch ($type) {
+ if ( $translate)
+ return date_i18n( $dateformatstring, $i );
+ else
+ return date( $dateformatstring, $i );
+}
+
+/**
+ * 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.
+ *
+ * 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 Either 'mysql' or 'timestamp'.
+ * @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
+ * @return int|string String if $type is 'gmt', int if $type is 'timestamp'.
+ */
+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;
+ return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * 3600 ) ) );
break;
case 'timestamp':
- if ( $gmt ) $d = time();
- else $d = time() + (get_option('gmt_offset') * 3600);
- return $d;
+ return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * 3600 );
break;
}
}
-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
+ *
+ * @param string $dateformatstring Format to display the date.
+ * @param int $unixtimestamp Optional. Unix timestamp.
+ * @param bool $gmt Optional, default is false. Whether to convert to GMT for time.
+ * @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);
+ // Sanity check for PHP 5.1.0-
+ if ( false === $i || intval($i) < 0 ) {
+ if ( ! $gmt )
+ $i = current_time( 'timestamp' );
+ else
+ $i = time();
+ // we should not let date() interfere with our
+ // specially computed timestamp
+ $gmt = true;
}
- $j = @date($dateformatstring, $i);
+
+ // store original value for language with untypical grammars
+ // see http://core.trac.wordpress.org/ticket/9396
+ $req_format = $dateformatstring;
+
+ $datefunc = $gmt? 'gmdate' : 'date';
+
+ if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
+ $datemonth = $wp_locale->get_month( $datefunc( 'm', $i ) );
+ $datemonth_abbrev = $wp_locale->get_month_abbrev( $datemonth );
+ $dateweekday = $wp_locale->get_weekday( $datefunc( 'w', $i ) );
+ $dateweekday_abbrev = $wp_locale->get_weekday_abbrev( $dateweekday );
+ $datemeridiem = $wp_locale->get_meridiem( $datefunc( 'a', $i ) );
+ $datemeridiem_capital = $wp_locale->get_meridiem( $datefunc( '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 );
+ }
+ $j = @$datefunc( $dateformatstring, $i );
+ // allow plugins to redo this entirely for languages with untypical grammars
+ $j = apply_filters('date_i18n', $j, $req_format, $i, $gmt);
return $j;
}
-function number_format_i18n($number, $decimals = null) {
+/**
+ * Convert number to format based on the locale.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $number The number to convert based on locale.
+ * @param int $decimals Precision of the number of decimal places.
+ * @return string Converted number in string format.
+ */
+function number_format_i18n( $number, $decimals = null ) {
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
+ $decimals = ( is_null( $decimals ) ) ? $wp_locale->number_format['decimals'] : intval( $decimals );
+
+ $num = number_format( $number, $decimals, $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
+
+ // let the user translate digits from latin to localized language
+ return apply_filters( 'number_format_i18n', $num );
+}
+
+/**
+ * Convert number of bytes largest unit bytes will fit into.
+ *
+ * It is easier to read 1kB than 1024 bytes and 1MB 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.
+ * @link http://en.wikipedia.org/wiki/Byte
+ *
+ * @since 2.3.0
+ *
+ * @param int|string $bytes Number of bytes. Note max integer size for integers.
+ * @param int $decimals Precision of number of decimal places.
+ * @return bool|string False on failure. Number string on success.
+ */
+function size_format( $bytes, $decimals = null ) {
$quant = array(
- 'TB' => pow(1024, 4),
- 'GB' => pow(1024, 3),
- 'MB' => pow(1024, 2),
- 'kB' => pow(1024, 1),
- 'B' => pow(1024, 0),
+ // ========================= Origin ====
+ 'TB' => 1099511627776, // pow( 1024, 4)
+ 'GB' => 1073741824, // pow( 1024, 3)
+ 'MB' => 1048576, // pow( 1024, 2)
+ 'kB' => 1024, // pow( 1024, 1)
+ 'B ' => 1, // pow( 1024, 0)
);
- foreach ($quant as $unit => $mag)
- if ( intval($bytes) >= $mag )
- return number_format_i18n($bytes / $mag, $decimals) . ' ' . $unit;
-}
+ foreach ( $quant as $unit => $mag )
+ if ( doubleval($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;
-
- if ( $weekday < get_option('start_of_week') )
- $weekday = 7 - (get_option('start_of_week') - $weekday);
-
- 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);
+ return false;
+}
- $day = $day - 86400;
+/**
+ * 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 $start_of_week Optional. Start of the week as an integer.
+ * @return array Keys are 'start' and 'end'.
+ */
+function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
+ $my = substr( $mysqlstring, 0, 4 ); // Mysql string Year
+ $mm = substr( $mysqlstring, 8, 2 ); // Mysql string Month
+ $md = substr( $mysqlstring, 5, 2 ); // Mysql string day
+ $day = mktime( 0, 0, 0, $md, $mm, $my ); // The timestamp for mysqlstring day.
+ $weekday = date( 'w', $day ); // The day of the week from the timestamp
+ $i = 86400; // One day
+ if( !is_numeric($start_of_week) )
+ $start_of_week = get_option( 'start_of_week' );
+
+ if ( $weekday < $start_of_week )
+ $weekday = 7 - $start_of_week - $weekday;
+
+ while ( $weekday > $start_of_week ) {
+ $weekday = date( 'w', $day );
+ if ( $weekday < $start_of_week )
+ $weekday = 7 - $start_of_week - $weekday;
+
+ $day -= 86400;
$i = 0;
}
$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;
+/**
+ * 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;
}
-function is_serialized($data) {
+/**
+ * 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 mixed $data Value to check to see if was serialized.
+ * @return bool False if not serialized and true if it was.
+ */
+function is_serialized( $data ) {
// if it isn't a string, it isn't serialized
- if ( !is_string($data) )
+ if ( !is_string( $data ) )
return false;
- $data = trim($data);
+ $data = trim( $data );
if ( 'N;' == $data )
return true;
- if ( !preg_match('/^([adObis]):/', $data, $badions) )
+ 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;
+ 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;
+ }
return false;
}
-function is_serialized_string($data) {
+/**
+ * Check whether serialized data is of string type.
+ *
+ * @since 2.0.5
+ *
+ * @param mixed $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) )
+ if ( !is_string( $data ) )
return false;
- $data = trim($data);
- if ( preg_match('/^s:[0-9]+:.*;$/s',$data) ) // this should fetch all serialized strings
+ $data = trim( $data );
+ if ( preg_match( '/^s:[0-9]+:.*;$/s', $data ) ) // this should fetch all serialized strings
return true;
return false;
}
-/* Options functions */
-
-// expects $setting to already be SQL-escaped
-function get_option($setting) {
+/**
+ * Retrieve option value based on setting name.
+ *
+ * If the option does not exist or does not have a value, then the return value
+ * will be false. This is useful to check whether you need to install an option
+ * and is commonly used during installation of plugin options and to test
+ * whether upgrading is required.
+ *
+ * You can "short-circuit" the retrieval of the option from the database for
+ * your plugin or core options that aren't protected. You can do so by hooking
+ * into the 'pre_option_$option' with the $option being replaced by the option
+ * name. You should not try to override special options, but you will not be
+ * prevented from doing so.
+ *
+ * There is a second filter called 'option_$option' with the $option being
+ * replaced with the option name. This gives the value as the only parameter.
+ *
+ * If the option was serialized, when the option was added and, or updated, then
+ * it will be unserialized, when it is returned.
+ *
+ * @since 1.5.0
+ * @package WordPress
+ * @subpackage Option
+ * @uses apply_filters() Calls 'pre_option_$optionname' false to allow
+ * overwriting the option value in a plugin.
+ * @uses apply_filters() Calls 'option_$optionname' with the option name value.
+ *
+ * @param string $setting Name of option to retrieve. Should already be SQL-escaped
+ * @return mixed Value set for the option.
+ */
+function get_option( $setting, $default = false ) {
global $wpdb;
// Allow plugins to short-circuit options.
return $pre;
// prevent non-existent options from triggering multiple queries
- $notoptions = wp_cache_get('notoptions', 'options');
- if ( isset($notoptions[$setting]) )
- return false;
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+ if ( isset( $notoptions[$setting] ) )
+ return $default;
$alloptions = wp_load_alloptions();
- if ( isset($alloptions[$setting]) ) {
+ if ( isset( $alloptions[$setting] ) ) {
$value = $alloptions[$setting];
} else {
- $value = wp_cache_get($setting, 'options');
+ $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
+ if ( defined( 'WP_INSTALLING' ) )
+ $suppress = $wpdb->suppress_errors();
+ // expected_slashed ($setting)
+ $row = $wpdb->get_row( "SELECT option_value FROM $wpdb->options WHERE option_name = '$setting' LIMIT 1" );
+ if ( defined( 'WP_INSTALLING' ) )
+ $wpdb->suppress_errors($suppress);
+
+ 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');
+ 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;
+ wp_cache_set( 'notoptions', $notoptions, 'options' );
+ return $default;
}
}
}
// 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)));
-}
-
-function form_option($option) {
- echo attribute_escape(get_option($option));
-}
-
+ 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 ) );
+}
+
+/**
+ * Protect WordPress special option from being modified.
+ *
+ * Will die if $option is in protected list. Protected options are 'alloptions'
+ * and 'notoptions' options.
+ *
+ * @since 2.2.0
+ * @package WordPress
+ * @subpackage Option
+ *
+ * @param string $option Option name.
+ */
+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' ), esc_html( $option ) ) );
+}
+
+/**
+ * Print option value after sanitizing for forms.
+ *
+ * @uses attr Sanitizes value.
+ * @since 1.5.0
+ * @package WordPress
+ * @subpackage Option
+ *
+ * @param string $option Option name.
+ */
+function form_option( $option ) {
+ echo esc_attr(get_option( $option ) );
+}
+
+/**
+ * Retrieve all autoload options or all options, if no autoloaded ones exist.
+ *
+ * This is different from wp_load_alloptions() in that this function does not
+ * cache its results and will retrieve all options from the database every time
+ *
+ * it is called.
+ *
+ * @since 1.0.0
+ * @package WordPress
+ * @subpackage Option
+ * @uses apply_filters() Calls 'pre_option_$optionname' hook with option value as parameter.
+ * @uses apply_filters() Calls 'all_options' on options list.
+ *
+ * @return array List of all options.
+ */
function get_alloptions() {
- global $wpdb, $wp_queries;
+ global $wpdb;
$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 ( !$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" );
$wpdb->show_errors($show);
- foreach ($options as $option) {
+ foreach ( (array) $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);
- }
- return apply_filters('all_options', $all_options);
-}
-
+ if ( in_array( $option->option_name, array( 'siteurl', 'home', 'category_base', 'tag_base' ) ) )
+ $option->option_value = untrailingslashit( $option->option_value );
+ $value = maybe_unserialize( $option->option_value );
+ $all_options->{$option->option_name} = apply_filters( 'pre_option_' . $option->option_name, $value );
+ }
+ return apply_filters( 'all_options', $all_options );
+}
+
+/**
+ * Loads and caches all autoloaded options, if available or all options.
+ *
+ * This is different from get_alloptions(), in that this function will cache the
+ * options and will return the cached options when called again.
+ *
+ * @since 2.2.0
+ * @package WordPress
+ * @subpackage Option
+ *
+ * @return array List all options.
+ */
function wp_load_alloptions() {
global $wpdb;
- $alloptions = wp_cache_get('alloptions', 'options');
+ $alloptions = wp_cache_get( 'alloptions', 'options' );
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);
+ $suppress = $wpdb->suppress_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->suppress_errors($suppress);
$alloptions = array();
foreach ( (array) $alloptions_db as $o )
$alloptions[$o->option_name] = $o->option_value;
- wp_cache_add('alloptions', $alloptions, 'options');
+ wp_cache_add( 'alloptions', $alloptions, 'options' );
}
return $alloptions;
}
-// expects $option_name to NOT be SQL-escaped
-function update_option($option_name, $newvalue) {
+/**
+ * Update the value of an option that was already added.
+ *
+ * You do not need to serialize values, if the value needs to be serialize, then
+ * it will be serialized before it is inserted into the database. Remember,
+ * resources can not be serialized or added as an option.
+ *
+ * If the option does not exist, then the option will be added with the option
+ * value, but you will not be able to set whether it is autoloaded. If you want
+ * to set whether an option autoloaded, then you need to use the add_option().
+ *
+ * Before the option is updated, then the filter named
+ * 'pre_update_option_$option_name', with the $option_name as the $option_name
+ * parameter value, will be called. The hook should accept two parameters, the
+ * first is the new value and the second is the old value. Whatever is
+ * returned will be used as the new value.
+ *
+ * After the value has been updated the action named 'update_option_$option_name'
+ * will be called. This action receives two parameters the first being the old
+ * value and the second the new value.
+ *
+ * @since 1.0.0
+ * @package WordPress
+ * @subpackage Option
+ *
+ * @param string $option_name Option name. Expected to not be SQL-escaped
+ * @param mixed $newvalue Option value.
+ * @return bool False if value was not updated and true if value was updated.
+ */
+function update_option( $option_name, $newvalue ) {
global $wpdb;
- wp_protect_special_option($option_name);
+ wp_protect_special_option( $option_name );
- $safe_option_name = $wpdb->escape($option_name);
- $newvalue = sanitize_option($option_name, $newvalue);
+ $safe_option_name = $wpdb->escape( $option_name );
+ $newvalue = sanitize_option( $option_name, $newvalue );
- if ( is_string($newvalue) )
- $newvalue = trim($newvalue);
+ $oldvalue = get_option( $safe_option_name );
+
+ $newvalue = apply_filters( 'pre_update_option_' . $option_name, $newvalue, $oldvalue );
// If the new and old values are the same, no need to update.
- $oldvalue = get_option($safe_option_name);
- if ( $newvalue === $oldvalue ) {
+ if ( $newvalue === $oldvalue )
return false;
- }
if ( false === $oldvalue ) {
- add_option($option_name, $newvalue);
+ add_option( $option_name, $newvalue );
return true;
}
- $notoptions = wp_cache_get('notoptions', 'options');
- if ( is_array($notoptions) && isset($notoptions[$option_name]) ) {
- unset($notoptions[$option_name]);
- wp_cache_set('notoptions', $notoptions, 'options');
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+ if ( is_array( $notoptions ) && isset( $notoptions[$option_name] ) ) {
+ unset( $notoptions[$option_name] );
+ wp_cache_set( 'notoptions', $notoptions, 'options' );
}
$_newvalue = $newvalue;
- $newvalue = maybe_serialize($newvalue);
+ $newvalue = maybe_serialize( $newvalue );
$alloptions = wp_load_alloptions();
- if ( isset($alloptions[$option_name]) ) {
+ if ( isset( $alloptions[$option_name] ) ) {
$alloptions[$option_name] = $newvalue;
- wp_cache_set('alloptions', $alloptions, 'options');
+ wp_cache_set( 'alloptions', $alloptions, 'options' );
} else {
- wp_cache_set($option_name, $newvalue, 'options');
+ wp_cache_set( $option_name, $newvalue, 'options' );
}
- $newvalue = $wpdb->escape($newvalue);
- $option_name = $wpdb->escape($option_name);
- $wpdb->query("UPDATE $wpdb->options SET option_value = '$newvalue' WHERE option_name = '$option_name'");
+ $wpdb->update($wpdb->options, array('option_value' => $newvalue), array('option_name' => $option_name) );
+
if ( $wpdb->rows_affected == 1 ) {
- do_action("update_option_{$option_name}", $oldvalue, $_newvalue);
+ do_action( "update_option_{$option_name}", $oldvalue, $_newvalue );
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') {
+/**
+ * Add a new option.
+ *
+ * You do not need to serialize values, if the value needs to be serialize, then
+ * it will be serialized before it is inserted into the database. Remember,
+ * resources can not be serialized or added as an option.
+ *
+ * You can create options without values and then add values later. Does not
+ * check whether the option has already been added, but does check that you
+ * aren't adding a protected WordPress option. Care should be taken to not name
+ * options, the same as the ones which are protected and to not add options
+ * that were already added.
+ *
+ * The filter named 'add_option_$optionname', with the $optionname being
+ * replaced with the option's name, will be called. The hook should accept two
+ * parameters, the first is the option name, and the second is the value.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 1.0.0
+ * @link http://alex.vort-x.net/blog/ Thanks Alex Stapleton
+ *
+ * @param string $name Option name to add. Expects to NOT be SQL escaped.
+ * @param mixed $value Optional. Option value, can be anything.
+ * @param mixed $deprecated Optional. Description. Not used anymore.
+ * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.
+ * @return null returns when finished.
+ */
+function add_option( $name, $value = '', $deprecated = '', $autoload = 'yes' ) {
global $wpdb;
- wp_protect_special_option($name);
- $safe_name = $wpdb->escape($name);
+ wp_protect_special_option( $name );
+ $safe_name = $wpdb->escape( $name );
+ $value = sanitize_option( $name, $value );
// 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) )
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+ if ( !is_array( $notoptions ) || !isset( $notoptions[$name] ) )
+ if ( false !== get_option( $safe_name ) )
return;
- $value = maybe_serialize($value);
+ $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');
+ wp_cache_set( 'alloptions', $alloptions, 'options' );
} else {
- wp_cache_set($name, $value, 'options');
+ wp_cache_set( $name, $value, 'options' );
}
// 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');
+ $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' );
}
- $name = $wpdb->escape($name);
- $value = $wpdb->escape($value);
- $wpdb->query("INSERT INTO $wpdb->options (option_name, option_value, autoload) VALUES ('$name', '$value', '$autoload')");
+ $wpdb->insert($wpdb->options, array('option_name' => $name, 'option_value' => $value, 'autoload' => $autoload) );
+ do_action( "add_option_{$name}", $name, $value );
return;
}
-function delete_option($name) {
+/**
+ * Removes option by name and prevents removal of protected WordPress options.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 1.2.0
+ *
+ * @param string $name Option name to remove.
+ * @return bool True, if succeed. False, if failure.
+ */
+function delete_option( $name ) {
global $wpdb;
- wp_protect_special_option($name);
+ 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'");
+ // expected_slashed ($name)
+ $option = $wpdb->get_row( "SELECT option_id, autoload FROM $wpdb->options WHERE option_name = '$name'" );
+ if ( is_null($option) || !$option->option_id )
+ return false;
+ // expected_slashed ($name)
+ $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 ( isset( $alloptions[$name] ) ) {
+ unset( $alloptions[$name] );
+ wp_cache_set( 'alloptions', $alloptions, 'options' );
}
} else {
- wp_cache_delete($name, 'options');
+ wp_cache_delete( $name, 'options' );
}
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;
+/**
+ * Delete a transient
+ *
+ * @since 2.8.0
+ * @package WordPress
+ * @subpackage Transient
+ *
+ * @param string $transient Transient name. Expected to not be SQL-escaped
+ * @return bool true if successful, false otherwise
+ */
+function delete_transient($transient) {
+ global $_wp_using_ext_object_cache, $wpdb;
+
+ if ( $_wp_using_ext_object_cache ) {
+ return wp_cache_delete($transient, 'transient');
+ } else {
+ $transient = '_transient_' . $wpdb->escape($transient);
+ return delete_option($transient);
+ }
+}
+
+/**
+ * Get the value of a transient
+ *
+ * If the transient does not exist or does not have a value, then the return value
+ * will be false.
+ *
+ * @since 2.8.0
+ * @package WordPress
+ * @subpackage Transient
+ *
+ * @param string $transient Transient name. Expected to not be SQL-escaped
+ * @return mixed Value of transient
+ */
+function get_transient($transient) {
+ global $_wp_using_ext_object_cache, $wpdb;
+
+ $pre = apply_filters( 'pre_transient_' . $transient, false );
+ if ( false !== $pre )
+ return $pre;
+
+ if ( $_wp_using_ext_object_cache ) {
+ $value = wp_cache_get($transient, 'transient');
+ } else {
+ $transient_option = '_transient_' . $wpdb->escape($transient);
+ // If option is not in alloptions, it is not autoloaded and thus has a timeout
+ $alloptions = wp_load_alloptions();
+ if ( !isset( $alloptions[$transient_option] ) ) {
+ $transient_timeout = '_transient_timeout_' . $wpdb->escape($transient);
+ if ( get_option($transient_timeout) < time() ) {
+ delete_option($transient_option);
+ delete_option($transient_timeout);
+ return false;
+ }
+ }
+
+ $value = get_option($transient_option);
+ }
+
+ return apply_filters('transient_' . $transient, $value);
}
-function gzip_compression() {
- if ( !get_option( 'gzipcompression' ) ) {
- return false;
+/**
+ * Set/update the value of a transient
+ *
+ * You do not need to serialize values, if the value needs to be serialize, then
+ * it will be serialized before it is set.
+ *
+ * @since 2.8.0
+ * @package WordPress
+ * @subpackage Transient
+ *
+ * @param string $transient Transient name. Expected to not be SQL-escaped
+ * @param mixed $value Transient value.
+ * @param int $expiration Time until expiration in seconds, default 0
+ * @return bool False if value was not set and true if value was set.
+ */
+function set_transient($transient, $value, $expiration = 0) {
+ global $_wp_using_ext_object_cache, $wpdb;
+
+ if ( $_wp_using_ext_object_cache ) {
+ return wp_cache_set($transient, $value, 'transient', $expiration);
+ } else {
+ $transient_timeout = '_transient_timeout_' . $transient;
+ $transient = '_transient_' . $transient;
+ $safe_transient = $wpdb->escape($transient);
+ if ( false === get_option( $safe_transient ) ) {
+ $autoload = 'yes';
+ if ( 0 != $expiration ) {
+ $autoload = 'no';
+ add_option($transient_timeout, time() + $expiration, '', 'no');
+ }
+ return add_option($transient, $value, '', $autoload);
+ } else {
+ if ( 0 != $expiration )
+ update_option($transient_timeout, time() + $expiration);
+ return update_option($transient, $value);
+ }
}
+}
+
+/**
+ * Saves and restores user interface settings stored in a cookie.
+ *
+ * Checks if the current user-settings cookie is updated and stores it. When no
+ * cookie exists (different browser used), adds the last saved cookie restoring
+ * the settings.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.7.0
+ */
+function wp_user_settings() {
+
+ if ( ! is_admin() )
+ return;
+
+ if ( defined('DOING_AJAX') )
+ return;
+
+ if ( ! $user = wp_get_current_user() )
+ return;
+
+ $settings = get_user_option( 'user-settings', $user->ID, false );
+
+ if ( isset( $_COOKIE['wp-settings-' . $user->ID] ) ) {
+ $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user->ID] );
+
+ if ( ! empty( $cookie ) && strpos( $cookie, '=' ) ) {
+ if ( $cookie == $settings )
+ return;
+
+ $last_time = (int) get_user_option( 'user-settings-time', $user->ID, false );
+ $saved = isset( $_COOKIE['wp-settings-time-' . $user->ID]) ? preg_replace( '/[^0-9]/', '', $_COOKIE['wp-settings-time-' . $user->ID] ) : 0;
+
+ if ( $saved > $last_time ) {
+ update_user_option( $user->ID, 'user-settings', $cookie, false );
+ update_user_option( $user->ID, 'user-settings-time', time() - 5, false );
+ return;
+ }
+ }
+ }
+
+ setcookie( 'wp-settings-' . $user->ID, $settings, time() + 31536000, SITECOOKIEPATH );
+ setcookie( 'wp-settings-time-' . $user->ID, time(), time() + 31536000, SITECOOKIEPATH );
+ $_COOKIE['wp-settings-' . $user->ID] = $settings;
+}
+
+/**
+ * Retrieve user interface setting value based on setting name.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.7.0
+ *
+ * @param string $name The name of the setting.
+ * @param string $default Optional default value to return when $name is not set.
+ * @return mixed the last saved user setting or the default value/false if it doesn't exist.
+ */
+function get_user_setting( $name, $default = false ) {
+
+ $all = get_all_user_settings();
+
+ return isset($all[$name]) ? $all[$name] : $default;
+}
+
+/**
+ * Add or update user interface setting.
+ *
+ * Both $name and $value can contain only ASCII letters, numbers and underscores.
+ * This function has to be used before any output has started as it calls setcookie().
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.8.0
+ *
+ * @param string $name The name of the setting.
+ * @param string $value The value for the setting.
+ * @return bool true if set successfully/false if not.
+ */
+function set_user_setting( $name, $value ) {
+
+ if ( headers_sent() )
+ return false;
+
+ $all = get_all_user_settings();
+ $name = preg_replace( '/[^A-Za-z0-9_]+/', '', $name );
+
+ if ( empty($name) )
+ return false;
+
+ $all[$name] = $value;
+
+ return wp_set_all_user_settings($all);
+}
+
+/**
+ * Delete user interface settings.
+ *
+ * Deleting settings would reset them to the defaults.
+ * This function has to be used before any output has started as it calls setcookie().
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.7.0
+ *
+ * @param mixed $names The name or array of names of the setting to be deleted.
+ * @return bool true if deleted successfully/false if not.
+ */
+function delete_user_setting( $names ) {
- if ( ( ini_get( 'zlib.output_compression' ) == 'On' || ini_get( 'zlib.output_compression_level' ) > 0 ) || ini_get( 'output_handler' ) == 'ob_gzhandler' ) {
+ if ( headers_sent() )
return false;
+
+ $all = get_all_user_settings();
+ $names = (array) $names;
+
+ foreach ( $names as $name ) {
+ if ( isset($all[$name]) ) {
+ unset($all[$name]);
+ $deleted = true;
+ }
}
- if ( extension_loaded( 'zlib' ) ) {
- ob_start( 'ob_gzhandler' );
+ if ( isset($deleted) )
+ return wp_set_all_user_settings($all);
+
+ return false;
+}
+
+/**
+ * Retrieve all user interface settings.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.7.0
+ *
+ * @return array the last saved user settings or empty array.
+ */
+function get_all_user_settings() {
+ global $_updated_user_settings;
+
+ if ( ! $user = wp_get_current_user() )
+ return array();
+
+ if ( isset($_updated_user_settings) && is_array($_updated_user_settings) )
+ return $_updated_user_settings;
+
+ $all = array();
+ if ( isset($_COOKIE['wp-settings-' . $user->ID]) ) {
+ $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user->ID] );
+
+ if ( $cookie && strpos($cookie, '=') ) // the '=' cannot be 1st char
+ parse_str($cookie, $all);
+
+ } else {
+ $option = get_user_option('user-settings', $user->ID);
+ if ( $option && is_string($option) )
+ parse_str( $option, $all );
}
+
+ return $all;
}
-function make_url_footnote($content) {
- preg_match_all('/<a(.+?)href=\"(.+?)\"(.*?)>(.+?)<\/a>/', $content, $matches);
- $j = 0;
- for ($i=0; $i<count($matches[0]); $i++) {
- $links_summary = (!$j) ? "\n" : $links_summary;
- $j++;
+/**
+ * Private. Set all user interface settings.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.8.0
+ *
+ */
+function wp_set_all_user_settings($all) {
+ global $_updated_user_settings;
+
+ if ( ! $user = wp_get_current_user() )
+ return false;
+
+ $_updated_user_settings = $all;
+ $settings = '';
+ foreach ( $all as $k => $v ) {
+ $v = preg_replace( '/[^A-Za-z0-9_]+/', '', $v );
+ $settings .= $k . '=' . $v . '&';
+ }
+
+ $settings = rtrim($settings, '&');
+
+ update_user_option( $user->ID, 'user-settings', $settings, false );
+ update_user_option( $user->ID, 'user-settings-time', time(), false );
+
+ return true;
+}
+
+/**
+ * Delete the user settings of the current user.
+ *
+ * @package WordPress
+ * @subpackage Option
+ * @since 2.7.0
+ */
+function delete_all_user_settings() {
+ if ( ! $user = wp_get_current_user() )
+ return;
+
+ update_user_option( $user->ID, 'user-settings', '', false );
+ setcookie('wp-settings-' . $user->ID, ' ', time() - 31536000, SITECOOKIEPATH);
+}
+
+/**
+ * Serialize data, if needed.
+ *
+ * @since 2.0.5
+ *
+ * @param mixed $data Data that might be serialized.
+ * @return mixed A scalar data
+ */
+function maybe_serialize( $data ) {
+ if ( is_array( $data ) || is_object( $data ) )
+ return serialize( $data );
+
+ if ( is_serialized( $data ) )
+ return serialize( $data );
+
+ return $data;
+}
+
+/**
+ * Strip HTML and put links at the bottom of stripped content.
+ *
+ * Searches for all of the links, strips them out of the content, and places
+ * them at the bottom of the content with numbers.
+ *
+ * @since 0.71
+ *
+ * @param string $content Content to get links
+ * @return string HTML stripped out of content with links at the bottom.
+ */
+function make_url_footnote( $content ) {
+ preg_match_all( '/<a(.+?)href=\"(.+?)\"(.*?)>(.+?)<\/a>/', $content, $matches );
+ $links_summary = "\n";
+ for ( $i=0; $i<count($matches[0]); $i++ ) {
$link_match = $matches[0][$i];
$link_number = '['.($i+1).']';
$link_url = $matches[2][$i];
$link_text = $matches[4][$i];
- $content = str_replace($link_match, $link_text.' '.$link_number, $content);
- $link_url = ((strtolower(substr($link_url,0,7)) != 'http://') && (strtolower(substr($link_url,0,8)) != 'https://')) ? get_option('home') . $link_url : $link_url;
- $links_summary .= "\n".$link_number.' '.$link_url;
+ $content = str_replace( $link_match, $link_text . ' ' . $link_number, $content );
+ $link_url = ( ( strtolower( substr( $link_url, 0, 7 ) ) != 'http://' ) && ( strtolower( substr( $link_url, 0, 8 ) ) != 'https://' ) ) ? get_option( 'home' ) . $link_url : $link_url;
+ $links_summary .= "\n" . $link_number . ' ' . $link_url;
}
- $content = strip_tags($content);
+ $content = strip_tags( $content );
$content .= $links_summary;
return $content;
}
-
-function xmlrpc_getposttitle($content) {
+/**
+ * Retrieve post title from XMLRPC XML.
+ *
+ * If the title element is not part of the XML, then the default post title from
+ * the $post_default_title will be used instead.
+ *
+ * @package WordPress
+ * @subpackage XMLRPC
+ * @since 0.71
+ *
+ * @global string $post_default_title Default XMLRPC post title.
+ *
+ * @param string $content XMLRPC XML Request content
+ * @return string Post title
+ */
+function xmlrpc_getposttitle( $content ) {
global $post_default_title;
- if ( preg_match('/<title>(.+?)<\/title>/is', $content, $matchtitle) ) {
- $post_title = $matchtitle[0];
- $post_title = preg_replace('/<title>/si', '', $post_title);
- $post_title = preg_replace('/<\/title>/si', '', $post_title);
+ if ( preg_match( '/<title>(.+?)<\/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.
+ *
+ * @package WordPress
+ * @subpackage XMLRPC
+ * @since 0.71
+ *
+ * @global string $post_default_category Default XMLRPC 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>(.+?)<\/category>/is', $content, $matchcat) ) {
- $post_category = trim($matchcat[1], ',');
- $post_category = explode(',', $post_category);
+ if ( preg_match( '/<category>(.+?)<\/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>(.+?)<\/title>/si', '', $content);
- $content = preg_replace('/<category>(.+?)<\/category>/si', '', $content);
- $content = trim($content);
+/**
+ * XMLRPC XML content without title and category elements.
+ *
+ * @package WordPress
+ * @subpackage XMLRPC
+ * @since 0.71
+ *
+ * @param string $content XMLRPC XML Request content
+ * @return string XMLRPC XML Request content without title and category elements.
+ */
+function xmlrpc_removepostdata( $content ) {
+ $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
+ $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
+ $content = trim( $content );
return $content;
}
-function debug_fopen($filename, $mode) {
+/**
+ * Open the file handle for debugging.
+ *
+ * This function is used for XMLRPC feature, but it is general purpose enough
+ * to be used in anywhere.
+ *
+ * @see fopen() for mode options.
+ * @package WordPress
+ * @subpackage Debug
+ * @since 0.71
+ * @uses $debug Used for whether debugging is enabled.
+ *
+ * @param string $filename File path to debug file.
+ * @param string $mode Same as fopen() mode parameter.
+ * @return bool|resource File handle. False on failure.
+ */
+function debug_fopen( $filename, $mode ) {
global $debug;
- if ( $debug == 1 ) {
- $fp = fopen($filename, $mode);
+ if ( 1 == $debug ) {
+ $fp = fopen( $filename, $mode );
return $fp;
} else {
return false;
}
}
-function debug_fwrite($fp, $string) {
+/**
+ * Write contents to the file used for debugging.
+ *
+ * Technically, this can be used to write to any file handle when the global
+ * $debug is set to 1 or true.
+ *
+ * @package WordPress
+ * @subpackage Debug
+ * @since 0.71
+ * @uses $debug Used for whether debugging is enabled.
+ *
+ * @param resource $fp File handle for debugging file.
+ * @param string $string Content to write to debug file.
+ */
+function debug_fwrite( $fp, $string ) {
global $debug;
- if ( $debug == 1 ) {
- fwrite($fp, $string);
- }
-}
-
-function debug_fclose($fp) {
+ if ( 1 == $debug )
+ fwrite( $fp, $string );
+}
+
+/**
+ * Close the debugging file handle.
+ *
+ * Technically, this can be used to close any file handle when the global $debug
+ * is set to 1 or true.
+ *
+ * @package WordPress
+ * @subpackage Debug
+ * @since 0.71
+ * @uses $debug Used for whether debugging is enabled.
+ *
+ * @param resource $fp Debug File handle.
+ */
+function debug_fclose( $fp ) {
global $debug;
- if ( $debug == 1 ) {
- fclose($fp);
- }
-}
-
+ if ( 1 == $debug )
+ fclose( $fp );
+}
+
+/**
+ * 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.
+ *
+ * @package WordPress
+ * @since 1.5.0
+ *
+ * @uses $wpdb
+ *
+ * @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;
+ include_once( ABSPATH . WPINC . '/class-IXR.php' );
- $log = debug_fopen(ABSPATH . 'enclosures.log', 'a');
+ $log = debug_fopen( ABSPATH . 'enclosures.log', 'a' );
$post_links = array();
- debug_fwrite($log, 'BEGIN '.date('YmdHis', time())."\n");
+ debug_fwrite( $log, 'BEGIN ' . date( 'YmdHis', time() ) . "\n" );
$pung = get_enclosed( $post_ID );
$punc = '.:?\-';
$any = $ltrs . $gunk . $punc;
- preg_match_all("{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp);
+ preg_match_all( "{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp );
- debug_fwrite($log, 'Post contents:');
- debug_fwrite($log, $content."\n");
+ debug_fwrite( $log, 'Post contents:' );
+ debug_fwrite( $log, $content . "\n" );
- 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 ( $pung as $link_test ) {
+ if ( !in_array( $link_test, $post_links_temp[0] ) ) { // link no longer in post
+ $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE (%s)", $post_ID, $link_test . '%') );
+ }
+ }
+
+ foreach ( (array) $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'] ) )
$post_links[] = $link_test;
- elseif (($test['path'] != '/') && ($test['path'] != ''))
+ elseif ( $test['path'] != '/' && $test['path'] != '' )
$post_links[] = $link_test;
- endif;
- endforeach;
+ }
+ }
- 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%')") ) {
+ 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, $url . '%' ) ) ) {
if ( $headers = wp_get_http_headers( $url) ) {
$len = (int) $headers['content-length'];
- $type = $wpdb->escape( $headers['content-type'] );
+ $type = $headers['content-type'];
$allowed_types = array( 'video', 'audio' );
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')" );
+ $wpdb->insert($wpdb->postmeta, array('post_id' => $post_ID, 'meta_key' => 'enclosure', 'meta_value' => $meta_value) );
}
}
}
- endforeach;
+ }
}
-function wp_get_http_headers( $url, $red = 1 ) {
- global $wp_version;
+/**
+ * Perform a HTTP HEAD or GET request.
+ *
+ * If $file_path is a writable filename, this will do a GET request and write
+ * the file to that path.
+ *
+ * @since 2.5.0
+ *
+ * @param string $url URL to fetch.
+ * @param string|bool $file_path Optional. File path to write request to.
+ * @param bool $deprecated Deprecated. Not used.
+ * @return bool|string False on failure and string of headers if HEAD request.
+ */
+function wp_get_http( $url, $file_path = false, $deprecated = false ) {
@set_time_limit( 60 );
- if ( $red > 5 )
- return false;
+ $options = array();
+ $options['redirection'] = 5;
- $parts = parse_url( $url );
- $file = $parts['path'] . ($parts['query'] ? '?'.$parts['query'] : '');
- $host = $parts['host'];
- if ( !isset( $parts['port'] ) )
- $parts['port'] = 80;
+ if ( false == $file_path )
+ $options['method'] = 'HEAD';
+ else
+ $options['method'] = 'GET';
- $head = "HEAD $file HTTP/1.1\r\nHOST: $host\r\nUser-Agent: WordPress/" . $wp_version . "\r\n\r\n";
+ $response = wp_remote_request($url, $options);
- $fp = @fsockopen($host, $parts['port'], $err_num, $err_msg, 3);
- if ( !$fp )
+ 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];
- }
+ $headers = wp_remote_retrieve_headers( $response );
+ $headers['response'] = $response['response']['code'];
- preg_match('/.*([0-9]{3}).*/', $response, $return);
- $headers['response'] = $return[1]; // HTTP response code eg 204, 200, 404
+ if ( false == $file_path )
+ return $headers;
- $code = $headers['response'];
- if ( ('302' == $code || '301' == $code) && isset($headers['location']) )
- return wp_get_http_headers( $headers['location'], ++$red );
+ // GET request - write it to the supplied filename
+ $out_fp = fopen($file_path, 'w');
+ if ( !$out_fp )
+ return $headers;
+
+ fwrite( $out_fp, $response['body']);
+ fclose($out_fp);
return $headers;
}
-function is_new_day() {
- global $day, $previousday;
- if ( $day != $previousday ) {
- return(1);
- } else {
- return(0);
- }
-}
+/**
+ * Retrieve HTTP Headers from URL.
+ *
+ * @since 1.5.1
+ *
+ * @param string $url
+ * @param bool $deprecated Not Used.
+ * @return bool|string False on failure, headers on success.
+ */
+function wp_get_http_headers( $url, $deprecated = false ) {
+ $response = wp_remote_head( $url );
-function build_query($data) {
- return _http_build_query($data, NULL, '&', '', false);
-}
+ if ( is_wp_error( $response ) )
+ return 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.
+ return wp_remote_retrieve_headers( $response );
+}
-Parameters:
-add_query_arg(newkey, newvalue, oldquery_or_uri) or
-add_query_arg(associative_array, oldquery_or_uri)
-*/
+/**
+ * Whether today is a new day.
+ *
+ * @since 0.71
+ * @uses $day Today
+ * @uses $previousday Previous day
+ *
+ * @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;
+}
+
+/**
+ * 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.
+ *
+ * @see _http_build_query() Used to build the query
+ * @link http://us2.php.net/manual/en/function.http-build-query.php more on what
+ * http_build_query() does.
+ *
+ * @since 2.3.0
+ *
+ * @param array $data URL-encode key/value pairs.
+ * @return string URL encoded string
+ */
+function build_query( $data ) {
+ return _http_build_query( $data, null, '&', '', false );
+}
+
+/**
+ * Retrieve a modified URL query string.
+ *
+ * You can rebuild the URL and append a new query variable to the URL query by
+ * using this function. You can also retrieve the full URL with query data.
+ *
+ * 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.
+ *
+ * @since 1.5.0
+ *
+ * @param mixed $param1 Either newkey or an associative_array
+ * @param mixed $param2 Either newvalue or oldquery or uri
+ * @param mixed $param3 Optional. Old query or uri
+ * @return string New URL query string.
+ */
function add_query_arg() {
$ret = '';
- if ( is_array(func_get_arg(0)) ) {
- if ( @func_num_args() < 2 || false === @func_get_arg(1) )
+ if ( is_array( func_get_arg(0) ) ) {
+ if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
$uri = $_SERVER['REQUEST_URI'];
else
- $uri = @func_get_arg(1);
+ $uri = @func_get_arg( 1 );
} else {
- if ( @func_num_args() < 3 || false === @func_get_arg(2) )
+ if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
$uri = $_SERVER['REQUEST_URI'];
else
- $uri = @func_get_arg(2);
+ $uri = @func_get_arg( 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) ) {
+ if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
$protocol = $matches[0];
- $uri = substr($uri, strlen($protocol));
+ $uri = substr( $uri, strlen( $protocol ) );
} else {
$protocol = '';
}
- if (strpos($uri, '?') !== false) {
- $parts = explode('?', $uri, 2);
- if ( 1 == count($parts) ) {
+ 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 ) {
+ } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
$base = $uri . '?';
$query = '';
} else {
$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( func_get_arg( 0 ) ) ) {
+ $kayvees = func_get_arg( 0 );
+ $qs = array_merge( $qs, $kayvees );
} else {
- $qs[func_get_arg(0)] = func_get_arg(1);
+ $qs[func_get_arg( 0 )] = func_get_arg( 1 );
}
- foreach ( $qs as $k => $v ) {
+ foreach ( (array) $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 list from the query string.
+ *
+ * @since 1.5.0
+ *
+ * @param string|array $key Query key or keys to remove.
+ * @param bool $query When false uses the $_SERVER value.
+ * @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) {
+/**
+ * Walks the array while sanitizing the contents.
+ *
+ * @uses $wpdb Used to sanitize values
+ * @since 0.71
+ *
+ * @param array $array Array to used to walk while sanitizing contents.
+ * @return array Sanitized $array.
+ */
+function add_magic_quotes( $array ) {
global $wpdb;
- foreach ($array as $k => $v) {
- if ( is_array($v) ) {
- $array[$k] = add_magic_quotes($v);
+ foreach ( (array) $array as $k => $v ) {
+ if ( is_array( $v ) ) {
+ $array[$k] = add_magic_quotes( $v );
} else {
- $array[$k] = $wpdb->escape($v);
+ $array[$k] = $wpdb->escape( $v );
}
}
return $array;
}
+/**
+ * HTTP request for URI to retrieve content.
+ *
+ * @since 1.5.1
+ * @uses wp_remote_get()
+ *
+ * @param string $uri URI/URL of web page to retrieve.
+ * @return bool|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_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 $response['body'];
}
-function wp($query_vars = '') {
+/**
+ * Setup the WordPress query.
+ *
+ * @since 2.0.0
+ *
+ * @param string $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) )
$wp_the_query = $wp_query;
}
+/**
+ * Retrieve the description for the HTTP status.
+ *
+ * @since 2.3.0
+ *
+ * @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',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
+ 207 => 'Multi-Status',
+ 226 => 'IM Used',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
+ 306 => 'Reserved',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
+ 402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
415 => 'Unsupported Media Type',
416 => 'Requested Range Not Satisfiable',
417 => 'Expectation Failed',
+ 422 => 'Unprocessable Entity',
+ 423 => 'Locked',
+ 424 => 'Failed Dependency',
+ 426 => 'Upgrade Required',
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'
);
}
- if ( isset( $wp_header_to_desc[$code] ) ) {
+ if ( isset( $wp_header_to_desc[$code] ) )
return $wp_header_to_desc[$code];
- } else {
+ else
return '';
- }
}
+/**
+ * Set HTTP status header.
+ *
+ * @since 2.0.0
+ * @uses apply_filters() Calls 'status_header' on status header string, HTTP
+ * HTTP code, HTTP code description, and protocol string as separate
+ * parameters.
+ *
+ * @param int $header HTTP status code
+ * @return null Does not return anything.
+ */
function status_header( $header ) {
$text = get_status_header_desc( $header );
return false;
$protocol = $_SERVER["SERVER_PROTOCOL"];
- if ( ('HTTP/1.1' != $protocol) && ('HTTP/1.0' != $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);
+ if ( function_exists( 'apply_filters' ) )
+ $status_header = apply_filters( 'status_header', $status_header, $header, $text, $protocol );
+
+ return @header( $status_header, true, $header );
+}
+
+/**
+ * Gets the header information to prevent caching.
+ *
+ * The several different headers cover the different ways cache prevention is handled
+ * by different browsers
+ *
+ * @since 2.8
+ *
+ * @uses apply_filters()
+ * @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',
+ 'Last-Modified' => gmdate( 'D, d M Y H:i:s' ) . ' GMT',
+ 'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
+ 'Pragma' => 'no-cache',
+ );
- if ( version_compare( phpversion(), '4.3.0', '>=' ) ) {
- return @header( $status_header, true, $header );
- } else {
- return @header( $status_header );
+ if ( function_exists('apply_filters') ) {
+ $headers = apply_filters('nocache_headers', $headers);
}
+ return $headers;
}
+/**
+ * Sets 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
+ * @uses 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();
+ foreach( (array) $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");
-}
-
+ 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
+ *
+ * @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' or 'n'
+ * @return bool True if yes, false on anything else
+ */
function bool_from_yn( $yn ) {
return ( strtolower( $yn ) == 'y' );
}
+/**
+ * Loads 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
+ * @uses $wp_query Used to tell if the use a comment feed.
+ * @uses do_action() Calls 'do_feed_$feed' hook, if a hook exists for the feed.
+ */
function do_feed() {
global $wp_query;
- $feed = get_query_var('feed');
+ $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();
$hook = 'do_feed_' . $feed;
- do_action($hook, $wp_query->is_comment_feed);
+ if ( !has_action($hook) ) {
+ $message = sprintf( __( 'ERROR: %s is not a valid feed template' ), esc_html($feed));
+ wp_die($message);
+ }
+
+ do_action( $hook, $wp_query->is_comment_feed );
}
+/**
+ * Load the RDF RSS 0.91 Feed template.
+ *
+ * @since 2.1.0
+ */
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
+ */
function do_feed_rss() {
- 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');
- }
-}
-
-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_template( ABSPATH . WPINC . '/feed-rss.php' );
+}
+
+/**
+ * Load either the RSS2 comment feed or the RSS2 posts feed.
+ *
+ * @since 2.1.0
+ *
+ * @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' );
+}
+
+/**
+ * Load either Atom comment feed or Atom posts feed.
+ *
+ * @since 2.1.0
+ *
+ * @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 robot.txt file content.
+ *
+ * The echo content should be with usage of the permalinks or for creating the
+ * robot.txt file.
+ *
+ * @since 2.1.0
+ * @uses do_action() Calls 'do_robotstxt' hook for displaying robot.txt rules.
+ */
function do_robots() {
- header('Content-Type: text/plain; charset=utf-8');
+ header( 'Content-Type: text/plain; charset=utf-8' );
- do_action('do_robotstxt');
+ do_action( 'do_robotstxt' );
- if ( '0' == get_option('blog_public') ) {
+ if ( '0' == get_option( 'blog_public' ) ) {
echo "User-agent: *\n";
echo "Disallow: /\n";
} else {
}
}
+/**
+ * Test whether blog 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 option siteurl for whether WordPress is installed.
+ *
+ * @since 2.1.0
+ * @uses $wpdb
+ *
+ * @return bool Whether blog 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();
+ $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 );
+
+ $installed = !empty( $installed );
+ wp_cache_set( 'is_blog_installed', $installed );
+
+ return $installed;
+}
+
+/**
+ * Retrieve URL with nonce added to URL query.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @param string $actionurl URL to add nonce action
+ * @param string $action Optional. Nonce action name
+ * @return string URL with nonce action added.
+ */
+function wp_nonce_url( $actionurl, $action = -1 ) {
+ $actionurl = str_replace( '&', '&', $actionurl );
+ return esc_html( add_query_arg( '_wpnonce', wp_create_nonce( $action ), $actionurl ) );
+}
+
+/**
+ * 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.
+ *
+ * If you set $echo to true and set $referer to true, then you will need to
+ * retrieve the {@link wp_referer_field() wp referer field}. If you have the
+ * $referer set to true and are echoing the nonce field, it will also echo the
+ * referer field.
+ *
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @param string $action Optional. Action name.
+ * @param string $name Optional. Nonce name.
+ * @param bool $referer Optional, default true. Whether to set the referer field for validation.
+ * @param bool $echo Optional, default true. Whether to display or return hidden form field.
+ * @return string Nonce field.
+ */
+function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
+ $name = esc_attr( $name );
+ $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
+ if ( $echo )
+ echo $nonce_field;
-function wp_nonce_field($action = -1, $name = "_wpnonce", $referer = true) {
- $name = attribute_escape($name);
- echo '<input type="hidden" name="' . $name . '" value="' . wp_create_nonce($action) . '" />';
if ( $referer )
- wp_referer_field();
-}
-
-function wp_referer_field() {
- $ref = attribute_escape($_SERVER['REQUEST_URI']);
- echo '<input type="hidden" name="_wp_http_referer" value="'. $ref . '" />';
- if ( wp_get_original_referer() ) {
- $original_ref = attribute_escape(stripslashes(wp_get_original_referer()));
- echo '<input type="hidden" name="_wp_original_http_referer" value="'. $original_ref . '" />';
- }
-}
-
-function wp_original_referer_field() {
- echo '<input type="hidden" name="_wp_original_http_referer" value="' . attribute_escape(stripslashes($_SERVER['REQUEST_URI'])) . '" />';
-}
-
+ wp_referer_field( $echo, 'previous' );
+
+ return $nonce_field;
+}
+
+/**
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @param bool $echo Whether to echo or return the referer field.
+ * @return string Referer field.
+ */
+function wp_referer_field( $echo = true) {
+ $ref = esc_attr( $_SERVER['REQUEST_URI'] );
+ $referer_field = '<input type="hidden" name="_wp_http_referer" value="'. $ref . '" />';
+
+ if ( $echo )
+ echo $referer_field;
+ return $referer_field;
+}
+
+/**
+ * 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 {@link wp_referer_field()}, if that was posted already or it will
+ * be the current page, if it doesn't exist.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @param bool $echo Whether to echo the original http referer
+ * @param string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to.
+ * @return string Original referer field.
+ */
+function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
+ $jump_back_to = ( 'previous' == $jump_back_to ) ? wp_get_referer() : $_SERVER['REQUEST_URI'];
+ $ref = ( wp_get_original_referer() ) ? wp_get_original_referer() : $jump_back_to;
+ $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( stripslashes( $ref ) ) . '" />';
+ if ( $echo )
+ echo $orig_referer_field;
+ return $orig_referer_field;
+}
+
+/**
+ * Retrieve referer from '_wp_http_referer', HTTP referer, or current page respectively.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @return string|bool False on failure. Referer URL on success.
+ */
function wp_get_referer() {
- foreach ( array($_REQUEST['_wp_http_referer'], $_SERVER['HTTP_REFERER']) as $ref )
- if ( !empty($ref) )
- return $ref;
+ $ref = '';
+ if ( ! empty( $_REQUEST['_wp_http_referer'] ) )
+ $ref = $_REQUEST['_wp_http_referer'];
+ else if ( ! empty( $_SERVER['HTTP_REFERER'] ) )
+ $ref = $_SERVER['HTTP_REFERER'];
+
+ if ( $ref !== $_SERVER['REQUEST_URI'] )
+ return $ref;
return false;
}
+/**
+ * Retrieve original referer that was posted, if it exists.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @return string|bool False if no original referer or original referer if set.
+ */
function wp_get_original_referer() {
- if ( !empty($_REQUEST['_wp_original_http_referer']) )
+ if ( !empty( $_REQUEST['_wp_original_http_referer'] ) )
return $_REQUEST['_wp_original_http_referer'];
return false;
}
-function wp_mkdir_p($target) {
+/**
+ * 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 or not. True if path already exists.
+ */
+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;
- }
+ $target = str_replace( '//', '/', $target );
+ if ( file_exists( $target ) )
+ return @is_dir( $target );
// Attempting to create the directory may clutter up our display.
- if (@ mkdir($target)) {
- $stat = @ stat(dirname($target));
+ if ( @mkdir( $target ) ) {
+ $stat = @stat( dirname( $target ) );
$dir_perms = $stat['mode'] & 0007777; // Get the permission bits.
- @ chmod($target, $dir_perms);
+ @chmod( $target, $dir_perms );
return true;
- } else {
- if ( is_dir(dirname($target)) )
+ } elseif ( is_dir( dirname( $target ) ) ) {
return 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 ( ( $target != '/' ) && ( wp_mkdir_p( dirname( $target ) ) ) )
+ return wp_mkdir_p( $target );
return false;
}
-// 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;
+/**
+ * Test if a give filesystem path is absolute ('/foo/bar', '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 (bool) preg_match('#^[/\\\\]#', $path);
+}
+
+/**
+ * Join two filesystem paths together (e.g. '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
+ * @param string $path
+ * @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, '/');
+}
+
+/**
+ * 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' - set to false.
+ *
+ * @since 2.0.0
+ * @uses apply_filters() Calls 'upload_dir' on returned array.
+ *
+ * @param string $time Optional. Time formatted in 'yyyy/mm'.
+ * @return array See above for description.
+ */
+function wp_upload_dir( $time = null ) {
+ $siteurl = get_option( 'siteurl' );
+ $upload_path = get_option( 'upload_path' );
+ $upload_path = trim($upload_path);
+ if ( empty($upload_path) )
+ $dir = WP_CONTENT_DIR . '/uploads';
+ else
+ $dir = $upload_path;
+
+ // $dir is absolute, $path is (maybe) relative to ABSPATH
+ $dir = path_join( ABSPATH, $dir );
- if ( $dir == ABSPATH ) { //the option was empty
- $dir = ABSPATH . 'wp-content/uploads';
+ if ( !$url = get_option( 'upload_url_path' ) ) {
+ if ( empty($upload_path) or ( $upload_path == $dir ) )
+ $url = WP_CONTENT_URL . '/uploads';
+ else
+ $url = trailingslashit( $siteurl ) . $upload_path;
}
if ( defined('UPLOADS') ) {
$dir = ABSPATH . UPLOADS;
- $url = trailingslashit($siteurl) . UPLOADS;
+ $url = trailingslashit( $siteurl ) . UPLOADS;
}
- if ( get_option('uploads_use_yearmonth_folders')) {
+ $bdir = $dir;
+ $burl = $url;
+
+ $subdir = '';
+ if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
// Generate the yearly and monthly dirs
- $time = current_time( 'mysql' );
+ if ( !$time )
+ $time = current_time( 'mysql' );
$y = substr( $time, 0, 4 );
$m = substr( $time, 5, 2 );
- $dir = $dir . "/$y/$m";
- $url = $url . "/$y/$m";
+ $subdir = "/$y/$m";
}
+ $dir .= $subdir;
+ $url .= $subdir;
+
+ $uploads = apply_filters( 'upload_dir', array( 'path' => $dir, 'url' => $url, 'subdir' => $subdir, 'basedir' => $bdir, 'baseurl' => $burl, 'error' => false ) );
+
// 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 ( ! wp_mkdir_p( $uploads['path'] ) ) {
+ $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $uploads['path'] );
+ return array( 'error' => $message );
+ }
+
+ return $uploads;
+}
+
+/**
+ * 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 must accept two parameters, the first one is the directory and
+ * the second is the filename. The callback must be a function.
+ *
+ * @since 2.5
+ *
+ * @param string $dir
+ * @param string $filename
+ * @param string $unique_filename_callback Function name, must be a function.
+ * @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
+ $info = pathinfo($filename);
+ $ext = !empty($info['extension']) ? $info['extension'] : '';
+ $name = basename($filename, ".{$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 $override['unique_filename_callback'] if supplied.
+ if ( $unique_filename_callback && function_exists( $unique_filename_callback ) ) {
+ $filename = $unique_filename_callback( $dir, $name );
+ } else {
+ $number = '';
- $uploads = array('path' => $dir, 'url' => $url, 'error' => false);
- return apply_filters('upload_dir', $uploads);
-}
+ if ( !empty( $ext ) )
+ $ext = ".$ext";
-function wp_upload_bits($name, $type, $bits) {
- if ( empty($name) )
- return array('error' => __("Empty filename"));
+ while ( file_exists( $dir . "/$filename" ) ) {
+ if ( '' == "$number$ext" )
+ $filename = $filename . ++$number . $ext;
+ else
+ $filename = str_replace( "$number$ext", ++$number . $ext, $filename );
+ }
+ }
- $wp_filetype = wp_check_filetype($name);
+ return $filename;
+}
+
+/**
+ * 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
+ * @param null $deprecated Not used. Set to null.
+ * @param mixed $bits File content
+ * @param string $time Optional. Time formatted in 'yyyy/mm'.
+ * @return array
+ */
+function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
+ if ( empty( $name ) )
+ return array( 'error' => __( 'Empty filename' ) );
+
+ $wp_filetype = wp_check_filetype( $name );
if ( !$wp_filetype['ext'] )
- return array('error' => __("Invalid file type"));
+ return array( 'error' => __( 'Invalid file type' ) );
- $upload = wp_upload_dir();
+ $upload = wp_upload_dir( $time );
if ( $upload['error'] !== false )
return $upload;
- $number = '';
- $filename = $name;
- $path_parts = pathinfo($filename);
- $ext = $path_parts['extension'];
- if ( empty($ext) )
- $ext = '';
- else
- $ext = ".$ext";
- while ( file_exists($upload['path'] . "/$filename") ) {
- if ( '' == "$number$ext" )
- $filename = $filename . ++$number . $ext;
- else
- $filename = str_replace("$number$ext", ++$number . $ext, $filename);
- }
+ $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 ) ) ) {
+ $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), dirname( $new_file ) );
+ 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 ) );
- $success = @ fwrite($ifp, $bits);
- fclose($ifp);
+ @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 );
// Compute the URL
$url = $upload['url'] . "/$filename";
- return array('file' => $new_file, 'url' => $url, 'error' => false);
-}
-
-function wp_check_filetype($filename, $mimes = null) {
+ return array( 'file' => $new_file, 'url' => $url, 'error' => false );
+}
+
+/**
+ * Retrieve the file type based on the extension name.
+ *
+ * @package WordPress
+ * @since 2.5.0
+ * @uses apply_filters() Calls 'ext2type' hook on default supported types.
+ *
+ * @param string $ext The extension to search.
+ * @return string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found.
+ */
+function wp_ext2type( $ext ) {
+ $ext2type = apply_filters('ext2type', array(
+ 'audio' => array('aac','ac3','aif','aiff','mp1','mp2','mp3','m3a','m4a','m4b','ogg','ram','wav','wma'),
+ 'video' => array('asf','avi','divx','dv','mov','mpg','mpeg','mp4','mpv','ogm','qt','rm','vob','wmv', 'm4v'),
+ 'document' => array('doc','docx','pages','odt','rtf','pdf'),
+ 'spreadsheet' => array('xls','xlsx','numbers','ods'),
+ 'interactive' => array('ppt','pptx','key','odp','swf'),
+ 'text' => array('txt'),
+ 'archive' => array('tar','bz2','gz','cab','dmg','rar','sea','sit','sqx','zip'),
+ 'code' => array('css','html','php','js'),
+ ));
+ 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 ) {
// Accepted MIME types are set here as PCRE unless provided.
- $mimes = is_array($mimes) ? $mimes : apply_filters('upload_mimes', array (
+ $mimes = ( is_array( $mimes ) ) ? $mimes : apply_filters( 'upload_mimes', array(
'jpg|jpeg|jpe' => 'image/jpeg',
'gif' => 'image/gif',
'png' => 'image/png',
'ico' => 'image/x-icon',
'asf|asx|wax|wmv|wmx' => 'video/asf',
'avi' => 'video/avi',
+ 'divx' => 'video/divx',
'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',
+ 'mp3|m4a' => 'audio/mpeg',
+ 'mp4|m4v' => 'video/mp4',
'ra|ram' => 'audio/x-realaudio',
'wav' => 'audio/wav',
'ogg' => 'audio/ogg',
'rtf' => 'application/rtf',
'js' => 'application/javascript',
'pdf' => 'application/pdf',
- 'doc' => 'application/msword',
- 'pot|pps|ppt' => 'application/vnd.ms-powerpoint',
+ 'doc|docx' => 'application/msword',
+ 'pot|pps|ppt|pptx' => 'application/vnd.ms-powerpoint',
'wri' => 'application/vnd.ms-write',
- 'xla|xls|xlt|xlw' => 'application/vnd.ms-excel',
+ 'xla|xls|xlsx|xlt|xlw' => 'application/vnd.ms-excel',
'mdb' => 'application/vnd.ms-access',
'mpp' => 'application/vnd.ms-project',
'swf' => 'application/x-shockwave-flash',
'odc' => 'application/vnd.oasis.opendocument.chart',
'odb' => 'application/vnd.oasis.opendocument.database',
'odf' => 'application/vnd.oasis.opendocument.formula',
-
- ));
+ )
+ );
$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');
-}
-
-function wp_explain_nonce($action) {
- if ( $action !== -1 && preg_match('/([a-z]+)-([a-z]+)(_(.+))?/', $action, $matches) ) {
+ return compact( 'ext', 'type' );
+}
+
+/**
+ * Retrieve nonce action "Are you sure" message.
+ *
+ * The action is split by verb and noun. The action format is as follows:
+ * verb-action_extra. The verb is before the first dash and has the format of
+ * letters and no spaces and numbers. The noun is after the dash and before the
+ * underscore, if an underscore exists. The noun is also only letters.
+ *
+ * The filter will be called for any action, which is not defined by WordPress.
+ * You may use the filter for your plugin to explain nonce actions to the user,
+ * when they get the "Are you sure?" message. The filter is in the format of
+ * 'explain_nonce_$verb-$noun' with the $verb replaced by the found verb and the
+ * $noun replaced by the found noun. The two parameters that are given to the
+ * hook are the localized "Are you sure you want to do this?" message with the
+ * extra text (the text after the underscore).
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @param string $action Nonce action.
+ * @return string Are you sure message.
+ */
+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');
-
- $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);
-
- $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);
-
- $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');
-
- $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');
-
- $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');
-
- $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');
-
- $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');
-
- if ( isset($trans[$verb][$noun]) ) {
- if ( !empty($trans[$verb][$noun][1]) ) {
+ $trans['update']['attachment'] = array( __( 'Your attempt to edit this attachment: “%s” has failed.' ), 'get_the_title' );
+
+ $trans['add']['category'] = array( __( 'Your attempt to add this category has failed.' ), false );
+ $trans['delete']['category'] = array( __( 'Your attempt to delete this category: “%s” has failed.' ), 'get_cat_name' );
+ $trans['update']['category'] = array( __( 'Your attempt to edit this category: “%s” has failed.' ), 'get_cat_name' );
+
+ $trans['delete']['comment'] = array( __( 'Your attempt to delete this comment: “%s” has failed.' ), 'use_id' );
+ $trans['unapprove']['comment'] = array( __( 'Your attempt to unapprove this comment: “%s” has failed.' ), 'use_id' );
+ $trans['approve']['comment'] = array( __( 'Your attempt to approve this comment: “%s” has failed.' ), 'use_id' );
+ $trans['update']['comment'] = array( __( 'Your attempt to edit this comment: “%s” has failed.' ), 'use_id' );
+ $trans['bulk']['comments'] = array( __( 'Your attempt to bulk modify comments has failed.' ), false );
+ $trans['moderate']['comments'] = array( __( 'Your attempt to moderate comments has failed.' ), false );
+
+ $trans['add']['bookmark'] = array( __( 'Your attempt to add this link has failed.' ), false );
+ $trans['delete']['bookmark'] = array( __( 'Your attempt to delete this link: “%s” has failed.' ), 'use_id' );
+ $trans['update']['bookmark'] = array( __( 'Your attempt to edit this link: “%s” has failed.' ), 'use_id' );
+ $trans['bulk']['bookmarks'] = array( __( 'Your attempt to bulk modify links has failed.' ), false );
+
+ $trans['add']['page'] = array( __( 'Your attempt to add this page has failed.' ), false );
+ $trans['delete']['page'] = array( __( 'Your attempt to delete this page: “%s” has failed.' ), 'get_the_title' );
+ $trans['update']['page'] = array( __( 'Your attempt to edit this page: “%s” has failed.' ), 'get_the_title' );
+
+ $trans['edit']['plugin'] = array( __( 'Your attempt to edit this plugin file: “%s” has failed.' ), 'use_id' );
+ $trans['activate']['plugin'] = array( __( 'Your attempt to activate this plugin: “%s” has failed.' ), 'use_id' );
+ $trans['deactivate']['plugin'] = array( __( 'Your attempt to deactivate this plugin: “%s” has failed.' ), 'use_id' );
+ $trans['upgrade']['plugin'] = array( __( 'Your attempt to upgrade this plugin: “%s” has failed.' ), 'use_id' );
+
+ $trans['add']['post'] = array( __( 'Your attempt to add this post has failed.' ), false );
+ $trans['delete']['post'] = array( __( 'Your attempt to delete this post: “%s” has failed.' ), 'get_the_title' );
+ $trans['update']['post'] = array( __( 'Your attempt to edit this post: “%s” has failed.' ), 'get_the_title' );
+
+ $trans['add']['user'] = array( __( 'Your attempt to add this user has failed.' ), false );
+ $trans['delete']['users'] = array( __( 'Your attempt to delete users has failed.' ), false );
+ $trans['bulk']['users'] = array( __( 'Your attempt to bulk modify users has failed.' ), false );
+ $trans['update']['user'] = array( __( 'Your attempt to edit this user: “%s” has failed.' ), 'get_the_author_meta', 'display_name' );
+ $trans['update']['profile'] = array( __( 'Your attempt to modify the profile for: “%s” has failed.' ), 'get_the_author_meta', 'display_name' );
+
+ $trans['update']['options'] = array( __( 'Your attempt to edit your settings has failed.' ), false );
+ $trans['update']['permalink'] = array( __( 'Your attempt to change your permalink structure to: %s has failed.' ), 'use_id' );
+ $trans['edit']['file'] = array( __( 'Your attempt to edit this file: “%s” has failed.' ), 'use_id' );
+ $trans['edit']['theme'] = array( __( 'Your attempt to edit this theme file: “%s” has failed.' ), 'use_id' );
+ $trans['switch']['theme'] = array( __( 'Your attempt to switch to this theme: “%s” has failed.' ), 'use_id' );
+
+ $trans['log']['out'] = array( sprintf( __( 'You are attempting to log out of %s' ), get_bloginfo( 'sitename' ) ), false );
+
+ if ( isset( $trans[$verb][$noun] ) ) {
+ if ( !empty( $trans[$verb][$noun][1] ) ) {
$lookup = $trans[$verb][$noun][1];
+ if ( isset($trans[$verb][$noun][2]) )
+ $lookup_value = $trans[$verb][$noun][2];
$object = $matches[4];
- if ( 'use_id' != $lookup )
- $object = call_user_func($lookup, $object);
- return sprintf($trans[$verb][$noun][0], $object);
+ if ( 'use_id' != $lookup ) {
+ if ( isset( $lookup_value ) )
+ $object = call_user_func( $lookup, $lookup_value, $object );
+ else
+ $object = call_user_func( $lookup, $object );
+ }
+ return sprintf( $trans[$verb][$noun][0], esc_html($object) );
} else {
return $trans[$verb][$noun][0];
}
}
- }
-
- return apply_filters( 'explain_nonce_' . $verb . '-' . $noun, __('Are you sure you want to do this?'), $matches[4] );
-}
-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());
-
- $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<form method='post' action='" . attribute_escape($pagenow) . "'>\n";
- foreach ( (array) $q as $a ) {
- $v = substr(strstr($a, '='), 1);
- $k = substr($a, 0, -(strlen($v)+1));
- $html .= "\t\t<input type='hidden' name='" . attribute_escape(urldecode($k)) . "' value='" . attribute_escape(urldecode($v)) . "' />\n";
- }
- $html .= "\t\t<input type='hidden' name='_wpnonce' value='" . wp_create_nonce($action) . "' />\n";
- $html .= "\t\t<div id='message' class='confirm fade'>\n\t\t<p>" . wp_specialchars(wp_explain_nonce($action)) . "</p>\n\t\t<p><a href='$adminurl'>" . __('No') . "</a> <input type='submit' value='" . __('Yes') . "' /></p>\n\t\t</div>\n\t</form>\n";
+ return apply_filters( 'explain_nonce_' . $verb . '-' . $noun, __( 'Are you sure you want to do this?' ), $matches[4] );
} else {
- $html .= "\t<div id='message' class='confirm fade'>\n\t<p>" . wp_specialchars(wp_explain_nonce($action)) . "</p>\n\t<p><a href='$adminurl'>" . __('No') . "</a> <a href='" . clean_url(add_query_arg( '_wpnonce', wp_create_nonce($action), $_SERVER['REQUEST_URI'] )) . "'>" . __('Yes') . "</a></p>\n\t</div>\n";
- }
- $html .= "</body>\n</html>";
- wp_die($html, $title);
-}
-
-function wp_die( $message, $title = '' ) {
+ return apply_filters( 'explain_nonce_' . $action, __( 'Are you sure you want to do this?' ) );
+ }
+}
+
+/**
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Security
+ * @since 2.0.4
+ *
+ * @param string $action The nonce action.
+ */
+function wp_nonce_ays( $action ) {
+ $title = __( 'WordPress Failure Notice' );
+ $html = esc_html( wp_explain_nonce( $action ) );
+ if ( wp_get_referer() )
+ $html .= "</p><p><a href='" . esc_url( remove_query_arg( 'updated', wp_get_referer() ) ) . "'>" . __( 'Please try again.' ) . "</a>";
+ elseif ( 'log-out' == $action )
+ $html .= "</p><p>" . sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url() );
+
+ wp_die( $html, $title);
+}
+
+/**
+ * Kill WordPress execution and display HTML message with error message.
+ *
+ * Call 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 siliently.
+ *
+ * @since 2.0.4
+ *
+ * @param string $message Error message.
+ * @param string $title Error title.
+ * @param string|array $args Optional arguements to control behaviour.
+ */
+function wp_die( $message, $title = '', $args = array() ) {
global $wp_locale;
+ $defaults = array( 'response' => 500 );
+ $r = wp_parse_args($args, $defaults);
+
+ $have_gettext = function_exists('__');
+
if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
- if ( empty($title) ) {
+ if ( empty( $title ) ) {
$error_data = $message->get_error_data();
- if ( is_array($error_data) && isset($error_data['title']) )
+ if ( is_array( $error_data ) && isset( $error_data['title'] ) )
$title = $error_data['title'];
}
$errors = $message->get_error_messages();
- switch ( count($errors) ) :
+ switch ( count( $errors ) ) :
case 0 :
$message = '';
break;
$message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
break;
endswitch;
- } elseif ( is_string($message) ) {
+ } elseif ( is_string( $message ) ) {
$message = "<p>$message</p>";
}
- if ( defined('WP_SITEURL') && '' != WP_SITEURL )
- $admin_dir = WP_SITEURL.'/wp-admin/';
- elseif (function_exists('get_bloginfo') && '' != get_bloginfo('wpurl'))
- $admin_dir = get_bloginfo('wpurl').'/wp-admin/';
- elseif (strpos($_SERVER['PHP_SELF'], 'wp-admin') !== false)
+ if ( isset( $r['back_link'] ) && $r['back_link'] ) {
+ $back_text = $have_gettext? __('« Back') : '« Back';
+ $message .= "\n<p><a href='javascript:history.back()'>$back_text</p>";
+ }
+
+ if ( defined( 'WP_SITEURL' ) && '' != WP_SITEURL )
+ $admin_dir = WP_SITEURL . '/wp-admin/';
+ elseif ( function_exists( 'get_bloginfo' ) && '' != get_bloginfo( 'wpurl' ) )
+ $admin_dir = get_bloginfo( 'wpurl' ) . '/wp-admin/';
+ elseif ( strpos( $_SERVER['PHP_SELF'], 'wp-admin' ) !== false )
$admin_dir = '';
else
$admin_dir = 'wp-admin/';
- if ( !function_exists('did_action') || !did_action('admin_head') ) :
+ if ( !function_exists( 'did_action' ) || !did_action( 'admin_head' ) ) :
if( !headers_sent() ){
- status_header(500);
+ status_header( $r['response'] );
nocache_headers();
- header('Content-Type: text/html; charset=utf-8');
+ header( 'Content-Type: text/html; charset=utf-8' );
}
- if ( empty($title) ){
- if( function_exists('__') )
- $title = __('WordPress › Error');
- else
- $title = 'WordPress › Error';
+ if ( empty($title) ) {
+ $title = $have_gettext? __('WordPress › Error') : 'WordPress › Error';
}
+ $text_direction = 'ltr';
+ if ( isset($r['text_direction']) && $r['text_direction'] == 'rtl' ) $text_direction = 'rtl';
+ if ( ( $wp_locale ) && ( 'rtl' == $wp_locale->text_direction ) ) $text_direction = 'rtl';
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists('language_attributes') ) language_attributes(); ?>>
+<html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists( 'language_attributes' ) ) language_attributes(); ?>>
<head>
- <title><?php echo $title ?></title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title><?php echo $title ?></title>
<link rel="stylesheet" href="<?php echo $admin_dir; ?>css/install.css" type="text/css" />
<?php
-if ( ( $wp_locale ) && ('rtl' == $wp_locale->text_direction) ) : ?>
+if ( 'rtl' == $text_direction ) : ?>
<link rel="stylesheet" href="<?php echo $admin_dir; ?>css/install-rtl.css" type="text/css" />
<?php endif; ?>
</head>
-<body>
+<body id="error-page">
<?php endif; ?>
- <h1 id="logo"><img alt="WordPress" src="<?php echo $admin_dir; ?>images/wordpress-logo.png" /></h1>
<?php echo $message; ?>
-
</body>
+<!-- Ticket #8942, IE bug fix: always pad the error page with enough characters such that it is greater than 512 bytes, even after gzip compression abcdefghijklmnopqrstuvwxyz1234567890aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz11223344556677889900abacbcbdcdcededfefegfgfhghgihihjijikjkjlklkmlmlnmnmononpopoqpqprqrqsrsrtstsubcbcdcdedefefgfabcadefbghicjkldmnoepqrfstugvwxhyz1i234j567k890laabmbccnddeoeffpgghqhiirjjksklltmmnunoovppqwqrrxsstytuuzvvw0wxx1yyz2z113223434455666777889890091abc2def3ghi4jkl5mno6pqr7stu8vwx9yz11aab2bcc3dd4ee5ff6gg7hh8ii9j0jk1kl2lmm3nnoo4p5pq6qrr7ss8tt9uuvv0wwx1x2yyzz13aba4cbcb5dcdc6dedfef8egf9gfh0ghg1ihi2hji3jik4jkj5lkl6kml7mln8mnm9ono -->
</html>
<?php
die();
}
-function _config_wp_home($url = '') {
+/**
+ * Retrieve the WordPress home page URL.
+ *
+ * If the constant named 'WP_HOME' exists, then it willl be used and returned by
+ * the function. This can be used to counter the redirection on your local
+ * development environment.
+ *
+ * @access private
+ * @package WordPress
+ * @since 2.2.0
+ *
+ * @param string $url URL for the home location
+ * @return string Homepage location.
+ */
+function _config_wp_home( $url = '' ) {
if ( defined( 'WP_HOME' ) )
return WP_HOME;
- else return $url;
-}
-
-function _config_wp_siteurl($url = '') {
+ return $url;
+}
+
+/**
+ * Retrieve the WordPress site URL.
+ *
+ * If the constant named 'WP_SITEURL' is defined, then the value in that
+ * constant will always be returned. This can be used for debugging a site on
+ * your localhost while not having to change the database to your URL.
+ *
+ * @access private
+ * @package WordPress
+ * @since 2.2.0
+ *
+ * @param string $url URL to set the WordPress site location.
+ * @return string The WordPress Site URL
+ */
+function _config_wp_siteurl( $url = '' ) {
if ( defined( 'WP_SITEURL' ) )
return WP_SITEURL;
- else return $url;
-}
-
-function _mce_set_direction() {
+ return $url;
+}
+
+/**
+ * Set the localized direction for MCE plugin.
+ *
+ * Will only set the direction to 'rtl', if the WordPress locale has the text
+ * direction set to 'rtl'.
+ *
+ * Fills in the 'directionality', 'plugins', and 'theme_advanced_button1' array
+ * keys. These keys are then returned in the $input array.
+ *
+ * @access private
+ * @package WordPress
+ * @subpackage MCE
+ * @since 2.1.0
+ *
+ * @param array $input MCE plugin array.
+ * @return array Direction set for 'rtl', if needed by locale.
+ */
+function _mce_set_direction( $input ) {
global $wp_locale;
- if ('rtl' == $wp_locale->text_direction) {
- echo 'directionality : "rtl" ,';
- echo 'theme_advanced_toolbar_align : "right" ,';
+ if ( 'rtl' == $wp_locale->text_direction ) {
+ $input['directionality'] = 'rtl';
+ $input['plugins'] .= ',directionality';
+ $input['theme_advanced_buttons1'] .= ',ltr';
}
-}
-
-function _mce_load_rtl_plugin($input) {
- global $wp_locale;
-
- if ('rtl' == $wp_locale->text_direction)
- $input[] = 'directionality';
return $input;
}
-function _mce_add_direction_buttons($input) {
- global $wp_locale;
-
- if ('rtl' == $wp_locale->text_direction) {
- $new_buttons = array('separator', 'ltr', 'rtl');
- $input = array_merge($input, $new_buttons);
- }
-
- return $input;
-}
+/**
+ * Convert smiley code to the icon graphic file equivalent.
+ *
+ * You can turn off smilies, by going to the write setting screen and unchecking
+ * the box, or by setting 'use_smilies' option to false or removing the option.
+ *
+ * Plugins may override the default smiley list by setting the $wpsmiliestrans
+ * to an array, with the key the code the blogger types in and the value the
+ * image file.
+ *
+ * The $wp_smiliessearch global is for the regular expression and is set each
+ * time the function is called.
+ *
+ * The full list of smilies can be found in the function and won't be listed in
+ * the description. Probably should create a Codex page for it, so that it is
+ * available.
+ *
+ * @global array $wpsmiliestrans
+ * @global array $wp_smiliessearch
+ * @since 2.2.0
+ */
function smilies_init() {
- global $wpsmiliestrans, $wp_smiliessearch, $wp_smiliesreplace;
+ global $wpsmiliestrans, $wp_smiliessearch;
// don't bother setting up smilies if they are disabled
- if ( !get_option('use_smilies') )
+ if ( !get_option( 'use_smilies' ) )
return;
- if (!isset($wpsmiliestrans)) {
+ if ( !isset( $wpsmiliestrans ) ) {
$wpsmiliestrans = array(
':mrgreen:' => 'icon_mrgreen.gif',
':neutral:' => 'icon_neutral.gif',
);
}
- $siteurl = get_option('siteurl');
+ if (count($wpsmiliestrans) == 0) {
+ return;
+ }
+
+ /*
+ * NOTE: we sort the smilies in reverse key order. This is to make sure
+ * we match the longest possible smilie (:???: vs :?) as the regular
+ * expression used below is first-match
+ */
+ krsort($wpsmiliestrans);
+
+ $wp_smiliessearch = '/(?:\s|^)';
+
+ $subchar = '';
foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
- $wp_smiliessearch[] = '/(\s|^)'.preg_quote($smiley, '/').'(\s|$)/';
- $smiley_masked = htmlspecialchars(trim($smiley), ENT_QUOTES);
- $wp_smiliesreplace[] = " <img src='$siteurl/wp-includes/images/smilies/$img' alt='$smiley_masked' class='wp-smiley' /> ";
+ $firstchar = substr($smiley, 0, 1);
+ $rest = substr($smiley, 1);
+
+ // new subpattern?
+ if ($firstchar != $subchar) {
+ if ($subchar != '') {
+ $wp_smiliessearch .= ')|(?:\s|^)';
+ }
+ $subchar = $firstchar;
+ $wp_smiliessearch .= preg_quote($firstchar, '/') . '(?:';
+ } else {
+ $wp_smiliessearch .= '|';
+ }
+ $wp_smiliessearch .= preg_quote($rest, '/');
}
+
+ $wp_smiliessearch .= ')(?:\s|$)/m';
}
+/**
+ * Merge user defined arguments into defaults array.
+ *
+ * This function is used throughout WordPress to allow for both string or array
+ * to be merged into another array.
+ *
+ * @since 2.2.0
+ *
+ * @param string|array $args Value to merge with $defaults
+ * @param array $defaults Array that serves as the defaults.
+ * @return array Merged user defined values with defaults.
+ */
function wp_parse_args( $args, $defaults = '' ) {
- if ( is_object($args) )
- $r = get_object_vars($args);
- else if ( is_array( $args ) )
+ if ( is_object( $args ) )
+ $r = get_object_vars( $args );
+ elseif ( is_array( $args ) )
$r =& $args;
else
wp_parse_str( $args, $r );
if ( is_array( $defaults ) )
return array_merge( $defaults, $r );
- else
- return $r;
-}
-
+ return $r;
+}
+
+/**
+ * Determines if Widgets library should be loaded.
+ *
+ * Checks to make sure that the widgets library hasn't already been loaded. If
+ * it hasn't, then it will load the widgets library and run an action hook.
+ *
+ * @since 2.2.0
+ * @uses add_action() Calls '_admin_menu' hook with 'wp_widgets_add_menu' value.
+ */
function wp_maybe_load_widgets() {
- if ( !function_exists( 'dynamic_sidebar' ) ) {
- require_once ABSPATH . WPINC . '/widgets.php';
- add_action( '_admin_menu', 'wp_widgets_add_menu' );
- }
+ if ( ! apply_filters('load_default_widgets', true) )
+ return;
+ require_once( ABSPATH . WPINC . '/default-widgets.php' );
+ add_action( '_admin_menu', 'wp_widgets_add_menu' );
}
+/**
+ * Append the Widgets menu to the themes main menu.
+ *
+ * @since 2.2.0
+ * @uses $submenu The administration submenu list.
+ */
function wp_widgets_add_menu() {
global $submenu;
$submenu['themes.php'][7] = array( __( 'Widgets' ), 'switch_themes', 'widgets.php' );
- ksort($submenu['themes.php'], SORT_NUMERIC);
-}
-
-// For PHP 5.2, make sure all output buffers are flushed
-// before our singletons our destroyed.
-function wp_ob_end_flush_all()
-{
- while ( @ob_end_flush() );
-}
-
+ ksort( $submenu['themes.php'], SORT_NUMERIC );
+}
+
+/**
+ * Flush all output buffers for PHP 5.2.
+ *
+ * Make sure all output buffers are flushed before our singletons our destroyed.
+ *
+ * @since 2.2.0
+ */
+function wp_ob_end_flush_all() {
+ $levels = ob_get_level();
+ for ($i=0; $i<$levels; $i++)
+ ob_end_flush();
+}
+
+/**
+ * Load the correct database class file.
+ *
+ * This function is used to load the database class file either at runtime or by
+ * wp-admin/setup-config.php We must globalise $wpdb to ensure that it is
+ * defined globally by the inline code in wp-db.php.
+ *
+ * @since 2.5.0
+ * @global $wpdb WordPress Database Object
+ */
+function require_wp_db() {
+ global $wpdb;
+ if ( file_exists( WP_CONTENT_DIR . '/db.php' ) )
+ require_once( WP_CONTENT_DIR . '/db.php' );
+ else
+ require_once( ABSPATH . WPINC . '/wp-db.php' );
+}
+
+/**
+ * Load custom DB error or display WordPress DB error.
+ *
+ * If a file exists in the wp-content directory named db-error.php, then it will
+ * be loaded instead of displaying the WordPress DB error. If it is not found,
+ * then the WordPress DB error will be displayed instead.
+ *
+ * The WordPress DB error sets the HTTP status header to 500 to try to prevent
+ * search engines from caching the message. Custom DB messages should do the
+ * same.
+ *
+ * This function was backported to the the WordPress 2.3.2, but originally was
+ * added in WordPress 2.5.0.
+ *
+ * @since 2.3.2
+ * @uses $wpdb
+ */
function dead_db() {
global $wpdb;
// Load custom DB error template, if present.
- if ( file_exists( ABSPATH . 'wp-content/db-error.php' ) ) {
- require_once( ABSPATH . 'wp-content/db-error.php' );
+ if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
+ require_once( WP_CONTENT_DIR . '/db-error.php' );
die();
}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists( 'language_attributes' ) ) language_attributes(); ?>>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Database Error</title>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
</head>
<body>
<h1>Error establishing a database connection</h1>
die();
}
+/**
+ * Converts value to nonnegative integer.
+ *
+ * @since 2.5.0
+ *
+ * @param mixed $maybeint Data you wish to have convered to an nonnegative integer
+ * @return int An nonnegative integer
+ */
+function absint( $maybeint ) {
+ return abs( intval( $maybeint ) );
+}
+
+/**
+ * Determines if the blog can be accessed over SSL.
+ *
+ * Determines if blog can be accessed over SSL by using cURL to access the site
+ * using the https in the siteurl. Requires cURL extension to work correctly.
+ *
+ * @since 2.5.0
+ *
+ * @return bool Whether or not SSL access is available
+ */
+function url_is_accessable_via_ssl($url)
+{
+ if (in_array('curl', get_loaded_extensions())) {
+ $ssl = preg_replace( '/^http:\/\//', 'https://', $url );
+
+ $ch = curl_init();
+ curl_setopt($ch, CURLOPT_URL, $ssl);
+ curl_setopt($ch, CURLOPT_FAILONERROR, true);
+ curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+ curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
+
+ curl_exec($ch);
+
+ $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+ curl_close ($ch);
+
+ if ($status == 200 || $status == 401) {
+ return true;
+ }
+ }
+ return false;
+}
+
+/**
+ * Secure URL, if available or the given URL.
+ *
+ * @since 2.5.0
+ *
+ * @param string $url Complete URL path with transport.
+ * @return string Secure or regular URL path.
+ */
+function atom_service_url_filter($url)
+{
+ if ( url_is_accessable_via_ssl($url) )
+ return preg_replace( '/^http:\/\//', 'https://', $url );
+ else
+ return $url;
+}
+
+/**
+ * Marks a function as deprecated and informs when it has been used.
+ *
+ * There is a hook deprecated_function_run that will be called that can be used
+ * to get the backtrace up to what file and function called the deprecated
+ * function.
+ *
+ * The current behavior is to trigger an user error if WP_DEBUG is defined and
+ * is true.
+ *
+ * This function is to be used in every function in depreceated.php
+ *
+ * @package WordPress
+ * @package Debug
+ * @since 2.5.0
+ * @access private
+ *
+ * @uses do_action() Calls 'deprecated_function_run' and passes the function name and what to use instead.
+ * @uses apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do trigger or false to not trigger error.
+ *
+ * @param string $function The function that was called
+ * @param string $version The version of WordPress that deprecated the function
+ * @param string $replacement Optional. The function that should have been called
+ */
+function _deprecated_function($function, $version, $replacement=null) {
+
+ do_action('deprecated_function_run', $function, $replacement);
+
+ // Allow plugin to filter the output error trigger
+ if( defined('WP_DEBUG') && ( true === WP_DEBUG ) && apply_filters( 'deprecated_function_trigger_error', true )) {
+ if( !is_null($replacement) )
+ trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
+ else
+ trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
+ }
+}
+
+/**
+ * Marks a file as deprecated and informs when it has been used.
+ *
+ * There is a hook deprecated_file_included that will be called that can be used
+ * to get the backtrace up to what file and function included the deprecated
+ * file.
+ *
+ * The current behavior is to trigger an user error if WP_DEBUG is defined and
+ * is true.
+ *
+ * This function is to be used in every file that is depreceated
+ *
+ * @package WordPress
+ * @package Debug
+ * @since 2.5.0
+ * @access private
+ *
+ * @uses do_action() Calls 'deprecated_file_included' and passes the file name and what to use instead.
+ * @uses apply_filters() Calls 'deprecated_file_trigger_error' and expects boolean value of true to do trigger or false to not trigger error.
+ *
+ * @param string $file The file that was included
+ * @param string $version The version of WordPress that deprecated the function
+ * @param string $replacement Optional. The function that should have been called
+ */
+function _deprecated_file($file, $version, $replacement=null) {
+
+ do_action('deprecated_file_included', $file, $replacement);
+
+ // Allow plugin to filter the output error trigger
+ if( defined('WP_DEBUG') && ( true === WP_DEBUG ) && apply_filters( 'deprecated_file_trigger_error', true )) {
+ if( !is_null($replacement) )
+ trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) );
+ else
+ trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) );
+ }
+}
+
+/**
+ * Is the server running earlier than 1.5.0 version of lighttpd
+ *
+ * @since 2.5.0
+ *
+ * @return bool Whether the server is running lighttpd < 1.5.0
+ */
+function is_lighttpd_before_150() {
+ $server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] )? $_SERVER['SERVER_SOFTWARE'] : '' );
+ $server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : '';
+ return 'lighttpd' == $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' );
+}
+
+/**
+ * Does the specified module exist in the apache config?
+ *
+ * @since 2.5.0
+ *
+ * @param string $mod e.g. mod_rewrite
+ * @param bool $default The default return value if the module is not found
+ * @return bool
+ */
+function apache_mod_loaded($mod, $default = false) {
+ global $is_apache;
+
+ if ( !$is_apache )
+ return false;
+
+ if ( function_exists('apache_get_modules') ) {
+ $mods = apache_get_modules();
+ if ( in_array($mod, $mods) )
+ return true;
+ } elseif ( function_exists('phpinfo') ) {
+ ob_start();
+ phpinfo(8);
+ $phpinfo = ob_get_clean();
+ if ( false !== strpos($phpinfo, $mod) )
+ return true;
+ }
+ return $default;
+}
+
+/**
+ * File validates against allowed set of defined rules.
+ *
+ * A return value of '1' means that the $file contains either '..' or './'. A
+ * return value of '2' means that the $file contains ':' after the first
+ * character. A return value of '3' means that the file is not in the allowed
+ * files list.
+ *
+ * @since 1.2.0
+ *
+ * @param string $file File path.
+ * @param array $allowed_files List of allowed files.
+ * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
+ */
+function validate_file( $file, $allowed_files = '' ) {
+ if ( false !== strpos( $file, '..' ))
+ return 1;
+
+ if ( false !== strpos( $file, './' ))
+ return 1;
+
+ if (':' == substr( $file, 1, 1 ))
+ return 2;
+
+ if (!empty ( $allowed_files ) && (!in_array( $file, $allowed_files ) ) )
+ return 3;
+
+ return 0;
+}
+
+/**
+ * Determine if SSL is used.
+ *
+ * @since 2.6.0
+ *
+ * @return bool True if SSL, false if not used.
+ */
+function is_ssl() {
+ if ( isset($_SERVER['HTTPS']) ) {
+ if ( 'on' == strtolower($_SERVER['HTTPS']) )
+ return true;
+ if ( '1' == $_SERVER['HTTPS'] )
+ return true;
+ } elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
+ return true;
+ }
+ return false;
+}
+
+/**
+ * Whether SSL login should be forced.
+ *
+ * @since 2.6.0
+ *
+ * @param string|bool $force Optional.
+ * @return bool True if forced, false if not forced.
+ */
+function force_ssl_login($force = '') {
+ static $forced;
+
+ if ( '' != $force ) {
+ $old_forced = $forced;
+ $forced = $force;
+ return $old_forced;
+ }
+
+ return $forced;
+}
+
+/**
+ * Whether to force SSL used for the Administration Panels.
+ *
+ * @since 2.6.0
+ *
+ * @param string|bool $force
+ * @return bool True if forced, false if not forced.
+ */
+function force_ssl_admin($force = '') {
+ static $forced;
+
+ if ( '' != $force ) {
+ $old_forced = $forced;
+ $forced = $force;
+ return $old_forced;
+ }
+
+ return $forced;
+}
+
+/**
+ * Guess the URL for the site.
+ *
+ * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
+ * directory.
+ *
+ * @since 2.6.0
+ *
+ * @return string
+ */
+function wp_guess_url() {
+ if ( defined('WP_SITEURL') && '' != WP_SITEURL ) {
+ $url = WP_SITEURL;
+ } else {
+ $schema = ( isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on' ) ? 'https://' : 'http://';
+ $url = preg_replace('|/wp-admin/.*|i', '', $schema . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
+ }
+ return $url;
+}
+
+/**
+ * Suspend cache invalidation.
+ *
+ * Turns cache invalidation on and off. Useful during imports where you don't wont to do invalidations
+ * every time a post is inserted. Callers must be sure that what they are doing won't lead to an inconsistent
+ * cache when invalidation is suspended.
+ *
+ * @since 2.7.0
+ *
+ * @param bool $suspend Whether to suspend or enable cache invalidation
+ * @return bool The current suspend setting
+ */
+function wp_suspend_cache_invalidation($suspend = true) {
+ global $_wp_suspend_cache_invalidation;
+
+ $current_suspend = $_wp_suspend_cache_invalidation;
+ $_wp_suspend_cache_invalidation = $suspend;
+ return $current_suspend;
+}
+
+function get_site_option( $key, $default = false, $use_cache = true ) {
+ return get_option($key, $default);
+}
+
+// expects $key, $value not to be SQL escaped
+function add_site_option( $key, $value ) {
+ return add_option($key, $value);
+}
+
+// expects $key, $value not to be SQL escaped
+function update_site_option( $key, $value ) {
+ return update_option($key, $value);
+}
+
+/**
+ * gmt_offset modification for smart timezone handling
+ *
+ * Overrides the gmt_offset option if we have a timezone_string available
+ */
+function wp_timezone_override_offset() {
+ if ( !wp_timezone_supported() ) {
+ return false;
+ }
+ if ( !$timezone_string = get_option( 'timezone_string' ) ) {
+ return false;
+ }
+
+ @date_default_timezone_set( $timezone_string );
+ $timezone_object = timezone_open( $timezone_string );
+ $datetime_object = date_create();
+ if ( false === $timezone_object || false === $datetime_object ) {
+ return false;
+ }
+ return round( timezone_offset_get( $timezone_object, $datetime_object ) / 3600, 2 );
+}
+
+/**
+ * Check for PHP timezone support
+ */
+function wp_timezone_supported() {
+ $support = false;
+ if (
+ function_exists( 'date_default_timezone_set' ) &&
+ function_exists( 'timezone_identifiers_list' ) &&
+ function_exists( 'timezone_open' ) &&
+ function_exists( 'timezone_offset_get' )
+ ) {
+ $support = true;
+ }
+ return apply_filters( 'timezone_support', $support );
+}
+
+function _wp_timezone_choice_usort_callback( $a, $b ) {
+ // Don't use translated versions of Etc
+ if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) {
+ // Make the order of these more like the old dropdown
+ if ( 'GMT+' === substr( $a['city'], 0, 4 ) && 'GMT+' === substr( $b['city'], 0, 4 ) ) {
+ return -1 * ( strnatcasecmp( $a['city'], $b['city'] ) );
+ }
+ if ( 'UTC' === $a['city'] ) {
+ if ( 'GMT+' === substr( $b['city'], 0, 4 ) ) {
+ return 1;
+ }
+ return -1;
+ }
+ if ( 'UTC' === $b['city'] ) {
+ if ( 'GMT+' === substr( $a['city'], 0, 4 ) ) {
+ return -1;
+ }
+ return 1;
+ }
+ return strnatcasecmp( $a['city'], $b['city'] );
+ }
+ if ( $a['t_continent'] == $b['t_continent'] ) {
+ if ( $a['t_city'] == $b['t_city'] ) {
+ return strnatcasecmp( $a['t_subcity'], $b['t_subcity'] );
+ }
+ return strnatcasecmp( $a['t_city'], $b['t_city'] );
+ } else {
+ // Force Etc to the bottom of the list
+ if ( 'Etc' === $a['continent'] ) {
+ return 1;
+ }
+ if ( 'Etc' === $b['continent'] ) {
+ return -1;
+ }
+ return strnatcasecmp( $a['t_continent'], $b['t_continent'] );
+ }
+}
+
+/**
+ * Gives a nicely formatted list of timezone strings // temporary! Not in final
+ *
+ * @param $selected_zone string Selected Zone
+ *
+ */
+function wp_timezone_choice( $selected_zone ) {
+ static $mo_loaded = false;
+
+ $continents = array( 'Africa', 'America', 'Antarctica', 'Arctic', 'Asia', 'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific', 'Etc' );
+
+ // Load translations for continents and cities
+ if ( !$mo_loaded ) {
+ $locale = get_locale();
+ $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
+ load_textdomain( 'continents-cities', $mofile );
+ $mo_loaded = true;
+ }
+
+ $zonen = array();
+ foreach ( timezone_identifiers_list() as $zone ) {
+ $zone = explode( '/', $zone );
+ if ( !in_array( $zone[0], $continents ) ) {
+ continue;
+ }
+ if ( 'Etc' === $zone[0] && in_array( $zone[1], array( 'UCT', 'GMT', 'GMT0', 'GMT+0', 'GMT-0', 'Greenwich', 'Universal', 'Zulu' ) ) ) {
+ continue;
+ }
+
+ // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
+ $exists = array(
+ 0 => ( isset( $zone[0] ) && $zone[0] ) ? true : false,
+ 1 => ( isset( $zone[1] ) && $zone[1] ) ? true : false,
+ 2 => ( isset( $zone[2] ) && $zone[2] ) ? true : false
+ );
+ $exists[3] = ( $exists[0] && 'Etc' !== $zone[0] ) ? true : false;
+ $exists[4] = ( $exists[1] && $exists[3] ) ? true : false;
+ $exists[5] = ( $exists[2] && $exists[3] ) ? true : false;
+
+ $zonen[] = array(
+ 'continent' => ( $exists[0] ? $zone[0] : '' ),
+ 'city' => ( $exists[1] ? $zone[1] : '' ),
+ 'subcity' => ( $exists[2] ? $zone[2] : '' ),
+ 't_continent' => ( $exists[3] ? translate( str_replace( '_', ' ', $zone[0] ), 'continents-cities' ) : '' ),
+ 't_city' => ( $exists[4] ? translate( str_replace( '_', ' ', $zone[1] ), 'continents-cities' ) : '' ),
+ 't_subcity' => ( $exists[5] ? translate( str_replace( '_', ' ', $zone[2] ), 'continents-cities' ) : '' )
+ );
+ }
+ usort( $zonen, '_wp_timezone_choice_usort_callback' );
+
+ $structure = array();
+
+ if ( empty( $selected_zone ) ) {
+ $structure[] = '<option selected="selected" value="">' . __( 'Select a city' ) . '</option>';
+ }
+
+ foreach ( $zonen as $key => $zone ) {
+ // Build value in an array to join later
+ $value = array( $zone['continent'] );
+
+ if ( empty( $zone['city'] ) ) {
+ // It's at the continent level (generally won't happen)
+ $display = $zone['t_continent'];
+ } else {
+ // It's inside a continent group
+
+ // Continent optgroup
+ if ( !isset( $zonen[$key - 1] ) || $zonen[$key - 1]['continent'] !== $zone['continent'] ) {
+ $label = ( 'Etc' === $zone['continent'] ) ? __( 'Manual offsets' ) : $zone['t_continent'];
+ $structure[] = '<optgroup label="'. esc_attr( $label ) .'">';
+ }
+
+ // Add the city to the value
+ $value[] = $zone['city'];
+ if ( 'Etc' === $zone['continent'] ) {
+ if ( 'UTC' === $zone['city'] ) {
+ $display = '';
+ } else {
+ $display = str_replace( 'GMT', '', $zone['city'] );
+ $display = strtr( $display, '+-', '-+' ) . ':00';
+ }
+ $display = sprintf( __( 'UTC %s' ), $display );
+ } else {
+ $display = $zone['t_city'];
+ if ( !empty( $zone['subcity'] ) ) {
+ // Add the subcity to the value
+ $value[] = $zone['subcity'];
+ $display .= ' - ' . $zone['t_subcity'];
+ }
+ }
+ }
+
+ // Build the value
+ $value = join( '/', $value );
+ $selected = '';
+ if ( $value === $selected_zone ) {
+ $selected = 'selected="selected" ';
+ }
+ $structure[] = '<option ' . $selected . 'value="' . esc_attr( $value ) . '">' . esc_html( $display ) . "</option>";
+
+ // Close continent optgroup
+ if ( !empty( $zone['city'] ) && ( !isset($zonen[$key + 1]) || (isset( $zonen[$key + 1] ) && $zonen[$key + 1]['continent'] !== $zone['continent']) ) ) {
+ $structure[] = '</optgroup>';
+ }
+ }
+
+ return join( "\n", $structure );
+}
+
+
+
+/**
+ * Strip close comment and close php tags from file headers used by WP
+ * See http://core.trac.wordpress.org/ticket/8497
+ *
+ * @since 2.8
+**/
+function _cleanup_header_comment($str) {
+ return trim(preg_replace("/\s*(?:\*\/|\?>).*/", '', $str));
+}
?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff