2011-12-20 00:15:32 +01:00
< ? php
/**
* Option API
*
* @ package WordPress
2014-02-25 18:14:14 +01:00
* @ subpackage Option
2011-12-20 00:15:32 +01:00
*/
/**
2016-06-26 19:29:30 +02:00
* Retrieves an option value based on an option name .
2011-12-20 00:15:32 +01:00
*
2021-06-01 02:00:58 +02:00
* If the option does not exist , and a default value is not provided ,
* boolean false is returned . This could be used to check whether you need
* to initialize an option during installation of a plugin , however that
2021-07-03 13:31:58 +02:00
* can be done better by using add_option () which will not overwrite
2021-06-01 02:00:58 +02:00
* existing options .
2011-12-20 00:15:32 +01:00
*
2021-07-03 13:31:58 +02:00
* Not initializing an option and using boolean `false` as a return value
2021-06-01 02:00:58 +02:00
* is a bad practice as it triggers an additional database query .
2011-12-20 00:15:32 +01:00
*
2021-06-01 02:00:58 +02:00
* The type of the returned value can be different from the type that was passed
* when saving or updating the option . If the option value was serialized ,
* then it will be unserialized when it is returned . In this case the type will
* be the same . For example , storing a non - scalar value like an array will
* return the same array .
*
* In most cases non - string scalar and null values will be converted and returned
* as string equivalents .
*
* Exceptions :
2021-07-03 13:31:58 +02:00
* 1. When the option has not been saved in the database , the `$default` value
* is returned if provided . If not , boolean `false` is returned .
* 2. When one of the Options API filters is used : { @ see 'pre_option_{$option}' },
* { @ see 'default_option_{$option}' }, or { @ see 'option_{$option}' }, the returned
2021-06-01 02:00:58 +02:00
* value may not match the expected type .
2021-07-03 13:31:58 +02:00
* 3. When the option has just been saved in the database , and get_option ()
2021-06-01 02:00:58 +02:00
* is used right after , non - string scalar and null values are not converted to
* string equivalents and the original type is returned .
*
* Examples :
*
* When adding options like this : `add_option( 'my_option_name', 'value' );`
2021-07-03 13:31:58 +02:00
* and then retrieving them with `get_option( 'my_option_name' );` , the returned
2021-06-01 02:00:58 +02:00
* values will be :
*
* `false` returns `string(0) ""`
* `true` returns `string(1) "1"`
* `0` returns `string(1) "0"`
* `1` returns `string(1) "1"`
* `'0'` returns `string(1) "0"`
* `'1'` returns `string(1) "1"`
* `null` returns `string(0) ""`
*
* When adding options with non - scalar values like
* `add_option( 'my_array', array( false, 'str', null ) );` , the returned value
* will be identical to the original as it is serialized before saving
* it in the database :
*
* array ( 3 ) {
* [ 0 ] => bool ( false )
* [ 1 ] => string ( 3 ) " str "
* [ 2 ] => NULL
* }
2016-01-09 04:12:26 +01:00
*
2011-12-20 00:15:32 +01:00
* @ since 1.5 . 0
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to retrieve . Expected to not be SQL - escaped .
2015-05-27 00:17:25 +02:00
* @ param mixed $default Optional . Default value to return if the option does not exist .
2021-06-01 02:00:58 +02:00
* @ return mixed Value of the option . A value of any type may be returned , including
* scalar ( string , boolean , float , integer ), null , array , object .
* Scalar and null values will be returned as strings as long as they originate
* from a database stored option value . If there is no option in the database ,
* boolean `false` is returned .
2011-12-20 00:15:32 +01:00
*/
function get_option ( $option , $default = false ) {
global $wpdb ;
Options, Meta APIs: Fix "passing null to non-nullable" deprecations to `(get|add|update|delete)_option()`.
In all four of the `get_option()`, `add_option()`, `update_option()` and `delete_option()` functions, the `$option` parameter (i.e. the option name) is passed to the PHP native `trim()` function without prior input validation.
In PHP 8.1, this could lead to a `trim(): Passing null to parameter #1 ($string) of type string is deprecated` for each of these functions.
`trim()`:
- expects a text string and is only useful when ''passed'' a text string as no other variable type can contain whitespace.
- will always return a `string`, which means that in practice for any non-string values passed, it would effectively function as a type cast to string.
This commit:
- Adds a check to verify the `$option` name is a scalar before processing it with `trim()`.
- The "type cast" behavior is maintained.
- If the given `$option` name is not a scalar, such as `null`, the fix prevents the PHP 8.1 deprecation notice.
- Tests are added for valid but undesired option names to safeguard against regressions.
This issue is already covered by:
- the existing `Tests_Option_Option::test_bad_option_names()` test group.
- the new `test_valid_but_undesired_option_names()` tests.
Follow-up to [13858], [22633], [23510], [25002], [51817].
Props jrf, hellofromTonya, pbearne.
See #53635.
Built from https://develop.svn.wordpress.org/trunk@51818
git-svn-id: http://core.svn.wordpress.org/trunk@51425 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-16 00:19:58 +02:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-12-01 00:11:00 +01:00
if ( empty ( $option ) ) {
2012-11-17 14:20:57 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
2012-11-17 14:20:57 +01:00
General: Update code for readability and inclusion
There are two pieces in here:
1) The update to change blacklist to blocklist is moved to disallowed_list. "Block" has a meaning in our code, and there could be ambiguity between this code and code related to blocks.
2) This improves backwards compatibility for code that was accessing the now deprecated code.
Previously: [48477], [48405], [48400], [48121], [48122], [48124], [48142], [48566]
Props: desrosj, SergeyBiryukov, johnjamesjacoby
Fixes: #50413
Built from https://develop.svn.wordpress.org/trunk@48575
git-svn-id: http://core.svn.wordpress.org/trunk@48337 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 05:14:06 +02:00
/*
* Until a proper _deprecated_option () function can be introduced ,
* redirect requests to deprecated keys to the new , correct ones .
*/
$deprecated_keys = array (
'blacklist_keys' => 'disallowed_keys' ,
'comment_whitelist' => 'comment_previously_approved' ,
);
if ( ! wp_installing () && isset ( $deprecated_keys [ $option ] ) ) {
_deprecated_argument (
__FUNCTION__ ,
'5.5.0' ,
sprintf (
/* translators: 1: Deprecated option key, 2: New option key. */
__ ( 'The "%1$s" option key has been renamed to "%2$s".' ),
$option ,
$deprecated_keys [ $option ]
)
);
return get_option ( $deprecated_keys [ $option ], $default );
}
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the value of an existing option before it is retrieved .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
2020-06-27 18:56:02 +02:00
* Returning a truthy value from the filter will effectively short - circuit retrieval
* and return the passed value instead .
2014-03-03 00:35:13 +01:00
*
* @ since 1.5 . 0
2015-08-27 19:00:24 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
2017-07-06 17:12:44 +02:00
* @ since 4.9 . 0 The `$default` parameter was added .
2014-03-03 00:35:13 +01:00
*
2020-06-27 18:56:02 +02:00
* @ param mixed $pre_option The value to return instead of the option value . This differs
* from `$default` , which is used as the fallback value in the event
* the option doesn ' t exist elsewhere in get_option () .
* Default false ( to skip past the short - circuit ) .
* @ param string $option Option name .
* @ param mixed $default The fallback value to return if the option does not exist .
* Default false .
2014-03-03 00:35:13 +01:00
*/
2017-07-06 17:12:44 +02:00
$pre = apply_filters ( " pre_option_ { $option } " , false , $option , $default );
2017-12-01 00:11:00 +01:00
if ( false !== $pre ) {
2011-12-20 00:15:32 +01:00
return $pre ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
if ( defined ( 'WP_SETUP_CONFIG' ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2016-10-25 19:08:29 +02:00
// Distinguish between `false` as a default, and not passing one.
$passed_default = func_num_args () > 1 ;
Use `wp_installing()` instead of `WP_INSTALLING` constant.
The `WP_INSTALLING` constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.
A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during `wpmu_create_blog()` -
for the "installing" flag to be set after WP has already loaded. In these
cases, `WP_INSTALLING` would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where `WP_INSTALLING`
was set the first time a site was created, and remained set for the rest of the
suite.
The new `wp_installing()` function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean `true` or `false`). Use of
the `WP_INSTALLING` constant is still supported; `wp_installing()` will default
to `true` if the constant is defined during the bootstrap.
Props boonebgorges, jeremyfelt.
See #31130.
Built from https://develop.svn.wordpress.org/trunk@34828
git-svn-id: http://core.svn.wordpress.org/trunk@34793 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-05 17:06:28 +02:00
if ( ! wp_installing () ) {
2020-01-29 01:45:18 +01:00
// Prevent non-existent options from triggering multiple queries.
2011-12-20 00:15:32 +01:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
2020-06-27 18:56:02 +02:00
2014-12-16 06:52:23 +01:00
if ( isset ( $notoptions [ $option ] ) ) {
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the default value for an option .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.4 . 0
2015-08-28 17:18:22 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
2016-10-25 19:08:29 +02:00
* @ since 4.7 . 0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $default The default value to return if the option does not exist
* in the database .
* @ param string $option Option name .
2016-10-25 19:08:29 +02:00
* @ param bool $passed_default Was `get_option()` passed a default value ?
2014-03-03 00:35:13 +01:00
*/
2016-10-25 19:08:29 +02:00
return apply_filters ( " default_option_ { $option } " , $default , $option , $passed_default );
2014-12-16 06:52:23 +01:00
}
2011-12-20 00:15:32 +01:00
$alloptions = wp_load_alloptions ();
2017-12-01 00:11:00 +01:00
if ( isset ( $alloptions [ $option ] ) ) {
$value = $alloptions [ $option ];
2011-12-20 00:15:32 +01:00
} else {
$value = wp_cache_get ( $option , 'options' );
if ( false === $value ) {
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1 " , $option ) );
2020-01-29 01:45:18 +01:00
// Has to be get_row() instead of get_var() because of funkiness with 0, false, null values.
2011-12-20 00:15:32 +01:00
if ( is_object ( $row ) ) {
$value = $row -> option_value ;
wp_cache_add ( $option , $value , 'options' );
2020-01-29 01:45:18 +01:00
} else { // Option does not exist, so we must cache its non-existence.
2015-06-25 21:01:26 +02:00
if ( ! is_array ( $notoptions ) ) {
2017-11-27 00:57:55 +01:00
$notoptions = array ();
2015-06-25 21:01:26 +02:00
}
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
$notoptions [ $option ] = true ;
2011-12-20 00:15:32 +01:00
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
2014-03-03 00:35:13 +01:00
/** This filter is documented in wp-includes/option.php */
2016-12-14 05:18:42 +01:00
return apply_filters ( " default_option_ { $option } " , $default , $option , $passed_default );
2011-12-20 00:15:32 +01:00
}
}
}
} else {
$suppress = $wpdb -> suppress_errors ();
2017-12-01 00:11:00 +01:00
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1 " , $option ) );
2011-12-20 00:15:32 +01:00
$wpdb -> suppress_errors ( $suppress );
2020-06-27 18:56:02 +02:00
2014-03-03 00:35:13 +01:00
if ( is_object ( $row ) ) {
2011-12-20 00:15:32 +01:00
$value = $row -> option_value ;
2014-03-03 00:35:13 +01:00
} else {
/** This filter is documented in wp-includes/option.php */
2016-12-14 05:18:42 +01:00
return apply_filters ( " default_option_ { $option } " , $default , $option , $passed_default );
2014-03-03 00:35:13 +01:00
}
2011-12-20 00:15:32 +01:00
}
2020-01-29 01:45:18 +01:00
// If home is not set, use siteurl.
2020-05-16 20:42:12 +02:00
if ( 'home' === $option && '' === $value ) {
2011-12-20 00:15:32 +01:00
return get_option ( 'siteurl' );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2020-04-05 05:02:11 +02:00
if ( in_array ( $option , array ( 'siteurl' , 'home' , 'category_base' , 'tag_base' ), true ) ) {
2011-12-20 00:15:32 +01:00
$value = untrailingslashit ( $value );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the value of an existing option .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 1.5 . 0 As 'option_' . $setting
* @ since 3.0 . 0
2015-08-28 17:20:20 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $value Value of the option . If stored serialized , it will be
* unserialized prior to being returned .
* @ param string $option Option name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
return apply_filters ( " option_ { $option } " , maybe_unserialize ( $value ), $option );
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Protects WordPress special option from being modified .
2011-12-20 00:15:32 +01:00
*
* Will die if $option is in protected list . Protected options are 'alloptions'
* and 'notoptions' options .
*
* @ since 2.2 . 0
*
* @ param string $option Option name .
*/
function wp_protect_special_option ( $option ) {
2017-12-01 00:11:00 +01:00
if ( 'alloptions' === $option || 'notoptions' === $option ) {
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
wp_die (
sprintf (
2019-09-03 02:41:05 +02:00
/* translators: %s: Option name. */
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
__ ( '%s is a protected WP option and may not be modified' ),
esc_html ( $option )
)
);
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Prints option value after sanitizing for forms .
2011-12-20 00:15:32 +01:00
*
* @ since 1.5 . 0
*
* @ param string $option Option name .
*/
function form_option ( $option ) {
echo esc_attr ( get_option ( $option ) );
}
/**
* Loads and caches all autoloaded options , if available or all options .
*
* @ since 2.2 . 0
2019-11-25 14:44:02 +01:00
* @ since 5.3 . 1 The `$force_cache` parameter was added .
2011-12-20 00:15:32 +01:00
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
See #31245.
Built from https://develop.svn.wordpress.org/trunk@46753
git-svn-id: http://core.svn.wordpress.org/trunk@46553 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-20 14:42:03 +01:00
* @ param bool $force_cache Optional . Whether to force an update of the local cache
* from the persistent cache . Default false .
2011-12-20 00:15:32 +01:00
* @ return array List of all options .
*/
Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
See #31245.
Built from https://develop.svn.wordpress.org/trunk@46753
git-svn-id: http://core.svn.wordpress.org/trunk@46553 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-20 14:42:03 +01:00
function wp_load_alloptions ( $force_cache = false ) {
2011-12-20 00:15:32 +01:00
global $wpdb ;
2017-09-28 02:23:47 +02:00
if ( ! wp_installing () || ! is_multisite () ) {
Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
See #31245.
Built from https://develop.svn.wordpress.org/trunk@46753
git-svn-id: http://core.svn.wordpress.org/trunk@46553 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-20 14:42:03 +01:00
$alloptions = wp_cache_get ( 'alloptions' , 'options' , $force_cache );
2017-09-28 02:23:47 +02:00
} else {
2011-12-20 00:15:32 +01:00
$alloptions = false ;
2017-09-28 02:23:47 +02:00
}
2011-12-20 00:15:32 +01:00
2017-09-28 02:23:47 +02:00
if ( ! $alloptions ) {
2019-07-03 01:42:58 +02:00
$suppress = $wpdb -> suppress_errors ();
$alloptions_db = $wpdb -> get_results ( " SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes' " );
if ( ! $alloptions_db ) {
2011-12-20 00:15:32 +01:00
$alloptions_db = $wpdb -> get_results ( " SELECT option_name, option_value FROM $wpdb->options " );
2017-09-28 02:23:47 +02:00
}
$wpdb -> suppress_errors ( $suppress );
2011-12-20 00:15:32 +01:00
$alloptions = array ();
foreach ( ( array ) $alloptions_db as $o ) {
2017-12-01 00:11:00 +01:00
$alloptions [ $o -> option_name ] = $o -> option_value ;
2011-12-20 00:15:32 +01:00
}
2017-09-28 02:23:47 +02:00
if ( ! wp_installing () || ! is_multisite () ) {
/**
* Filters all options before caching them .
*
* @ since 4.9 . 0
*
* @ param array $alloptions Array with all options .
*/
$alloptions = apply_filters ( 'pre_cache_alloptions' , $alloptions );
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
wp_cache_add ( 'alloptions' , $alloptions , 'options' );
2017-09-28 02:23:47 +02:00
}
2011-12-20 00:15:32 +01:00
}
2017-09-28 02:23:47 +02:00
/**
* Filters all options after retrieving them .
*
* @ since 4.9 . 0
*
* @ param array $alloptions Array with all options .
*/
return apply_filters ( 'alloptions' , $alloptions );
2011-12-20 00:15:32 +01:00
}
/**
* Loads and caches certain often requested site options if is_multisite () and a persistent cache is not being used .
*
* @ since 3.0 . 0
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2017-08-12 14:48:47 +02:00
* @ param int $network_id Optional site ID for which to query the options . Defaults to the current site .
2011-12-20 00:15:32 +01:00
*/
2017-08-12 14:48:47 +02:00
function wp_load_core_site_options ( $network_id = null ) {
2013-09-06 20:10:09 +02:00
global $wpdb ;
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
if ( ! is_multisite () || wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
return ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
if ( empty ( $network_id ) ) {
2017-08-12 15:11:43 +02:00
$network_id = get_current_network_id ();
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
$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' , 'ms_files_rewriting' );
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
$core_options_in = " ' " . implode ( " ', ' " , $core_options ) . " ' " ;
$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 " , $network_id ) );
2011-12-20 00:15:32 +01:00
foreach ( $options as $option ) {
2017-12-01 00:11:00 +01:00
$key = $option -> meta_key ;
$cache_key = " { $network_id } : $key " ;
2011-12-20 00:15:32 +01:00
$option -> meta_value = maybe_unserialize ( $option -> meta_value );
wp_cache_set ( $cache_key , $option -> meta_value , 'site-options' );
}
}
/**
2020-02-23 02:07:08 +01:00
* Updates the value of an option that was already added .
2011-12-20 00:15:32 +01:00
*
2020-02-23 02:07:08 +01:00
* You do not need to serialize values . If the value needs to be serialized ,
* then it will be serialized before it is inserted into the database .
* Remember , resources cannot be serialized or added as an option .
2011-12-20 00:15:32 +01:00
*
2020-02-25 21:08:07 +01:00
* If the option does not exist , it will be created .
2019-09-15 03:29:54 +02:00
2019-09-15 04:07:55 +02:00
* This function is designed to work with or without a logged - in user . In terms of security ,
2019-09-15 03:29:54 +02:00
* plugin developers should check the current user ' s capabilities before updating any options .
2011-12-20 00:15:32 +01:00
*
* @ since 1.0 . 0
2015-03-05 20:13:25 +01:00
* @ since 4.2 . 0 The `$autoload` parameter was added .
2011-12-20 00:15:32 +01:00
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to update . Expected to not be SQL - escaped .
2015-03-05 20:13:25 +01:00
* @ param mixed $value Option value . Must be serializable if non - scalar . Expected to not be SQL - escaped .
2015-03-06 14:57:26 +01:00
* @ param string | bool $autoload Optional . Whether to load the option when WordPress starts up . For existing options ,
* `$autoload` can only be updated using `update_option()` if `$value` is also changed .
2015-05-10 18:58:27 +02:00
* Accepts 'yes' | true to enable or 'no' | false to disable . For non - existent options ,
* the default value is 'yes' . Default null .
2020-07-05 16:46:03 +02:00
* @ return bool True if the value was updated , false otherwise .
2011-12-20 00:15:32 +01:00
*/
2015-03-06 14:57:26 +01:00
function update_option ( $option , $value , $autoload = null ) {
2011-12-20 00:15:32 +01:00
global $wpdb ;
Options, Meta APIs: Fix "passing null to non-nullable" deprecations to `(get|add|update|delete)_option()`.
In all four of the `get_option()`, `add_option()`, `update_option()` and `delete_option()` functions, the `$option` parameter (i.e. the option name) is passed to the PHP native `trim()` function without prior input validation.
In PHP 8.1, this could lead to a `trim(): Passing null to parameter #1 ($string) of type string is deprecated` for each of these functions.
`trim()`:
- expects a text string and is only useful when ''passed'' a text string as no other variable type can contain whitespace.
- will always return a `string`, which means that in practice for any non-string values passed, it would effectively function as a type cast to string.
This commit:
- Adds a check to verify the `$option` name is a scalar before processing it with `trim()`.
- The "type cast" behavior is maintained.
- If the given `$option` name is not a scalar, such as `null`, the fix prevents the PHP 8.1 deprecation notice.
- Tests are added for valid but undesired option names to safeguard against regressions.
This issue is already covered by:
- the existing `Tests_Option_Option::test_bad_option_names()` test group.
- the new `test_valid_but_undesired_option_names()` tests.
Follow-up to [13858], [22633], [23510], [25002], [51817].
Props jrf, hellofromTonya, pbearne.
See #53635.
Built from https://develop.svn.wordpress.org/trunk@51818
git-svn-id: http://core.svn.wordpress.org/trunk@51425 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-16 00:19:58 +02:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-12-01 00:11:00 +01:00
if ( empty ( $option ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
General: Update code for readability and inclusion
There are two pieces in here:
1) The update to change blacklist to blocklist is moved to disallowed_list. "Block" has a meaning in our code, and there could be ambiguity between this code and code related to blocks.
2) This improves backwards compatibility for code that was accessing the now deprecated code.
Previously: [48477], [48405], [48400], [48121], [48122], [48124], [48142], [48566]
Props: desrosj, SergeyBiryukov, johnjamesjacoby
Fixes: #50413
Built from https://develop.svn.wordpress.org/trunk@48575
git-svn-id: http://core.svn.wordpress.org/trunk@48337 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 05:14:06 +02:00
/*
* Until a proper _deprecated_option () function can be introduced ,
* redirect requests to deprecated keys to the new , correct ones .
*/
$deprecated_keys = array (
'blacklist_keys' => 'disallowed_keys' ,
'comment_whitelist' => 'comment_previously_approved' ,
);
if ( ! wp_installing () && isset ( $deprecated_keys [ $option ] ) ) {
_deprecated_argument (
__FUNCTION__ ,
'5.5.0' ,
sprintf (
/* translators: 1: Deprecated option key, 2: New option key. */
__ ( 'The "%1$s" option key has been renamed to "%2$s".' ),
$option ,
$deprecated_keys [ $option ]
)
);
return update_option ( $deprecated_keys [ $option ], $value , $autoload );
}
2011-12-20 00:15:32 +01:00
wp_protect_special_option ( $option );
2017-12-01 00:11:00 +01:00
if ( is_object ( $value ) ) {
2013-10-02 22:43:10 +02:00
$value = clone $value ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
$value = sanitize_option ( $option , $value );
2013-10-02 22:43:10 +02:00
$old_value = get_option ( $option );
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters a specific option before its value is ( maybe ) serialized and updated .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.6 . 0
2015-08-28 17:22:20 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $value The new , unserialized option value .
* @ param mixed $old_value The old option value .
* @ param string $option Option name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
$value = apply_filters ( " pre_update_option_ { $option } " , $value , $old_value , $option );
2011-12-20 00:15:32 +01:00
2014-03-28 14:57:14 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters an option before its value is ( maybe ) serialized and updated .
2014-03-28 14:57:14 +01:00
*
* @ since 3.9 . 0
*
* @ param mixed $value The new , unserialized option value .
* @ param string $option Name of the option .
* @ param mixed $old_value The old option value .
*/
$value = apply_filters ( 'pre_update_option' , $value , $option , $old_value );
2016-12-11 22:43:43 +01:00
/*
* If the new and old values are the same , no need to update .
*
* Unserialized values will be adequate in most cases . If the unserialized
* data differs , the ( maybe ) serialized data is checked to avoid
* unnecessary database calls for otherwise identical object instances .
*
* See https :// core . trac . wordpress . org / ticket / 38903
*/
if ( $value === $old_value || maybe_serialize ( $value ) === maybe_serialize ( $old_value ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2016-12-11 22:43:43 +01:00
}
2011-12-20 00:15:32 +01:00
2015-02-18 20:14:27 +01:00
/** This filter is documented in wp-includes/option.php */
2016-12-14 05:18:42 +01:00
if ( apply_filters ( " default_option_ { $option } " , false , $option , false ) === $old_value ) {
2015-03-06 14:57:26 +01:00
// Default setting for new options is 'yes'.
if ( null === $autoload ) {
$autoload = 'yes' ;
}
2015-03-05 20:13:25 +01:00
return add_option ( $option , $value , '' , $autoload );
}
2013-10-02 22:43:10 +02:00
$serialized_value = maybe_serialize ( $value );
2014-03-03 00:35:13 +01:00
/**
* Fires immediately before an option value is updated .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the option to update .
* @ param mixed $old_value The old option value .
* @ param mixed $value The new option value .
*/
2013-10-26 04:57:09 +02:00
do_action ( 'update_option' , $option , $old_value , $value );
2014-03-03 00:35:13 +01:00
2015-03-06 14:57:26 +01:00
$update_args = array (
'option_value' => $serialized_value ,
);
if ( null !== $autoload ) {
$update_args [ 'autoload' ] = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes' ;
}
$result = $wpdb -> update ( $wpdb -> options , $update_args , array ( 'option_name' => $option ) );
2017-12-01 00:11:00 +01:00
if ( ! $result ) {
2013-10-02 22:43:10 +02:00
return false ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
2011-12-20 00:15:32 +01:00
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
}
Use `wp_installing()` instead of `WP_INSTALLING` constant.
The `WP_INSTALLING` constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.
A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during `wpmu_create_blog()` -
for the "installing" flag to be set after WP has already loaded. In these
cases, `WP_INSTALLING` would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where `WP_INSTALLING`
was set the first time a site was created, and remained set for the rest of the
suite.
The new `wp_installing()` function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean `true` or `false`). Use of
the `WP_INSTALLING` constant is still supported; `wp_installing()` will default
to `true` if the constant is defined during the bootstrap.
Props boonebgorges, jeremyfelt.
See #31130.
Built from https://develop.svn.wordpress.org/trunk@34828
git-svn-id: http://core.svn.wordpress.org/trunk@34793 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-05 17:06:28 +02:00
if ( ! wp_installing () ) {
Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
See #31245.
Built from https://develop.svn.wordpress.org/trunk@46753
git-svn-id: http://core.svn.wordpress.org/trunk@46553 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-20 14:42:03 +01:00
$alloptions = wp_load_alloptions ( true );
2017-12-01 00:11:00 +01:00
if ( isset ( $alloptions [ $option ] ) ) {
2013-10-02 22:43:10 +02:00
$alloptions [ $option ] = $serialized_value ;
2011-12-20 00:15:32 +01:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
} else {
2013-10-02 22:43:10 +02:00
wp_cache_set ( $option , $serialized_value , 'options' );
2011-12-20 00:15:32 +01:00
}
}
2014-03-03 00:35:13 +01:00
/**
* Fires after the value of a specific option has been successfully updated .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.0 . 1
2015-08-28 17:24:21 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $old_value The old option value .
* @ param mixed $value The new option value .
* @ param string $option Option name .
2014-03-03 00:35:13 +01:00
*/
2015-08-25 23:42:20 +02:00
do_action ( " update_option_ { $option } " , $old_value , $value , $option );
2014-03-03 00:35:13 +01:00
/**
* Fires after the value of an option has been successfully updated .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the updated option .
* @ param mixed $old_value The old option value .
* @ param mixed $value The new option value .
*/
2013-10-02 22:43:10 +02:00
do_action ( 'updated_option' , $option , $old_value , $value );
2020-06-27 18:56:02 +02:00
2013-10-02 22:43:10 +02:00
return true ;
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Adds a new option .
2011-12-20 00:15:32 +01:00
*
2020-02-23 02:07:08 +01:00
* You do not need to serialize values . If the value needs to be serialized ,
* then it will be serialized before it is inserted into the database .
* Remember , resources cannot be serialized or added as an option .
2011-12-20 00:15:32 +01:00
*
* You can create options without values and then update the values later .
* Existing options will not be updated and checks are performed to ensure that you
* aren ' t adding a protected WordPress option . Care should be taken to not name
* options the same as the ones which are protected .
*
* @ since 1.0 . 0
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2020-07-23 23:11:05 +02:00
* @ param string $option Name of the option to add . Expected to not be SQL - escaped .
* @ param mixed $value Optional . Option value . Must be serializable if non - scalar .
* Expected to not be SQL - escaped .
* @ param string $deprecated Optional . Description . Not used anymore .
* @ param string | bool $autoload Optional . Whether to load the option when WordPress starts up .
* Default is enabled . Accepts 'no' to disable for legacy reasons .
2020-07-05 16:46:03 +02:00
* @ return bool True if the option was added , false otherwise .
2011-12-20 00:15:32 +01:00
*/
function add_option ( $option , $value = '' , $deprecated = '' , $autoload = 'yes' ) {
global $wpdb ;
2017-12-01 00:11:00 +01:00
if ( ! empty ( $deprecated ) ) {
2016-07-06 14:40:29 +02:00
_deprecated_argument ( __FUNCTION__ , '2.3.0' );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
Options, Meta APIs: Fix "passing null to non-nullable" deprecations to `(get|add|update|delete)_option()`.
In all four of the `get_option()`, `add_option()`, `update_option()` and `delete_option()` functions, the `$option` parameter (i.e. the option name) is passed to the PHP native `trim()` function without prior input validation.
In PHP 8.1, this could lead to a `trim(): Passing null to parameter #1 ($string) of type string is deprecated` for each of these functions.
`trim()`:
- expects a text string and is only useful when ''passed'' a text string as no other variable type can contain whitespace.
- will always return a `string`, which means that in practice for any non-string values passed, it would effectively function as a type cast to string.
This commit:
- Adds a check to verify the `$option` name is a scalar before processing it with `trim()`.
- The "type cast" behavior is maintained.
- If the given `$option` name is not a scalar, such as `null`, the fix prevents the PHP 8.1 deprecation notice.
- Tests are added for valid but undesired option names to safeguard against regressions.
This issue is already covered by:
- the existing `Tests_Option_Option::test_bad_option_names()` test group.
- the new `test_valid_but_undesired_option_names()` tests.
Follow-up to [13858], [22633], [23510], [25002], [51817].
Props jrf, hellofromTonya, pbearne.
See #53635.
Built from https://develop.svn.wordpress.org/trunk@51818
git-svn-id: http://core.svn.wordpress.org/trunk@51425 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-16 00:19:58 +02:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-12-01 00:11:00 +01:00
if ( empty ( $option ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
General: Update code for readability and inclusion
There are two pieces in here:
1) The update to change blacklist to blocklist is moved to disallowed_list. "Block" has a meaning in our code, and there could be ambiguity between this code and code related to blocks.
2) This improves backwards compatibility for code that was accessing the now deprecated code.
Previously: [48477], [48405], [48400], [48121], [48122], [48124], [48142], [48566]
Props: desrosj, SergeyBiryukov, johnjamesjacoby
Fixes: #50413
Built from https://develop.svn.wordpress.org/trunk@48575
git-svn-id: http://core.svn.wordpress.org/trunk@48337 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 05:14:06 +02:00
/*
* Until a proper _deprecated_option () function can be introduced ,
* redirect requests to deprecated keys to the new , correct ones .
*/
$deprecated_keys = array (
'blacklist_keys' => 'disallowed_keys' ,
'comment_whitelist' => 'comment_previously_approved' ,
);
if ( ! wp_installing () && isset ( $deprecated_keys [ $option ] ) ) {
_deprecated_argument (
__FUNCTION__ ,
'5.5.0' ,
sprintf (
/* translators: 1: Deprecated option key, 2: New option key. */
__ ( 'The "%1$s" option key has been renamed to "%2$s".' ),
$option ,
$deprecated_keys [ $option ]
)
);
return add_option ( $deprecated_keys [ $option ], $value , $deprecated , $autoload );
}
2011-12-20 00:15:32 +01:00
wp_protect_special_option ( $option );
2017-12-01 00:11:00 +01:00
if ( is_object ( $value ) ) {
2011-12-20 00:15:32 +01:00
$value = clone $value ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
$value = sanitize_option ( $option , $value );
2020-01-29 01:45:18 +01:00
// Make sure the option doesn't already exist.
// We can check the 'notoptions' cache before we ask for a DB query.
2011-12-20 00:15:32 +01:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
if ( ! is_array ( $notoptions ) || ! isset ( $notoptions [ $option ] ) ) {
2015-02-18 20:14:27 +01:00
/** This filter is documented in wp-includes/option.php */
2017-12-01 00:11:00 +01:00
if ( apply_filters ( " default_option_ { $option } " , false , $option , false ) !== get_option ( $option ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
}
2011-12-20 00:15:32 +01:00
2013-10-02 22:43:10 +02:00
$serialized_value = maybe_serialize ( $value );
2017-12-01 00:11:00 +01:00
$autoload = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes' ;
2014-03-03 00:35:13 +01:00
/**
* Fires before an option is added .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the option to add .
* @ param mixed $value Value of the option .
*/
2013-10-02 22:43:10 +02:00
do_action ( 'add_option' , $option , $value );
$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 , $serialized_value , $autoload ) );
2017-12-01 00:11:00 +01:00
if ( ! $result ) {
2013-10-02 22:43:10 +02:00
return false ;
2017-12-01 00:11:00 +01:00
}
2013-10-02 22:43:10 +02:00
Use `wp_installing()` instead of `WP_INSTALLING` constant.
The `WP_INSTALLING` constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.
A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during `wpmu_create_blog()` -
for the "installing" flag to be set after WP has already loaded. In these
cases, `WP_INSTALLING` would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where `WP_INSTALLING`
was set the first time a site was created, and remained set for the rest of the
suite.
The new `wp_installing()` function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean `true` or `false`). Use of
the `WP_INSTALLING` constant is still supported; `wp_installing()` will default
to `true` if the constant is defined during the bootstrap.
Props boonebgorges, jeremyfelt.
See #31130.
Built from https://develop.svn.wordpress.org/trunk@34828
git-svn-id: http://core.svn.wordpress.org/trunk@34793 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-05 17:06:28 +02:00
if ( ! wp_installing () ) {
2020-05-16 20:42:12 +02:00
if ( 'yes' === $autoload ) {
Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
See #31245.
Built from https://develop.svn.wordpress.org/trunk@46753
git-svn-id: http://core.svn.wordpress.org/trunk@46553 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-20 14:42:03 +01:00
$alloptions = wp_load_alloptions ( true );
2013-10-02 22:43:10 +02:00
$alloptions [ $option ] = $serialized_value ;
2011-12-20 00:15:32 +01:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
} else {
2013-10-02 22:43:10 +02:00
wp_cache_set ( $option , $serialized_value , 'options' );
2011-12-20 00:15:32 +01:00
}
}
2020-01-29 01:45:18 +01:00
// This option exists now.
$notoptions = wp_cache_get ( 'notoptions' , 'options' ); // Yes, again... we need it to be fresh.
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
2011-12-20 00:15:32 +01:00
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
}
2014-03-03 00:35:13 +01:00
/**
* Fires after a specific option has been added .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.5 . 0 As " add_option_ { $name } "
* @ since 3.0 . 0
*
* @ param string $option Name of the option to add .
* @ param mixed $value Value of the option .
*/
2013-10-02 22:43:10 +02:00
do_action ( " add_option_ { $option } " , $option , $value );
2014-03-03 00:35:13 +01:00
/**
* Fires after an option has been added .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the added option .
* @ param mixed $value Value of the option .
*/
2013-10-02 22:43:10 +02:00
do_action ( 'added_option' , $option , $value );
2020-06-27 18:56:02 +02:00
2013-10-02 22:43:10 +02:00
return true ;
2011-12-20 00:15:32 +01:00
}
/**
* Removes option by name . Prevents removal of protected WordPress options .
*
* @ since 1.2 . 0
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to delete . Expected to not be SQL - escaped .
* @ return bool True if the option was deleted , false otherwise .
2011-12-20 00:15:32 +01:00
*/
function delete_option ( $option ) {
global $wpdb ;
Options, Meta APIs: Fix "passing null to non-nullable" deprecations to `(get|add|update|delete)_option()`.
In all four of the `get_option()`, `add_option()`, `update_option()` and `delete_option()` functions, the `$option` parameter (i.e. the option name) is passed to the PHP native `trim()` function without prior input validation.
In PHP 8.1, this could lead to a `trim(): Passing null to parameter #1 ($string) of type string is deprecated` for each of these functions.
`trim()`:
- expects a text string and is only useful when ''passed'' a text string as no other variable type can contain whitespace.
- will always return a `string`, which means that in practice for any non-string values passed, it would effectively function as a type cast to string.
This commit:
- Adds a check to verify the `$option` name is a scalar before processing it with `trim()`.
- The "type cast" behavior is maintained.
- If the given `$option` name is not a scalar, such as `null`, the fix prevents the PHP 8.1 deprecation notice.
- Tests are added for valid but undesired option names to safeguard against regressions.
This issue is already covered by:
- the existing `Tests_Option_Option::test_bad_option_names()` test group.
- the new `test_valid_but_undesired_option_names()` tests.
Follow-up to [13858], [22633], [23510], [25002], [51817].
Props jrf, hellofromTonya, pbearne.
See #53635.
Built from https://develop.svn.wordpress.org/trunk@51818
git-svn-id: http://core.svn.wordpress.org/trunk@51425 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-16 00:19:58 +02:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-12-01 00:11:00 +01:00
if ( empty ( $option ) ) {
2013-02-28 17:49:20 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
2013-02-28 17:49:20 +01:00
2011-12-20 00:15:32 +01:00
wp_protect_special_option ( $option );
2020-01-29 01:45:18 +01:00
// Get the ID, if no ID then return.
2011-12-20 00:15:32 +01:00
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT autoload FROM $wpdb->options WHERE option_name = %s " , $option ) );
2017-12-01 00:11:00 +01:00
if ( is_null ( $row ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2017-12-01 00:11:00 +01:00
}
2014-03-03 00:35:13 +01:00
/**
* Fires immediately before an option is deleted .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the option to delete .
*/
2011-12-20 00:15:32 +01:00
do_action ( 'delete_option' , $option );
2014-03-03 00:35:13 +01:00
2012-03-24 16:24:31 +01:00
$result = $wpdb -> delete ( $wpdb -> options , array ( 'option_name' => $option ) );
2020-06-27 18:56:02 +02:00
Use `wp_installing()` instead of `WP_INSTALLING` constant.
The `WP_INSTALLING` constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.
A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during `wpmu_create_blog()` -
for the "installing" flag to be set after WP has already loaded. In these
cases, `WP_INSTALLING` would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where `WP_INSTALLING`
was set the first time a site was created, and remained set for the rest of the
suite.
The new `wp_installing()` function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean `true` or `false`). Use of
the `WP_INSTALLING` constant is still supported; `wp_installing()` will default
to `true` if the constant is defined during the bootstrap.
Props boonebgorges, jeremyfelt.
See #31130.
Built from https://develop.svn.wordpress.org/trunk@34828
git-svn-id: http://core.svn.wordpress.org/trunk@34793 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-05 17:06:28 +02:00
if ( ! wp_installing () ) {
2020-05-16 20:42:12 +02:00
if ( 'yes' === $row -> autoload ) {
Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
See #31245.
Built from https://develop.svn.wordpress.org/trunk@46753
git-svn-id: http://core.svn.wordpress.org/trunk@46553 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-11-20 14:42:03 +01:00
$alloptions = wp_load_alloptions ( true );
2017-12-01 00:11:00 +01:00
if ( is_array ( $alloptions ) && isset ( $alloptions [ $option ] ) ) {
unset ( $alloptions [ $option ] );
2011-12-20 00:15:32 +01:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
}
} else {
wp_cache_delete ( $option , 'options' );
}
}
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
if ( $result ) {
2014-03-03 00:35:13 +01:00
/**
* Fires after a specific option has been deleted .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
*
* @ param string $option Name of the deleted option .
*/
2016-08-22 20:25:31 +02:00
do_action ( " delete_option_ { $option } " , $option );
2014-03-03 00:35:13 +01:00
/**
* Fires after an option has been deleted .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the deleted option .
*/
2011-12-20 00:15:32 +01:00
do_action ( 'deleted_option' , $option );
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
return true ;
}
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
return false ;
}
/**
2020-02-23 02:07:08 +01:00
* Deletes a transient .
2011-12-20 00:15:32 +01:00
*
* @ since 2.8 . 0
*
* @ param string $transient Transient name . Expected to not be SQL - escaped .
2020-07-05 16:46:03 +02:00
* @ return bool True if the transient was deleted , false otherwise .
2011-12-20 00:15:32 +01:00
*/
function delete_transient ( $transient ) {
2014-03-03 00:35:13 +01:00
/**
* Fires immediately before a specific transient is deleted .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
*
* @ param string $transient Transient name .
*/
2016-08-22 20:25:31 +02:00
do_action ( " delete_transient_ { $transient } " , $transient );
2011-12-20 00:15:32 +01:00
2022-02-09 00:30:03 +01:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
$result = wp_cache_delete ( $transient , 'transient' );
} else {
$option_timeout = '_transient_timeout_' . $transient ;
2017-12-01 00:11:00 +01:00
$option = '_transient_' . $transient ;
$result = delete_option ( $option );
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
if ( $result ) {
2011-12-20 00:15:32 +01:00
delete_option ( $option_timeout );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
}
2014-03-03 00:35:13 +01:00
if ( $result ) {
/**
* Fires after a transient is deleted .
*
* @ since 3.0 . 0
*
* @ param string $transient Deleted transient name .
*/
2011-12-20 00:15:32 +01:00
do_action ( 'deleted_transient' , $transient );
2014-03-03 00:35:13 +01:00
}
2011-12-20 00:15:32 +01:00
return $result ;
}
/**
2020-02-23 02:07:08 +01:00
* Retrieves the value of a transient .
2011-12-20 00:15:32 +01:00
*
2014-06-05 17:34:14 +02:00
* If the transient does not exist , does not have a value , or has expired ,
* then the return value will be false .
2011-12-20 00:15:32 +01:00
*
* @ since 2.8 . 0
*
2014-06-05 17:34:14 +02:00
* @ param string $transient Transient name . Expected to not be SQL - escaped .
* @ return mixed Value of transient .
2011-12-20 00:15:32 +01:00
*/
function get_transient ( $transient ) {
2014-03-03 00:35:13 +01:00
2015-08-25 23:42:20 +02:00
/**
2020-06-27 18:56:02 +02:00
* Filters the value of an existing transient before it is retrieved .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
2020-06-26 20:49:09 +02:00
* Returning a truthy value from the filter will effectively short - circuit retrieval
2020-06-27 18:56:02 +02:00
* and return the passed value instead .
2014-03-03 00:35:13 +01:00
*
* @ since 2.8 . 0
2015-08-28 17:25:21 +02:00
* @ since 4.4 . 0 The `$transient` parameter was added
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $pre_transient The default value to return if the transient does not exist .
* Any value other than false will short - circuit the retrieval
2020-06-27 18:56:02 +02:00
* of the transient , and return that value .
2015-08-25 23:42:20 +02:00
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
$pre = apply_filters ( " pre_transient_ { $transient } " , false , $transient );
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
if ( false !== $pre ) {
2011-12-20 00:15:32 +01:00
return $pre ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2022-02-09 00:30:03 +01:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
$value = wp_cache_get ( $transient , 'transient' );
} else {
$transient_option = '_transient_' . $transient ;
Use `wp_installing()` instead of `WP_INSTALLING` constant.
The `WP_INSTALLING` constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.
A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during `wpmu_create_blog()` -
for the "installing" flag to be set after WP has already loaded. In these
cases, `WP_INSTALLING` would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where `WP_INSTALLING`
was set the first time a site was created, and remained set for the rest of the
suite.
The new `wp_installing()` function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean `true` or `false`). Use of
the `WP_INSTALLING` constant is still supported; `wp_installing()` will default
to `true` if the constant is defined during the bootstrap.
Props boonebgorges, jeremyfelt.
See #31130.
Built from https://develop.svn.wordpress.org/trunk@34828
git-svn-id: http://core.svn.wordpress.org/trunk@34793 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-05 17:06:28 +02:00
if ( ! wp_installing () ) {
2020-01-29 01:45:18 +01:00
// If option is not in alloptions, it is not autoloaded and thus has a timeout.
2011-12-20 00:15:32 +01:00
$alloptions = wp_load_alloptions ();
2017-12-01 00:11:00 +01:00
if ( ! isset ( $alloptions [ $transient_option ] ) ) {
2011-12-20 00:15:32 +01:00
$transient_timeout = '_transient_timeout_' . $transient ;
2017-12-01 00:11:00 +01:00
$timeout = get_option ( $transient_timeout );
2015-07-07 18:45:26 +02:00
if ( false !== $timeout && $timeout < time () ) {
2017-12-01 00:11:00 +01:00
delete_option ( $transient_option );
2011-12-20 00:15:32 +01:00
delete_option ( $transient_timeout );
2013-08-21 21:14:09 +02:00
$value = false ;
2011-12-20 00:15:32 +01:00
}
}
}
2017-12-01 00:11:00 +01:00
if ( ! isset ( $value ) ) {
2013-08-21 21:14:09 +02:00
$value = get_option ( $transient_option );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
}
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters an existing transient ' s value .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.8 . 0
2015-08-28 17:27:20 +02:00
* @ since 4.4 . 0 The `$transient` parameter was added
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $value Value of transient .
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
return apply_filters ( " transient_ { $transient } " , $value , $transient );
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Sets / updates the value of a transient .
2011-12-20 00:15:32 +01:00
*
2020-02-23 02:07:08 +01:00
* You do not need to serialize values . If the value needs to be serialized ,
* then it will be serialized before it is set .
2011-12-20 00:15:32 +01:00
*
* @ since 2.8 . 0
*
2020-04-22 12:31:09 +02:00
* @ param string $transient Transient name . Expected to not be SQL - escaped .
* Must be 172 characters or fewer in length .
2014-06-11 18:33:15 +02:00
* @ param mixed $value Transient value . Must be serializable if non - scalar .
* Expected to not be SQL - escaped .
2015-10-13 23:31:25 +02:00
* @ param int $expiration Optional . Time until expiration in seconds . Default 0 ( no expiration ) .
2020-07-05 16:46:03 +02:00
* @ return bool True if the value was set , false otherwise .
2011-12-20 00:15:32 +01:00
*/
function set_transient ( $transient , $value , $expiration = 0 ) {
2014-03-03 00:35:13 +01:00
2015-02-11 18:12:26 +01:00
$expiration = ( int ) $expiration ;
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters a specific transient before its value is set .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2015-08-28 17:29:21 +02:00
* @ since 4.2 . 0 The `$expiration` parameter was added .
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $value New value of transient .
* @ param int $expiration Time until expiration in seconds .
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
$value = apply_filters ( " pre_set_transient_ { $transient } " , $value , $expiration , $transient );
2011-12-20 00:15:32 +01:00
2015-10-06 16:10:25 +02:00
/**
2016-05-22 20:34:26 +02:00
* Filters the expiration for a transient before its value is set .
2015-10-06 16:10:25 +02:00
*
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
*
* @ since 4.4 . 0
*
2015-10-13 23:31:25 +02:00
* @ param int $expiration Time until expiration in seconds . Use 0 for no expiration .
2015-10-06 19:59:25 +02:00
* @ param mixed $value New value of transient .
2015-10-06 16:10:25 +02:00
* @ param string $transient Transient name .
*/
2016-08-22 20:25:31 +02:00
$expiration = apply_filters ( " expiration_of_transient_ { $transient } " , $expiration , $value , $transient );
2015-10-06 16:10:25 +02:00
2022-02-09 00:30:03 +01:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
$result = wp_cache_set ( $transient , $value , 'transient' , $expiration );
} else {
$transient_timeout = '_transient_timeout_' . $transient ;
2017-12-01 00:11:00 +01:00
$transient_option = '_transient_' . $transient ;
2020-06-27 18:56:02 +02:00
2015-10-29 12:52:28 +01:00
if ( false === get_option ( $transient_option ) ) {
2011-12-20 00:15:32 +01:00
$autoload = 'yes' ;
if ( $expiration ) {
$autoload = 'no' ;
add_option ( $transient_timeout , time () + $expiration , '' , 'no' );
}
2015-10-29 12:52:28 +01:00
$result = add_option ( $transient_option , $value , '' , $autoload );
2011-12-20 00:15:32 +01:00
} else {
2014-03-25 19:23:14 +01:00
// If expiration is requested, but the transient has no timeout option,
// delete, then re-create transient rather than update.
$update = true ;
2020-06-27 18:56:02 +02:00
2014-03-25 19:23:14 +01:00
if ( $expiration ) {
if ( false === get_option ( $transient_timeout ) ) {
2015-10-29 12:52:28 +01:00
delete_option ( $transient_option );
2014-03-25 19:23:14 +01:00
add_option ( $transient_timeout , time () + $expiration , '' , 'no' );
2015-10-29 12:52:28 +01:00
$result = add_option ( $transient_option , $value , '' , 'no' );
2014-03-25 19:23:14 +01:00
$update = false ;
} else {
update_option ( $transient_timeout , time () + $expiration );
}
}
2020-06-27 18:56:02 +02:00
2014-03-25 19:23:14 +01:00
if ( $update ) {
2015-10-29 12:52:28 +01:00
$result = update_option ( $transient_option , $value );
2014-03-25 19:23:14 +01:00
}
2011-12-20 00:15:32 +01:00
}
}
2014-03-03 00:35:13 +01:00
2011-12-20 00:15:32 +01:00
if ( $result ) {
2014-03-03 00:35:13 +01:00
/**
* Fires after the value for a specific transient has been set .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2015-10-12 23:02:25 +02:00
* @ since 3.6 . 0 The `$value` and `$expiration` parameters were added .
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-10-12 23:02:25 +02:00
* @ param mixed $value Transient value .
2015-10-13 23:31:25 +02:00
* @ param int $expiration Time until expiration in seconds .
2015-10-12 23:02:25 +02:00
* @ param string $transient The name of the transient .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
do_action ( " set_transient_ { $transient } " , $value , $expiration , $transient );
2014-03-03 00:35:13 +01:00
/**
* Fires after the value for a transient has been set .
*
* @ since 3.0 . 0
2015-10-12 23:02:25 +02:00
* @ since 3.6 . 0 The `$value` and `$expiration` parameters were added .
2014-03-03 00:35:13 +01:00
*
* @ param string $transient The name of the transient .
* @ param mixed $value Transient value .
2015-10-13 23:31:25 +02:00
* @ param int $expiration Time until expiration in seconds .
2014-03-03 00:35:13 +01:00
*/
2013-06-16 06:06:12 +02:00
do_action ( 'setted_transient' , $transient , $value , $expiration );
2011-12-20 00:15:32 +01:00
}
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
return $result ;
}
2017-10-21 15:22:49 +02:00
/**
* Deletes all expired transients .
*
* The multi - table delete syntax is used to delete the transient record
2017-10-25 01:00:47 +02:00
* from table a , and the corresponding transient_timeout record from table b .
2017-10-21 15:22:49 +02:00
*
* @ since 4.9 . 0
*
* @ param bool $force_db Optional . Force cleanup to run against the database even when an external object cache is used .
*/
2017-10-25 01:00:47 +02:00
function delete_expired_transients ( $force_db = false ) {
2017-10-21 15:22:49 +02:00
global $wpdb ;
if ( ! $force_db && wp_using_ext_object_cache () ) {
return ;
}
2017-12-01 00:11:00 +01:00
$wpdb -> query (
$wpdb -> prepare (
" DELETE a, b FROM { $wpdb -> options } a, { $wpdb -> options } b
2017-10-21 15:22:49 +02:00
WHERE a . option_name LIKE % s
AND a . option_name NOT LIKE % s
AND b . option_name = CONCAT ( '_transient_timeout_' , SUBSTRING ( a . option_name , 12 ) )
AND b . option_value < % d " ,
2017-12-01 00:11:00 +01:00
$wpdb -> esc_like ( '_transient_' ) . '%' ,
$wpdb -> esc_like ( '_transient_timeout_' ) . '%' ,
time ()
)
);
2017-10-21 15:22:49 +02:00
if ( ! is_multisite () ) {
2020-01-29 01:45:18 +01:00
// Single site stores site transients in the options table.
2017-12-01 00:11:00 +01:00
$wpdb -> query (
$wpdb -> prepare (
" DELETE a, b FROM { $wpdb -> options } a, { $wpdb -> options } b
2017-10-21 15:22:49 +02:00
WHERE a . option_name LIKE % s
AND a . option_name NOT LIKE % s
AND b . option_name = CONCAT ( '_site_transient_timeout_' , SUBSTRING ( a . option_name , 17 ) )
AND b . option_value < % d " ,
2017-12-01 00:11:00 +01:00
$wpdb -> esc_like ( '_site_transient_' ) . '%' ,
$wpdb -> esc_like ( '_site_transient_timeout_' ) . '%' ,
time ()
)
);
2017-10-21 15:22:49 +02:00
} elseif ( is_multisite () && is_main_site () && is_main_network () ) {
// Multisite stores site transients in the sitemeta table.
2017-12-01 00:11:00 +01:00
$wpdb -> query (
$wpdb -> prepare (
" DELETE a, b FROM { $wpdb -> sitemeta } a, { $wpdb -> sitemeta } b
2017-10-21 15:22:49 +02:00
WHERE a . meta_key LIKE % s
AND a . meta_key NOT LIKE % s
AND b . meta_key = CONCAT ( '_site_transient_timeout_' , SUBSTRING ( a . meta_key , 17 ) )
AND b . meta_value < % d " ,
2017-12-01 00:11:00 +01:00
$wpdb -> esc_like ( '_site_transient_' ) . '%' ,
$wpdb -> esc_like ( '_site_transient_timeout_' ) . '%' ,
time ()
)
);
2017-10-21 15:22:49 +02:00
}
}
2011-12-20 00:15:32 +01:00
/**
* Saves and restores user interface settings stored in a cookie .
*
* Checks if the current user - settings cookie is updated and stores it . When no
* cookie exists ( different browser used ), adds the last saved cookie restoring
* the settings .
*
* @ since 2.7 . 0
*/
function wp_user_settings () {
2016-08-23 16:33:30 +02:00
if ( ! is_admin () || wp_doing_ajax () ) {
2011-12-20 00:15:32 +01:00
return ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2019-07-03 01:42:58 +02:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-20 00:15:32 +01:00
return ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2017-01-20 18:33:41 +01:00
if ( ! is_user_member_of_blog () ) {
2012-10-17 20:58:09 +02:00
return ;
2014-08-02 22:09:16 +02:00
}
2012-10-17 20:58:09 +02:00
2013-08-23 23:43:09 +02:00
$settings = ( string ) get_user_option ( 'user-settings' , $user_id );
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
if ( isset ( $_COOKIE [ 'wp-settings-' . $user_id ] ) ) {
$cookie = preg_replace ( '/[^A-Za-z0-9=&_]/' , '' , $_COOKIE [ 'wp-settings-' . $user_id ] );
2011-12-20 00:15:32 +01:00
2020-01-29 01:45:18 +01:00
// No change or both empty.
2017-12-01 00:11:00 +01:00
if ( $cookie == $settings ) {
2013-08-23 23:43:09 +02:00
return ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2013-08-23 23:43:09 +02:00
$last_saved = ( int ) get_user_option ( 'user-settings-time' , $user_id );
2017-12-01 00:11:00 +01:00
$current = isset ( $_COOKIE [ 'wp-settings-time-' . $user_id ] ) ? preg_replace ( '/[^0-9]/' , '' , $_COOKIE [ 'wp-settings-time-' . $user_id ] ) : 0 ;
2011-12-20 00:15:32 +01:00
2020-01-29 01:45:18 +01:00
// The cookie is newer than the saved value. Update the user_option and leave the cookie as-is.
2013-08-23 23:43:09 +02:00
if ( $current > $last_saved ) {
update_user_option ( $user_id , 'user-settings' , $cookie , false );
update_user_option ( $user_id , 'user-settings-time' , time () - 5 , false );
return ;
2011-12-20 00:15:32 +01:00
}
}
2013-08-23 23:43:09 +02:00
// The cookie is not set in the current browser or the saved value is newer.
2015-10-08 05:05:25 +02:00
$secure = ( 'https' === parse_url ( admin_url (), PHP_URL_SCHEME ) );
2014-08-13 04:47:16 +02:00
setcookie ( 'wp-settings-' . $user_id , $settings , time () + YEAR_IN_SECONDS , SITECOOKIEPATH , null , $secure );
setcookie ( 'wp-settings-time-' . $user_id , time (), time () + YEAR_IN_SECONDS , SITECOOKIEPATH , null , $secure );
2017-12-01 00:11:00 +01:00
$_COOKIE [ 'wp-settings-' . $user_id ] = $settings ;
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Retrieves user interface setting value based on setting name .
2011-12-20 00:15:32 +01:00
*
* @ since 2.7 . 0
*
2021-01-05 18:16:11 +01:00
* @ param string $name The name of the setting .
* @ param string | false $default Optional . Default value to return when $name is not set . Default false .
2020-07-05 16:46:03 +02:00
* @ return mixed The last saved user setting or the default value / false if it doesn ' t exist .
2011-12-20 00:15:32 +01:00
*/
function get_user_setting ( $name , $default = false ) {
2013-08-23 23:43:09 +02:00
$all_user_settings = get_all_user_settings ();
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
return isset ( $all_user_settings [ $name ] ) ? $all_user_settings [ $name ] : $default ;
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Adds or updates user interface setting .
2011-12-20 00:15:32 +01:00
*
2019-08-27 03:17:55 +02:00
* Both $name and $value can contain only ASCII letters , numbers , hyphens , and underscores .
2016-04-20 17:47:26 +02:00
*
2011-12-20 00:15:32 +01:00
* This function has to be used before any output has started as it calls setcookie () .
*
* @ since 2.8 . 0
*
2015-05-27 00:17:25 +02:00
* @ param string $name The name of the setting .
2011-12-20 00:15:32 +01:00
* @ param string $value The value for the setting .
2020-07-05 16:46:03 +02:00
* @ return bool | null True if set successfully , false otherwise .
* Null if the current user is not a member of the site .
2011-12-20 00:15:32 +01:00
*/
function set_user_setting ( $name , $value ) {
2014-08-02 22:09:16 +02:00
if ( headers_sent () ) {
2011-12-20 00:15:32 +01:00
return false ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
$all_user_settings = get_all_user_settings ();
$all_user_settings [ $name ] = $value ;
2011-12-20 00:15:32 +01:00
2013-08-23 23:43:09 +02:00
return wp_set_all_user_settings ( $all_user_settings );
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Deletes user interface settings .
2011-12-20 00:15:32 +01:00
*
* Deleting settings would reset them to the defaults .
2016-04-20 17:47:26 +02:00
*
2011-12-20 00:15:32 +01:00
* This function has to be used before any output has started as it calls setcookie () .
*
* @ since 2.7 . 0
*
2014-11-30 23:56:25 +01:00
* @ param string $names The name or array of names of the setting to be deleted .
2020-07-05 16:46:03 +02:00
* @ return bool | null True if deleted successfully , false otherwise .
* Null if the current user is not a member of the site .
2011-12-20 00:15:32 +01:00
*/
function delete_user_setting ( $names ) {
2014-08-02 22:09:16 +02:00
if ( headers_sent () ) {
2011-12-20 00:15:32 +01:00
return false ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2013-08-23 23:43:09 +02:00
$all_user_settings = get_all_user_settings ();
2017-12-01 00:11:00 +01:00
$names = ( array ) $names ;
$deleted = false ;
2011-12-20 00:15:32 +01:00
foreach ( $names as $name ) {
2017-12-01 00:11:00 +01:00
if ( isset ( $all_user_settings [ $name ] ) ) {
unset ( $all_user_settings [ $name ] );
2011-12-20 00:15:32 +01:00
$deleted = true ;
}
}
2014-08-02 22:09:16 +02:00
if ( $deleted ) {
2013-08-23 23:43:09 +02:00
return wp_set_all_user_settings ( $all_user_settings );
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
return false ;
}
/**
2020-02-23 02:07:08 +01:00
* Retrieves all user interface settings .
2011-12-20 00:15:32 +01:00
*
* @ since 2.7 . 0
*
2015-05-27 00:17:25 +02:00
* @ global array $_updated_user_settings
*
2020-07-05 16:46:03 +02:00
* @ return array The last saved user settings or empty array .
2011-12-20 00:15:32 +01:00
*/
function get_all_user_settings () {
global $_updated_user_settings ;
2019-07-03 01:42:58 +02:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-20 00:15:32 +01:00
return array ();
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2014-08-02 22:09:16 +02:00
if ( isset ( $_updated_user_settings ) && is_array ( $_updated_user_settings ) ) {
2011-12-20 00:15:32 +01:00
return $_updated_user_settings ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2013-08-23 23:43:09 +02:00
$user_settings = array ();
2011-12-20 00:15:32 +01:00
2017-12-01 00:11:00 +01:00
if ( isset ( $_COOKIE [ 'wp-settings-' . $user_id ] ) ) {
$cookie = preg_replace ( '/[^A-Za-z0-9=&_-]/' , '' , $_COOKIE [ 'wp-settings-' . $user_id ] );
2011-12-20 00:15:32 +01:00
2020-01-29 01:45:18 +01:00
if ( strpos ( $cookie , '=' ) ) { // '=' cannot be 1st char.
2014-08-13 04:47:16 +02:00
parse_str ( $cookie , $user_settings );
}
2011-12-20 00:15:32 +01:00
} else {
2013-08-23 23:43:09 +02:00
$option = get_user_option ( 'user-settings' , $user_id );
2014-08-13 04:47:16 +02:00
if ( $option && is_string ( $option ) ) {
2013-08-23 23:43:09 +02:00
parse_str ( $option , $user_settings );
2014-08-13 04:47:16 +02:00
}
2011-12-20 00:15:32 +01:00
}
2013-08-23 23:43:09 +02:00
$_updated_user_settings = $user_settings ;
return $user_settings ;
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Private . Sets all user interface settings .
2011-12-20 00:15:32 +01:00
*
* @ since 2.8 . 0
2016-04-20 17:45:29 +02:00
* @ access private
2011-12-20 00:15:32 +01:00
*
2015-05-27 00:17:25 +02:00
* @ global array $_updated_user_settings
*
2016-04-20 17:45:29 +02:00
* @ param array $user_settings User settings .
2020-07-05 16:46:03 +02:00
* @ return bool | null True if set successfully , false if the current user could not be found .
* Null if the current user is not a member of the site .
2011-12-20 00:15:32 +01:00
*/
2013-08-23 23:43:09 +02:00
function wp_set_all_user_settings ( $user_settings ) {
2011-12-20 00:15:32 +01:00
global $_updated_user_settings ;
2019-07-03 01:42:58 +02:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-20 00:15:32 +01:00
return false ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2017-01-20 18:33:41 +01:00
if ( ! is_user_member_of_blog () ) {
2012-10-17 20:58:09 +02:00
return ;
2014-08-02 22:09:16 +02:00
}
2012-10-17 20:58:09 +02:00
2011-12-20 00:15:32 +01:00
$settings = '' ;
2013-08-23 23:43:09 +02:00
foreach ( $user_settings as $name => $value ) {
2017-12-01 00:11:00 +01:00
$_name = preg_replace ( '/[^A-Za-z0-9_-]+/' , '' , $name );
2015-09-01 05:57:21 +02:00
$_value = preg_replace ( '/[^A-Za-z0-9_-]+/' , '' , $value );
2013-08-23 23:43:09 +02:00
2014-08-02 22:09:16 +02:00
if ( ! empty ( $_name ) ) {
2013-08-23 23:43:09 +02:00
$settings .= $_name . '=' . $_value . '&' ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
}
2014-08-02 22:09:16 +02:00
$settings = rtrim ( $settings , '&' );
2013-08-23 23:43:09 +02:00
parse_str ( $settings , $_updated_user_settings );
2011-12-20 00:15:32 +01:00
2013-08-23 23:43:09 +02:00
update_user_option ( $user_id , 'user-settings' , $settings , false );
update_user_option ( $user_id , 'user-settings-time' , time (), false );
2011-12-20 00:15:32 +01:00
return true ;
}
/**
2020-02-23 02:07:08 +01:00
* Deletes the user settings of the current user .
2011-12-20 00:15:32 +01:00
*
* @ since 2.7 . 0
*/
function delete_all_user_settings () {
2019-07-03 01:42:58 +02:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-20 00:15:32 +01:00
return ;
2014-08-02 22:09:16 +02:00
}
2011-12-20 00:15:32 +01:00
2013-08-23 23:43:09 +02:00
update_user_option ( $user_id , 'user-settings' , '' , false );
2014-08-13 04:47:16 +02:00
setcookie ( 'wp-settings-' . $user_id , ' ' , time () - YEAR_IN_SECONDS , SITECOOKIEPATH );
2011-12-20 00:15:32 +01:00
}
/**
2015-10-02 20:01:27 +02:00
* Retrieve an option value for the current network based on name of option .
2011-12-20 00:15:32 +01:00
*
* @ since 2.8 . 0
2015-10-02 21:32:30 +02:00
* @ since 4.4 . 0 The `$use_cache` parameter was deprecated .
2015-10-02 20:01:27 +02:00
* @ since 4.4 . 0 Modified into wrapper for get_network_option ()
*
* @ see get_network_option ()
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to retrieve . Expected to not be SQL - escaped .
* @ param mixed $default Optional . Value to return if the option doesn ' t exist . Default false .
2015-10-02 20:01:27 +02:00
* @ param bool $deprecated Whether to use cache . Multisite only . Always set to true .
* @ return mixed Value set for the option .
*/
function get_site_option ( $option , $default = false , $deprecated = true ) {
2015-10-12 00:44:27 +02:00
return get_network_option ( null , $option , $default );
2015-10-02 20:01:27 +02:00
}
/**
2020-02-23 02:07:08 +01:00
* Adds a new option for the current network .
2015-10-02 20:01:27 +02:00
*
* Existing options will not be updated . Note that prior to 3.3 this wasn ' t the case .
*
* @ since 2.8 . 0
* @ since 4.4 . 0 Modified into wrapper for add_network_option ()
*
* @ see add_network_option ()
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to add . Expected to not be SQL - escaped .
2015-10-02 20:01:27 +02:00
* @ param mixed $value Option value , can be anything . Expected to not be SQL - escaped .
2020-07-05 16:46:03 +02:00
* @ return bool True if the option was added , false otherwise .
2015-10-02 20:01:27 +02:00
*/
function add_site_option ( $option , $value ) {
2015-10-12 00:44:27 +02:00
return add_network_option ( null , $option , $value );
2015-10-02 20:01:27 +02:00
}
/**
* Removes a option by name for the current network .
*
* @ since 2.8 . 0
* @ since 4.4 . 0 Modified into wrapper for delete_network_option ()
*
* @ see delete_network_option ()
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to delete . Expected to not be SQL - escaped .
* @ return bool True if the option was deleted , false otherwise .
2015-10-02 20:01:27 +02:00
*/
function delete_site_option ( $option ) {
2015-10-12 00:44:27 +02:00
return delete_network_option ( null , $option );
2015-10-02 20:01:27 +02:00
}
/**
2020-02-23 02:07:08 +01:00
* Updates the value of an option that was already added for the current network .
2015-10-02 20:01:27 +02:00
*
* @ since 2.8 . 0
* @ since 4.4 . 0 Modified into wrapper for update_network_option ()
*
* @ see update_network_option ()
*
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option . Expected to not be SQL - escaped .
2015-10-02 20:01:27 +02:00
* @ param mixed $value Option value . Expected to not be SQL - escaped .
2020-07-05 16:46:03 +02:00
* @ return bool True if the value was updated , false otherwise .
2015-10-02 20:01:27 +02:00
*/
function update_site_option ( $option , $value ) {
2015-10-12 00:44:27 +02:00
return update_network_option ( null , $option , $value );
2015-10-02 20:01:27 +02:00
}
/**
2020-02-23 02:07:08 +01:00
* Retrieves a network ' s option value based on the option name .
2015-10-02 20:01:27 +02:00
*
* @ since 4.4 . 0
2011-12-20 00:15:32 +01:00
*
2014-03-03 00:35:13 +01:00
* @ see get_option ()
2011-12-20 00:15:32 +01:00
*
2019-01-08 07:00:50 +01:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2020-07-23 23:11:05 +02:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
* @ param string $option Name of the option to retrieve . Expected to not be SQL - escaped .
* @ param mixed $default Optional . Value to return if the option doesn ' t exist . Default false .
2011-12-20 00:15:32 +01:00
* @ return mixed Value set for the option .
*/
2015-10-12 00:44:27 +02:00
function get_network_option ( $network_id , $option , $default = false ) {
2016-10-19 06:47:30 +02:00
global $wpdb ;
2015-10-02 20:01:27 +02:00
2015-10-12 01:30:24 +02:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 20:01:27 +02:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 06:47:30 +02:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 20:01:27 +02:00
}
2011-12-20 00:15:32 +01:00
2014-03-03 00:35:13 +01:00
/**
2020-06-27 18:56:02 +02:00
* Filters the value of an existing network option before it is retrieved .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
2020-06-26 20:49:09 +02:00
* Returning a truthy value from the filter will effectively short - circuit retrieval
* and return the passed value instead .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As 'pre_site_option_' . $key
* @ since 3.0 . 0
2016-10-19 06:54:29 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2017-07-06 17:12:44 +02:00
* @ since 4.9 . 0 The `$default` parameter was added .
2014-03-03 00:35:13 +01:00
*
2020-06-27 18:56:02 +02:00
* @ param mixed $pre_option The value to return instead of the option value . This differs
* from `$default` , which is used as the fallback value in the event
* the option doesn ' t exist elsewhere in get_network_option () .
* Default false ( to skip past the short - circuit ) .
2015-08-25 23:42:20 +02:00
* @ param string $option Option name .
2016-10-19 06:54:29 +02:00
* @ param int $network_id ID of the network .
2017-07-06 17:12:44 +02:00
* @ param mixed $default The fallback value to return if the option does not exist .
2020-06-27 18:56:02 +02:00
* Default false .
2014-03-03 00:35:13 +01:00
*/
2017-07-06 17:12:44 +02:00
$pre = apply_filters ( " pre_site_option_ { $option } " , false , $option , $network_id , $default );
2014-03-03 00:35:13 +01:00
2015-10-02 20:01:27 +02:00
if ( false !== $pre ) {
return $pre ;
}
2011-12-20 00:15:32 +01:00
2020-01-29 01:45:18 +01:00
// Prevent non-existent options from triggering multiple queries.
2015-10-02 20:01:27 +02:00
$notoptions_key = " $network_id :notoptions " ;
2017-12-01 00:11:00 +01:00
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
2014-03-03 00:35:13 +01:00
2018-03-13 16:37:33 +01:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters a specific default network option .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.4 . 0
2015-08-28 17:31:21 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
2016-10-19 06:54:29 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 06:54:29 +02:00
* @ param mixed $default The value to return if the site option does not exist
* in the database .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 06:54:29 +02:00
return apply_filters ( " default_site_option_ { $option } " , $default , $option , $network_id );
2014-03-03 00:35:13 +01:00
}
2013-08-17 00:42:09 +02:00
2012-05-14 19:00:13 +02:00
if ( ! is_multisite () ) {
2014-03-03 00:35:13 +01:00
/** This filter is documented in wp-includes/option.php */
2016-10-19 06:54:29 +02:00
$default = apply_filters ( 'default_site_option_' . $option , $default , $option , $network_id );
2017-12-01 00:11:00 +01:00
$value = get_option ( $option , $default );
2011-12-20 00:15:32 +01:00
} else {
2015-10-02 20:01:27 +02:00
$cache_key = " $network_id : $option " ;
2017-12-01 00:11:00 +01:00
$value = wp_cache_get ( $cache_key , 'site-options' );
2011-12-20 00:15:32 +01:00
2015-10-02 20:01:27 +02:00
if ( ! isset ( $value ) || false === $value ) {
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d " , $option , $network_id ) );
2011-12-20 00:15:32 +01:00
2020-01-29 01:45:18 +01:00
// Has to be get_row() instead of get_var() because of funkiness with 0, false, null values.
2011-12-20 00:15:32 +01:00
if ( is_object ( $row ) ) {
$value = $row -> meta_value ;
$value = maybe_unserialize ( $value );
wp_cache_set ( $cache_key , $value , 'site-options' );
} else {
2015-06-25 21:01:26 +02:00
if ( ! is_array ( $notoptions ) ) {
2015-10-02 20:01:27 +02:00
$notoptions = array ();
2015-06-25 21:01:26 +02:00
}
2020-06-27 18:56:02 +02:00
2015-10-02 20:01:27 +02:00
$notoptions [ $option ] = true ;
2013-11-21 20:07:10 +01:00
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
2014-03-03 00:35:13 +01:00
/** This filter is documented in wp-includes/option.php */
2016-10-19 06:54:29 +02:00
$value = apply_filters ( 'default_site_option_' . $option , $default , $option , $network_id );
2011-12-20 00:15:32 +01:00
}
}
}
2018-03-13 16:37:33 +01:00
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
}
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the value of an existing network option .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As 'site_option_' . $key
* @ since 3.0 . 0
2016-10-19 06:54:29 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 06:54:29 +02:00
* @ param mixed $value Value of network option .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 06:54:29 +02:00
return apply_filters ( " site_option_ { $option } " , $value , $option , $network_id );
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Adds a new network option .
2011-12-20 00:15:32 +01:00
*
2015-10-02 20:01:27 +02:00
* Existing options will not be updated .
2011-12-20 00:15:32 +01:00
*
2015-10-02 20:01:27 +02:00
* @ since 4.4 . 0
2011-12-20 00:15:32 +01:00
*
2014-03-03 00:35:13 +01:00
* @ see add_option ()
2011-12-20 00:15:32 +01:00
*
2019-01-08 07:00:50 +01:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2015-10-12 00:44:27 +02:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to add . Expected to not be SQL - escaped .
2015-10-12 00:44:27 +02:00
* @ param mixed $value Option value , can be anything . Expected to not be SQL - escaped .
2020-07-05 16:46:03 +02:00
* @ return bool True if the option was added , false otherwise .
2011-12-20 00:15:32 +01:00
*/
2015-10-12 00:44:27 +02:00
function add_network_option ( $network_id , $option , $value ) {
2016-10-19 06:47:30 +02:00
global $wpdb ;
2015-10-02 20:01:27 +02:00
2015-10-12 01:30:24 +02:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 20:01:27 +02:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 06:47:30 +02:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 20:01:27 +02:00
}
2011-12-20 00:15:32 +01:00
2013-08-17 00:42:09 +02:00
wp_protect_special_option ( $option );
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the value of a specific network option before it is added .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As 'pre_add_site_option_' . $key
* @ since 3.0 . 0
2016-10-19 06:56:28 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 06:56:28 +02:00
* @ param mixed $value Value of network option .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 06:56:28 +02:00
$value = apply_filters ( " pre_add_site_option_ { $option } " , $value , $option , $network_id );
2014-03-03 00:35:13 +01:00
2015-10-02 20:01:27 +02:00
$notoptions_key = " $network_id :notoptions " ;
2011-12-20 00:15:32 +01:00
2015-10-02 20:01:27 +02:00
if ( ! is_multisite () ) {
2016-04-16 21:48:27 +02:00
$result = add_option ( $option , $value , '' , 'no' );
2011-12-20 00:15:32 +01:00
} else {
2015-10-02 20:01:27 +02:00
$cache_key = " $network_id : $option " ;
2011-12-20 00:15:32 +01:00
2020-01-29 01:45:18 +01:00
// Make sure the option doesn't already exist.
// We can check the 'notoptions' cache before we ask for a DB query.
2013-11-21 20:07:10 +01:00
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
2020-06-27 18:56:02 +02:00
2015-10-02 20:01:27 +02:00
if ( ! is_array ( $notoptions ) || ! isset ( $notoptions [ $option ] ) ) {
2015-10-12 00:44:27 +02:00
if ( false !== get_network_option ( $network_id , $option , false ) ) {
2013-08-17 00:42:09 +02:00
return false ;
2015-10-02 20:01:27 +02:00
}
}
2011-12-20 00:15:32 +01:00
$value = sanitize_option ( $option , $value );
2013-08-17 00:42:09 +02:00
2013-10-02 22:43:10 +02:00
$serialized_value = maybe_serialize ( $value );
2017-12-01 00:11:00 +01:00
$result = $wpdb -> insert (
2018-08-17 03:51:36 +02:00
$wpdb -> sitemeta ,
array (
2017-12-01 00:11:00 +01:00
'site_id' => $network_id ,
'meta_key' => $option ,
'meta_value' => $serialized_value ,
)
);
2011-12-20 00:15:32 +01:00
2015-10-02 20:01:27 +02:00
if ( ! $result ) {
2013-10-02 22:43:10 +02:00
return false ;
2015-10-02 20:01:27 +02:00
}
2013-10-02 22:43:10 +02:00
wp_cache_set ( $cache_key , $value , 'site-options' );
2013-08-17 00:42:09 +02:00
2020-01-29 01:45:18 +01:00
// This option exists now.
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' ); // Yes, again... we need it to be fresh.
2020-06-27 18:56:02 +02:00
2015-10-02 20:01:27 +02:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
2013-11-21 20:07:10 +01:00
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
2013-08-17 00:42:09 +02:00
}
2011-12-20 00:15:32 +01:00
}
if ( $result ) {
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires after a specific network option has been successfully added .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As " add_site_option_ { $key } "
* @ since 3.0 . 0
2016-10-19 06:56:28 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 06:56:28 +02:00
* @ param string $option Name of the network option .
* @ param mixed $value Value of the network option .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 06:56:28 +02:00
do_action ( " add_site_option_ { $option } " , $option , $value , $network_id );
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires after a network option has been successfully added .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2016-10-19 06:56:28 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 06:56:28 +02:00
* @ param string $option Name of the network option .
* @ param mixed $value Value of the network option .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 06:56:28 +02:00
do_action ( 'add_site_option' , $option , $value , $network_id );
2014-03-03 00:35:13 +01:00
2011-12-20 00:15:32 +01:00
return true ;
}
2015-10-02 20:01:27 +02:00
2011-12-20 00:15:32 +01:00
return false ;
}
/**
2015-10-02 20:01:27 +02:00
* Removes a network option by name .
2011-12-20 00:15:32 +01:00
*
2015-10-02 20:01:27 +02:00
* @ since 4.4 . 0
2011-12-20 00:15:32 +01:00
*
2014-03-03 00:35:13 +01:00
* @ see delete_option ()
2011-12-20 00:15:32 +01:00
*
2019-01-08 07:00:50 +01:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2015-10-12 00:44:27 +02:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
2020-07-05 16:46:03 +02:00
* @ param string $option Name of the option to delete . Expected to not be SQL - escaped .
* @ return bool True if the option was deleted , false otherwise .
2011-12-20 00:15:32 +01:00
*/
2015-10-12 00:44:27 +02:00
function delete_network_option ( $network_id , $option ) {
2016-10-19 06:47:30 +02:00
global $wpdb ;
2015-10-02 20:01:27 +02:00
2015-10-12 01:30:24 +02:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 20:01:27 +02:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 06:47:30 +02:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 20:01:27 +02:00
}
2011-12-20 00:15:32 +01:00
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires immediately before a specific network option is deleted .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2016-10-19 07:02:29 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2015-08-25 23:42:20 +02:00
*
2016-10-19 07:02:29 +02:00
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 07:02:29 +02:00
do_action ( " pre_delete_site_option_ { $option } " , $option , $network_id );
2011-12-20 00:15:32 +01:00
2015-10-02 20:01:27 +02:00
if ( ! is_multisite () ) {
2011-12-20 00:15:32 +01:00
$result = delete_option ( $option );
} else {
2015-10-02 20:01:27 +02:00
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT meta_id FROM { $wpdb -> sitemeta } WHERE meta_key = %s AND site_id = %d " , $option , $network_id ) );
if ( is_null ( $row ) || ! $row -> meta_id ) {
2011-12-20 00:15:32 +01:00
return false ;
2015-10-02 20:01:27 +02:00
}
$cache_key = " $network_id : $option " ;
2011-12-20 00:15:32 +01:00
wp_cache_delete ( $cache_key , 'site-options' );
2017-12-01 00:11:00 +01:00
$result = $wpdb -> delete (
2018-08-17 03:51:36 +02:00
$wpdb -> sitemeta ,
array (
2017-12-01 00:11:00 +01:00
'meta_key' => $option ,
'site_id' => $network_id ,
)
);
2011-12-20 00:15:32 +01:00
}
if ( $result ) {
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires after a specific network option has been deleted .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As " delete_site_option_ { $key } "
* @ since 3.0 . 0
2016-10-19 07:02:29 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 07:02:29 +02:00
* @ param string $option Name of the network option .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 07:02:29 +02:00
do_action ( " delete_site_option_ { $option } " , $option , $network_id );
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires after a network option has been deleted .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2016-10-19 07:02:29 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 07:02:29 +02:00
* @ param string $option Name of the network option .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 07:02:29 +02:00
do_action ( 'delete_site_option' , $option , $network_id );
2014-03-03 00:35:13 +01:00
2011-12-20 00:15:32 +01:00
return true ;
}
2015-10-02 20:01:27 +02:00
2011-12-20 00:15:32 +01:00
return false ;
}
/**
2020-02-23 02:07:08 +01:00
* Updates the value of a network option that was already added .
2011-12-20 00:15:32 +01:00
*
2015-10-02 20:01:27 +02:00
* @ since 4.4 . 0
2011-12-20 00:15:32 +01:00
*
2014-03-03 00:35:13 +01:00
* @ see update_option ()
2011-12-20 00:15:32 +01:00
*
2019-01-08 07:00:50 +01:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-27 00:17:25 +02:00
*
2020-07-23 23:11:05 +02:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
* @ param string $option Name of the option . Expected to not be SQL - escaped .
* @ param mixed $value Option value . Expected to not be SQL - escaped .
2020-07-05 16:46:03 +02:00
* @ return bool True if the value was updated , false otherwise .
2011-12-20 00:15:32 +01:00
*/
2015-10-12 00:44:27 +02:00
function update_network_option ( $network_id , $option , $value ) {
2016-10-19 06:47:30 +02:00
global $wpdb ;
2015-10-02 20:01:27 +02:00
2015-10-12 01:30:24 +02:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 20:01:27 +02:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 06:47:30 +02:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 20:01:27 +02:00
}
2011-12-20 00:15:32 +01:00
2013-08-17 00:42:09 +02:00
wp_protect_special_option ( $option );
2015-10-12 00:44:27 +02:00
$old_value = get_network_option ( $network_id , $option , false );
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters a specific network option before its value is updated .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As 'pre_update_site_option_' . $key
* @ since 3.0 . 0
2016-10-19 07:00:29 +02:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 07:00:29 +02:00
* @ param mixed $value New value of the network option .
* @ param mixed $old_value Old value of the network option .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 07:00:29 +02:00
$value = apply_filters ( " pre_update_site_option_ { $option } " , $value , $old_value , $option , $network_id );
2011-12-20 00:15:32 +01:00
2019-01-21 05:27:51 +01:00
/*
* If the new and old values are the same , no need to update .
*
* Unserialized values will be adequate in most cases . If the unserialized
* data differs , the ( maybe ) serialized data is checked to avoid
* unnecessary database calls for otherwise identical object instances .
*
* See https :// core . trac . wordpress . org / ticket / 44956
*/
if ( $value === $old_value || maybe_serialize ( $value ) === maybe_serialize ( $old_value ) ) {
2011-12-20 00:15:32 +01:00
return false ;
2015-10-02 20:01:27 +02:00
}
2011-12-20 00:15:32 +01:00
2015-10-02 20:01:27 +02:00
if ( false === $old_value ) {
2015-10-12 00:44:27 +02:00
return add_network_option ( $network_id , $option , $value );
2015-10-02 20:01:27 +02:00
}
2011-12-20 00:15:32 +01:00
2015-10-02 20:01:27 +02:00
$notoptions_key = " $network_id :notoptions " ;
2017-12-01 00:11:00 +01:00
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
2020-06-27 18:56:02 +02:00
2015-10-02 20:01:27 +02:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
2013-11-21 20:07:10 +01:00
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
2013-08-17 00:42:09 +02:00
}
2015-10-02 20:01:27 +02:00
if ( ! is_multisite () ) {
2016-04-16 21:48:27 +02:00
$result = update_option ( $option , $value , 'no' );
2011-12-20 00:15:32 +01:00
} else {
$value = sanitize_option ( $option , $value );
2013-10-02 22:43:10 +02:00
$serialized_value = maybe_serialize ( $value );
2017-12-01 00:11:00 +01:00
$result = $wpdb -> update (
2018-08-17 03:51:36 +02:00
$wpdb -> sitemeta ,
array ( 'meta_value' => $serialized_value ),
array (
2017-12-01 00:11:00 +01:00
'site_id' => $network_id ,
'meta_key' => $option ,
)
);
2013-10-02 22:43:10 +02:00
if ( $result ) {
2015-10-02 20:01:27 +02:00
$cache_key = " $network_id : $option " ;
2013-10-02 22:43:10 +02:00
wp_cache_set ( $cache_key , $value , 'site-options' );
}
2011-12-20 00:15:32 +01:00
}
if ( $result ) {
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires after the value of a specific network option has been successfully updated .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0 As " update_site_option_ { $key } "
* @ since 3.0 . 0
2016-10-19 07:00:29 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 07:00:29 +02:00
* @ param string $option Name of the network option .
* @ param mixed $value Current value of the network option .
* @ param mixed $old_value Old value of the network option .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 07:00:29 +02:00
do_action ( " update_site_option_ { $option } " , $option , $value , $old_value , $network_id );
2014-03-03 00:35:13 +01:00
/**
2015-10-02 20:01:27 +02:00
* Fires after the value of a network option has been successfully updated .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2016-10-19 07:00:29 +02:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-03 00:35:13 +01:00
*
2016-10-19 07:00:29 +02:00
* @ param string $option Name of the network option .
* @ param mixed $value Current value of the network option .
* @ param mixed $old_value Old value of the network option .
* @ param int $network_id ID of the network .
2014-03-03 00:35:13 +01:00
*/
2016-10-19 07:00:29 +02:00
do_action ( 'update_site_option' , $option , $value , $old_value , $network_id );
2014-03-03 00:35:13 +01:00
2011-12-20 00:15:32 +01:00
return true ;
}
2015-10-02 20:01:27 +02:00
2011-12-20 00:15:32 +01:00
return false ;
}
/**
2020-02-23 02:07:08 +01:00
* Deletes a site transient .
2011-12-20 00:15:32 +01:00
*
* @ since 2.9 . 0
*
* @ param string $transient Transient name . Expected to not be SQL - escaped .
2020-07-05 16:46:03 +02:00
* @ return bool True if the transient was deleted , false otherwise .
2011-12-20 00:15:32 +01:00
*/
function delete_site_transient ( $transient ) {
2014-03-03 00:35:13 +01:00
/**
* Fires immediately before a specific site transient is deleted .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
*
* @ param string $transient Transient name .
*/
2016-08-22 20:25:31 +02:00
do_action ( " delete_site_transient_ { $transient } " , $transient );
2014-03-03 00:35:13 +01:00
2022-02-09 00:30:03 +01:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
$result = wp_cache_delete ( $transient , 'site-transient' );
} else {
$option_timeout = '_site_transient_timeout_' . $transient ;
2017-12-01 00:11:00 +01:00
$option = '_site_transient_' . $transient ;
$result = delete_site_option ( $option );
2020-06-27 18:56:02 +02:00
2017-12-01 00:11:00 +01:00
if ( $result ) {
2015-10-07 19:11:25 +02:00
delete_site_option ( $option_timeout );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
}
2020-06-27 18:56:02 +02:00
2014-03-03 00:35:13 +01:00
if ( $result ) {
/**
* Fires after a transient is deleted .
*
* @ since 3.0 . 0
*
* @ param string $transient Deleted transient name .
*/
2011-12-20 00:15:32 +01:00
do_action ( 'deleted_site_transient' , $transient );
2014-03-03 00:35:13 +01:00
}
2011-12-20 00:15:32 +01:00
return $result ;
}
/**
2020-02-23 02:07:08 +01:00
* Retrieves the value of a site transient .
2011-12-20 00:15:32 +01:00
*
2014-06-05 17:34:14 +02:00
* If the transient does not exist , does not have a value , or has expired ,
* then the return value will be false .
2011-12-20 00:15:32 +01:00
*
* @ since 2.9 . 0
*
2014-03-03 00:35:13 +01:00
* @ see get_transient ()
2011-12-20 00:15:32 +01:00
*
* @ param string $transient Transient name . Expected to not be SQL - escaped .
2014-06-05 17:34:14 +02:00
* @ return mixed Value of transient .
2011-12-20 00:15:32 +01:00
*/
function get_site_transient ( $transient ) {
2014-03-03 00:35:13 +01:00
/**
2020-06-27 18:56:02 +02:00
* Filters the value of an existing site transient before it is retrieved .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
2020-06-26 20:49:09 +02:00
* Returning a truthy value from the filter will effectively short - circuit retrieval
* and return the passed value instead .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0
2015-10-06 19:59:25 +02:00
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $pre_site_transient The default value to return if the site transient does not exist .
* Any value other than false will short - circuit the retrieval
2020-06-27 18:56:02 +02:00
* of the transient , and return that value .
2015-08-25 23:42:20 +02:00
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
$pre = apply_filters ( " pre_site_transient_ { $transient } " , false , $transient );
2014-03-03 00:35:13 +01:00
2017-12-01 00:11:00 +01:00
if ( false !== $pre ) {
2011-12-20 00:15:32 +01:00
return $pre ;
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
2022-02-09 00:30:03 +01:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
$value = wp_cache_get ( $transient , 'site-transient' );
} else {
// Core transients that do not have a timeout. Listed here so querying timeouts can be avoided.
2017-12-01 00:11:00 +01:00
$no_timeout = array ( 'update_core' , 'update_plugins' , 'update_themes' );
2011-12-20 00:15:32 +01:00
$transient_option = '_site_transient_' . $transient ;
2020-04-05 05:02:11 +02:00
if ( ! in_array ( $transient , $no_timeout , true ) ) {
2011-12-20 00:15:32 +01:00
$transient_timeout = '_site_transient_timeout_' . $transient ;
2017-12-01 00:11:00 +01:00
$timeout = get_site_option ( $transient_timeout );
2011-12-20 00:15:32 +01:00
if ( false !== $timeout && $timeout < time () ) {
2017-12-01 00:11:00 +01:00
delete_site_option ( $transient_option );
2015-10-07 19:11:25 +02:00
delete_site_option ( $transient_timeout );
2013-08-21 21:14:09 +02:00
$value = false ;
2011-12-20 00:15:32 +01:00
}
}
2017-12-01 00:11:00 +01:00
if ( ! isset ( $value ) ) {
2015-10-07 19:11:25 +02:00
$value = get_site_option ( $transient_option );
2017-12-01 00:11:00 +01:00
}
2011-12-20 00:15:32 +01:00
}
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the value of an existing site transient .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 2.9 . 0
2015-10-06 19:59:25 +02:00
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $value Value of site transient .
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
return apply_filters ( " site_transient_ { $transient } " , $value , $transient );
2011-12-20 00:15:32 +01:00
}
/**
2020-02-23 02:07:08 +01:00
* Sets / updates the value of a site transient .
2011-12-20 00:15:32 +01:00
*
2020-02-23 02:07:08 +01:00
* You do not need to serialize values . If the value needs to be serialized ,
* then it will be serialized before it is set .
2011-12-20 00:15:32 +01:00
*
* @ since 2.9 . 0
*
2014-03-03 00:35:13 +01:00
* @ see set_transient ()
2011-12-20 00:15:32 +01:00
*
2014-06-11 18:33:15 +02:00
* @ param string $transient Transient name . Expected to not be SQL - escaped . Must be
2017-04-15 11:28:43 +02:00
* 167 characters or fewer in length .
2014-06-11 18:33:15 +02:00
* @ param mixed $value Transient value . Expected to not be SQL - escaped .
2015-10-13 23:31:25 +02:00
* @ param int $expiration Optional . Time until expiration in seconds . Default 0 ( no expiration ) .
2020-07-05 16:46:03 +02:00
* @ return bool True if the value was set , false otherwise .
2011-12-20 00:15:32 +01:00
*/
function set_site_transient ( $transient , $value , $expiration = 0 ) {
2014-03-03 00:35:13 +01:00
/**
2016-05-22 20:34:26 +02:00
* Filters the value of a specific site transient before it is set .
2014-03-03 00:35:13 +01:00
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2015-10-06 19:59:25 +02:00
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-03 00:35:13 +01:00
*
2015-10-06 19:59:25 +02:00
* @ param mixed $value New value of site transient .
2015-08-25 23:42:20 +02:00
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
$value = apply_filters ( " pre_set_site_transient_ { $transient } " , $value , $transient );
2014-03-03 00:35:13 +01:00
2013-09-16 19:43:09 +02:00
$expiration = ( int ) $expiration ;
2011-12-20 00:15:32 +01:00
2015-10-06 16:10:25 +02:00
/**
2016-05-22 20:34:26 +02:00
* Filters the expiration for a site transient before its value is set .
2015-10-06 16:10:25 +02:00
*
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
*
* @ since 4.4 . 0
*
2015-10-13 23:31:25 +02:00
* @ param int $expiration Time until expiration in seconds . Use 0 for no expiration .
2015-10-06 19:59:25 +02:00
* @ param mixed $value New value of site transient .
2015-10-06 16:10:25 +02:00
* @ param string $transient Transient name .
*/
2016-08-22 20:25:31 +02:00
$expiration = apply_filters ( " expiration_of_site_transient_ { $transient } " , $expiration , $value , $transient );
2015-10-06 16:10:25 +02:00
2022-02-09 00:30:03 +01:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-20 00:15:32 +01:00
$result = wp_cache_set ( $transient , $value , 'site-transient' , $expiration );
} else {
$transient_timeout = '_site_transient_timeout_' . $transient ;
2017-12-01 00:11:00 +01:00
$option = '_site_transient_' . $transient ;
2020-06-27 18:56:02 +02:00
2015-10-07 19:11:25 +02:00
if ( false === get_site_option ( $option ) ) {
2017-12-01 00:11:00 +01:00
if ( $expiration ) {
2015-10-07 19:11:25 +02:00
add_site_option ( $transient_timeout , time () + $expiration );
2017-12-01 00:11:00 +01:00
}
2015-10-07 19:11:25 +02:00
$result = add_site_option ( $option , $value );
2011-12-20 00:15:32 +01:00
} else {
2017-12-01 00:11:00 +01:00
if ( $expiration ) {
2015-10-07 19:11:25 +02:00
update_site_option ( $transient_timeout , time () + $expiration );
2017-12-01 00:11:00 +01:00
}
2015-10-07 19:11:25 +02:00
$result = update_site_option ( $option , $value );
2011-12-20 00:15:32 +01:00
}
}
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
if ( $result ) {
2014-03-03 00:35:13 +01:00
/**
* Fires after the value for a specific site transient has been set .
*
2014-11-30 12:53:22 +01:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-03 00:35:13 +01:00
*
* @ since 3.0 . 0
2015-08-28 17:41:21 +02:00
* @ since 4.4 . 0 The `$transient` parameter was added
2014-03-03 00:35:13 +01:00
*
2015-08-25 23:42:20 +02:00
* @ param mixed $value Site transient value .
2015-10-13 23:31:25 +02:00
* @ param int $expiration Time until expiration in seconds .
2015-08-25 23:42:20 +02:00
* @ param string $transient Transient name .
2014-03-03 00:35:13 +01:00
*/
2016-08-22 20:25:31 +02:00
do_action ( " set_site_transient_ { $transient } " , $value , $expiration , $transient );
2014-03-03 00:35:13 +01:00
/**
* Fires after the value for a site transient has been set .
*
* @ since 3.0 . 0
*
* @ param string $transient The name of the site transient .
* @ param mixed $value Site transient value .
2015-10-13 23:31:25 +02:00
* @ param int $expiration Time until expiration in seconds .
2014-03-03 00:35:13 +01:00
*/
2013-06-16 06:06:12 +02:00
do_action ( 'setted_site_transient' , $transient , $value , $expiration );
2011-12-20 00:15:32 +01:00
}
2020-06-27 18:56:02 +02:00
2011-12-20 00:15:32 +01:00
return $result ;
2015-10-06 19:59:25 +02:00
}
2016-09-30 17:53:29 +02:00
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
/**
2020-02-23 02:07:08 +01:00
* Registers default settings available in WordPress .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*
* The settings registered here are primarily useful for the REST API , so this
* does not encompass all settings available in WordPress .
*
* @ since 4.7 . 0
*/
function register_initial_settings () {
2017-12-01 00:11:00 +01:00
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'blogname' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'name' => 'title' ,
),
'type' => 'string' ,
'description' => __ ( 'Site title.' ),
)
);
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
2017-12-01 00:11:00 +01:00
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'blogdescription' ,
array (
2016-12-03 06:16:44 +01:00
'show_in_rest' => array (
2017-12-01 00:11:00 +01:00
'name' => 'description' ,
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
),
2016-12-03 06:16:44 +01:00
'type' => 'string' ,
2017-12-01 00:11:00 +01:00
'description' => __ ( 'Site tagline.' ),
)
);
if ( ! is_multisite () ) {
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'siteurl' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'name' => 'url' ,
'schema' => array (
'format' => 'uri' ,
),
),
'type' => 'string' ,
'description' => __ ( 'Site URL.' ),
)
);
2016-12-03 06:16:44 +01:00
}
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
2016-12-03 06:39:42 +01:00
if ( ! is_multisite () ) {
2017-12-01 00:11:00 +01:00
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'admin_email' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'name' => 'email' ,
'schema' => array (
'format' => 'email' ,
),
2016-12-03 06:39:42 +01:00
),
2017-12-01 00:11:00 +01:00
'type' => 'string' ,
'description' => __ ( 'This address is used for admin purposes, like new user notification.' ),
)
);
}
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'timezone_string' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'name' => 'timezone' ,
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
),
2016-12-03 06:39:42 +01:00
'type' => 'string' ,
2017-12-01 00:11:00 +01:00
'description' => __ ( 'A city in the same timezone as you.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'date_format' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'string' ,
'description' => __ ( 'A date format for all date strings.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'time_format' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'string' ,
'description' => __ ( 'A time format for all time strings.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'start_of_week' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'integer' ,
'description' => __ ( 'A day number of the week that the week should start on.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'general' ,
'WPLANG' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'name' => 'language' ,
),
'type' => 'string' ,
'description' => __ ( 'WordPress locale code.' ),
'default' => 'en_US' ,
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'writing' ,
'use_smilies' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'boolean' ,
'description' => __ ( 'Convert emoticons like :-) and :-P to graphics on display.' ),
'default' => true ,
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'writing' ,
'default_category' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'integer' ,
'description' => __ ( 'Default post category.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'writing' ,
'default_post_format' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'string' ,
'description' => __ ( 'Default post format.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'reading' ,
'posts_per_page' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => true ,
'type' => 'integer' ,
'description' => __ ( 'Blog pages show at most.' ),
'default' => 10 ,
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'discussion' ,
'default_ping_status' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'schema' => array (
'enum' => array ( 'open' , 'closed' ),
),
2016-10-27 00:21:01 +02:00
),
2017-12-01 00:11:00 +01:00
'type' => 'string' ,
'description' => __ ( 'Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.' ),
)
);
register_setting (
2018-08-17 03:51:36 +02:00
'discussion' ,
'default_comment_status' ,
array (
2017-12-01 00:11:00 +01:00
'show_in_rest' => array (
'schema' => array (
'enum' => array ( 'open' , 'closed' ),
),
2016-10-27 00:21:01 +02:00
),
2017-12-01 00:11:00 +01:00
'type' => 'string' ,
2019-05-26 20:51:52 +02:00
'description' => __ ( 'Allow people to submit comments on new posts.' ),
2017-12-01 00:11:00 +01:00
)
);
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
2016-09-30 17:53:29 +02:00
/**
2020-02-23 02:07:08 +01:00
* Registers a setting and its data .
2016-09-30 17:53:29 +02:00
*
* @ since 2.7 . 0
2021-09-21 15:22:01 +02:00
* @ since 3.0 . 0 The `misc` option group was deprecated .
* @ since 3.5 . 0 The `privacy` option group was deprecated .
2016-09-30 17:53:29 +02:00
* @ since 4.7 . 0 `$args` can be passed to set flags on the setting , similar to `register_meta()` .
2020-07-14 14:33:02 +02:00
* @ since 5.5 . 0 `$new_whitelist_options` was renamed to `$new_allowed_options` .
* Please consider writing more inclusive code .
2016-09-30 17:53:29 +02:00
*
2020-07-14 14:33:02 +02:00
* @ global array $new_allowed_options
2016-09-30 17:53:29 +02:00
* @ global array $wp_registered_settings
*
General: Remove “whitelist” and “blacklist” in favor of more clear and inclusive language.
“The WordPress open source community cares about diversity. We strive to maintain a welcoming environment where everyone can feel included.”
With this commit, all occurrences of “whitelist” and “blacklist” (with the single exception of the `$new_whitelist_options` global variable) are removed. A new ticket has been opened to explore renaming the `$new_whitelist_options` variable (#50434).
Changing to more specific names or rewording sentences containing these terms not only makes the code more inclusive, but also helps provide clarity. These terms are often ambiguous. What is being blocked or allowed is not always immediately clear. This can make it more difficult for non-native English speakers to read through the codebase.
Words matter. If one contributor feels more welcome because these terms are removed, this was worth the effort.
Props strangerstudios, jorbin, desrosj, joemcgill, timothyblynjacobs, ocean90, ayeshrajans, davidbaumwald, earnjam.
See #48900, #50434.
Fixes #50413.
Built from https://develop.svn.wordpress.org/trunk@48121
git-svn-id: http://core.svn.wordpress.org/trunk@47890 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-22 19:26:13 +02:00
* @ param string $option_group A settings group name . Should correspond to an allowed option key name .
* Default allowed option key names include 'general' , 'discussion' , 'media' ,
2021-09-20 18:20:00 +02:00
* 'reading' , 'writing' , and 'options' .
2016-09-30 17:53:29 +02:00
* @ param string $option_name The name of an option to sanitize and save .
* @ param array $args {
* Data used to describe the setting when registered .
*
2020-02-19 23:56:07 +01:00
* @ type string $type The type of data associated with this setting .
* Valid values are 'string' , 'boolean' , 'integer' , 'number' , 'array' , and 'object' .
* @ type string $description A description of the data attached to this setting .
* @ type callable $sanitize_callback A callback function that sanitizes the option ' s value .
* @ type bool | array $show_in_rest Whether data associated with this setting should be included in the REST API .
* When registering complex settings , this argument may optionally be an
* array with a 'schema' key .
* @ type mixed $default Default value when calling `get_option()` .
2016-09-30 17:53:29 +02:00
* }
*/
function register_setting ( $option_group , $option_name , $args = array () ) {
2020-07-14 14:33:02 +02:00
global $new_allowed_options , $wp_registered_settings ;
/*
* In 5.5 . 0 , the `$new_whitelist_options` global variable was renamed to `$new_allowed_options` .
* Please consider writing more inclusive code .
*/
$GLOBALS [ 'new_whitelist_options' ] = & $new_allowed_options ;
2016-09-30 17:53:29 +02:00
$defaults = array (
'type' => 'string' ,
'group' => $option_group ,
'description' => '' ,
'sanitize_callback' => null ,
'show_in_rest' => false ,
);
// Back-compat: old sanitize callback is added.
if ( is_callable ( $args ) ) {
$args = array (
'sanitize_callback' => $args ,
);
}
/**
* Filters the registration arguments when registering a setting .
*
* @ since 4.7 . 0
*
* @ param array $args Array of setting registration arguments .
* @ param array $defaults Array of default arguments .
* @ param string $option_group Setting group .
* @ param string $option_name Setting name .
*/
$args = apply_filters ( 'register_setting_args' , $args , $defaults , $option_group , $option_name );
2020-06-27 18:56:02 +02:00
2016-09-30 17:53:29 +02:00
$args = wp_parse_args ( $args , $defaults );
2020-02-19 23:56:07 +01:00
// Require an item schema when registering settings with an array type.
if ( false !== $args [ 'show_in_rest' ] && 'array' === $args [ 'type' ] && ( ! is_array ( $args [ 'show_in_rest' ] ) || ! isset ( $args [ 'show_in_rest' ][ 'schema' ][ 'items' ] ) ) ) {
_doing_it_wrong ( __FUNCTION__ , __ ( 'When registering an "array" setting to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.4.0' );
}
2016-09-30 17:53:29 +02:00
if ( ! is_array ( $wp_registered_settings ) ) {
$wp_registered_settings = array ();
}
2020-05-16 20:42:12 +02:00
if ( 'misc' === $option_group ) {
2017-12-01 00:11:00 +01:00
_deprecated_argument (
2018-08-17 03:51:36 +02:00
__FUNCTION__ ,
'3.0.0' ,
2017-12-01 00:11:00 +01:00
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
/* translators: %s: misc */
2017-12-01 00:11:00 +01:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 12:50:41 +01:00
'misc'
)
);
2016-09-30 17:53:29 +02:00
$option_group = 'general' ;
}
2020-05-16 20:42:12 +02:00
if ( 'privacy' === $option_group ) {
2017-12-01 00:11:00 +01:00
_deprecated_argument (
2018-08-17 03:51:36 +02:00
__FUNCTION__ ,
'3.5.0' ,
2017-12-01 00:11:00 +01:00
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
/* translators: %s: privacy */
2017-12-01 00:11:00 +01:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 12:50:41 +01:00
'privacy'
)
);
2016-09-30 17:53:29 +02:00
$option_group = 'reading' ;
}
2020-07-14 14:33:02 +02:00
$new_allowed_options [ $option_group ][] = $option_name ;
2020-07-05 17:07:06 +02:00
2016-09-30 17:53:29 +02:00
if ( ! empty ( $args [ 'sanitize_callback' ] ) ) {
add_filter ( " sanitize_option_ { $option_name } " , $args [ 'sanitize_callback' ] );
}
2016-10-25 19:08:29 +02:00
if ( array_key_exists ( 'default' , $args ) ) {
add_filter ( " default_option_ { $option_name } " , 'filter_default_option' , 10 , 3 );
}
2016-09-30 17:53:29 +02:00
2020-07-05 17:07:06 +02:00
/**
* Fires immediately before the setting is registered but after its filters are in place .
*
* @ since 5.5 . 0
*
* @ param string $option_group Setting group .
* @ param string $option_name Setting name .
* @ param array $args Array of setting registration arguments .
*/
do_action ( 'register_setting' , $option_group , $option_name , $args );
2016-09-30 17:53:29 +02:00
$wp_registered_settings [ $option_name ] = $args ;
}
/**
2020-02-23 02:07:08 +01:00
* Unregisters a setting .
2016-09-30 17:53:29 +02:00
*
* @ since 2.7 . 0
* @ since 4.7 . 0 `$sanitize_callback` was deprecated . The callback from `register_setting()` is now used instead .
2020-07-14 14:33:02 +02:00
* @ since 5.5 . 0 `$new_whitelist_options` was renamed to `$new_allowed_options` .
* Please consider writing more inclusive code .
2016-09-30 17:53:29 +02:00
*
2020-07-14 14:33:02 +02:00
* @ global array $new_allowed_options
2019-01-08 07:00:50 +01:00
* @ global array $wp_registered_settings
2016-09-30 17:53:29 +02:00
*
2021-11-08 11:48:59 +01:00
* @ param string $option_group The settings group name used during registration .
* @ param string $option_name The name of the option to unregister .
* @ param callable $deprecated Optional . Deprecated .
2016-09-30 17:53:29 +02:00
*/
function unregister_setting ( $option_group , $option_name , $deprecated = '' ) {
2020-07-14 14:33:02 +02:00
global $new_allowed_options , $wp_registered_settings ;
/*
* In 5.5 . 0 , the `$new_whitelist_options` global variable was renamed to `$new_allowed_options` .
* Please consider writing more inclusive code .
*/
$GLOBALS [ 'new_whitelist_options' ] = & $new_allowed_options ;
2016-09-30 17:53:29 +02:00
2020-05-16 20:42:12 +02:00
if ( 'misc' === $option_group ) {
2017-12-01 00:11:00 +01:00
_deprecated_argument (
2018-08-17 03:51:36 +02:00
__FUNCTION__ ,
'3.0.0' ,
2017-12-01 00:11:00 +01:00
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
/* translators: %s: misc */
2017-12-01 00:11:00 +01:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 12:50:41 +01:00
'misc'
)
);
2016-09-30 17:53:29 +02:00
$option_group = 'general' ;
}
2020-05-16 20:42:12 +02:00
if ( 'privacy' === $option_group ) {
2017-12-01 00:11:00 +01:00
_deprecated_argument (
2018-08-17 03:51:36 +02:00
__FUNCTION__ ,
'3.5.0' ,
2017-12-01 00:11:00 +01:00
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
/* translators: %s: privacy */
2017-12-01 00:11:00 +01:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 12:50:41 +01:00
'privacy'
)
);
2016-09-30 17:53:29 +02:00
$option_group = 'reading' ;
}
2020-07-14 14:33:02 +02:00
$pos = array_search ( $option_name , ( array ) $new_allowed_options [ $option_group ], true );
2020-07-05 17:07:06 +02:00
2020-02-09 17:55:09 +01:00
if ( false !== $pos ) {
2020-07-14 14:33:02 +02:00
unset ( $new_allowed_options [ $option_group ][ $pos ] );
2016-09-30 17:53:29 +02:00
}
2020-07-05 17:07:06 +02:00
2016-09-30 17:53:29 +02:00
if ( '' !== $deprecated ) {
2017-12-01 00:11:00 +01:00
_deprecated_argument (
2018-08-17 03:51:36 +02:00
__FUNCTION__ ,
'4.7.0' ,
2017-12-01 00:11:00 +01:00
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
/* translators: 1: $sanitize_callback, 2: register_setting() */
2017-12-01 00:11:00 +01:00
__ ( '%1$s is deprecated. The callback from %2$s is used instead.' ),
2017-01-29 12:50:41 +01:00
'<code>$sanitize_callback</code>' ,
'<code>register_setting()</code>'
)
);
2016-09-30 17:53:29 +02:00
remove_filter ( " sanitize_option_ { $option_name } " , $deprecated );
}
if ( isset ( $wp_registered_settings [ $option_name ] ) ) {
// Remove the sanitize callback if one was set during registration.
if ( ! empty ( $wp_registered_settings [ $option_name ][ 'sanitize_callback' ] ) ) {
remove_filter ( " sanitize_option_ { $option_name } " , $wp_registered_settings [ $option_name ][ 'sanitize_callback' ] );
}
2018-02-06 15:49:32 +01:00
// Remove the default filter if a default was provided during registration.
if ( array_key_exists ( 'default' , $wp_registered_settings [ $option_name ] ) ) {
remove_filter ( " default_option_ { $option_name } " , 'filter_default_option' , 10 );
}
2020-07-05 17:07:06 +02:00
/**
* Fires immediately before the setting is unregistered and after its filters have been removed .
*
* @ since 5.5 . 0
*
* @ param string $option_group Setting group .
* @ param string $option_name Setting name .
*/
do_action ( 'unregister_setting' , $option_group , $option_name );
2016-09-30 17:53:29 +02:00
unset ( $wp_registered_settings [ $option_name ] );
}
}
/**
* Retrieves an array of registered settings .
*
* @ since 4.7 . 0
*
2019-01-08 07:00:50 +01:00
* @ global array $wp_registered_settings
*
2016-09-30 17:53:29 +02:00
* @ return array List of registered settings , keyed by option name .
*/
function get_registered_settings () {
global $wp_registered_settings ;
if ( ! is_array ( $wp_registered_settings ) ) {
return array ();
}
return $wp_registered_settings ;
}
2016-10-25 19:08:29 +02:00
/**
2020-02-23 02:07:08 +01:00
* Filters the default value for the option .
2016-10-25 19:08:29 +02:00
*
* For settings which register a default setting in `register_setting()` , this
* function is added as a filter to `default_option_{$option}` .
*
* @ since 4.7 . 0
*
2020-07-23 23:11:05 +02:00
* @ param mixed $default Existing default value to return .
* @ param string $option Option name .
* @ param bool $passed_default Was `get_option()` passed a default value ?
2016-10-25 19:08:29 +02:00
* @ return mixed Filtered default value .
*/
function filter_default_option ( $default , $option , $passed_default ) {
if ( $passed_default ) {
return $default ;
}
$registered = get_registered_settings ();
if ( empty ( $registered [ $option ] ) ) {
return $default ;
}
return $registered [ $option ][ 'default' ];
}