9 * Converts MySQL DATETIME field to user specified date format.
11 * If $dateformatstring has 'G' value, then gmmktime() function will be used to
12 * make the time. If $dateformatstring is set to 'U', then mktime() function
13 * will be used to make the time.
15 * The $translate will only be used, if it is set to true and it is by default
16 * and if the $wp_locale object has the month and weekday set.
20 * @param string $dateformatstring Either 'G', 'U', or php date format.
21 * @param string $mysqlstring Time from mysql DATETIME field.
22 * @param bool $translate Optional. Default is true. Will switch format to locale.
23 * @return string Date formatted by $dateformatstring or locale (if available).
25 function mysql2date( $dateformatstring, $mysqlstring, $translate = true ) {
30 if ( 'G' == $dateformatstring )
31 return strtotime( $m . ' +0000' );
35 if ( 'U' == $dateformatstring )
39 return date_i18n( $dateformatstring, $i );
41 return date( $dateformatstring, $i );
45 * Retrieve the current time based on specified type.
47 * The 'mysql' type will return the time in the format for MySQL DATETIME field.
48 * The 'timestamp' type will return the current timestamp.
50 * If $gmt is set to either '1' or 'true', then both types will use GMT time.
51 * if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
55 * @param string $type Either 'mysql' or 'timestamp'.
56 * @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
57 * @return int|string String if $type is 'gmt', int if $type is 'timestamp'.
59 function current_time( $type, $gmt = 0 ) {
62 return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * 3600 ) ) );
65 return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * 3600 );
71 * Retrieve the date in localized format, based on timestamp.
73 * If the locale specifies the locale month and weekday, then the locale will
74 * take over the format for the date. If it isn't, then the date format string
75 * will be used instead.
79 * @param string $dateformatstring Format to display the date.
80 * @param int $unixtimestamp Optional. Unix timestamp.
81 * @param bool $gmt Optional, default is false. Whether to convert to GMT for time.
82 * @return string The date, translated if locale specifies it.
84 function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
90 $i = current_time( 'timestamp' );
93 // we should not let date() interfere with our
94 // specially computed timestamp
98 // store original value for language with untypical grammars
99 // see http://core.trac.wordpress.org/ticket/9396
100 $req_format = $dateformatstring;
102 $datefunc = $gmt? 'gmdate' : 'date';
104 if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
105 $datemonth = $wp_locale->get_month( $datefunc( 'm', $i ) );
106 $datemonth_abbrev = $wp_locale->get_month_abbrev( $datemonth );
107 $dateweekday = $wp_locale->get_weekday( $datefunc( 'w', $i ) );
108 $dateweekday_abbrev = $wp_locale->get_weekday_abbrev( $dateweekday );
109 $datemeridiem = $wp_locale->get_meridiem( $datefunc( 'a', $i ) );
110 $datemeridiem_capital = $wp_locale->get_meridiem( $datefunc( 'A', $i ) );
111 $dateformatstring = ' '.$dateformatstring;
112 $dateformatstring = preg_replace( "/([^\\\])D/", "\\1" . backslashit( $dateweekday_abbrev ), $dateformatstring );
113 $dateformatstring = preg_replace( "/([^\\\])F/", "\\1" . backslashit( $datemonth ), $dateformatstring );
114 $dateformatstring = preg_replace( "/([^\\\])l/", "\\1" . backslashit( $dateweekday ), $dateformatstring );
115 $dateformatstring = preg_replace( "/([^\\\])M/", "\\1" . backslashit( $datemonth_abbrev ), $dateformatstring );
116 $dateformatstring = preg_replace( "/([^\\\])a/", "\\1" . backslashit( $datemeridiem ), $dateformatstring );
117 $dateformatstring = preg_replace( "/([^\\\])A/", "\\1" . backslashit( $datemeridiem_capital ), $dateformatstring );
119 $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
121 $timezone_formats = array( 'P', 'I', 'O', 'T', 'Z', 'e' );
122 $timezone_formats_re = implode( '|', $timezone_formats );
123 if ( preg_match( "/$timezone_formats_re/", $dateformatstring ) ) {
124 $timezone_string = get_option( 'timezone_string' );
125 if ( $timezone_string ) {
126 $timezone_object = timezone_open( $timezone_string );
127 $date_object = date_create( null, $timezone_object );
128 foreach( $timezone_formats as $timezone_format ) {
129 if ( false !== strpos( $dateformatstring, $timezone_format ) ) {
130 $formatted = date_format( $date_object, $timezone_format );
131 $dateformatstring = ' '.$dateformatstring;
132 $dateformatstring = preg_replace( "/([^\\\])$timezone_format/", "\\1" . backslashit( $formatted ), $dateformatstring );
133 $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
138 $j = @$datefunc( $dateformatstring, $i );
139 // allow plugins to redo this entirely for languages with untypical grammars
140 $j = apply_filters('date_i18n', $j, $req_format, $i, $gmt);
145 * Convert integer number to format based on the locale.
149 * @param int $number The number to convert based on locale.
150 * @param int $decimals Precision of the number of decimal places.
151 * @return string Converted number in string format.
153 function number_format_i18n( $number, $decimals = 0 ) {
155 $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
156 return apply_filters( 'number_format_i18n', $formatted );
160 * Convert number of bytes largest unit bytes will fit into.
162 * It is easier to read 1kB than 1024 bytes and 1MB than 1048576 bytes. Converts
163 * number of bytes to human readable number by taking the number of that unit
164 * that the bytes will go into it. Supports TB value.
166 * Please note that integers in PHP are limited to 32 bits, unless they are on
167 * 64 bit architecture, then they have 64 bit size. If you need to place the
168 * larger size then what PHP integer type will hold, then use a string. It will
169 * be converted to a double, which should always have 64 bit length.
171 * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
172 * @link http://en.wikipedia.org/wiki/Byte
176 * @param int|string $bytes Number of bytes. Note max integer size for integers.
177 * @param int $decimals Precision of number of decimal places. Deprecated.
178 * @return bool|string False on failure. Number string on success.
180 function size_format( $bytes, $decimals = 0 ) {
182 // ========================= Origin ====
183 'TB' => 1099511627776, // pow( 1024, 4)
184 'GB' => 1073741824, // pow( 1024, 3)
185 'MB' => 1048576, // pow( 1024, 2)
186 'kB' => 1024, // pow( 1024, 1)
187 'B ' => 1, // pow( 1024, 0)
189 foreach ( $quant as $unit => $mag )
190 if ( doubleval($bytes) >= $mag )
191 return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
197 * Get the week start and end from the datetime or date string from mysql.
201 * @param string $mysqlstring Date or datetime field type from mysql.
202 * @param int $start_of_week Optional. Start of the week as an integer.
203 * @return array Keys are 'start' and 'end'.
205 function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
206 $my = substr( $mysqlstring, 0, 4 ); // Mysql string Year
207 $mm = substr( $mysqlstring, 8, 2 ); // Mysql string Month
208 $md = substr( $mysqlstring, 5, 2 ); // Mysql string day
209 $day = mktime( 0, 0, 0, $md, $mm, $my ); // The timestamp for mysqlstring day.
210 $weekday = date( 'w', $day ); // The day of the week from the timestamp
211 if ( !is_numeric($start_of_week) )
212 $start_of_week = get_option( 'start_of_week' );
214 if ( $weekday < $start_of_week )
217 $start = $day - 86400 * ( $weekday - $start_of_week ); // The most recent week start day on or before $day
218 $end = $start + 604799; // $start + 7 days - 1 second
219 return compact( 'start', 'end' );
223 * Unserialize value only if it was serialized.
227 * @param string $original Maybe unserialized original, if is needed.
228 * @return mixed Unserialized data can be any type.
230 function maybe_unserialize( $original ) {
231 if ( is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
232 return @unserialize( $original );
237 * Check value to find if it was serialized.
239 * If $data is not an string, then returned value will always be false.
240 * Serialized data is always a string.
244 * @param mixed $data Value to check to see if was serialized.
245 * @return bool False if not serialized and true if it was.
247 function is_serialized( $data ) {
248 // if it isn't a string, it isn't serialized
249 if ( ! is_string( $data ) )
251 $data = trim( $data );
254 $length = strlen( $data );
257 if ( ':' !== $data[1] )
259 $lastc = $data[$length-1];
260 if ( ';' !== $lastc && '}' !== $lastc )
265 if ( '"' !== $data[$length-2] )
269 return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
273 return (bool) preg_match( "/^{$token}:[0-9.E-]+;\$/", $data );
279 * Check whether serialized data is of string type.
283 * @param mixed $data Serialized data
284 * @return bool False if not a serialized string, true if it is.
286 function is_serialized_string( $data ) {
287 // if it isn't a string, it isn't a serialized string
288 if ( !is_string( $data ) )
290 $data = trim( $data );
291 $length = strlen( $data );
294 elseif ( ':' !== $data[1] )
296 elseif ( ';' !== $data[$length-1] )
298 elseif ( $data[0] !== 's' )
300 elseif ( '"' !== $data[$length-2] )
307 * Retrieve option value based on name of option.
309 * If the option does not exist or does not have a value, then the return value
310 * will be false. This is useful to check whether you need to install an option
311 * and is commonly used during installation of plugin options and to test
312 * whether upgrading is required.
314 * If the option was serialized then it will be unserialized when it is returned.
319 * @uses apply_filters() Calls 'pre_option_$option' before checking the option.
320 * Any value other than false will "short-circuit" the retrieval of the option
321 * and return the returned value. You should not try to override special options,
322 * but you will not be prevented from doing so.
323 * @uses apply_filters() Calls 'option_$option', after checking the option, with
326 * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
327 * @param mixed $default Optional. Default value to return if the option does not exist.
328 * @return mixed Value set for the option.
330 function get_option( $option, $default = false ) {
333 // Allow plugins to short-circuit options.
334 $pre = apply_filters( 'pre_option_' . $option, false );
335 if ( false !== $pre )
338 $option = trim($option);
339 if ( empty($option) )
342 if ( defined( 'WP_SETUP_CONFIG' ) )
345 if ( ! defined( 'WP_INSTALLING' ) ) {
346 // prevent non-existent options from triggering multiple queries
347 $notoptions = wp_cache_get( 'notoptions', 'options' );
348 if ( isset( $notoptions[$option] ) )
351 $alloptions = wp_load_alloptions();
353 if ( isset( $alloptions[$option] ) ) {
354 $value = $alloptions[$option];
356 $value = wp_cache_get( $option, 'options' );
358 if ( false === $value ) {
359 $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
361 // Has to be get_row instead of get_var because of funkiness with 0, false, null values
362 if ( is_object( $row ) ) {
363 $value = $row->option_value;
364 wp_cache_add( $option, $value, 'options' );
365 } else { // option does not exist, so we must cache its non-existence
366 $notoptions[$option] = true;
367 wp_cache_set( 'notoptions', $notoptions, 'options' );
373 $suppress = $wpdb->suppress_errors();
374 $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
375 $wpdb->suppress_errors( $suppress );
376 if ( is_object( $row ) )
377 $value = $row->option_value;
382 // If home is not set use siteurl.
383 if ( 'home' == $option && '' == $value )
384 return get_option( 'siteurl' );
386 if ( in_array( $option, array('siteurl', 'home', 'category_base', 'tag_base') ) )
387 $value = untrailingslashit( $value );
389 return apply_filters( 'option_' . $option, maybe_unserialize( $value ) );
393 * Protect WordPress special option from being modified.
395 * Will die if $option is in protected list. Protected options are 'alloptions'
396 * and 'notoptions' options.
402 * @param string $option Option name.
404 function wp_protect_special_option( $option ) {
405 $protected = array( 'alloptions', 'notoptions' );
406 if ( in_array( $option, $protected ) )
407 wp_die( sprintf( __( '%s is a protected WP option and may not be modified' ), esc_html( $option ) ) );
411 * Print option value after sanitizing for forms.
413 * @uses attr Sanitizes value.
418 * @param string $option Option name.
420 function form_option( $option ) {
421 echo esc_attr( get_option( $option ) );
425 * Loads and caches all autoloaded options, if available or all options.
431 * @return array List of all options.
433 function wp_load_alloptions() {
436 if ( !defined( 'WP_INSTALLING' ) || !is_multisite() )
437 $alloptions = wp_cache_get( 'alloptions', 'options' );
441 if ( !$alloptions ) {
442 $suppress = $wpdb->suppress_errors();
443 if ( !$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) )
444 $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" );
445 $wpdb->suppress_errors($suppress);
446 $alloptions = array();
447 foreach ( (array) $alloptions_db as $o ) {
448 $alloptions[$o->option_name] = $o->option_value;
450 if ( !defined( 'WP_INSTALLING' ) || !is_multisite() )
451 wp_cache_add( 'alloptions', $alloptions, 'options' );
458 * Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.
464 * @param int $site_id Optional site ID for which to query the options. Defaults to the current site.
466 function wp_load_core_site_options( $site_id = null ) {
467 global $wpdb, $_wp_using_ext_object_cache;
469 if ( !is_multisite() || $_wp_using_ext_object_cache || defined( 'WP_INSTALLING' ) )
472 if ( empty($site_id) )
473 $site_id = $wpdb->siteid;
475 $core_options = array('site_name', 'siteurl', 'active_sitewide_plugins', '_site_transient_timeout_theme_roots', '_site_transient_theme_roots', 'site_admins', 'can_compress_scripts', 'global_terms_enabled' );
477 $core_options_in = "'" . implode("', '", $core_options) . "'";
478 $options = $wpdb->get_results( $wpdb->prepare("SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN ($core_options_in) AND site_id = %d", $site_id) );
480 foreach ( $options as $option ) {
481 $key = $option->meta_key;
482 $cache_key = "{$site_id}:$key";
483 $option->meta_value = maybe_unserialize( $option->meta_value );
485 wp_cache_set( $cache_key, $option->meta_value, 'site-options' );
490 * Update the value of an option that was already added.
492 * You do not need to serialize values. If the value needs to be serialized, then
493 * it will be serialized before it is inserted into the database. Remember,
494 * resources can not be serialized or added as an option.
496 * If the option does not exist, then the option will be added with the option
497 * value, but you will not be able to set whether it is autoloaded. If you want
498 * to set whether an option is autoloaded, then you need to use the add_option().
504 * @uses apply_filters() Calls 'pre_update_option_$option' hook to allow overwriting the
505 * option value to be stored.
506 * @uses do_action() Calls 'update_option' hook before updating the option.
507 * @uses do_action() Calls 'update_option_$option' and 'updated_option' hooks on success.
509 * @param string $option Option name. Expected to not be SQL-escaped.
510 * @param mixed $newvalue Option value. Expected to not be SQL-escaped.
511 * @return bool False if value was not updated and true if value was updated.
513 function update_option( $option, $newvalue ) {
516 $option = trim($option);
517 if ( empty($option) )
520 wp_protect_special_option( $option );
522 if ( is_object($newvalue) )
523 $newvalue = clone $newvalue;
525 $newvalue = sanitize_option( $option, $newvalue );
526 $oldvalue = get_option( $option );
527 $newvalue = apply_filters( 'pre_update_option_' . $option, $newvalue, $oldvalue );
529 // If the new and old values are the same, no need to update.
530 if ( $newvalue === $oldvalue )
533 if ( false === $oldvalue )
534 return add_option( $option, $newvalue );
536 $notoptions = wp_cache_get( 'notoptions', 'options' );
537 if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {
538 unset( $notoptions[$option] );
539 wp_cache_set( 'notoptions', $notoptions, 'options' );
542 $_newvalue = $newvalue;
543 $newvalue = maybe_serialize( $newvalue );
545 do_action( 'update_option', $option, $oldvalue, $_newvalue );
546 if ( ! defined( 'WP_INSTALLING' ) ) {
547 $alloptions = wp_load_alloptions();
548 if ( isset( $alloptions[$option] ) ) {
549 $alloptions[$option] = $_newvalue;
550 wp_cache_set( 'alloptions', $alloptions, 'options' );
552 wp_cache_set( $option, $_newvalue, 'options' );
556 $result = $wpdb->update( $wpdb->options, array( 'option_value' => $newvalue ), array( 'option_name' => $option ) );
559 do_action( "update_option_{$option}", $oldvalue, $_newvalue );
560 do_action( 'updated_option', $option, $oldvalue, $_newvalue );
569 * You do not need to serialize values. If the value needs to be serialized, then
570 * it will be serialized before it is inserted into the database. Remember,
571 * resources can not be serialized or added as an option.
573 * You can create options without values and then update the values later.
574 * Existing options will not be updated and checks are performed to ensure that you
575 * aren't adding a protected WordPress option. Care should be taken to not name
576 * options the same as the ones which are protected.
582 * @uses do_action() Calls 'add_option' hook before adding the option.
583 * @uses do_action() Calls 'add_option_$option' and 'added_option' hooks on success.
585 * @param string $option Name of option to add. Expected to not be SQL-escaped.
586 * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
587 * @param mixed $deprecated Optional. Description. Not used anymore.
588 * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.
589 * @return bool False if option was not added and true if option was added.
591 function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {
594 if ( !empty( $deprecated ) )
595 _deprecated_argument( __FUNCTION__, '2.3' );
597 $option = trim($option);
598 if ( empty($option) )
601 wp_protect_special_option( $option );
603 if ( is_object($value) )
604 $value = clone $value;
606 $value = sanitize_option( $option, $value );
608 // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query
609 $notoptions = wp_cache_get( 'notoptions', 'options' );
610 if ( !is_array( $notoptions ) || !isset( $notoptions[$option] ) )
611 if ( false !== get_option( $option ) )
615 $value = maybe_serialize( $value );
616 $autoload = ( 'no' === $autoload ) ? 'no' : 'yes';
617 do_action( 'add_option', $option, $_value );
618 if ( ! defined( 'WP_INSTALLING' ) ) {
619 if ( 'yes' == $autoload ) {
620 $alloptions = wp_load_alloptions();
621 $alloptions[$option] = $value;
622 wp_cache_set( 'alloptions', $alloptions, 'options' );
624 wp_cache_set( $option, $value, 'options' );
628 // This option exists now
629 $notoptions = wp_cache_get( 'notoptions', 'options' ); // yes, again... we need it to be fresh
630 if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {
631 unset( $notoptions[$option] );
632 wp_cache_set( 'notoptions', $notoptions, 'options' );
635 $result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $value, $autoload ) );
638 do_action( "add_option_{$option}", $option, $_value );
639 do_action( 'added_option', $option, $_value );
646 * Removes option by name. Prevents removal of protected WordPress options.
652 * @uses do_action() Calls 'delete_option' hook before option is deleted.
653 * @uses do_action() Calls 'deleted_option' and 'delete_option_$option' hooks on success.
655 * @param string $option Name of option to remove. Expected to not be SQL-escaped.
656 * @return bool True, if option is successfully deleted. False on failure.
658 function delete_option( $option ) {
661 wp_protect_special_option( $option );
663 // Get the ID, if no ID then return
664 $row = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $option ) );
665 if ( is_null( $row ) )
667 do_action( 'delete_option', $option );
668 $result = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->options WHERE option_name = %s", $option) );
669 if ( ! defined( 'WP_INSTALLING' ) ) {
670 if ( 'yes' == $row->autoload ) {
671 $alloptions = wp_load_alloptions();
672 if ( is_array( $alloptions ) && isset( $alloptions[$option] ) ) {
673 unset( $alloptions[$option] );
674 wp_cache_set( 'alloptions', $alloptions, 'options' );
677 wp_cache_delete( $option, 'options' );
681 do_action( "delete_option_$option", $option );
682 do_action( 'deleted_option', $option );
689 * Delete a transient.
693 * @subpackage Transient
695 * @uses do_action() Calls 'delete_transient_$transient' hook before transient is deleted.
696 * @uses do_action() Calls 'deleted_transient' hook on success.
698 * @param string $transient Transient name. Expected to not be SQL-escaped.
699 * @return bool true if successful, false otherwise
701 function delete_transient( $transient ) {
702 global $_wp_using_ext_object_cache;
704 do_action( 'delete_transient_' . $transient, $transient );
706 if ( $_wp_using_ext_object_cache ) {
707 $result = wp_cache_delete( $transient, 'transient' );
709 $option_timeout = '_transient_timeout_' . $transient;
710 $option = '_transient_' . $transient;
711 $result = delete_option( $option );
713 delete_option( $option_timeout );
717 do_action( 'deleted_transient', $transient );
722 * Get the value of a transient.
724 * If the transient does not exist or does not have a value, then the return value
727 * @uses apply_filters() Calls 'pre_transient_$transient' hook before checking the transient.
728 * Any value other than false will "short-circuit" the retrieval of the transient
729 * and return the returned value.
730 * @uses apply_filters() Calls 'transient_$option' hook, after checking the transient, with
731 * the transient value.
735 * @subpackage Transient
737 * @param string $transient Transient name. Expected to not be SQL-escaped
738 * @return mixed Value of transient
740 function get_transient( $transient ) {
741 global $_wp_using_ext_object_cache;
743 $pre = apply_filters( 'pre_transient_' . $transient, false );
744 if ( false !== $pre )
747 if ( $_wp_using_ext_object_cache ) {
748 $value = wp_cache_get( $transient, 'transient' );
750 $transient_option = '_transient_' . $transient;
751 if ( ! defined( 'WP_INSTALLING' ) ) {
752 // If option is not in alloptions, it is not autoloaded and thus has a timeout
753 $alloptions = wp_load_alloptions();
754 if ( !isset( $alloptions[$transient_option] ) ) {
755 $transient_timeout = '_transient_timeout_' . $transient;
756 if ( get_option( $transient_timeout ) < time() ) {
757 delete_option( $transient_option );
758 delete_option( $transient_timeout );
764 $value = get_option( $transient_option );
767 return apply_filters( 'transient_' . $transient, $value );
771 * Set/update the value of a transient.
773 * You do not need to serialize values. If the value needs to be serialized, then
774 * it will be serialized before it is set.
778 * @subpackage Transient
780 * @uses apply_filters() Calls 'pre_set_transient_$transient' hook to allow overwriting the
781 * transient value to be stored.
782 * @uses do_action() Calls 'set_transient_$transient' and 'setted_transient' hooks on success.
784 * @param string $transient Transient name. Expected to not be SQL-escaped.
785 * @param mixed $value Transient value. Expected to not be SQL-escaped.
786 * @param int $expiration Time until expiration in seconds, default 0
787 * @return bool False if value was not set and true if value was set.
789 function set_transient( $transient, $value, $expiration = 0 ) {
790 global $_wp_using_ext_object_cache;
792 $value = apply_filters( 'pre_set_transient_' . $transient, $value );
794 if ( $_wp_using_ext_object_cache ) {
795 $result = wp_cache_set( $transient, $value, 'transient', $expiration );
797 $transient_timeout = '_transient_timeout_' . $transient;
798 $transient = '_transient_' . $transient;
799 if ( false === get_option( $transient ) ) {
803 add_option( $transient_timeout, time() + $expiration, '', 'no' );
805 $result = add_option( $transient, $value, '', $autoload );
808 update_option( $transient_timeout, time() + $expiration );
809 $result = update_option( $transient, $value );
813 do_action( 'set_transient_' . $transient );
814 do_action( 'setted_transient', $transient );
820 * Saves and restores user interface settings stored in a cookie.
822 * Checks if the current user-settings cookie is updated and stores it. When no
823 * cookie exists (different browser used), adds the last saved cookie restoring
830 function wp_user_settings() {
835 if ( defined('DOING_AJAX') )
838 if ( ! $user = wp_get_current_user() )
841 $settings = get_user_option( 'user-settings', $user->ID );
843 if ( isset( $_COOKIE['wp-settings-' . $user->ID] ) ) {
844 $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user->ID] );
846 if ( ! empty( $cookie ) && strpos( $cookie, '=' ) ) {
847 if ( $cookie == $settings )
850 $last_time = (int) get_user_option( 'user-settings-time', $user->ID );
851 $saved = isset( $_COOKIE['wp-settings-time-' . $user->ID]) ? preg_replace( '/[^0-9]/', '', $_COOKIE['wp-settings-time-' . $user->ID] ) : 0;
853 if ( $saved > $last_time ) {
854 update_user_option( $user->ID, 'user-settings', $cookie, false );
855 update_user_option( $user->ID, 'user-settings-time', time() - 5, false );
861 setcookie( 'wp-settings-' . $user->ID, $settings, time() + 31536000, SITECOOKIEPATH );
862 setcookie( 'wp-settings-time-' . $user->ID, time(), time() + 31536000, SITECOOKIEPATH );
863 $_COOKIE['wp-settings-' . $user->ID] = $settings;
867 * Retrieve user interface setting value based on setting name.
873 * @param string $name The name of the setting.
874 * @param string $default Optional default value to return when $name is not set.
875 * @return mixed the last saved user setting or the default value/false if it doesn't exist.
877 function get_user_setting( $name, $default = false ) {
879 $all = get_all_user_settings();
881 return isset($all[$name]) ? $all[$name] : $default;
885 * Add or update user interface setting.
887 * Both $name and $value can contain only ASCII letters, numbers and underscores.
888 * This function has to be used before any output has started as it calls setcookie().
894 * @param string $name The name of the setting.
895 * @param string $value The value for the setting.
896 * @return bool true if set successfully/false if not.
898 function set_user_setting( $name, $value ) {
900 if ( headers_sent() )
903 $all = get_all_user_settings();
904 $name = preg_replace( '/[^A-Za-z0-9_]+/', '', $name );
909 $all[$name] = $value;
911 return wp_set_all_user_settings($all);
915 * Delete user interface settings.
917 * Deleting settings would reset them to the defaults.
918 * This function has to be used before any output has started as it calls setcookie().
924 * @param mixed $names The name or array of names of the setting to be deleted.
925 * @return bool true if deleted successfully/false if not.
927 function delete_user_setting( $names ) {
929 if ( headers_sent() )
932 $all = get_all_user_settings();
933 $names = (array) $names;
935 foreach ( $names as $name ) {
936 if ( isset($all[$name]) ) {
942 if ( isset($deleted) )
943 return wp_set_all_user_settings($all);
949 * Retrieve all user interface settings.
955 * @return array the last saved user settings or empty array.
957 function get_all_user_settings() {
958 global $_updated_user_settings;
960 if ( ! $user = wp_get_current_user() )
963 if ( isset($_updated_user_settings) && is_array($_updated_user_settings) )
964 return $_updated_user_settings;
967 if ( isset($_COOKIE['wp-settings-' . $user->ID]) ) {
968 $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user->ID] );
970 if ( $cookie && strpos($cookie, '=') ) // the '=' cannot be 1st char
971 parse_str($cookie, $all);
974 $option = get_user_option('user-settings', $user->ID);
975 if ( $option && is_string($option) )
976 parse_str( $option, $all );
983 * Private. Set all user interface settings.
989 * @param unknown $all
992 function wp_set_all_user_settings($all) {
993 global $_updated_user_settings;
995 if ( ! $user = wp_get_current_user() )
998 $_updated_user_settings = $all;
1000 foreach ( $all as $k => $v ) {
1001 $v = preg_replace( '/[^A-Za-z0-9_]+/', '', $v );
1002 $settings .= $k . '=' . $v . '&';
1005 $settings = rtrim($settings, '&');
1007 update_user_option( $user->ID, 'user-settings', $settings, false );
1008 update_user_option( $user->ID, 'user-settings-time', time(), false );
1014 * Delete the user settings of the current user.
1016 * @package WordPress
1017 * @subpackage Option
1020 function delete_all_user_settings() {
1021 if ( ! $user = wp_get_current_user() )
1024 update_user_option( $user->ID, 'user-settings', '', false );
1025 setcookie('wp-settings-' . $user->ID, ' ', time() - 31536000, SITECOOKIEPATH);
1029 * Serialize data, if needed.
1033 * @param mixed $data Data that might be serialized.
1034 * @return mixed A scalar data
1036 function maybe_serialize( $data ) {
1037 if ( is_array( $data ) || is_object( $data ) )
1038 return serialize( $data );
1040 // Double serialization is required for backward compatibility.
1041 // See http://core.trac.wordpress.org/ticket/12930
1042 if ( is_serialized( $data ) )
1043 return serialize( $data );
1049 * Retrieve post title from XMLRPC XML.
1051 * If the title element is not part of the XML, then the default post title from
1052 * the $post_default_title will be used instead.
1054 * @package WordPress
1055 * @subpackage XMLRPC
1058 * @global string $post_default_title Default XMLRPC post title.
1060 * @param string $content XMLRPC XML Request content
1061 * @return string Post title
1063 function xmlrpc_getposttitle( $content ) {
1064 global $post_default_title;
1065 if ( preg_match( '/<title>(.+?)<\/title>/is', $content, $matchtitle ) ) {
1066 $post_title = $matchtitle[1];
1068 $post_title = $post_default_title;
1074 * Retrieve the post category or categories from XMLRPC XML.
1076 * If the category element is not found, then the default post category will be
1077 * used. The return type then would be what $post_default_category. If the
1078 * category is found, then it will always be an array.
1080 * @package WordPress
1081 * @subpackage XMLRPC
1084 * @global string $post_default_category Default XMLRPC post category.
1086 * @param string $content XMLRPC XML Request content
1087 * @return string|array List of categories or category name.
1089 function xmlrpc_getpostcategory( $content ) {
1090 global $post_default_category;
1091 if ( preg_match( '/<category>(.+?)<\/category>/is', $content, $matchcat ) ) {
1092 $post_category = trim( $matchcat[1], ',' );
1093 $post_category = explode( ',', $post_category );
1095 $post_category = $post_default_category;
1097 return $post_category;
1101 * XMLRPC XML content without title and category elements.
1103 * @package WordPress
1104 * @subpackage XMLRPC
1107 * @param string $content XMLRPC XML Request content
1108 * @return string XMLRPC XML Request content without title and category elements.
1110 function xmlrpc_removepostdata( $content ) {
1111 $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
1112 $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
1113 $content = trim( $content );
1118 * Open the file handle for debugging.
1120 * This function is used for XMLRPC feature, but it is general purpose enough
1121 * to be used in anywhere.
1123 * @see fopen() for mode options.
1124 * @package WordPress
1127 * @uses $debug Used for whether debugging is enabled.
1129 * @param string $filename File path to debug file.
1130 * @param string $mode Same as fopen() mode parameter.
1131 * @return bool|resource File handle. False on failure.
1133 function debug_fopen( $filename, $mode ) {
1135 if ( 1 == $debug ) {
1136 $fp = fopen( $filename, $mode );
1144 * Write contents to the file used for debugging.
1146 * Technically, this can be used to write to any file handle when the global
1147 * $debug is set to 1 or true.
1149 * @package WordPress
1152 * @uses $debug Used for whether debugging is enabled.
1154 * @param resource $fp File handle for debugging file.
1155 * @param string $string Content to write to debug file.
1157 function debug_fwrite( $fp, $string ) {
1160 fwrite( $fp, $string );
1164 * Close the debugging file handle.
1166 * Technically, this can be used to close any file handle when the global $debug
1167 * is set to 1 or true.
1169 * @package WordPress
1172 * @uses $debug Used for whether debugging is enabled.
1174 * @param resource $fp Debug File handle.
1176 function debug_fclose( $fp ) {
1183 * Check content for video and audio links to add as enclosures.
1185 * Will not add enclosures that have already been added and will
1186 * remove enclosures that are no longer in the post. This is called as
1187 * pingbacks and trackbacks.
1189 * @package WordPress
1194 * @param string $content Post Content
1195 * @param int $post_ID Post ID
1197 function do_enclose( $content, $post_ID ) {
1200 //TODO: Tidy this ghetto code up and make the debug code optional
1201 include_once( ABSPATH . WPINC . '/class-IXR.php' );
1203 $log = debug_fopen( ABSPATH . 'enclosures.log', 'a' );
1204 $post_links = array();
1205 debug_fwrite( $log, 'BEGIN ' . date( 'YmdHis', time() ) . "\n" );
1207 $pung = get_enclosed( $post_ID );
1210 $gunk = '/#~:.?+=&%@!\-';
1212 $any = $ltrs . $gunk . $punc;
1214 preg_match_all( "{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp );
1216 debug_fwrite( $log, 'Post contents:' );
1217 debug_fwrite( $log, $content . "\n" );
1219 foreach ( $pung as $link_test ) {
1220 if ( !in_array( $link_test, $post_links_temp[0] ) ) { // link no longer in post
1221 $mid = $wpdb->get_col( $wpdb->prepare("SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE (%s)", $post_ID, like_escape( $link_test ) . '%') );
1222 do_action( 'delete_postmeta', $mid );
1223 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->postmeta WHERE meta_id IN(%s)", implode( ',', $mid ) ) );
1224 do_action( 'deleted_postmeta', $mid );
1228 foreach ( (array) $post_links_temp[0] as $link_test ) {
1229 if ( !in_array( $link_test, $pung ) ) { // If we haven't pung it already
1230 $test = @parse_url( $link_test );
1231 if ( false === $test )
1233 if ( isset( $test['query'] ) )
1234 $post_links[] = $link_test;
1235 elseif ( isset($test['path']) && ( $test['path'] != '/' ) && ($test['path'] != '' ) )
1236 $post_links[] = $link_test;
1240 foreach ( (array) $post_links as $url ) {
1241 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, like_escape( $url ) . '%' ) ) ) {
1243 if ( $headers = wp_get_http_headers( $url) ) {
1244 $len = (int) $headers['content-length'];
1245 $type = $headers['content-type'];
1246 $allowed_types = array( 'video', 'audio' );
1248 // Check to see if we can figure out the mime type from
1250 $url_parts = @parse_url( $url );
1251 if ( false !== $url_parts ) {
1252 $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );
1253 if ( !empty( $extension ) ) {
1254 foreach ( get_allowed_mime_types( ) as $exts => $mime ) {
1255 if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
1263 if ( in_array( substr( $type, 0, strpos( $type, "/" ) ), $allowed_types ) ) {
1264 $meta_value = "$url\n$len\n$type\n";
1265 $wpdb->insert($wpdb->postmeta, array('post_id' => $post_ID, 'meta_key' => 'enclosure', 'meta_value' => $meta_value) );
1266 do_action( 'added_postmeta', $wpdb->insert_id, $post_ID, 'enclosure', $meta_value );
1274 * Perform a HTTP HEAD or GET request.
1276 * If $file_path is a writable filename, this will do a GET request and write
1277 * the file to that path.
1281 * @param string $url URL to fetch.
1282 * @param string|bool $file_path Optional. File path to write request to.
1283 * @param int $red (private) The number of Redirects followed, Upon 5 being hit, returns false.
1284 * @return bool|string False on failure and string of headers if HEAD request.
1286 function wp_get_http( $url, $file_path = false, $red = 1 ) {
1287 @set_time_limit( 60 );
1293 $options['redirection'] = 5;
1295 if ( false == $file_path )
1296 $options['method'] = 'HEAD';
1298 $options['method'] = 'GET';
1300 $response = wp_remote_request($url, $options);
1302 if ( is_wp_error( $response ) )
1305 $headers = wp_remote_retrieve_headers( $response );
1306 $headers['response'] = wp_remote_retrieve_response_code( $response );
1308 // WP_HTTP no longer follows redirects for HEAD requests.
1309 if ( 'HEAD' == $options['method'] && in_array($headers['response'], array(301, 302)) && isset( $headers['location'] ) ) {
1310 return wp_get_http( $headers['location'], $file_path, ++$red );
1313 if ( false == $file_path )
1316 // GET request - write it to the supplied filename
1317 $out_fp = fopen($file_path, 'w');
1321 fwrite( $out_fp, wp_remote_retrieve_body( $response ) );
1329 * Retrieve HTTP Headers from URL.
1333 * @param string $url
1334 * @param bool $deprecated Not Used.
1335 * @return bool|string False on failure, headers on success.
1337 function wp_get_http_headers( $url, $deprecated = false ) {
1338 if ( !empty( $deprecated ) )
1339 _deprecated_argument( __FUNCTION__, '2.7' );
1341 $response = wp_remote_head( $url );
1343 if ( is_wp_error( $response ) )
1346 return wp_remote_retrieve_headers( $response );
1350 * Whether today is a new day.
1354 * @uses $previousday Previous day
1356 * @return int 1 when new day, 0 if not a new day.
1358 function is_new_day() {
1359 global $currentday, $previousday;
1360 if ( $currentday != $previousday )
1367 * Build URL query based on an associative and, or indexed array.
1369 * This is a convenient function for easily building url queries. It sets the
1370 * separator to '&' and uses _http_build_query() function.
1372 * @see _http_build_query() Used to build the query
1373 * @link http://us2.php.net/manual/en/function.http-build-query.php more on what
1374 * http_build_query() does.
1378 * @param array $data URL-encode key/value pairs.
1379 * @return string URL encoded string
1381 function build_query( $data ) {
1382 return _http_build_query( $data, null, '&', '', false );
1385 // from php.net (modified by Mark Jaquith to behave like the native PHP5 function)
1386 function _http_build_query($data, $prefix=null, $sep=null, $key='', $urlencode=true) {
1389 foreach ( (array) $data as $k => $v ) {
1392 if ( is_int($k) && $prefix != null )
1395 $k = $key . '%5B' . $k . '%5D';
1398 elseif ( $v === FALSE )
1401 if ( is_array($v) || is_object($v) )
1402 array_push($ret,_http_build_query($v, '', $sep, $k, $urlencode));
1403 elseif ( $urlencode )
1404 array_push($ret, $k.'='.urlencode($v));
1406 array_push($ret, $k.'='.$v);
1409 if ( NULL === $sep )
1410 $sep = ini_get('arg_separator.output');
1412 return implode($sep, $ret);
1416 * Retrieve a modified URL query string.
1418 * You can rebuild the URL and append a new query variable to the URL query by
1419 * using this function. You can also retrieve the full URL with query data.
1421 * Adding a single key & value or an associative array. Setting a key value to
1422 * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER
1423 * value. Additional values provided are expected to be encoded appropriately
1424 * with urlencode() or rawurlencode().
1428 * @param mixed $param1 Either newkey or an associative_array
1429 * @param mixed $param2 Either newvalue or oldquery or uri
1430 * @param mixed $param3 Optional. Old query or uri
1431 * @return string New URL query string.
1433 function add_query_arg() {
1435 if ( is_array( func_get_arg(0) ) ) {
1436 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
1437 $uri = $_SERVER['REQUEST_URI'];
1439 $uri = @func_get_arg( 1 );
1441 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
1442 $uri = $_SERVER['REQUEST_URI'];
1444 $uri = @func_get_arg( 2 );
1447 if ( $frag = strstr( $uri, '#' ) )
1448 $uri = substr( $uri, 0, -strlen( $frag ) );
1452 if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
1453 $protocol = $matches[0];
1454 $uri = substr( $uri, strlen( $protocol ) );
1459 if ( strpos( $uri, '?' ) !== false ) {
1460 $parts = explode( '?', $uri, 2 );
1461 if ( 1 == count( $parts ) ) {
1465 $base = $parts[0] . '?';
1468 } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
1476 wp_parse_str( $query, $qs );
1477 $qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
1478 if ( is_array( func_get_arg( 0 ) ) ) {
1479 $kayvees = func_get_arg( 0 );
1480 $qs = array_merge( $qs, $kayvees );
1482 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
1485 foreach ( (array) $qs as $k => $v ) {
1490 $ret = build_query( $qs );
1491 $ret = trim( $ret, '?' );
1492 $ret = preg_replace( '#=(&|$)#', '$1', $ret );
1493 $ret = $protocol . $base . $ret . $frag;
1494 $ret = rtrim( $ret, '?' );
1499 * Removes an item or list from the query string.
1503 * @param string|array $key Query key or keys to remove.
1504 * @param bool $query When false uses the $_SERVER value.
1505 * @return string New URL query string.
1507 function remove_query_arg( $key, $query=false ) {
1508 if ( is_array( $key ) ) { // removing multiple keys
1509 foreach ( $key as $k )
1510 $query = add_query_arg( $k, false, $query );
1513 return add_query_arg( $key, false, $query );
1517 * Walks the array while sanitizing the contents.
1521 * @param array $array Array to used to walk while sanitizing contents.
1522 * @return array Sanitized $array.
1524 function add_magic_quotes( $array ) {
1525 foreach ( (array) $array as $k => $v ) {
1526 if ( is_array( $v ) ) {
1527 $array[$k] = add_magic_quotes( $v );
1529 $array[$k] = addslashes( $v );
1536 * HTTP request for URI to retrieve content.
1539 * @uses wp_remote_get()
1541 * @param string $uri URI/URL of web page to retrieve.
1542 * @return bool|string HTTP content. False on failure.
1544 function wp_remote_fopen( $uri ) {
1545 $parsed_url = @parse_url( $uri );
1547 if ( !$parsed_url || !is_array( $parsed_url ) )
1551 $options['timeout'] = 10;
1553 $response = wp_remote_get( $uri, $options );
1555 if ( is_wp_error( $response ) )
1558 return wp_remote_retrieve_body( $response );
1562 * Set up the WordPress query.
1566 * @param string $query_vars Default WP_Query arguments.
1568 function wp( $query_vars = '' ) {
1569 global $wp, $wp_query, $wp_the_query;
1570 $wp->main( $query_vars );
1572 if ( !isset($wp_the_query) )
1573 $wp_the_query = $wp_query;
1577 * Retrieve the description for the HTTP status.
1581 * @param int $code HTTP status code.
1582 * @return string Empty string if not found, or description if found.
1584 function get_status_header_desc( $code ) {
1585 global $wp_header_to_desc;
1587 $code = absint( $code );
1589 if ( !isset( $wp_header_to_desc ) ) {
1590 $wp_header_to_desc = array(
1592 101 => 'Switching Protocols',
1593 102 => 'Processing',
1598 203 => 'Non-Authoritative Information',
1599 204 => 'No Content',
1600 205 => 'Reset Content',
1601 206 => 'Partial Content',
1602 207 => 'Multi-Status',
1605 300 => 'Multiple Choices',
1606 301 => 'Moved Permanently',
1609 304 => 'Not Modified',
1612 307 => 'Temporary Redirect',
1614 400 => 'Bad Request',
1615 401 => 'Unauthorized',
1616 402 => 'Payment Required',
1619 405 => 'Method Not Allowed',
1620 406 => 'Not Acceptable',
1621 407 => 'Proxy Authentication Required',
1622 408 => 'Request Timeout',
1625 411 => 'Length Required',
1626 412 => 'Precondition Failed',
1627 413 => 'Request Entity Too Large',
1628 414 => 'Request-URI Too Long',
1629 415 => 'Unsupported Media Type',
1630 416 => 'Requested Range Not Satisfiable',
1631 417 => 'Expectation Failed',
1632 422 => 'Unprocessable Entity',
1634 424 => 'Failed Dependency',
1635 426 => 'Upgrade Required',
1637 500 => 'Internal Server Error',
1638 501 => 'Not Implemented',
1639 502 => 'Bad Gateway',
1640 503 => 'Service Unavailable',
1641 504 => 'Gateway Timeout',
1642 505 => 'HTTP Version Not Supported',
1643 506 => 'Variant Also Negotiates',
1644 507 => 'Insufficient Storage',
1645 510 => 'Not Extended'
1649 if ( isset( $wp_header_to_desc[$code] ) )
1650 return $wp_header_to_desc[$code];
1656 * Set HTTP status header.
1659 * @uses apply_filters() Calls 'status_header' on status header string, HTTP
1660 * HTTP code, HTTP code description, and protocol string as separate
1663 * @param int $header HTTP status code
1666 function status_header( $header ) {
1667 $text = get_status_header_desc( $header );
1669 if ( empty( $text ) )
1672 $protocol = $_SERVER["SERVER_PROTOCOL"];
1673 if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
1674 $protocol = 'HTTP/1.0';
1675 $status_header = "$protocol $header $text";
1676 if ( function_exists( 'apply_filters' ) )
1677 $status_header = apply_filters( 'status_header', $status_header, $header, $text, $protocol );
1679 return @header( $status_header, true, $header );
1683 * Gets the header information to prevent caching.
1685 * The several different headers cover the different ways cache prevention is handled
1686 * by different browsers
1690 * @uses apply_filters()
1691 * @return array The associative array of header names and field values.
1693 function wp_get_nocache_headers() {
1695 'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
1696 'Last-Modified' => gmdate( 'D, d M Y H:i:s' ) . ' GMT',
1697 'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
1698 'Pragma' => 'no-cache',
1701 if ( function_exists('apply_filters') ) {
1702 $headers = (array) apply_filters('nocache_headers', $headers);
1708 * Sets the headers to prevent caching for the different browsers.
1710 * Different browsers support different nocache headers, so several headers must
1711 * be sent so that all of them get the point that no caching should occur.
1714 * @uses wp_get_nocache_headers()
1716 function nocache_headers() {
1717 $headers = wp_get_nocache_headers();
1718 foreach( $headers as $name => $field_value )
1719 @header("{$name}: {$field_value}");
1723 * Set the headers for caching for 10 days with JavaScript content type.
1727 function cache_javascript_headers() {
1728 $expiresOffset = 864000; // 10 days
1729 header( "Content-Type: text/javascript; charset=" . get_bloginfo( 'charset' ) );
1730 header( "Vary: Accept-Encoding" ); // Handle proxies
1731 header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $expiresOffset ) . " GMT" );
1735 * Retrieve the number of database queries during the WordPress execution.
1739 * @return int Number of database queries
1741 function get_num_queries() {
1743 return $wpdb->num_queries;
1747 * Whether input is yes or no. Must be 'y' to be true.
1751 * @param string $yn Character string containing either 'y' or 'n'
1752 * @return bool True if yes, false on anything else
1754 function bool_from_yn( $yn ) {
1755 return ( strtolower( $yn ) == 'y' );
1759 * Loads the feed template from the use of an action hook.
1761 * If the feed action does not have a hook, then the function will die with a
1762 * message telling the visitor that the feed is not valid.
1764 * It is better to only have one hook for each feed.
1767 * @uses $wp_query Used to tell if the use a comment feed.
1768 * @uses do_action() Calls 'do_feed_$feed' hook, if a hook exists for the feed.
1770 function do_feed() {
1773 $feed = get_query_var( 'feed' );
1775 // Remove the pad, if present.
1776 $feed = preg_replace( '/^_+/', '', $feed );
1778 if ( $feed == '' || $feed == 'feed' )
1779 $feed = get_default_feed();
1781 $hook = 'do_feed_' . $feed;
1782 if ( !has_action($hook) ) {
1783 $message = sprintf( __( 'ERROR: %s is not a valid feed template.' ), esc_html($feed));
1784 wp_die( $message, '', array( 'response' => 404 ) );
1787 do_action( $hook, $wp_query->is_comment_feed );
1791 * Load the RDF RSS 0.91 Feed template.
1795 function do_feed_rdf() {
1796 load_template( ABSPATH . WPINC . '/feed-rdf.php' );
1800 * Load the RSS 1.0 Feed Template.
1804 function do_feed_rss() {
1805 load_template( ABSPATH . WPINC . '/feed-rss.php' );
1809 * Load either the RSS2 comment feed or the RSS2 posts feed.
1813 * @param bool $for_comments True for the comment feed, false for normal feed.
1815 function do_feed_rss2( $for_comments ) {
1816 if ( $for_comments )
1817 load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' );
1819 load_template( ABSPATH . WPINC . '/feed-rss2.php' );
1823 * Load either Atom comment feed or Atom posts feed.
1827 * @param bool $for_comments True for the comment feed, false for normal feed.
1829 function do_feed_atom( $for_comments ) {
1831 load_template( ABSPATH . WPINC . '/feed-atom-comments.php');
1833 load_template( ABSPATH . WPINC . '/feed-atom.php' );
1837 * Display the robots.txt file content.
1839 * The echo content should be with usage of the permalinks or for creating the
1843 * @uses do_action() Calls 'do_robotstxt' hook for displaying robots.txt rules.
1845 function do_robots() {
1846 header( 'Content-Type: text/plain; charset=utf-8' );
1848 do_action( 'do_robotstxt' );
1850 $output = "User-agent: *\n";
1851 $public = get_option( 'blog_public' );
1852 if ( '0' == $public ) {
1853 $output .= "Disallow: /\n";
1855 $site_url = parse_url( site_url() );
1856 $path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : '';
1857 $output .= "Disallow: $path/wp-admin/\n";
1858 $output .= "Disallow: $path/wp-includes/\n";
1861 echo apply_filters('robots_txt', $output, $public);
1865 * Test whether blog is already installed.
1867 * The cache will be checked first. If you have a cache plugin, which saves the
1868 * cache values, then this will work. If you use the default WordPress cache,
1869 * and the database goes away, then you might have problems.
1871 * Checks for the option siteurl for whether WordPress is installed.
1876 * @return bool Whether blog is already installed.
1878 function is_blog_installed() {
1881 // Check cache first. If options table goes away and we have true cached, oh well.
1882 if ( wp_cache_get( 'is_blog_installed' ) )
1885 $suppress = $wpdb->suppress_errors();
1886 if ( ! defined( 'WP_INSTALLING' ) ) {
1887 $alloptions = wp_load_alloptions();
1889 // If siteurl is not set to autoload, check it specifically
1890 if ( !isset( $alloptions['siteurl'] ) )
1891 $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
1893 $installed = $alloptions['siteurl'];
1894 $wpdb->suppress_errors( $suppress );
1896 $installed = !empty( $installed );
1897 wp_cache_set( 'is_blog_installed', $installed );
1902 // If visiting repair.php, return true and let it take over.
1903 if ( defined( 'WP_REPAIRING' ) )
1906 $suppress = $wpdb->suppress_errors();
1908 // Loop over the WP tables. If none exist, then scratch install is allowed.
1909 // If one or more exist, suggest table repair since we got here because the options
1910 // table could not be accessed.
1911 $wp_tables = $wpdb->tables();
1912 foreach ( $wp_tables as $table ) {
1913 // The existence of custom user tables shouldn't suggest an insane state or prevent a clean install.
1914 if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table )
1916 if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table )
1919 if ( ! $wpdb->get_results( "DESCRIBE $table;" ) )
1922 // One or more tables exist. We are insane.
1924 // Die with a DB error.
1925 $wpdb->error = sprintf( /*WP_I18N_NO_TABLES*/'One or more database tables are unavailable. The database may need to be <a href="%s">repaired</a>.'/*/WP_I18N_NO_TABLES*/, 'maint/repair.php?referrer=is_blog_installed' );
1929 $wpdb->suppress_errors( $suppress );
1931 wp_cache_set( 'is_blog_installed', false );
1937 * Retrieve URL with nonce added to URL query.
1939 * @package WordPress
1940 * @subpackage Security
1943 * @param string $actionurl URL to add nonce action
1944 * @param string $action Optional. Nonce action name
1945 * @return string URL with nonce action added.
1947 function wp_nonce_url( $actionurl, $action = -1 ) {
1948 $actionurl = str_replace( '&', '&', $actionurl );
1949 return esc_html( add_query_arg( '_wpnonce', wp_create_nonce( $action ), $actionurl ) );
1953 * Retrieve or display nonce hidden field for forms.
1955 * The nonce field is used to validate that the contents of the form came from
1956 * the location on the current site and not somewhere else. The nonce does not
1957 * offer absolute protection, but should protect against most cases. It is very
1958 * important to use nonce field in forms.
1960 * The $action and $name are optional, but if you want to have better security,
1961 * it is strongly suggested to set those two parameters. It is easier to just
1962 * call the function without any parameters, because validation of the nonce
1963 * doesn't require any parameters, but since crackers know what the default is
1964 * it won't be difficult for them to find a way around your nonce and cause
1967 * The input name will be whatever $name value you gave. The input value will be
1968 * the nonce creation value.
1970 * @package WordPress
1971 * @subpackage Security
1974 * @param string $action Optional. Action name.
1975 * @param string $name Optional. Nonce name.
1976 * @param bool $referer Optional, default true. Whether to set the referer field for validation.
1977 * @param bool $echo Optional, default true. Whether to display or return hidden form field.
1978 * @return string Nonce field.
1980 function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
1981 $name = esc_attr( $name );
1982 $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
1985 $nonce_field .= wp_referer_field( false );
1990 return $nonce_field;
1994 * Retrieve or display referer hidden field for forms.
1996 * The referer link is the current Request URI from the server super global. The
1997 * input name is '_wp_http_referer', in case you wanted to check manually.
1999 * @package WordPress
2000 * @subpackage Security
2003 * @param bool $echo Whether to echo or return the referer field.
2004 * @return string Referer field.
2006 function wp_referer_field( $echo = true ) {
2007 $ref = esc_attr( $_SERVER['REQUEST_URI'] );
2008 $referer_field = '<input type="hidden" name="_wp_http_referer" value="'. $ref . '" />';
2011 echo $referer_field;
2012 return $referer_field;
2016 * Retrieve or display original referer hidden field for forms.
2018 * The input name is '_wp_original_http_referer' and will be either the same
2019 * value of {@link wp_referer_field()}, if that was posted already or it will
2020 * be the current page, if it doesn't exist.
2022 * @package WordPress
2023 * @subpackage Security
2026 * @param bool $echo Whether to echo the original http referer
2027 * @param string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to.
2028 * @return string Original referer field.
2030 function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
2031 $jump_back_to = ( 'previous' == $jump_back_to ) ? wp_get_referer() : $_SERVER['REQUEST_URI'];
2032 $ref = ( wp_get_original_referer() ) ? wp_get_original_referer() : $jump_back_to;
2033 $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( stripslashes( $ref ) ) . '" />';
2035 echo $orig_referer_field;
2036 return $orig_referer_field;
2040 * Retrieve referer from '_wp_http_referer' or HTTP referer. If it's the same
2041 * as the current request URL, will return false.
2043 * @package WordPress
2044 * @subpackage Security
2047 * @return string|bool False on failure. Referer URL on success.
2049 function wp_get_referer() {
2051 if ( ! empty( $_REQUEST['_wp_http_referer'] ) )
2052 $ref = $_REQUEST['_wp_http_referer'];
2053 else if ( ! empty( $_SERVER['HTTP_REFERER'] ) )
2054 $ref = $_SERVER['HTTP_REFERER'];
2056 if ( $ref && $ref !== $_SERVER['REQUEST_URI'] )
2062 * Retrieve original referer that was posted, if it exists.
2064 * @package WordPress
2065 * @subpackage Security
2068 * @return string|bool False if no original referer or original referer if set.
2070 function wp_get_original_referer() {
2071 if ( !empty( $_REQUEST['_wp_original_http_referer'] ) )
2072 return $_REQUEST['_wp_original_http_referer'];
2077 * Recursive directory creation based on full path.
2079 * Will attempt to set permissions on folders.
2083 * @param string $target Full path to attempt to create.
2084 * @return bool Whether the path was created. True if path already exists.
2086 function wp_mkdir_p( $target ) {
2087 // from php.net/mkdir user contributed notes
2088 $target = str_replace( '//', '/', $target );
2090 // safe mode fails with a trailing slash under certain PHP versions.
2091 $target = rtrim($target, '/'); // Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
2092 if ( empty($target) )
2095 if ( file_exists( $target ) )
2096 return @is_dir( $target );
2098 // Attempting to create the directory may clutter up our display.
2099 if ( @mkdir( $target ) ) {
2100 $stat = @stat( dirname( $target ) );
2101 $dir_perms = $stat['mode'] & 0007777; // Get the permission bits.
2102 @chmod( $target, $dir_perms );
2104 } elseif ( is_dir( dirname( $target ) ) ) {
2108 // If the above failed, attempt to create the parent node, then try again.
2109 if ( ( $target != '/' ) && ( wp_mkdir_p( dirname( $target ) ) ) )
2110 return wp_mkdir_p( $target );
2116 * Test if a give filesystem path is absolute ('/foo/bar', 'c:\windows').
2120 * @param string $path File path
2121 * @return bool True if path is absolute, false is not absolute.
2123 function path_is_absolute( $path ) {
2124 // this is definitive if true but fails if $path does not exist or contains a symbolic link
2125 if ( realpath($path) == $path )
2128 if ( strlen($path) == 0 || $path[0] == '.' )
2131 // windows allows absolute paths like this
2132 if ( preg_match('#^[a-zA-Z]:\\\\#', $path) )
2135 // a path starting with / or \ is absolute; anything else is relative
2136 return ( $path[0] == '/' || $path[0] == '\\' );
2140 * Join two filesystem paths together (e.g. 'give me $path relative to $base').
2142 * If the $path is absolute, then it the full path is returned.
2146 * @param string $base
2147 * @param string $path
2148 * @return string The path with the base or absolute path.
2150 function path_join( $base, $path ) {
2151 if ( path_is_absolute($path) )
2154 return rtrim($base, '/') . '/' . ltrim($path, '/');
2158 * Determines a writable directory for temporary files.
2159 * Function's preference is to WP_CONTENT_DIR followed by the return value of <code>sys_get_temp_dir()</code>, before finally defaulting to /tmp/
2161 * In the event that this function does not find a writable location, It may be overridden by the <code>WP_TEMP_DIR</code> constant in your <code>wp-config.php</code> file.
2165 * @return string Writable temporary directory
2167 function get_temp_dir() {
2169 if ( defined('WP_TEMP_DIR') )
2170 return trailingslashit(WP_TEMP_DIR);
2173 return trailingslashit($temp);
2175 $temp = WP_CONTENT_DIR . '/';
2176 if ( is_dir($temp) && @is_writable($temp) )
2179 if ( function_exists('sys_get_temp_dir') ) {
2180 $temp = sys_get_temp_dir();
2181 if ( @is_writable($temp) )
2182 return trailingslashit($temp);
2185 $temp = ini_get('upload_tmp_dir');
2186 if ( is_dir($temp) && @is_writable($temp) )
2187 return trailingslashit($temp);
2194 * Get an array containing the current upload directory's path and url.
2196 * Checks the 'upload_path' option, which should be from the web root folder,
2197 * and if it isn't empty it will be used. If it is empty, then the path will be
2198 * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
2199 * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
2201 * The upload URL path is set either by the 'upload_url_path' option or by using
2202 * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
2204 * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
2205 * the administration settings panel), then the time will be used. The format
2206 * will be year first and then month.
2208 * If the path couldn't be created, then an error will be returned with the key
2209 * 'error' containing the error message. The error suggests that the parent
2210 * directory is not writable by the server.
2212 * On success, the returned array will have many indices:
2213 * 'path' - base directory and sub directory or full path to upload directory.
2214 * 'url' - base url and sub directory or absolute URL to upload directory.
2215 * 'subdir' - sub directory if uploads use year/month folders option is on.
2216 * 'basedir' - path without subdir.
2217 * 'baseurl' - URL path without subdir.
2218 * 'error' - set to false.
2221 * @uses apply_filters() Calls 'upload_dir' on returned array.
2223 * @param string $time Optional. Time formatted in 'yyyy/mm'.
2224 * @return array See above for description.
2226 function wp_upload_dir( $time = null ) {
2228 $siteurl = get_option( 'siteurl' );
2229 $upload_path = get_option( 'upload_path' );
2230 $upload_path = trim($upload_path);
2231 $main_override = is_multisite() && defined( 'MULTISITE' ) && is_main_site();
2232 if ( empty($upload_path) ) {
2233 $dir = WP_CONTENT_DIR . '/uploads';
2235 $dir = $upload_path;
2236 if ( 'wp-content/uploads' == $upload_path ) {
2237 $dir = WP_CONTENT_DIR . '/uploads';
2238 } elseif ( 0 !== strpos($dir, ABSPATH) ) {
2239 // $dir is absolute, $upload_path is (maybe) relative to ABSPATH
2240 $dir = path_join( ABSPATH, $dir );
2244 if ( !$url = get_option( 'upload_url_path' ) ) {
2245 if ( empty($upload_path) || ( 'wp-content/uploads' == $upload_path ) || ( $upload_path == $dir ) )
2246 $url = WP_CONTENT_URL . '/uploads';
2248 $url = trailingslashit( $siteurl ) . $upload_path;
2251 if ( defined('UPLOADS') && !$main_override && ( !isset( $switched ) || $switched === false ) ) {
2252 $dir = ABSPATH . UPLOADS;
2253 $url = trailingslashit( $siteurl ) . UPLOADS;
2256 if ( is_multisite() && !$main_override && ( !isset( $switched ) || $switched === false ) ) {
2257 if ( defined( 'BLOGUPLOADDIR' ) )
2258 $dir = untrailingslashit(BLOGUPLOADDIR);
2259 $url = str_replace( UPLOADS, 'files', $url );
2266 if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
2267 // Generate the yearly and monthly dirs
2269 $time = current_time( 'mysql' );
2270 $y = substr( $time, 0, 4 );
2271 $m = substr( $time, 5, 2 );
2278 $uploads = apply_filters( 'upload_dir', array( 'path' => $dir, 'url' => $url, 'subdir' => $subdir, 'basedir' => $bdir, 'baseurl' => $burl, 'error' => false ) );
2280 // Make sure we have an uploads dir
2281 if ( ! wp_mkdir_p( $uploads['path'] ) ) {
2282 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $uploads['path'] );
2283 return array( 'error' => $message );
2290 * Get a filename that is sanitized and unique for the given directory.
2292 * If the filename is not unique, then a number will be added to the filename
2293 * before the extension, and will continue adding numbers until the filename is
2296 * The callback is passed three parameters, the first one is the directory, the
2297 * second is the filename, and the third is the extension.
2301 * @param string $dir
2302 * @param string $filename
2303 * @param mixed $unique_filename_callback Callback.
2304 * @return string New filename, if given wasn't unique.
2306 function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
2307 // sanitize the file name before we begin processing
2308 $filename = sanitize_file_name($filename);
2310 // separate the filename into a name and extension
2311 $info = pathinfo($filename);
2312 $ext = !empty($info['extension']) ? '.' . $info['extension'] : '';
2313 $name = basename($filename, $ext);
2315 // edge case: if file is named '.ext', treat as an empty name
2316 if ( $name === $ext )
2319 // Increment the file number until we have a unique file to save in $dir. Use callback if supplied.
2320 if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
2321 $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
2325 // change '.ext' to lower case
2326 if ( $ext && strtolower($ext) != $ext ) {
2327 $ext2 = strtolower($ext);
2328 $filename2 = preg_replace( '|' . preg_quote($ext) . '$|', $ext2, $filename );
2330 // check for both lower and upper case extension or image sub-sizes may be overwritten
2331 while ( file_exists($dir . "/$filename") || file_exists($dir . "/$filename2") ) {
2332 $new_number = $number + 1;
2333 $filename = str_replace( "$number$ext", "$new_number$ext", $filename );
2334 $filename2 = str_replace( "$number$ext2", "$new_number$ext2", $filename2 );
2335 $number = $new_number;
2340 while ( file_exists( $dir . "/$filename" ) ) {
2341 if ( '' == "$number$ext" )
2342 $filename = $filename . ++$number . $ext;
2344 $filename = str_replace( "$number$ext", ++$number . $ext, $filename );
2352 * Create a file in the upload folder with given content.
2354 * If there is an error, then the key 'error' will exist with the error message.
2355 * If success, then the key 'file' will have the unique file path, the 'url' key
2356 * will have the link to the new file. and the 'error' key will be set to false.
2358 * This function will not move an uploaded file to the upload folder. It will
2359 * create a new file with the content in $bits parameter. If you move the upload
2360 * file, read the content of the uploaded file, and then you can give the
2361 * filename and content to this function, which will add it to the upload
2364 * The permissions will be set on the new file automatically by this function.
2368 * @param string $name
2369 * @param null $deprecated Never used. Set to null.
2370 * @param mixed $bits File content
2371 * @param string $time Optional. Time formatted in 'yyyy/mm'.
2374 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
2375 if ( !empty( $deprecated ) )
2376 _deprecated_argument( __FUNCTION__, '2.0' );
2378 if ( empty( $name ) )
2379 return array( 'error' => __( 'Empty filename' ) );
2381 $wp_filetype = wp_check_filetype( $name );
2382 if ( !$wp_filetype['ext'] )
2383 return array( 'error' => __( 'Invalid file type' ) );
2385 $upload = wp_upload_dir( $time );
2387 if ( $upload['error'] !== false )
2390 $upload_bits_error = apply_filters( 'wp_upload_bits', array( 'name' => $name, 'bits' => $bits, 'time' => $time ) );
2391 if ( !is_array( $upload_bits_error ) ) {
2392 $upload[ 'error' ] = $upload_bits_error;
2396 $filename = wp_unique_filename( $upload['path'], $name );
2398 $new_file = $upload['path'] . "/$filename";
2399 if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
2400 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), dirname( $new_file ) );
2401 return array( 'error' => $message );
2404 $ifp = @ fopen( $new_file, 'wb' );
2406 return array( 'error' => sprintf( __( 'Could not write file %s' ), $new_file ) );
2408 @fwrite( $ifp, $bits );
2412 // Set correct file permissions
2413 $stat = @ stat( dirname( $new_file ) );
2414 $perms = $stat['mode'] & 0007777;
2415 $perms = $perms & 0000666;
2416 @ chmod( $new_file, $perms );
2420 $url = $upload['url'] . "/$filename";
2422 return array( 'file' => $new_file, 'url' => $url, 'error' => false );
2426 * Retrieve the file type based on the extension name.
2428 * @package WordPress
2430 * @uses apply_filters() Calls 'ext2type' hook on default supported types.
2432 * @param string $ext The extension to search.
2433 * @return string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found.
2435 function wp_ext2type( $ext ) {
2436 $ext2type = apply_filters( 'ext2type', array(
2437 'audio' => array( 'aac', 'ac3', 'aif', 'aiff', 'm3a', 'm4a', 'm4b', 'mka', 'mp1', 'mp2', 'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
2438 'video' => array( 'asf', 'avi', 'divx', 'dv', 'flv', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt', 'rm', 'vob', 'wmv' ),
2439 'document' => array( 'doc', 'docx', 'docm', 'dotm', 'odt', 'pages', 'pdf', 'rtf', 'wp', 'wpd' ),
2440 'spreadsheet' => array( 'numbers', 'ods', 'xls', 'xlsx', 'xlsb', 'xlsm' ),
2441 'interactive' => array( 'key', 'ppt', 'pptx', 'pptm', 'odp', 'swf' ),
2442 'text' => array( 'asc', 'csv', 'tsv', 'txt' ),
2443 'archive' => array( 'bz2', 'cab', 'dmg', 'gz', 'rar', 'sea', 'sit', 'sqx', 'tar', 'tgz', 'zip', '7z' ),
2444 'code' => array( 'css', 'htm', 'html', 'php', 'js' ),
2446 foreach ( $ext2type as $type => $exts )
2447 if ( in_array( $ext, $exts ) )
2452 * Retrieve the file type from the file name.
2454 * You can optionally define the mime array, if needed.
2458 * @param string $filename File name or path.
2459 * @param array $mimes Optional. Key is the file extension with value as the mime type.
2460 * @return array Values with extension first and mime type.
2462 function wp_check_filetype( $filename, $mimes = null ) {
2463 if ( empty($mimes) )
2464 $mimes = get_allowed_mime_types();
2468 foreach ( $mimes as $ext_preg => $mime_match ) {
2469 $ext_preg = '!\.(' . $ext_preg . ')$!i';
2470 if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
2471 $type = $mime_match;
2472 $ext = $ext_matches[1];
2477 return compact( 'ext', 'type' );
2481 * Attempt to determine the real file type of a file.
2482 * If unable to, the file name extension will be used to determine type.
2484 * If it's determined that the extension does not match the file's real type,
2485 * then the "proper_filename" value will be set with a proper filename and extension.
2487 * Currently this function only supports validating images known to getimagesize().
2491 * @param string $file Full path to the image.
2492 * @param string $filename The filename of the image (may differ from $file due to $file being in a tmp directory)
2493 * @param array $mimes Optional. Key is the file extension with value as the mime type.
2494 * @return array Values for the extension, MIME, and either a corrected filename or false if original $filename is valid
2496 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
2498 $proper_filename = false;
2500 // Do basic extension validation and MIME mapping
2501 $wp_filetype = wp_check_filetype( $filename, $mimes );
2502 extract( $wp_filetype );
2504 // We can't do any further validation without a file to work with
2505 if ( ! file_exists( $file ) )
2506 return compact( 'ext', 'type', 'proper_filename' );
2508 // We're able to validate images using GD
2509 if ( $type && 0 === strpos( $type, 'image/' ) && function_exists('getimagesize') ) {
2511 // Attempt to figure out what type of image it actually is
2512 $imgstats = @getimagesize( $file );
2514 // If getimagesize() knows what kind of image it really is and if the real MIME doesn't match the claimed MIME
2515 if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
2516 // This is a simplified array of MIMEs that getimagesize() can detect and their extensions
2517 // You shouldn't need to use this filter, but it's here just in case
2518 $mime_to_ext = apply_filters( 'getimagesize_mimes_to_exts', array(
2519 'image/jpeg' => 'jpg',
2520 'image/png' => 'png',
2521 'image/gif' => 'gif',
2522 'image/bmp' => 'bmp',
2523 'image/tiff' => 'tif',
2526 // Replace whatever is after the last period in the filename with the correct extension
2527 if ( ! empty( $mime_to_ext[ $imgstats['mime'] ] ) ) {
2528 $filename_parts = explode( '.', $filename );
2529 array_pop( $filename_parts );
2530 $filename_parts[] = $mime_to_ext[ $imgstats['mime'] ];
2531 $new_filename = implode( '.', $filename_parts );
2533 if ( $new_filename != $filename )
2534 $proper_filename = $new_filename; // Mark that it changed
2536 // Redefine the extension / MIME
2537 $wp_filetype = wp_check_filetype( $new_filename, $mimes );
2538 extract( $wp_filetype );
2543 // Let plugins try and validate other types of files
2544 // Should return an array in the style of array( 'ext' => $ext, 'type' => $type, 'proper_filename' => $proper_filename )
2545 return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes );
2549 * Retrieve list of allowed mime types and file extensions.
2553 * @return array Array of mime types keyed by the file extension regex corresponding to those types.
2555 function get_allowed_mime_types() {
2556 static $mimes = false;
2559 // Accepted MIME types are set here as PCRE unless provided.
2560 $mimes = apply_filters( 'upload_mimes', array(
2561 'jpg|jpeg|jpe' => 'image/jpeg',
2562 'gif' => 'image/gif',
2563 'png' => 'image/png',
2564 'bmp' => 'image/bmp',
2565 'tif|tiff' => 'image/tiff',
2566 'ico' => 'image/x-icon',
2567 'asf|asx|wax|wmv|wmx' => 'video/asf',
2568 'avi' => 'video/avi',
2569 'divx' => 'video/divx',
2570 'flv' => 'video/x-flv',
2571 'mov|qt' => 'video/quicktime',
2572 'mpeg|mpg|mpe' => 'video/mpeg',
2573 'txt|asc|c|cc|h' => 'text/plain',
2574 'csv' => 'text/csv',
2575 'tsv' => 'text/tab-separated-values',
2576 'ics' => 'text/calendar',
2577 'rtx' => 'text/richtext',
2578 'css' => 'text/css',
2579 'htm|html' => 'text/html',
2580 'mp3|m4a|m4b' => 'audio/mpeg',
2581 'mp4|m4v' => 'video/mp4',
2582 'ra|ram' => 'audio/x-realaudio',
2583 'wav' => 'audio/wav',
2584 'ogg|oga' => 'audio/ogg',
2585 'ogv' => 'video/ogg',
2586 'mid|midi' => 'audio/midi',
2587 'wma' => 'audio/wma',
2588 'mka' => 'audio/x-matroska',
2589 'mkv' => 'video/x-matroska',
2590 'rtf' => 'application/rtf',
2591 'js' => 'application/javascript',
2592 'pdf' => 'application/pdf',
2593 'doc|docx' => 'application/msword',
2594 'pot|pps|ppt|pptx|ppam|pptm|sldm|ppsm|potm' => 'application/vnd.ms-powerpoint',
2595 'wri' => 'application/vnd.ms-write',
2596 'xla|xls|xlsx|xlt|xlw|xlam|xlsb|xlsm|xltm' => 'application/vnd.ms-excel',
2597 'mdb' => 'application/vnd.ms-access',
2598 'mpp' => 'application/vnd.ms-project',
2599 'docm|dotm' => 'application/vnd.ms-word',
2600 'pptx|sldx|ppsx|potx' => 'application/vnd.openxmlformats-officedocument.presentationml',
2601 'xlsx|xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml',
2602 'docx|dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml',
2603 'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
2604 'swf' => 'application/x-shockwave-flash',
2605 'class' => 'application/java',
2606 'tar' => 'application/x-tar',
2607 'zip' => 'application/zip',
2608 'gz|gzip' => 'application/x-gzip',
2609 'rar' => 'application/rar',
2610 '7z' => 'application/x-7z-compressed',
2611 'exe' => 'application/x-msdownload',
2612 // openoffice formats
2613 'odt' => 'application/vnd.oasis.opendocument.text',
2614 'odp' => 'application/vnd.oasis.opendocument.presentation',
2615 'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
2616 'odg' => 'application/vnd.oasis.opendocument.graphics',
2617 'odc' => 'application/vnd.oasis.opendocument.chart',
2618 'odb' => 'application/vnd.oasis.opendocument.database',
2619 'odf' => 'application/vnd.oasis.opendocument.formula',
2620 // wordperfect formats
2621 'wp|wpd' => 'application/wordperfect',
2629 * Retrieve nonce action "Are you sure" message.
2631 * The action is split by verb and noun. The action format is as follows:
2632 * verb-action_extra. The verb is before the first dash and has the format of
2633 * letters and no spaces and numbers. The noun is after the dash and before the
2634 * underscore, if an underscore exists. The noun is also only letters.
2636 * The filter will be called for any action, which is not defined by WordPress.
2637 * You may use the filter for your plugin to explain nonce actions to the user,
2638 * when they get the "Are you sure?" message. The filter is in the format of
2639 * 'explain_nonce_$verb-$noun' with the $verb replaced by the found verb and the
2640 * $noun replaced by the found noun. The two parameters that are given to the
2641 * hook are the localized "Are you sure you want to do this?" message with the
2642 * extra text (the text after the underscore).
2644 * @package WordPress
2645 * @subpackage Security
2648 * @param string $action Nonce action.
2649 * @return string Are you sure message.
2651 function wp_explain_nonce( $action ) {
2652 if ( $action !== -1 && preg_match( '/([a-z]+)-([a-z]+)(_(.+))?/', $action, $matches ) ) {
2653 $verb = $matches[1];
2654 $noun = $matches[2];
2657 $trans['update']['attachment'] = array( __( 'Your attempt to edit this attachment: “%s” has failed.' ), 'get_the_title' );
2659 $trans['add']['category'] = array( __( 'Your attempt to add this category has failed.' ), false );
2660 $trans['delete']['category'] = array( __( 'Your attempt to delete this category: “%s” has failed.' ), 'get_cat_name' );
2661 $trans['update']['category'] = array( __( 'Your attempt to edit this category: “%s” has failed.' ), 'get_cat_name' );
2663 $trans['delete']['comment'] = array( __( 'Your attempt to delete this comment: “%s” has failed.' ), 'use_id' );
2664 $trans['unapprove']['comment'] = array( __( 'Your attempt to unapprove this comment: “%s” has failed.' ), 'use_id' );
2665 $trans['approve']['comment'] = array( __( 'Your attempt to approve this comment: “%s” has failed.' ), 'use_id' );
2666 $trans['update']['comment'] = array( __( 'Your attempt to edit this comment: “%s” has failed.' ), 'use_id' );
2667 $trans['bulk']['comments'] = array( __( 'Your attempt to bulk modify comments has failed.' ), false );
2668 $trans['moderate']['comments'] = array( __( 'Your attempt to moderate comments has failed.' ), false );
2670 $trans['add']['bookmark'] = array( __( 'Your attempt to add this link has failed.' ), false );
2671 $trans['delete']['bookmark'] = array( __( 'Your attempt to delete this link: “%s” has failed.' ), 'use_id' );
2672 $trans['update']['bookmark'] = array( __( 'Your attempt to edit this link: “%s” has failed.' ), 'use_id' );
2673 $trans['bulk']['bookmarks'] = array( __( 'Your attempt to bulk modify links has failed.' ), false );
2675 $trans['add']['page'] = array( __( 'Your attempt to add this page has failed.' ), false );
2676 $trans['delete']['page'] = array( __( 'Your attempt to delete this page: “%s” has failed.' ), 'get_the_title' );
2677 $trans['update']['page'] = array( __( 'Your attempt to edit this page: “%s” has failed.' ), 'get_the_title' );
2679 $trans['edit']['plugin'] = array( __( 'Your attempt to edit this plugin file: “%s” has failed.' ), 'use_id' );
2680 $trans['activate']['plugin'] = array( __( 'Your attempt to activate this plugin: “%s” has failed.' ), 'use_id' );
2681 $trans['deactivate']['plugin'] = array( __( 'Your attempt to deactivate this plugin: “%s” has failed.' ), 'use_id' );
2682 $trans['upgrade']['plugin'] = array( __( 'Your attempt to update this plugin: “%s” has failed.' ), 'use_id' );
2684 $trans['add']['post'] = array( __( 'Your attempt to add this post has failed.' ), false );
2685 $trans['delete']['post'] = array( __( 'Your attempt to delete this post: “%s” has failed.' ), 'get_the_title' );
2686 $trans['update']['post'] = array( __( 'Your attempt to edit this post: “%s” has failed.' ), 'get_the_title' );
2688 $trans['add']['user'] = array( __( 'Your attempt to add this user has failed.' ), false );
2689 $trans['delete']['users'] = array( __( 'Your attempt to delete users has failed.' ), false );
2690 $trans['bulk']['users'] = array( __( 'Your attempt to bulk modify users has failed.' ), false );
2691 $trans['update']['user'] = array( __( 'Your attempt to edit this user: “%s” has failed.' ), 'get_the_author_meta', 'display_name' );
2692 $trans['update']['profile'] = array( __( 'Your attempt to modify the profile for: “%s” has failed.' ), 'get_the_author_meta', 'display_name' );
2694 $trans['update']['options'] = array( __( 'Your attempt to edit your settings has failed.' ), false );
2695 $trans['update']['permalink'] = array( __( 'Your attempt to change your permalink structure to: %s has failed.' ), 'use_id' );
2696 $trans['edit']['file'] = array( __( 'Your attempt to edit this file: “%s” has failed.' ), 'use_id' );
2697 $trans['edit']['theme'] = array( __( 'Your attempt to edit this theme file: “%s” has failed.' ), 'use_id' );
2698 $trans['switch']['theme'] = array( __( 'Your attempt to switch to this theme: “%s” has failed.' ), 'use_id' );
2700 $trans['log']['out'] = array( sprintf( __( 'You are attempting to log out of %s' ), get_bloginfo( 'sitename' ) ), false );
2702 if ( isset( $trans[$verb][$noun] ) ) {
2703 if ( !empty( $trans[$verb][$noun][1] ) ) {
2704 $lookup = $trans[$verb][$noun][1];
2705 if ( isset($trans[$verb][$noun][2]) )
2706 $lookup_value = $trans[$verb][$noun][2];
2707 $object = $matches[4];
2708 if ( 'use_id' != $lookup ) {
2709 if ( isset( $lookup_value ) )
2710 $object = call_user_func( $lookup, $lookup_value, $object );
2712 $object = call_user_func( $lookup, $object );
2714 return sprintf( $trans[$verb][$noun][0], esc_html($object) );
2716 return $trans[$verb][$noun][0];
2720 return apply_filters( 'explain_nonce_' . $verb . '-' . $noun, __( 'Are you sure you want to do this?' ), isset($matches[4]) ? $matches[4] : '' );
2722 return apply_filters( 'explain_nonce_' . $action, __( 'Are you sure you want to do this?' ) );
2727 * Display "Are You Sure" message to confirm the action being taken.
2729 * If the action has the nonce explain message, then it will be displayed along
2730 * with the "Are you sure?" message.
2732 * @package WordPress
2733 * @subpackage Security
2736 * @param string $action The nonce action.
2738 function wp_nonce_ays( $action ) {
2739 $title = __( 'WordPress Failure Notice' );
2740 $html = esc_html( wp_explain_nonce( $action ) );
2741 if ( 'log-out' == $action )
2742 $html .= "</p><p>" . sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url() );
2743 elseif ( wp_get_referer() )
2744 $html .= "</p><p><a href='" . esc_url( remove_query_arg( 'updated', wp_get_referer() ) ) . "'>" . __( 'Please try again.' ) . "</a>";
2746 wp_die( $html, $title, array('response' => 403) );
2751 * Kill WordPress execution and display HTML message with error message.
2753 * This function complements the die() PHP function. The difference is that
2754 * HTML will be displayed to the user. It is recommended to use this function
2755 * only, when the execution should not continue any further. It is not
2756 * recommended to call this function very often and try to handle as many errors
2757 * as possible silently.
2761 * @param string $message Error message.
2762 * @param string $title Error title.
2763 * @param string|array $args Optional arguments to control behavior.
2765 function wp_die( $message, $title = '', $args = array() ) {
2766 if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
2769 if ( function_exists( 'apply_filters' ) ) {
2770 $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler');
2772 $function = '_default_wp_die_handler';
2775 call_user_func( $function, $message, $title, $args );
2779 * Kill WordPress execution and display HTML message with error message.
2781 * This is the default handler for wp_die if you want a custom one for your
2782 * site then you can overload using the wp_die_handler filter in wp_die
2787 * @param string $message Error message.
2788 * @param string $title Error title.
2789 * @param string|array $args Optional arguments to control behavior.
2791 function _default_wp_die_handler( $message, $title = '', $args = array() ) {
2792 $defaults = array( 'response' => 500 );
2793 $r = wp_parse_args($args, $defaults);
2795 $have_gettext = function_exists('__');
2797 if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
2798 if ( empty( $title ) ) {
2799 $error_data = $message->get_error_data();
2800 if ( is_array( $error_data ) && isset( $error_data['title'] ) )
2801 $title = $error_data['title'];
2803 $errors = $message->get_error_messages();
2804 switch ( count( $errors ) ) :
2809 $message = "<p>{$errors[0]}</p>";
2812 $message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
2815 } elseif ( is_string( $message ) ) {
2816 $message = "<p>$message</p>";
2819 if ( isset( $r['back_link'] ) && $r['back_link'] ) {
2820 $back_text = $have_gettext? __('« Back') : '« Back';
2821 $message .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";
2824 if ( !function_exists( 'did_action' ) || !did_action( 'admin_head' ) ) :
2825 if ( !headers_sent() ) {
2826 status_header( $r['response'] );
2828 header( 'Content-Type: text/html; charset=utf-8' );
2831 if ( empty($title) )
2832 $title = $have_gettext ? __('WordPress › Error') : 'WordPress › Error';
2834 $text_direction = 'ltr';
2835 if ( isset($r['text_direction']) && 'rtl' == $r['text_direction'] )
2836 $text_direction = 'rtl';
2837 elseif ( function_exists( 'is_rtl' ) && is_rtl() )
2838 $text_direction = 'rtl';
2841 <!-- Ticket #11289, IE bug fix: always pad the error page with enough characters such that it is greater than 512 bytes, even after gzip compression abcdefghijklmnopqrstuvwxyz1234567890aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz11223344556677889900abacbcbdcdcededfefegfgfhghgihihjijikjkjlklkmlmlnmnmononpopoqpqprqrqsrsrtstsubcbcdcdedefefgfabcadefbghicjkldmnoepqrfstugvwxhyz1i234j567k890laabmbccnddeoeffpgghqhiirjjksklltmmnunoovppqwqrrxsstytuuzvvw0wxx1yyz2z113223434455666777889890091abc2def3ghi4jkl5mno6pqr7stu8vwx9yz11aab2bcc3dd4ee5ff6gg7hh8ii9j0jk1kl2lmm3nnoo4p5pq6qrr7ss8tt9uuvv0wwx1x2yyzz13aba4cbcb5dcdc6dedfef8egf9gfh0ghg1ihi2hji3jik4jkj5lkl6kml7mln8mnm9ono
2843 <html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists( 'language_attributes' ) && function_exists( 'is_rtl' ) ) language_attributes(); else echo "dir='$text_direction'"; ?>>
2845 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2846 <title><?php echo $title ?></title>
2847 <style type="text/css">
2849 background: #f9f9f9;
2854 font-family: sans-serif;
2857 -webkit-border-radius: 3px;
2859 border: 1px solid #dfdfdf;
2868 margin: 25px 0 20px;
2871 font-family: Consolas, Monaco, monospace;
2874 margin-bottom: 10px;
2879 text-decoration: none;
2886 font-family: sans-serif;
2887 text-decoration: none;
2888 font-size: 14px !important;
2892 border: 1px solid #bbb;
2894 -webkit-border-radius: 15px;
2895 border-radius: 15px;
2896 -moz-box-sizing: content-box;
2897 -webkit-box-sizing: content-box;
2898 box-sizing: content-box;
2899 background-color: #f5f5f5;
2900 background-image: -ms-linear-gradient(top, #ffffff, #f2f2f2);
2901 background-image: -moz-linear-gradient(top, #ffffff, #f2f2f2);
2902 background-image: -o-linear-gradient(top, #ffffff, #f2f2f2);
2903 background-image: -webkit-gradient(linear, left top, left bottom, from(#ffffff), to(#f2f2f2));
2904 background-image: -webkit-linear-gradient(top, #ffffff, #f2f2f2);
2905 background-image: linear-gradient(top, #ffffff, #f2f2f2);
2914 background-image: -ms-linear-gradient(top, #f2f2f2, #ffffff);
2915 background-image: -moz-linear-gradient(top, #f2f2f2, #ffffff);
2916 background-image: -o-linear-gradient(top, #f2f2f2, #ffffff);
2917 background-image: -webkit-gradient(linear, left top, left bottom, from(#f2f2f2), to(#ffffff));
2918 background-image: -webkit-linear-gradient(top, #f2f2f2, #ffffff);
2919 background-image: linear-gradient(top, #f2f2f2, #ffffff);
2922 <?php if ( 'rtl' == $text_direction ) : ?>
2923 body { font-family: Tahoma, Arial; }
2927 <body id="error-page">
2928 <?php endif; // !function_exists( 'did_action' ) || !did_action( 'admin_head' ) ?>
2929 <?php echo $message; ?>
2937 * Kill WordPress execution and display XML message with error message.
2939 * This is the handler for wp_die when processing XMLRPC requests.
2944 * @param string $message Error message.
2945 * @param string $title Error title.
2946 * @param string|array $args Optional arguments to control behavior.
2948 function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
2949 global $wp_xmlrpc_server;
2950 $defaults = array( 'response' => 500 );
2952 $r = wp_parse_args($args, $defaults);
2954 if ( $wp_xmlrpc_server ) {
2955 $error = new IXR_Error( $r['response'] , $message);
2956 $wp_xmlrpc_server->output( $error->getXml() );
2962 * Filter to enable special wp_die handler for xmlrpc requests.
2967 function _xmlrpc_wp_die_filter() {
2968 return '_xmlrpc_wp_die_handler';
2973 * Retrieve the WordPress home page URL.
2975 * If the constant named 'WP_HOME' exists, then it will be used and returned by
2976 * the function. This can be used to counter the redirection on your local
2977 * development environment.
2980 * @package WordPress
2983 * @param string $url URL for the home location
2984 * @return string Homepage location.
2986 function _config_wp_home( $url = '' ) {
2987 if ( defined( 'WP_HOME' ) )
2988 return untrailingslashit( WP_HOME );
2993 * Retrieve the WordPress site URL.
2995 * If the constant named 'WP_SITEURL' is defined, then the value in that
2996 * constant will always be returned. This can be used for debugging a site on
2997 * your localhost while not having to change the database to your URL.
3000 * @package WordPress
3003 * @param string $url URL to set the WordPress site location.
3004 * @return string The WordPress Site URL
3006 function _config_wp_siteurl( $url = '' ) {
3007 if ( defined( 'WP_SITEURL' ) )
3008 return untrailingslashit( WP_SITEURL );
3013 * Set the localized direction for MCE plugin.
3015 * Will only set the direction to 'rtl', if the WordPress locale has the text
3016 * direction set to 'rtl'.
3018 * Fills in the 'directionality', 'plugins', and 'theme_advanced_button1' array
3019 * keys. These keys are then returned in the $input array.
3022 * @package WordPress
3026 * @param array $input MCE plugin array.
3027 * @return array Direction set for 'rtl', if needed by locale.
3029 function _mce_set_direction( $input ) {
3031 $input['directionality'] = 'rtl';
3032 $input['plugins'] .= ',directionality';
3033 $input['theme_advanced_buttons1'] .= ',ltr';
3041 * Convert smiley code to the icon graphic file equivalent.
3043 * You can turn off smilies, by going to the write setting screen and unchecking
3044 * the box, or by setting 'use_smilies' option to false or removing the option.
3046 * Plugins may override the default smiley list by setting the $wpsmiliestrans
3047 * to an array, with the key the code the blogger types in and the value the
3050 * The $wp_smiliessearch global is for the regular expression and is set each
3051 * time the function is called.
3053 * The full list of smilies can be found in the function and won't be listed in
3054 * the description. Probably should create a Codex page for it, so that it is
3057 * @global array $wpsmiliestrans
3058 * @global array $wp_smiliessearch
3061 function smilies_init() {
3062 global $wpsmiliestrans, $wp_smiliessearch;
3064 // don't bother setting up smilies if they are disabled
3065 if ( !get_option( 'use_smilies' ) )
3068 if ( !isset( $wpsmiliestrans ) ) {
3069 $wpsmiliestrans = array(
3070 ':mrgreen:' => 'icon_mrgreen.gif',
3071 ':neutral:' => 'icon_neutral.gif',
3072 ':twisted:' => 'icon_twisted.gif',
3073 ':arrow:' => 'icon_arrow.gif',
3074 ':shock:' => 'icon_eek.gif',
3075 ':smile:' => 'icon_smile.gif',
3076 ':???:' => 'icon_confused.gif',
3077 ':cool:' => 'icon_cool.gif',
3078 ':evil:' => 'icon_evil.gif',
3079 ':grin:' => 'icon_biggrin.gif',
3080 ':idea:' => 'icon_idea.gif',
3081 ':oops:' => 'icon_redface.gif',
3082 ':razz:' => 'icon_razz.gif',
3083 ':roll:' => 'icon_rolleyes.gif',
3084 ':wink:' => 'icon_wink.gif',
3085 ':cry:' => 'icon_cry.gif',
3086 ':eek:' => 'icon_surprised.gif',
3087 ':lol:' => 'icon_lol.gif',
3088 ':mad:' => 'icon_mad.gif',
3089 ':sad:' => 'icon_sad.gif',
3090 '8-)' => 'icon_cool.gif',
3091 '8-O' => 'icon_eek.gif',
3092 ':-(' => 'icon_sad.gif',
3093 ':-)' => 'icon_smile.gif',
3094 ':-?' => 'icon_confused.gif',
3095 ':-D' => 'icon_biggrin.gif',
3096 ':-P' => 'icon_razz.gif',
3097 ':-o' => 'icon_surprised.gif',
3098 ':-x' => 'icon_mad.gif',
3099 ':-|' => 'icon_neutral.gif',
3100 ';-)' => 'icon_wink.gif',
3101 '8)' => 'icon_cool.gif',
3102 '8O' => 'icon_eek.gif',
3103 ':(' => 'icon_sad.gif',
3104 ':)' => 'icon_smile.gif',
3105 ':?' => 'icon_confused.gif',
3106 ':D' => 'icon_biggrin.gif',
3107 ':P' => 'icon_razz.gif',
3108 ':o' => 'icon_surprised.gif',
3109 ':x' => 'icon_mad.gif',
3110 ':|' => 'icon_neutral.gif',
3111 ';)' => 'icon_wink.gif',
3112 ':!:' => 'icon_exclaim.gif',
3113 ':?:' => 'icon_question.gif',
3117 if (count($wpsmiliestrans) == 0) {
3122 * NOTE: we sort the smilies in reverse key order. This is to make sure
3123 * we match the longest possible smilie (:???: vs :?) as the regular
3124 * expression used below is first-match
3126 krsort($wpsmiliestrans);
3128 $wp_smiliessearch = '/(?:\s|^)';
3131 foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
3132 $firstchar = substr($smiley, 0, 1);
3133 $rest = substr($smiley, 1);
3136 if ($firstchar != $subchar) {
3137 if ($subchar != '') {
3138 $wp_smiliessearch .= ')|(?:\s|^)';
3140 $subchar = $firstchar;
3141 $wp_smiliessearch .= preg_quote($firstchar, '/') . '(?:';
3143 $wp_smiliessearch .= '|';
3145 $wp_smiliessearch .= preg_quote($rest, '/');
3148 $wp_smiliessearch .= ')(?:\s|$)/m';
3152 * Merge user defined arguments into defaults array.
3154 * This function is used throughout WordPress to allow for both string or array
3155 * to be merged into another array.
3159 * @param string|array $args Value to merge with $defaults
3160 * @param array $defaults Array that serves as the defaults.
3161 * @return array Merged user defined values with defaults.
3163 function wp_parse_args( $args, $defaults = '' ) {
3164 if ( is_object( $args ) )
3165 $r = get_object_vars( $args );
3166 elseif ( is_array( $args ) )
3169 wp_parse_str( $args, $r );
3171 if ( is_array( $defaults ) )
3172 return array_merge( $defaults, $r );
3177 * Clean up an array, comma- or space-separated list of IDs.
3181 * @param array|string $list
3182 * @return array Sanitized array of IDs
3184 function wp_parse_id_list( $list ) {
3185 if ( !is_array($list) )
3186 $list = preg_split('/[\s,]+/', $list);
3188 return array_unique(array_map('absint', $list));
3192 * Extract a slice of an array, given a list of keys.
3196 * @param array $array The original array
3197 * @param array $keys The list of keys
3198 * @return array The array slice
3200 function wp_array_slice_assoc( $array, $keys ) {
3202 foreach ( $keys as $key )
3203 if ( isset( $array[ $key ] ) )
3204 $slice[ $key ] = $array[ $key ];
3210 * Filters a list of objects, based on a set of key => value arguments.
3214 * @param array $list An array of objects to filter
3215 * @param array $args An array of key => value arguments to match against each object
3216 * @param string $operator The logical operation to perform. 'or' means only one element
3217 * from the array needs to match; 'and' means all elements must match. The default is 'and'.
3218 * @param bool|string $field A field from the object to place instead of the entire object
3219 * @return array A list of objects or object fields
3221 function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
3222 if ( ! is_array( $list ) )
3225 $list = wp_list_filter( $list, $args, $operator );
3228 $list = wp_list_pluck( $list, $field );
3234 * Filters a list of objects, based on a set of key => value arguments.
3238 * @param array $list An array of objects to filter
3239 * @param array $args An array of key => value arguments to match against each object
3240 * @param string $operator The logical operation to perform:
3241 * 'AND' means all elements from the array must match;
3242 * 'OR' means only one element needs to match;
3243 * 'NOT' means no elements may match.
3244 * The default is 'AND'.
3247 function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
3248 if ( ! is_array( $list ) )
3251 if ( empty( $args ) )
3254 $operator = strtoupper( $operator );
3255 $count = count( $args );
3256 $filtered = array();
3258 foreach ( $list as $key => $obj ) {
3259 $to_match = (array) $obj;
3262 foreach ( $args as $m_key => $m_value ) {
3263 if ( $m_value == $to_match[ $m_key ] )
3267 if ( ( 'AND' == $operator && $matched == $count )
3268 || ( 'OR' == $operator && $matched > 0 )
3269 || ( 'NOT' == $operator && 0 == $matched ) ) {
3270 $filtered[$key] = $obj;
3278 * Pluck a certain field out of each object in a list.
3282 * @param array $list A list of objects or arrays
3283 * @param int|string $field A field from the object to place instead of the entire object
3286 function wp_list_pluck( $list, $field ) {
3287 foreach ( $list as $key => $value ) {
3288 if ( is_object( $value ) )
3289 $list[ $key ] = $value->$field;
3291 $list[ $key ] = $value[ $field ];
3298 * Determines if Widgets library should be loaded.
3300 * Checks to make sure that the widgets library hasn't already been loaded. If
3301 * it hasn't, then it will load the widgets library and run an action hook.
3304 * @uses add_action() Calls '_admin_menu' hook with 'wp_widgets_add_menu' value.
3306 function wp_maybe_load_widgets() {
3307 if ( ! apply_filters('load_default_widgets', true) )
3309 require_once( ABSPATH . WPINC . '/default-widgets.php' );
3310 add_action( '_admin_menu', 'wp_widgets_add_menu' );
3314 * Append the Widgets menu to the themes main menu.
3317 * @uses $submenu The administration submenu list.
3319 function wp_widgets_add_menu() {
3321 $submenu['themes.php'][7] = array( __( 'Widgets' ), 'edit_theme_options', 'widgets.php' );
3322 ksort( $submenu['themes.php'], SORT_NUMERIC );
3326 * Flush all output buffers for PHP 5.2.
3328 * Make sure all output buffers are flushed before our singletons our destroyed.
3332 function wp_ob_end_flush_all() {
3333 $levels = ob_get_level();
3334 for ($i=0; $i<$levels; $i++)
3339 * Load custom DB error or display WordPress DB error.
3341 * If a file exists in the wp-content directory named db-error.php, then it will
3342 * be loaded instead of displaying the WordPress DB error. If it is not found,
3343 * then the WordPress DB error will be displayed instead.
3345 * The WordPress DB error sets the HTTP status header to 500 to try to prevent
3346 * search engines from caching the message. Custom DB messages should do the
3349 * This function was backported to the the WordPress 2.3.2, but originally was
3350 * added in WordPress 2.5.0.
3355 function dead_db() {
3358 // Load custom DB error template, if present.
3359 if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
3360 require_once( WP_CONTENT_DIR . '/db-error.php' );
3364 // If installing or in the admin, provide the verbose message.
3365 if ( defined('WP_INSTALLING') || defined('WP_ADMIN') )
3366 wp_die($wpdb->error);
3368 // Otherwise, be terse.
3369 status_header( 500 );
3371 header( 'Content-Type: text/html; charset=utf-8' );
3374 <html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists( 'language_attributes' ) ) language_attributes(); ?>>
3376 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
3377 <title><?php echo /*WP_I18N_DB_ERROR*/'Database Error'/*/WP_I18N_DB_ERROR*/; ?></title>
3381 <h1><?php echo /*WP_I18N_DB_CONNECTION_ERROR*/'Error establishing a database connection'/*/WP_I18N_DB_CONNECTION_ERROR*/; ?></h1>
3389 * Converts value to nonnegative integer.
3393 * @param mixed $maybeint Data you wish to have converted to a nonnegative integer
3394 * @return int An nonnegative integer
3396 function absint( $maybeint ) {
3397 return abs( intval( $maybeint ) );
3401 * Determines if the blog can be accessed over SSL.
3403 * Determines if blog can be accessed over SSL by using cURL to access the site
3404 * using the https in the siteurl. Requires cURL extension to work correctly.
3408 * @param string $url
3409 * @return bool Whether SSL access is available
3411 function url_is_accessable_via_ssl($url)
3413 if (in_array('curl', get_loaded_extensions())) {
3414 $ssl = preg_replace( '/^http:\/\//', 'https://', $url );
3417 curl_setopt($ch, CURLOPT_URL, $ssl);
3418 curl_setopt($ch, CURLOPT_FAILONERROR, true);
3419 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
3420 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
3421 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
3425 $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
3428 if ($status == 200 || $status == 401) {
3436 * Marks a function as deprecated and informs when it has been used.
3438 * There is a hook deprecated_function_run that will be called that can be used
3439 * to get the backtrace up to what file and function called the deprecated
3442 * The current behavior is to trigger a user error if WP_DEBUG is true.
3444 * This function is to be used in every function that is deprecated.
3446 * @package WordPress
3451 * @uses do_action() Calls 'deprecated_function_run' and passes the function name, what to use instead,
3452 * and the version the function was deprecated in.
3453 * @uses apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
3454 * trigger or false to not trigger error.
3456 * @param string $function The function that was called
3457 * @param string $version The version of WordPress that deprecated the function
3458 * @param string $replacement Optional. The function that should have been called
3460 function _deprecated_function( $function, $version, $replacement = null ) {
3462 do_action( 'deprecated_function_run', $function, $replacement, $version );
3464 // Allow plugin to filter the output error trigger
3465 if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
3466 if ( ! is_null($replacement) )
3467 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
3469 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
3474 * Marks a file as deprecated and informs when it has been used.
3476 * There is a hook deprecated_file_included that will be called that can be used
3477 * to get the backtrace up to what file and function included the deprecated
3480 * The current behavior is to trigger a user error if WP_DEBUG is true.
3482 * This function is to be used in every file that is deprecated.
3484 * @package WordPress
3489 * @uses do_action() Calls 'deprecated_file_included' and passes the file name, what to use instead,
3490 * the version in which the file was deprecated, and any message regarding the change.
3491 * @uses apply_filters() Calls 'deprecated_file_trigger_error' and expects boolean value of true to do
3492 * trigger or false to not trigger error.
3494 * @param string $file The file that was included
3495 * @param string $version The version of WordPress that deprecated the file
3496 * @param string $replacement Optional. The file that should have been included based on ABSPATH
3497 * @param string $message Optional. A message regarding the change
3499 function _deprecated_file( $file, $version, $replacement = null, $message = '' ) {
3501 do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
3503 // Allow plugin to filter the output error trigger
3504 if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
3505 $message = empty( $message ) ? '' : ' ' . $message;
3506 if ( ! is_null( $replacement ) )
3507 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) . $message );
3509 trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) . $message );
3513 * Marks a function argument as deprecated and informs when it has been used.
3515 * This function is to be used whenever a deprecated function argument is used.
3516 * Before this function is called, the argument must be checked for whether it was
3517 * used by comparing it to its default value or evaluating whether it is empty.
3520 * if ( !empty($deprecated) )
3521 * _deprecated_argument( __FUNCTION__, '3.0' );
3524 * There is a hook deprecated_argument_run that will be called that can be used
3525 * to get the backtrace up to what file and function used the deprecated
3528 * The current behavior is to trigger a user error if WP_DEBUG is true.
3530 * @package WordPress
3535 * @uses do_action() Calls 'deprecated_argument_run' and passes the function name, a message on the change,
3536 * and the version in which the argument was deprecated.
3537 * @uses apply_filters() Calls 'deprecated_argument_trigger_error' and expects boolean value of true to do
3538 * trigger or false to not trigger error.
3540 * @param string $function The function that was called
3541 * @param string $version The version of WordPress that deprecated the argument used
3542 * @param string $message Optional. A message regarding the change.
3544 function _deprecated_argument( $function, $version, $message = null ) {
3546 do_action( 'deprecated_argument_run', $function, $message, $version );
3548 // Allow plugin to filter the output error trigger
3549 if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
3550 if ( ! is_null( $message ) )
3551 trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s'), $function, $version, $message ) );
3553 trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
3558 * Marks something as being incorrectly called.
3560 * There is a hook doing_it_wrong_run that will be called that can be used
3561 * to get the backtrace up to what file and function called the deprecated
3564 * The current behavior is to trigger a user error if WP_DEBUG is true.
3566 * @package WordPress
3571 * @uses do_action() Calls 'doing_it_wrong_run' and passes the function arguments.
3572 * @uses apply_filters() Calls 'doing_it_wrong_trigger_error' and expects boolean value of true to do
3573 * trigger or false to not trigger error.
3575 * @param string $function The function that was called.
3576 * @param string $message A message explaining what has been done incorrectly.
3577 * @param string $version The version of WordPress where the message was added.
3579 function _doing_it_wrong( $function, $message, $version ) {
3581 do_action( 'doing_it_wrong_run', $function, $message, $version );
3583 // Allow plugin to filter the output error trigger
3584 if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true ) ) {
3585 $version = is_null( $version ) ? '' : sprintf( __( '(This message was added in version %s.)' ), $version );
3586 $message .= ' ' . __( 'Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.' );
3587 trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) );
3592 * Is the server running earlier than 1.5.0 version of lighttpd?
3596 * @return bool Whether the server is running lighttpd < 1.5.0
3598 function is_lighttpd_before_150() {
3599 $server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] )? $_SERVER['SERVER_SOFTWARE'] : '' );
3600 $server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : '';
3601 return 'lighttpd' == $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' );
3605 * Does the specified module exist in the Apache config?
3609 * @param string $mod e.g. mod_rewrite
3610 * @param bool $default The default return value if the module is not found
3613 function apache_mod_loaded($mod, $default = false) {
3619 if ( function_exists('apache_get_modules') ) {
3620 $mods = apache_get_modules();
3621 if ( in_array($mod, $mods) )
3623 } elseif ( function_exists('phpinfo') ) {
3626 $phpinfo = ob_get_clean();
3627 if ( false !== strpos($phpinfo, $mod) )
3634 * Check if IIS 7 supports pretty permalinks.
3640 function iis7_supports_permalinks() {
3643 $supports_permalinks = false;
3645 /* First we check if the DOMDocument class exists. If it does not exist,
3646 * which is the case for PHP 4.X, then we cannot easily update the xml configuration file,
3647 * hence we just bail out and tell user that pretty permalinks cannot be used.
3648 * This is not a big issue because PHP 4.X is going to be deprecated and for IIS it
3649 * is recommended to use PHP 5.X NTS.
3650 * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
3651 * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
3652 * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
3653 * via ISAPI then pretty permalinks will not work.
3655 $supports_permalinks = class_exists('DOMDocument') && isset($_SERVER['IIS_UrlRewriteModule']) && ( php_sapi_name() == 'cgi-fcgi' );
3658 return apply_filters('iis7_supports_permalinks', $supports_permalinks);
3662 * File validates against allowed set of defined rules.
3664 * A return value of '1' means that the $file contains either '..' or './'. A
3665 * return value of '2' means that the $file contains ':' after the first
3666 * character. A return value of '3' means that the file is not in the allowed
3671 * @param string $file File path.
3672 * @param array $allowed_files List of allowed files.
3673 * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
3675 function validate_file( $file, $allowed_files = '' ) {
3676 if ( false !== strpos( $file, '..' ) )
3679 if ( false !== strpos( $file, './' ) )
3682 if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files ) )
3685 if (':' == substr( $file, 1, 1 ) )
3692 * Determine if SSL is used.
3696 * @return bool True if SSL, false if not used.
3699 if ( isset($_SERVER['HTTPS']) ) {
3700 if ( 'on' == strtolower($_SERVER['HTTPS']) )
3702 if ( '1' == $_SERVER['HTTPS'] )
3704 } elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
3711 * Whether SSL login should be forced.
3715 * @param string|bool $force Optional.
3716 * @return bool True if forced, false if not forced.
3718 function force_ssl_login( $force = null ) {
3719 static $forced = false;
3721 if ( !is_null( $force ) ) {
3722 $old_forced = $forced;
3731 * Whether to force SSL used for the Administration Screens.
3735 * @param string|bool $force
3736 * @return bool True if forced, false if not forced.
3738 function force_ssl_admin( $force = null ) {
3739 static $forced = false;
3741 if ( !is_null( $force ) ) {
3742 $old_forced = $forced;
3751 * Guess the URL for the site.
3753 * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
3760 function wp_guess_url() {
3761 if ( defined('WP_SITEURL') && '' != WP_SITEURL ) {
3764 $schema = is_ssl() ? 'https://' : 'http://';
3765 $url = preg_replace('|/wp-admin/.*|i', '', $schema . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
3767 return rtrim($url, '/');
3771 * Temporarily suspend cache additions.
3773 * Stops more data being added to the cache, but still allows cache retrieval.
3774 * This is useful for actions, such as imports, when a lot of data would otherwise
3775 * be almost uselessly added to the cache.
3777 * Suspension lasts for a single page load at most. Remember to call this
3778 * function again if you wish to re-enable cache adds earlier.
3782 * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
3783 * @return bool The current suspend setting
3785 function wp_suspend_cache_addition( $suspend = null ) {
3786 static $_suspend = false;
3788 if ( is_bool( $suspend ) )
3789 $_suspend = $suspend;
3795 * Suspend cache invalidation.
3797 * Turns cache invalidation on and off. Useful during imports where you don't wont to do invalidations
3798 * every time a post is inserted. Callers must be sure that what they are doing won't lead to an inconsistent
3799 * cache when invalidation is suspended.
3803 * @param bool $suspend Whether to suspend or enable cache invalidation
3804 * @return bool The current suspend setting
3806 function wp_suspend_cache_invalidation($suspend = true) {
3807 global $_wp_suspend_cache_invalidation;
3809 $current_suspend = $_wp_suspend_cache_invalidation;
3810 $_wp_suspend_cache_invalidation = $suspend;
3811 return $current_suspend;
3815 * Retrieve site option value based on name of option.
3818 * @package WordPress
3819 * @subpackage Option
3822 * @uses apply_filters() Calls 'pre_site_option_$option' before checking the option.
3823 * Any value other than false will "short-circuit" the retrieval of the option
3824 * and return the returned value.
3825 * @uses apply_filters() Calls 'site_option_$option', after checking the option, with
3828 * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
3829 * @param mixed $default Optional value to return if option doesn't exist. Default false.
3830 * @param bool $use_cache Whether to use cache. Multisite only. Default true.
3831 * @return mixed Value set for the option.
3833 function get_site_option( $option, $default = false, $use_cache = true ) {
3836 // Allow plugins to short-circuit site options.
3837 $pre = apply_filters( 'pre_site_option_' . $option, false );
3838 if ( false !== $pre )
3841 if ( !is_multisite() ) {
3842 $value = get_option($option, $default);
3844 $cache_key = "{$wpdb->siteid}:$option";
3846 $value = wp_cache_get($cache_key, 'site-options');
3848 if ( !isset($value) || (false === $value) ) {
3849 $row = $wpdb->get_row( $wpdb->prepare("SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) );
3851 // Has to be get_row instead of get_var because of funkiness with 0, false, null values
3852 if ( is_object( $row ) ) {
3853 $value = $row->meta_value;
3854 $value = maybe_unserialize( $value );
3855 wp_cache_set( $cache_key, $value, 'site-options' );
3862 return apply_filters( 'site_option_' . $option, $value );
3866 * Add a new site option.
3868 * Existing options will not be updated. Note that prior to 3.3 this wasn't the case.
3871 * @package WordPress
3872 * @subpackage Option
3875 * @uses apply_filters() Calls 'pre_add_site_option_$option' hook to allow overwriting the
3876 * option value to be stored.
3877 * @uses do_action() Calls 'add_site_option_$option' and 'add_site_option' hooks on success.
3879 * @param string $option Name of option to add. Expected to not be SQL-escaped.
3880 * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
3881 * @return bool False if option was not added and true if option was added.
3883 function add_site_option( $option, $value ) {
3886 $value = apply_filters( 'pre_add_site_option_' . $option, $value );
3888 if ( !is_multisite() ) {
3889 $result = add_option( $option, $value );
3891 $cache_key = "{$wpdb->siteid}:$option";
3893 if ( false !== get_site_option( $option ) )
3896 $value = sanitize_option( $option, $value );
3897 wp_cache_set( $cache_key, $value, 'site-options' );
3900 $value = maybe_serialize( $value );
3901 $result = $wpdb->insert( $wpdb->sitemeta, array('site_id' => $wpdb->siteid, 'meta_key' => $option, 'meta_value' => $value ) );
3906 do_action( "add_site_option_{$option}", $option, $value );
3907 do_action( "add_site_option", $option, $value );
3914 * Removes site option by name.
3916 * @see delete_option()
3917 * @package WordPress
3918 * @subpackage Option
3921 * @uses do_action() Calls 'pre_delete_site_option_$option' hook before option is deleted.
3922 * @uses do_action() Calls 'delete_site_option' and 'delete_site_option_$option'
3925 * @param string $option Name of option to remove. Expected to not be SQL-escaped.
3926 * @return bool True, if succeed. False, if failure.
3928 function delete_site_option( $option ) {
3931 // ms_protect_special_option( $option ); @todo
3933 do_action( 'pre_delete_site_option_' . $option );
3935 if ( !is_multisite() ) {
3936 $result = delete_option( $option );
3938 $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) );
3939 if ( is_null( $row ) || !$row->meta_id )
3941 $cache_key = "{$wpdb->siteid}:$option";
3942 wp_cache_delete( $cache_key, 'site-options' );
3944 $result = $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) );
3948 do_action( "delete_site_option_{$option}", $option );
3949 do_action( "delete_site_option", $option );
3956 * Update the value of a site option that was already added.
3958 * @see update_option()
3960 * @package WordPress
3961 * @subpackage Option
3963 * @uses apply_filters() Calls 'pre_update_site_option_$option' hook to allow overwriting the
3964 * option value to be stored.
3965 * @uses do_action() Calls 'update_site_option_$option' and 'update_site_option' hooks on success.
3967 * @param string $option Name of option. Expected to not be SQL-escaped.
3968 * @param mixed $value Option value. Expected to not be SQL-escaped.
3969 * @return bool False if value was not updated and true if value was updated.
3971 function update_site_option( $option, $value ) {
3974 $oldvalue = get_site_option( $option );
3975 $value = apply_filters( 'pre_update_site_option_' . $option, $value, $oldvalue );
3977 if ( $value === $oldvalue )
3980 if ( false === $oldvalue )
3981 return add_site_option( $option, $value );
3983 if ( !is_multisite() ) {
3984 $result = update_option( $option, $value );
3986 $value = sanitize_option( $option, $value );
3987 $cache_key = "{$wpdb->siteid}:$option";
3988 wp_cache_set( $cache_key, $value, 'site-options' );
3991 $value = maybe_serialize( $value );
3992 $result = $wpdb->update( $wpdb->sitemeta, array( 'meta_value' => $value ), array( 'site_id' => $wpdb->siteid, 'meta_key' => $option ) );
3997 do_action( "update_site_option_{$option}", $option, $value, $oldvalue );
3998 do_action( "update_site_option", $option, $value, $oldvalue );
4005 * Delete a site transient.
4008 * @package WordPress
4009 * @subpackage Transient
4011 * @uses do_action() Calls 'delete_site_transient_$transient' hook before transient is deleted.
4012 * @uses do_action() Calls 'deleted_site_transient' hook on success.
4014 * @param string $transient Transient name. Expected to not be SQL-escaped.
4015 * @return bool True if successful, false otherwise
4017 function delete_site_transient( $transient ) {
4018 global $_wp_using_ext_object_cache;
4020 do_action( 'delete_site_transient_' . $transient, $transient );
4021 if ( $_wp_using_ext_object_cache ) {
4022 $result = wp_cache_delete( $transient, 'site-transient' );
4024 $option_timeout = '_site_transient_timeout_' . $transient;
4025 $option = '_site_transient_' . $transient;
4026 $result = delete_site_option( $option );
4028 delete_site_option( $option_timeout );
4031 do_action( 'deleted_site_transient', $transient );
4036 * Get the value of a site transient.
4038 * If the transient does not exist or does not have a value, then the return value
4041 * @see get_transient()
4043 * @package WordPress
4044 * @subpackage Transient
4046 * @uses apply_filters() Calls 'pre_site_transient_$transient' hook before checking the transient.
4047 * Any value other than false will "short-circuit" the retrieval of the transient
4048 * and return the returned value.
4049 * @uses apply_filters() Calls 'site_transient_$option' hook, after checking the transient, with
4050 * the transient value.
4052 * @param string $transient Transient name. Expected to not be SQL-escaped.
4053 * @return mixed Value of transient
4055 function get_site_transient( $transient ) {
4056 global $_wp_using_ext_object_cache;
4058 $pre = apply_filters( 'pre_site_transient_' . $transient, false );
4059 if ( false !== $pre )
4062 if ( $_wp_using_ext_object_cache ) {
4063 $value = wp_cache_get( $transient, 'site-transient' );
4065 // Core transients that do not have a timeout. Listed here so querying timeouts can be avoided.
4066 $no_timeout = array('update_core', 'update_plugins', 'update_themes');
4067 $transient_option = '_site_transient_' . $transient;
4068 if ( ! in_array( $transient, $no_timeout ) ) {
4069 $transient_timeout = '_site_transient_timeout_' . $transient;
4070 $timeout = get_site_option( $transient_timeout );
4071 if ( false !== $timeout && $timeout < time() ) {
4072 delete_site_option( $transient_option );
4073 delete_site_option( $transient_timeout );
4078 $value = get_site_option( $transient_option );
4081 return apply_filters( 'site_transient_' . $transient, $value );
4085 * Set/update the value of a site transient.
4087 * You do not need to serialize values, if the value needs to be serialize, then
4088 * it will be serialized before it is set.
4090 * @see set_transient()
4092 * @package WordPress
4093 * @subpackage Transient
4095 * @uses apply_filters() Calls 'pre_set_site_transient_$transient' hook to allow overwriting the
4096 * transient value to be stored.
4097 * @uses do_action() Calls 'set_site_transient_$transient' and 'setted_site_transient' hooks on success.
4099 * @param string $transient Transient name. Expected to not be SQL-escaped.
4100 * @param mixed $value Transient value. Expected to not be SQL-escaped.
4101 * @param int $expiration Time until expiration in seconds, default 0
4102 * @return bool False if value was not set and true if value was set.
4104 function set_site_transient( $transient, $value, $expiration = 0 ) {
4105 global $_wp_using_ext_object_cache;
4107 $value = apply_filters( 'pre_set_site_transient_' . $transient, $value );
4109 if ( $_wp_using_ext_object_cache ) {
4110 $result = wp_cache_set( $transient, $value, 'site-transient', $expiration );
4112 $transient_timeout = '_site_transient_timeout_' . $transient;
4113 $transient = '_site_transient_' . $transient;
4114 if ( false === get_site_option( $transient ) ) {
4116 add_site_option( $transient_timeout, time() + $expiration );
4117 $result = add_site_option( $transient, $value );
4120 update_site_option( $transient_timeout, time() + $expiration );
4121 $result = update_site_option( $transient, $value );
4125 do_action( 'set_site_transient_' . $transient );
4126 do_action( 'setted_site_transient', $transient );
4136 * @package WordPress
4138 * @param int $blog_id optional blog id to test (default current blog)
4139 * @return bool True if not multisite or $blog_id is main site
4141 function is_main_site( $blog_id = '' ) {
4142 global $current_site, $current_blog;
4144 if ( !is_multisite() )
4148 $blog_id = $current_blog->blog_id;
4150 return $blog_id == $current_site->blog_id;
4154 * Whether global terms are enabled.
4158 * @package WordPress
4160 * @return bool True if multisite and global terms enabled
4162 function global_terms_enabled() {
4163 if ( ! is_multisite() )
4166 static $global_terms = null;
4167 if ( is_null( $global_terms ) ) {
4168 $filter = apply_filters( 'global_terms_enabled', null );
4169 if ( ! is_null( $filter ) )
4170 $global_terms = (bool) $filter;
4172 $global_terms = (bool) get_site_option( 'global_terms_enabled', false );
4174 return $global_terms;
4178 * gmt_offset modification for smart timezone handling.
4180 * Overrides the gmt_offset option if we have a timezone_string available.
4184 * @return float|bool
4186 function wp_timezone_override_offset() {
4187 if ( !$timezone_string = get_option( 'timezone_string' ) ) {
4191 $timezone_object = timezone_open( $timezone_string );
4192 $datetime_object = date_create();
4193 if ( false === $timezone_object || false === $datetime_object ) {
4196 return round( timezone_offset_get( $timezone_object, $datetime_object ) / 3600, 2 );
4200 * {@internal Missing Short Description}}
4204 * @param unknown_type $a
4205 * @param unknown_type $b
4208 function _wp_timezone_choice_usort_callback( $a, $b ) {
4209 // Don't use translated versions of Etc
4210 if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) {
4211 // Make the order of these more like the old dropdown
4212 if ( 'GMT+' === substr( $a['city'], 0, 4 ) && 'GMT+' === substr( $b['city'], 0, 4 ) ) {
4213 return -1 * ( strnatcasecmp( $a['city'], $b['city'] ) );
4215 if ( 'UTC' === $a['city'] ) {
4216 if ( 'GMT+' === substr( $b['city'], 0, 4 ) ) {
4221 if ( 'UTC' === $b['city'] ) {
4222 if ( 'GMT+' === substr( $a['city'], 0, 4 ) ) {
4227 return strnatcasecmp( $a['city'], $b['city'] );
4229 if ( $a['t_continent'] == $b['t_continent'] ) {
4230 if ( $a['t_city'] == $b['t_city'] ) {
4231 return strnatcasecmp( $a['t_subcity'], $b['t_subcity'] );
4233 return strnatcasecmp( $a['t_city'], $b['t_city'] );
4235 // Force Etc to the bottom of the list
4236 if ( 'Etc' === $a['continent'] ) {
4239 if ( 'Etc' === $b['continent'] ) {
4242 return strnatcasecmp( $a['t_continent'], $b['t_continent'] );
4247 * Gives a nicely formatted list of timezone strings. // temporary! Not in final
4251 * @param string $selected_zone Selected Zone
4254 function wp_timezone_choice( $selected_zone ) {
4255 static $mo_loaded = false;
4257 $continents = array( 'Africa', 'America', 'Antarctica', 'Arctic', 'Asia', 'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific');
4259 // Load translations for continents and cities
4260 if ( !$mo_loaded ) {
4261 $locale = get_locale();
4262 $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
4263 load_textdomain( 'continents-cities', $mofile );
4268 foreach ( timezone_identifiers_list() as $zone ) {
4269 $zone = explode( '/', $zone );
4270 if ( !in_array( $zone[0], $continents ) ) {
4274 // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
4276 0 => ( isset( $zone[0] ) && $zone[0] ),
4277 1 => ( isset( $zone[1] ) && $zone[1] ),
4278 2 => ( isset( $zone[2] ) && $zone[2] ),
4280 $exists[3] = ( $exists[0] && 'Etc' !== $zone[0] );
4281 $exists[4] = ( $exists[1] && $exists[3] );
4282 $exists[5] = ( $exists[2] && $exists[3] );
4285 'continent' => ( $exists[0] ? $zone[0] : '' ),
4286 'city' => ( $exists[1] ? $zone[1] : '' ),
4287 'subcity' => ( $exists[2] ? $zone[2] : '' ),
4288 't_continent' => ( $exists[3] ? translate( str_replace( '_', ' ', $zone[0] ), 'continents-cities' ) : '' ),
4289 't_city' => ( $exists[4] ? translate( str_replace( '_', ' ', $zone[1] ), 'continents-cities' ) : '' ),
4290 't_subcity' => ( $exists[5] ? translate( str_replace( '_', ' ', $zone[2] ), 'continents-cities' ) : '' )
4293 usort( $zonen, '_wp_timezone_choice_usort_callback' );
4295 $structure = array();
4297 if ( empty( $selected_zone ) ) {
4298 $structure[] = '<option selected="selected" value="">' . __( 'Select a city' ) . '</option>';
4301 foreach ( $zonen as $key => $zone ) {
4302 // Build value in an array to join later
4303 $value = array( $zone['continent'] );
4305 if ( empty( $zone['city'] ) ) {
4306 // It's at the continent level (generally won't happen)
4307 $display = $zone['t_continent'];
4309 // It's inside a continent group
4311 // Continent optgroup
4312 if ( !isset( $zonen[$key - 1] ) || $zonen[$key - 1]['continent'] !== $zone['continent'] ) {
4313 $label = $zone['t_continent'];
4314 $structure[] = '<optgroup label="'. esc_attr( $label ) .'">';
4317 // Add the city to the value
4318 $value[] = $zone['city'];
4320 $display = $zone['t_city'];
4321 if ( !empty( $zone['subcity'] ) ) {
4322 // Add the subcity to the value
4323 $value[] = $zone['subcity'];
4324 $display .= ' - ' . $zone['t_subcity'];
4329 $value = join( '/', $value );
4331 if ( $value === $selected_zone ) {
4332 $selected = 'selected="selected" ';
4334 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $value ) . '">' . esc_html( $display ) . "</option>";
4336 // Close continent optgroup
4337 if ( !empty( $zone['city'] ) && ( !isset($zonen[$key + 1]) || (isset( $zonen[$key + 1] ) && $zonen[$key + 1]['continent'] !== $zone['continent']) ) ) {
4338 $structure[] = '</optgroup>';
4343 $structure[] = '<optgroup label="'. esc_attr__( 'UTC' ) .'">';
4345 if ( 'UTC' === $selected_zone )
4346 $selected = 'selected="selected" ';
4347 $structure[] = '<option ' . $selected . 'value="' . esc_attr( 'UTC' ) . '">' . __('UTC') . '</option>';
4348 $structure[] = '</optgroup>';
4350 // Do manual UTC offsets
4351 $structure[] = '<optgroup label="'. esc_attr__( 'Manual Offsets' ) .'">';
4352 $offset_range = array (-12, -11.5, -11, -10.5, -10, -9.5, -9, -8.5, -8, -7.5, -7, -6.5, -6, -5.5, -5, -4.5, -4, -3.5, -3, -2.5, -2, -1.5, -1, -0.5,
4353 0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 5.75, 6, 6.5, 7, 7.5, 8, 8.5, 8.75, 9, 9.5, 10, 10.5, 11, 11.5, 12, 12.75, 13, 13.75, 14);
4354 foreach ( $offset_range as $offset ) {
4356 $offset_name = '+' . $offset;
4358 $offset_name = (string) $offset;
4360 $offset_value = $offset_name;
4361 $offset_name = str_replace(array('.25','.5','.75'), array(':15',':30',':45'), $offset_name);
4362 $offset_name = 'UTC' . $offset_name;
4363 $offset_value = 'UTC' . $offset_value;
4365 if ( $offset_value === $selected_zone )
4366 $selected = 'selected="selected" ';
4367 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $offset_value ) . '">' . esc_html( $offset_name ) . "</option>";
4370 $structure[] = '</optgroup>';
4372 return join( "\n", $structure );
4376 * Strip close comment and close php tags from file headers used by WP.
4377 * See http://core.trac.wordpress.org/ticket/8497
4381 * @param string $str
4384 function _cleanup_header_comment($str) {
4385 return trim(preg_replace("/\s*(?:\*\/|\?>).*/", '', $str));
4389 * Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.
4393 function wp_scheduled_delete() {
4396 $delete_timestamp = time() - (60*60*24*EMPTY_TRASH_DAYS);
4398 $posts_to_delete = $wpdb->get_results($wpdb->prepare("SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wp_trash_meta_time' AND meta_value < '%d'", $delete_timestamp), ARRAY_A);
4400 foreach ( (array) $posts_to_delete as $post ) {
4401 $post_id = (int) $post['post_id'];
4405 $del_post = get_post($post_id);
4407 if ( !$del_post || 'trash' != $del_post->post_status ) {
4408 delete_post_meta($post_id, '_wp_trash_meta_status');
4409 delete_post_meta($post_id, '_wp_trash_meta_time');
4411 wp_delete_post($post_id);
4415 $comments_to_delete = $wpdb->get_results($wpdb->prepare("SELECT comment_id FROM $wpdb->commentmeta WHERE meta_key = '_wp_trash_meta_time' AND meta_value < '%d'", $delete_timestamp), ARRAY_A);
4417 foreach ( (array) $comments_to_delete as $comment ) {
4418 $comment_id = (int) $comment['comment_id'];
4422 $del_comment = get_comment($comment_id);
4424 if ( !$del_comment || 'trash' != $del_comment->comment_approved ) {
4425 delete_comment_meta($comment_id, '_wp_trash_meta_time');
4426 delete_comment_meta($comment_id, '_wp_trash_meta_status');
4428 wp_delete_comment($comment_id);
4434 * Retrieve metadata from a file.
4436 * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
4437 * Each piece of metadata must be on its own line. Fields can not span multiple
4438 * lines, the value will get cut at the end of the first line.
4440 * If the file data is not within that first 8kiB, then the author should correct
4441 * their plugin file and move the data headers to the top.
4443 * @see http://codex.wordpress.org/File_Header
4446 * @param string $file Path to the file
4447 * @param array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name')
4448 * @param string $context If specified adds filter hook "extra_{$context}_headers"
4450 function get_file_data( $file, $default_headers, $context = '' ) {
4451 // We don't need to write to the file, so just open for reading.
4452 $fp = fopen( $file, 'r' );
4454 // Pull only the first 8kiB of the file in.
4455 $file_data = fread( $fp, 8192 );
4457 // PHP will close file handle, but we are good citizens.
4460 if ( $context != '' ) {
4461 $extra_headers = apply_filters( "extra_{$context}_headers", array() );
4463 $extra_headers = array_flip( $extra_headers );
4464 foreach( $extra_headers as $key=>$value ) {
4465 $extra_headers[$key] = $key;
4467 $all_headers = array_merge( $extra_headers, (array) $default_headers );
4469 $all_headers = $default_headers;
4472 foreach ( $all_headers as $field => $regex ) {
4473 preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, ${$field});
4474 if ( !empty( ${$field} ) )
4475 ${$field} = _cleanup_header_comment( ${$field}[1] );
4480 $file_data = compact( array_keys( $all_headers ) );
4486 * Used internally to tidy up the search terms.
4494 function _search_terms_tidy($t) {
4495 return trim($t, "\"'\n\r ");
4501 * Useful for returning true to filters easily.
4504 * @see __return_false()
4507 function __return_true() {
4514 * Useful for returning false to filters easily.
4517 * @see __return_true()
4518 * @return bool false
4520 function __return_false() {
4527 * Useful for returning 0 to filters easily.
4530 * @see __return_zero()
4533 function __return_zero() {
4538 * Returns an empty array.
4540 * Useful for returning an empty array to filters easily.
4543 * @see __return_zero()
4544 * @return array Empty array
4546 function __return_empty_array() {
4551 * Send a HTTP header to disable content type sniffing in browsers which support it.
4553 * @link http://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx
4554 * @link http://src.chromium.org/viewvc/chrome?view=rev&revision=6985
4559 function send_nosniff_header() {
4560 @header( 'X-Content-Type-Options: nosniff' );
4564 * Returns a MySQL expression for selecting the week number based on the start_of_week option.
4568 * @param string $column
4571 function _wp_mysql_week( $column ) {
4572 switch ( $start_of_week = (int) get_option( 'start_of_week' ) ) {
4575 return "WEEK( $column, 0 )";
4577 return "WEEK( $column, 1 )";
4583 return "WEEK( DATE_SUB( $column, INTERVAL $start_of_week DAY ), 0 )";
4588 * Finds hierarchy loops using a callback function that maps object IDs to parent IDs.
4593 * @param callback $callback function that accepts ( ID, $callback_args ) and outputs parent_ID
4594 * @param int $start The ID to start the loop check at
4595 * @param int $start_parent the parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback
4596 * @param array $callback_args optional additional arguments to send to $callback
4597 * @return array IDs of all members of loop
4599 function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) {
4600 $override = is_null( $start_parent ) ? array() : array( $start => $start_parent );
4602 if ( !$arbitrary_loop_member = wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override, $callback_args ) )
4605 return wp_find_hierarchy_loop_tortoise_hare( $callback, $arbitrary_loop_member, $override, $callback_args, true );
4609 * Uses the "The Tortoise and the Hare" algorithm to detect loops.
4611 * For every step of the algorithm, the hare takes two steps and the tortoise one.
4612 * If the hare ever laps the tortoise, there must be a loop.
4617 * @param callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID
4618 * @param int $start The ID to start the loop check at
4619 * @param array $override an array of ( ID => parent_ID, ... ) to use instead of $callback
4620 * @param array $callback_args optional additional arguments to send to $callback
4621 * @param bool $_return_loop Return loop members or just detect presence of loop?
4622 * Only set to true if you already know the given $start is part of a loop
4623 * (otherwise the returned array might include branches)
4624 * @return mixed scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop
4626 function wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override = array(), $callback_args = array(), $_return_loop = false ) {
4627 $tortoise = $hare = $evanescent_hare = $start;
4630 // Set evanescent_hare to one past hare
4631 // Increment hare two steps
4635 ( $evanescent_hare = isset( $override[$hare] ) ? $override[$hare] : call_user_func_array( $callback, array_merge( array( $hare ), $callback_args ) ) )
4637 ( $hare = isset( $override[$evanescent_hare] ) ? $override[$evanescent_hare] : call_user_func_array( $callback, array_merge( array( $evanescent_hare ), $callback_args ) ) )
4639 if ( $_return_loop )
4640 $return[$tortoise] = $return[$evanescent_hare] = $return[$hare] = true;
4642 // tortoise got lapped - must be a loop
4643 if ( $tortoise == $evanescent_hare || $tortoise == $hare )
4644 return $_return_loop ? $return : $tortoise;
4646 // Increment tortoise by one step
4647 $tortoise = isset( $override[$tortoise] ) ? $override[$tortoise] : call_user_func_array( $callback, array_merge( array( $tortoise ), $callback_args ) );
4654 * Send a HTTP header to limit rendering of pages to same origin iframes.
4656 * @link https://developer.mozilla.org/en/the_x-frame-options_response_header
4661 function send_frame_options_header() {
4662 @header( 'X-Frame-Options: SAMEORIGIN' );
4666 * Retrieve a list of protocols to allow in HTML attributes.
4672 * @return array Array of allowed protocols
4674 function wp_allowed_protocols() {
4677 if ( empty( $protocols ) ) {
4678 $protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn' );
4679 $protocols = apply_filters( 'kses_allowed_protocols', $protocols );