2011-12-19 18:15:32 -05:00
< ? php
/**
* Option API
*
* @ package WordPress
2014-02-25 12:14:14 -05:00
* @ subpackage Option
2011-12-19 18:15:32 -05:00
*/
/**
2016-06-26 13:29:30 -04:00
* Retrieves an option value based on an option name .
2011-12-19 18:15:32 -05:00
*
2021-05-31 20:00:58 -04: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 07:31:58 -04:00
* can be done better by using add_option () which will not overwrite
2021-05-31 20:00:58 -04:00
* existing options .
2011-12-19 18:15:32 -05:00
*
2021-07-03 07:31:58 -04:00
* Not initializing an option and using boolean `false` as a return value
2021-05-31 20:00:58 -04:00
* is a bad practice as it triggers an additional database query .
2011-12-19 18:15:32 -05:00
*
2021-05-31 20:00:58 -04: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 :
2022-04-29 15:24:09 -04:00
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* 1. When the option has not been saved in the database , the `$default_value` value
2021-07-03 07:31:58 -04:00
* is returned if provided . If not , boolean `false` is returned .
2022-04-29 15:24:09 -04:00
* 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-05-31 20:00:58 -04:00
* value may not match the expected type .
2021-07-03 07:31:58 -04:00
* 3. When the option has just been saved in the database , and get_option ()
2021-05-31 20:00:58 -04:00
* is used right after , non - string scalar and null values are not converted to
* string equivalents and the original type is returned .
*
* Examples :
*
2022-04-29 15:24:09 -04:00
* When adding options like this : `add_option( 'my_option_name', 'value' )`
* and then retrieving them with `get_option( 'my_option_name' )` , the returned
2021-05-31 20:00:58 -04:00
* values will be :
*
2022-04-29 15:24:09 -04:00
* - `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) ""`
2021-05-31 20:00:58 -04:00
*
* When adding options with non - scalar values like
2022-04-29 15:24:09 -04:00
* `add_option( 'my_array', array( false, 'str', null ) )` , the returned value
2021-05-31 20:00:58 -04:00
* will be identical to the original as it is serialized before saving
* it in the database :
*
2022-04-29 15:24:09 -04:00
* array ( 3 ) {
* [ 0 ] => bool ( false )
* [ 1 ] => string ( 3 ) " str "
* [ 2 ] => NULL
* }
2016-01-08 22:12:26 -05:00
*
2011-12-19 18:15:32 -05:00
* @ since 1.5 . 0
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ param string $option Name of the option to retrieve . Expected to not be SQL - escaped .
* @ param mixed $default_value Optional . Default value to return if the option does not exist .
2021-05-31 20:00:58 -04: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-19 18:15:32 -05:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
function get_option ( $option , $default_value = false ) {
2011-12-19 18:15:32 -05: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-15 18:19:58 -04:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-11-30 18:11:00 -05:00
if ( empty ( $option ) ) {
2012-11-17 08:20:57 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2012-11-17 08:20:57 -05: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-22 23:14:06 -04: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' ,
);
2022-08-19 20:27:12 -04:00
if ( isset ( $deprecated_keys [ $option ] ) && ! wp_installing () ) {
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-22 23:14:06 -04:00
_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 ]
)
);
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return get_option ( $deprecated_keys [ $option ], $default_value );
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-22 23:14:06 -04:00
}
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters the value of an existing option before it is retrieved .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
2022-08-04 10:52:11 -04:00
* Returning a value other than false from the filter will short - circuit retrieval
* and return that value instead .
2014-03-02 18:35:13 -05:00
*
* @ since 1.5 . 0
2015-08-27 13:00:24 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ since 4.9 . 0 The `$default_value` parameter was added .
*
* @ param mixed $pre_option The value to return instead of the option value . This differs from
* `$default_value` , 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_value The fallback value to return if the option does not exist .
* Default false .
2014-03-02 18:35:13 -05:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
$pre = apply_filters ( " pre_option_ { $option } " , false , $option , $default_value );
2017-07-06 11:12:44 -04:00
2022-09-13 15:29:12 -04:00
/**
* Filters the value of all existing options before it is retrieved .
*
* Returning a truthy value from the filter will effectively short - circuit retrieval
* and return the passed value instead .
*
* @ since 6.1 . 0
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ param mixed $pre_option The value to return instead of the option value . This differs from
* `$default_value` , 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 Name of the option .
* @ param mixed $default_value The fallback value to return if the option does not exist .
* Default false .
2022-09-13 15:29:12 -04:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
$pre = apply_filters ( 'pre_option' , $pre , $option , $default_value );
2022-09-13 15:29:12 -04:00
2017-11-30 18:11:00 -05:00
if ( false !== $pre ) {
2011-12-19 18:15:32 -05:00
return $pre ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2017-11-30 18:11:00 -05:00
if ( defined ( 'WP_SETUP_CONFIG' ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2016-10-25 13:08:29 -04: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 11:06:28 -04:00
if ( ! wp_installing () ) {
2011-12-19 18:15:32 -05:00
$alloptions = wp_load_alloptions ();
2017-11-30 18:11:00 -05:00
if ( isset ( $alloptions [ $option ] ) ) {
$value = $alloptions [ $option ];
2011-12-19 18:15:32 -05:00
} else {
$value = wp_cache_get ( $option , 'options' );
if ( false === $value ) {
2023-09-15 12:15:22 -04:00
// Prevent non-existent options from triggering multiple queries.
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
// Prevent non-existent `notoptions` key from triggering multiple key lookups.
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
} elseif ( isset ( $notoptions [ $option ] ) ) {
/**
* Filters the default value for an option .
*
* The dynamic portion of the hook name , `$option` , refers to the option name .
*
* @ since 3.4 . 0
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value .
*
* @ param mixed $default_value The default value to return if the option does not exist
* in the database .
* @ param string $option Option name .
* @ param bool $passed_default Was `get_option()` passed a default value ?
*/
return apply_filters ( " default_option_ { $option } " , $default_value , $option , $passed_default );
}
2011-12-19 18:15:32 -05:00
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1 " , $option ) );
2020-01-28 19:45:18 -05:00
// Has to be get_row() instead of get_var() because of funkiness with 0, false, null values.
2011-12-19 18:15:32 -05:00
if ( is_object ( $row ) ) {
$value = $row -> option_value ;
wp_cache_add ( $option , $value , 'options' );
2020-01-28 19:45:18 -05:00
} else { // Option does not exist, so we must cache its non-existence.
2017-11-30 18:11:00 -05:00
$notoptions [ $option ] = true ;
2011-12-19 18:15:32 -05:00
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
2014-03-02 18:35:13 -05:00
/** This filter is documented in wp-includes/option.php */
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return apply_filters ( " default_option_ { $option } " , $default_value , $option , $passed_default );
2011-12-19 18:15:32 -05:00
}
}
}
} else {
$suppress = $wpdb -> suppress_errors ();
2017-11-30 18:11:00 -05:00
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1 " , $option ) );
2011-12-19 18:15:32 -05:00
$wpdb -> suppress_errors ( $suppress );
2020-06-27 12:56:02 -04:00
2014-03-02 18:35:13 -05:00
if ( is_object ( $row ) ) {
2011-12-19 18:15:32 -05:00
$value = $row -> option_value ;
2014-03-02 18:35:13 -05:00
} else {
/** This filter is documented in wp-includes/option.php */
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return apply_filters ( " default_option_ { $option } " , $default_value , $option , $passed_default );
2014-03-02 18:35:13 -05:00
}
2011-12-19 18:15:32 -05:00
}
2020-01-28 19:45:18 -05:00
// If home is not set, use siteurl.
2020-05-16 14:42:12 -04:00
if ( 'home' === $option && '' === $value ) {
2011-12-19 18:15:32 -05:00
return get_option ( 'siteurl' );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2020-04-04 23:02:11 -04:00
if ( in_array ( $option , array ( 'siteurl' , 'home' , 'category_base' , 'tag_base' ), true ) ) {
2011-12-19 18:15:32 -05:00
$value = untrailingslashit ( $value );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters the value of an existing option .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 1.5 . 0 As 'option_' . $setting
* @ since 3.0 . 0
2015-08-28 11:20:20 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04: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-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
return apply_filters ( " option_ { $option } " , maybe_unserialize ( $value ), $option );
2011-12-19 18:15:32 -05:00
}
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
/**
2023-10-26 18:56:19 -04:00
* Primes specific options into the cache with a single database query .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
*
2023-10-23 17:29:27 -04:00
* Only options that do not already exist in cache will be loaded .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
*
* @ since 6.4 . 0
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
2023-11-14 07:44:27 -05:00
* @ param string [] $options An array of option names to be loaded .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
*/
2023-10-26 18:56:19 -04:00
function wp_prime_option_caches ( $options ) {
2023-11-14 07:44:27 -05:00
global $wpdb ;
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
$alloptions = wp_load_alloptions ();
$cached_options = wp_cache_get_multiple ( $options , 'options' );
2023-10-30 18:58:24 -04:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
}
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
// Filter options that are not in the cache.
$options_to_prime = array ();
foreach ( $options as $option ) {
2023-10-30 18:58:24 -04:00
if (
( ! isset ( $cached_options [ $option ] ) || false === $cached_options [ $option ] )
&& ! isset ( $alloptions [ $option ] )
&& ! isset ( $notoptions [ $option ] )
) {
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
$options_to_prime [] = $option ;
}
}
2023-10-23 17:29:27 -04:00
// Bail early if there are no options to be loaded.
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
if ( empty ( $options_to_prime ) ) {
return ;
}
$results = $wpdb -> get_results (
$wpdb -> prepare (
sprintf (
" SELECT option_name, option_value FROM $wpdb->options WHERE option_name IN (%s) " ,
implode ( ',' , array_fill ( 0 , count ( $options_to_prime ), '%s' ) )
),
$options_to_prime
)
);
$options_found = array ();
foreach ( $results as $result ) {
2023-10-30 18:58:24 -04:00
/*
* The cache is primed with the raw value ( i . e . not maybe_unserialized ) .
*
* `get_option()` will handle unserializing the value as needed .
*/
$options_found [ $result -> option_name ] = $result -> option_value ;
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
}
wp_cache_set_multiple ( $options_found , 'options' );
// If all options were found, no need to update `notoptions` cache.
if ( count ( $options_found ) === count ( $options_to_prime ) ) {
return ;
}
$options_not_found = array_diff ( $options_to_prime , array_keys ( $options_found ) );
// Add the options that were not found to the cache.
$update_notoptions = false ;
foreach ( $options_not_found as $option_name ) {
if ( ! isset ( $notoptions [ $option_name ] ) ) {
$notoptions [ $option_name ] = true ;
$update_notoptions = true ;
}
}
// Only update the cache if it was modified.
if ( $update_notoptions ) {
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
}
}
/**
2023-10-26 18:56:19 -04:00
* Primes the cache of all options registered with a specific option group .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
*
* @ since 6.4 . 0
*
* @ global array $new_allowed_options
*
2023-10-23 17:29:27 -04:00
* @ param string $option_group The option group to load options for .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
*/
2023-10-26 18:56:19 -04:00
function wp_prime_option_caches_by_group ( $option_group ) {
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
global $new_allowed_options ;
if ( isset ( $new_allowed_options [ $option_group ] ) ) {
2023-10-26 18:56:19 -04:00
wp_prime_option_caches ( $new_allowed_options [ $option_group ] );
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
}
}
/**
* Retrieves multiple options .
*
2023-10-23 17:29:27 -04:00
* Options are loaded as necessary first in order to use a single database query at most .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
*
* @ since 6.4 . 0
*
2023-11-14 07:44:27 -05:00
* @ param string [] $options An array of option names to retrieve .
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
* @ return array An array of key - value pairs for the requested options .
*/
function get_options ( $options ) {
2023-10-26 18:56:19 -04:00
wp_prime_option_caches ( $options );
Options, Meta APIs: Introduce `prime_options()` to load multiple options with a single database request.
WordPress's `get_option()` function generally relies on making individual database requests for each option, however with the majority of options (in most cases) being autoloaded, i.e. fetched once with a single database request and then stored in (memory) cache.
As part of a greater effort to reduce the amount of options that are unnecessarily autoloaded, this changeset introduces an alternative way to retrieve multiple options in a performant manner, with a single database request. This provides a reasonable alternative for e.g. plugins that use several options which only need to be loaded in a few specific screens.
Specifically, this changeset introduces the following functions:
* `prime_options( $options )` is the foundation to load multiple specific options with a single database request. Only options that aren't already cached (in `alloptions` or an individual cache) are retrieved from the database.
* `prime_options_by_group( $option_group )` is a convenience wrapper function for the above which allows to prime all options of a specific option group (as configured via `register_setting()`).
* `get_options( $options )` is another wrapper function which first primes the requested options and then returns them in an associative array, calling `get_option()` for each of them.
Props mukesh27, joemcgill, costdev, olliejones.
Fixes #58962.
Built from https://develop.svn.wordpress.org/trunk@56445
git-svn-id: http://core.svn.wordpress.org/trunk@55957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-24 10:42:17 -04:00
$result = array ();
foreach ( $options as $option ) {
$result [ $option ] = get_option ( $option );
}
return $result ;
}
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
/**
* Sets the autoload values for multiple options in the database .
*
* Autoloading too many options can lead to performance problems , especially if the options are not frequently used .
* This function allows modifying the autoload value for multiple options without changing the actual option value .
* This is for example recommended for plugin activation and deactivation hooks , to ensure any options exclusively used
* by the plugin which are generally autoloaded can be set to not autoload when the plugin is inactive .
*
* @ since 6.4 . 0
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ since 6.7 . 0 The autoload values 'yes' and 'no' are deprecated .
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param array $options Associative array of option names and their autoload values to set . The option names are
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* expected to not be SQL - escaped . The autoload values should be boolean values . For backward
* compatibility 'yes' and 'no' are also accepted , though using these values is deprecated .
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
* @ return array Associative array of all provided $options as keys and boolean values for whether their autoload value
* was updated .
*/
function wp_set_option_autoload_values ( array $options ) {
global $wpdb ;
if ( ! $options ) {
return array ();
}
$grouped_options = array (
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
'on' => array (),
'off' => array (),
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
);
$results = array ();
foreach ( $options as $option => $autoload ) {
wp_protect_special_option ( $option ); // Ensure only valid options can be passed.
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
/*
* Sanitize autoload value and categorize accordingly .
* The values 'yes' , 'no' , 'on' , and 'off' are supported for backward compatibility .
*/
if ( 'off' === $autoload || 'no' === $autoload || false === $autoload ) {
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
$grouped_options [ 'off' ][] = $option ;
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
} else {
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
$grouped_options [ 'on' ][] = $option ;
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
}
$results [ $option ] = false ; // Initialize result value.
}
$where = array ();
$where_args = array ();
foreach ( $grouped_options as $autoload => $options ) {
if ( ! $options ) {
continue ;
}
$placeholders = implode ( ',' , array_fill ( 0 , count ( $options ), '%s' ) );
$where [] = " autoload != '%s' AND option_name IN ( $placeholders ) " ;
$where_args [] = $autoload ;
foreach ( $options as $option ) {
$where_args [] = $option ;
}
}
$where = 'WHERE ' . implode ( ' OR ' , $where );
/*
* Determine the relevant options that do not already use the given autoload value .
* If no options are returned , no need to update .
*/
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare
$options_to_update = $wpdb -> get_col ( $wpdb -> prepare ( " SELECT option_name FROM $wpdb->options $where " , $where_args ) );
if ( ! $options_to_update ) {
return $results ;
}
// Run UPDATE queries as needed (maximum 2) to update the relevant options' autoload values to 'yes' or 'no'.
foreach ( $grouped_options as $autoload => $options ) {
if ( ! $options ) {
continue ;
}
$options = array_intersect ( $options , $options_to_update );
$grouped_options [ $autoload ] = $options ;
if ( ! $grouped_options [ $autoload ] ) {
continue ;
}
// Run query to update autoload value for all the options where it is needed.
$success = $wpdb -> query (
$wpdb -> prepare (
" UPDATE $wpdb->options SET autoload = %s WHERE option_name IN ( " . implode ( ',' , array_fill ( 0 , count ( $grouped_options [ $autoload ] ), '%s' ) ) . ')' ,
array_merge (
array ( $autoload ),
$grouped_options [ $autoload ]
)
)
);
if ( ! $success ) {
// Set option list to an empty array to indicate no options were updated.
$grouped_options [ $autoload ] = array ();
continue ;
}
// Assume that on success all options were updated, which should be the case given only new values are sent.
foreach ( $grouped_options [ $autoload ] as $option ) {
$results [ $option ] = true ;
}
}
/*
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* If any options were changed to 'on' , delete their individual caches , and delete 'alloptions' cache so that it
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
* is refreshed as needed .
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* If no options were changed to 'on' but any options were changed to 'no' , delete them from the 'alloptions'
* cache . This is not necessary when options were changed to 'on' , since in that situation the entire cache is
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
* deleted anyway .
*/
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
if ( $grouped_options [ 'on' ] ) {
wp_cache_delete_multiple ( $grouped_options [ 'on' ], 'options' );
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
wp_cache_delete ( 'alloptions' , 'options' );
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
} elseif ( $grouped_options [ 'off' ] ) {
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
$alloptions = wp_load_alloptions ( true );
2023-11-01 20:04:24 -04:00
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
foreach ( $grouped_options [ 'off' ] as $option ) {
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
if ( isset ( $alloptions [ $option ] ) ) {
unset ( $alloptions [ $option ] );
}
}
2023-11-01 20:04:24 -04:00
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
}
return $results ;
}
/**
* Sets the autoload value for multiple options in the database .
*
* This is a wrapper for { @ see wp_set_option_autoload_values ()}, which can be used to set different autoload values for
* each option at once .
*
* @ since 6.4 . 0
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ since 6.7 . 0 The autoload values 'yes' and 'no' are deprecated .
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
*
* @ see wp_set_option_autoload_values ()
*
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ param string [] $options List of option names . Expected to not be SQL - escaped .
* @ param bool $autoload Autoload value to control whether to load the options when WordPress starts up .
* For backward compatibility 'yes' and 'no' are also accepted , though using these values is
* deprecated .
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
* @ return array Associative array of all provided $options as keys and boolean values for whether their autoload value
* was updated .
*/
function wp_set_options_autoload ( array $options , $autoload ) {
return wp_set_option_autoload_values (
array_fill_keys ( $options , $autoload )
);
}
/**
* Sets the autoload value for an option in the database .
*
* This is a wrapper for { @ see wp_set_option_autoload_values ()}, which can be used to set the autoload value for
* multiple options at once .
*
* @ since 6.4 . 0
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ since 6.7 . 0 The autoload values 'yes' and 'no' are deprecated .
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
*
* @ see wp_set_option_autoload_values ()
*
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ param string $option Name of the option . Expected to not be SQL - escaped .
* @ param bool $autoload Autoload value to control whether to load the option when WordPress starts up .
* For backward compatibility 'yes' and 'no' are also accepted , though using these values is
* deprecated .
Options, Meta APIs: Introduce `wp_set_option_autoload_values()`.
This function accepts an associative array of option names and their autoload values to set, and it will update those values in the database in bulk, only for those options where the autoload field is not already set to the given value.
Two wrapper functions for ease of use accompany the new main function:
* `wp_set_options_autoload( $options, $autoload )` can be used to set multiple options to the same autoload value.
* `wp_set_option_autoload( $option, $autoload )` can be used to set the autoload value for a single option.
All of these functions allow changing the autoload value of an option, which previously has only been possible in combination with updating the value. This limitation prevented some relevant use-cases: For example, a plugin deactivation hook could set all of its options to not autoload, as a cleanup routine, while not actually deleting any data. The plugin's activation hook could then implement the reverse, resetting those options' autoload values to the originally intended ones for when using the plugin.
Props boonebgorges, joemcgill, costdev, mukesh27, SergeyBiryukov, tabrisrp, flixos90.
Fixes #58964.
Built from https://develop.svn.wordpress.org/trunk@56508
git-svn-id: http://core.svn.wordpress.org/trunk@56020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-01 15:57:20 -04:00
* @ return bool True if the autoload value was modified , false otherwise .
*/
function wp_set_option_autoload ( $option , $autoload ) {
$result = wp_set_option_autoload_values ( array ( $option => $autoload ) );
if ( isset ( $result [ $option ] ) ) {
return $result [ $option ];
}
return false ;
}
2011-12-19 18:15:32 -05:00
/**
2020-02-22 20:07:08 -05:00
* Protects WordPress special option from being modified .
2011-12-19 18:15:32 -05: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-11-30 18:11:00 -05: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 13:13:59 -04:00
wp_die (
sprintf (
2019-09-02 20:41:05 -04: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 13:13:59 -04:00
__ ( '%s is a protected WP option and may not be modified' ),
esc_html ( $option )
)
);
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Prints option value after sanitizing for forms .
2011-12-19 18:15:32 -05: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 08:44:02 -05:00
* @ since 5.3 . 1 The `$force_cache` parameter was added .
2011-12-19 18:15:32 -05:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04: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 08:42:03 -05:00
* @ param bool $force_cache Optional . Whether to force an update of the local cache
* from the persistent cache . Default false .
2011-12-19 18:15:32 -05: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 08:42:03 -05:00
function wp_load_alloptions ( $force_cache = false ) {
2011-12-19 18:15:32 -05:00
global $wpdb ;
2023-02-07 07:49:17 -05:00
/**
* Filters the array of alloptions before it is populated .
*
* Returning an array from the filter will effectively short circuit
* wp_load_alloptions (), returning that value instead .
*
* @ since 6.2 . 0
*
* @ param array | null $alloptions An array of alloptions . Default null .
* @ param bool $force_cache Whether to force an update of the local cache from the persistent cache . Default false .
*/
$alloptions = apply_filters ( 'pre_wp_load_alloptions' , null , $force_cache );
if ( is_array ( $alloptions ) ) {
return $alloptions ;
}
2017-09-27 20:23:47 -04: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 08:42:03 -05:00
$alloptions = wp_cache_get ( 'alloptions' , 'options' , $force_cache );
2017-09-27 20:23:47 -04:00
} else {
2011-12-19 18:15:32 -05:00
$alloptions = false ;
2017-09-27 20:23:47 -04:00
}
2011-12-19 18:15:32 -05:00
2017-09-27 20:23:47 -04:00
if ( ! $alloptions ) {
2019-07-02 19:42:58 -04:00
$suppress = $wpdb -> suppress_errors ();
2024-06-10 22:31:13 -04:00
$alloptions_db = $wpdb -> get_results ( " SELECT option_name, option_value FROM $wpdb->options WHERE autoload IN ( ' " . implode ( " ', ' " , esc_sql ( wp_autoload_values_to_autoload () ) ) . " ' ) " );
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
2019-07-02 19:42:58 -04:00
if ( ! $alloptions_db ) {
2011-12-19 18:15:32 -05:00
$alloptions_db = $wpdb -> get_results ( " SELECT option_name, option_value FROM $wpdb->options " );
2017-09-27 20:23:47 -04:00
}
$wpdb -> suppress_errors ( $suppress );
2011-12-19 18:15:32 -05:00
$alloptions = array ();
foreach ( ( array ) $alloptions_db as $o ) {
2017-11-30 18:11:00 -05:00
$alloptions [ $o -> option_name ] = $o -> option_value ;
2011-12-19 18:15:32 -05:00
}
2017-09-27 20:23:47 -04: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 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
wp_cache_add ( 'alloptions' , $alloptions , 'options' );
2017-09-27 20:23:47 -04:00
}
2011-12-19 18:15:32 -05:00
}
2017-09-27 20:23:47 -04: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-19 18:15:32 -05:00
}
/**
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
* Primes specific network options for the current network into the cache with a single database query .
2011-12-19 18:15:32 -05:00
*
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
* Only network options that do not already exist in cache will be loaded .
*
* If site is not multisite , then call wp_prime_option_caches () .
*
* @ since 6.6 . 0
*
* @ see wp_prime_network_option_caches ()
*
* @ param string [] $options An array of option names to be loaded .
*/
function wp_prime_site_option_caches ( array $options ) {
wp_prime_network_option_caches ( null , $options );
}
/**
* Primes specific network options into the cache with a single database query .
*
* Only network options that do not already exist in cache will be loaded .
*
* If site is not multisite , then call wp_prime_option_caches () .
*
* @ since 6.6 . 0
2022-10-18 14:16:16 -04:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
* @ param string [] $options An array of option names to be loaded .
2011-12-19 18:15:32 -05:00
*/
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
function wp_prime_network_option_caches ( $network_id , array $options ) {
2022-10-18 14:16:16 -04:00
global $wpdb ;
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
if ( wp_installing () ) {
return ;
}
if ( ! is_multisite () ) {
wp_prime_option_caches ( $options );
return ;
}
if ( $network_id && ! is_numeric ( $network_id ) ) {
2011-12-19 18:15:32 -05:00
return ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
if ( ! $network_id ) {
2017-08-12 09:11:43 -04:00
$network_id = get_current_network_id ();
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
$cache_keys = array ();
foreach ( $options as $option ) {
$cache_keys [ $option ] = " { $network_id } : { $option } " ;
}
$cache_group = 'site-options' ;
$cached_options = wp_cache_get_multiple ( array_values ( $cache_keys ), $cache_group );
2022-10-18 14:16:16 -04:00
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
$notoptions_key = " $network_id :notoptions " ;
$notoptions = wp_cache_get ( $notoptions_key , $cache_group );
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
}
// Filter options that are not in the cache.
$options_to_prime = array ();
foreach ( $cache_keys as $option => $cache_key ) {
if (
( ! isset ( $cached_options [ $cache_key ] ) || false === $cached_options [ $cache_key ] )
&& ! isset ( $notoptions [ $option ] )
) {
$options_to_prime [] = $option ;
2023-06-27 06:41:30 -04:00
}
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
}
2023-06-27 06:41:30 -04:00
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
// Bail early if there are no options to be loaded.
if ( empty ( $options_to_prime ) ) {
2023-06-27 06:41:30 -04:00
return ;
}
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
$query_args = $options_to_prime ;
$query_args [] = $network_id ;
$results = $wpdb -> get_results (
$wpdb -> prepare (
sprintf (
" SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN (%s) AND site_id = %s " ,
implode ( ',' , array_fill ( 0 , count ( $options_to_prime ), '%s' ) ),
'%d'
),
$query_args
)
);
2022-10-18 14:16:16 -04:00
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
$data = array ();
$options_found = array ();
foreach ( $results as $result ) {
$key = $result -> meta_key ;
$cache_key = $cache_keys [ $key ];
$data [ $cache_key ] = maybe_unserialize ( $result -> meta_value );
$options_found [] = $key ;
}
wp_cache_set_multiple ( $data , $cache_group );
// If all options were found, no need to update `notoptions` cache.
if ( count ( $options_found ) === count ( $options_to_prime ) ) {
return ;
}
$options_not_found = array_diff ( $options_to_prime , $options_found );
2022-10-18 14:16:16 -04:00
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
// Add the options that were not found to the cache.
$update_notoptions = false ;
foreach ( $options_not_found as $option_name ) {
if ( ! isset ( $notoptions [ $option_name ] ) ) {
$notoptions [ $option_name ] = true ;
$update_notoptions = true ;
}
}
// Only update the cache if it was modified.
if ( $update_notoptions ) {
wp_cache_set ( $notoptions_key , $notoptions , $cache_group );
}
}
/**
* Loads and primes caches of certain often requested network options if is_multisite () .
*
* @ since 3.0 . 0
* @ since 6.3 . 0 Also prime caches for network options when persistent object cache is enabled .
* @ since 6.6 . 0 Uses wp_prime_network_option_caches () .
*
* @ param int $network_id Optional . Network ID of network for which to prime network options cache . Defaults to current network .
*/
function wp_load_core_site_options ( $network_id = null ) {
if ( ! is_multisite () || wp_installing () ) {
return ;
2022-10-18 14:16:16 -04:00
}
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04: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' , 'WPLANG' );
wp_prime_network_option_caches ( $network_id , $core_options );
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Updates the value of an option that was already added .
2011-12-19 18:15:32 -05:00
*
2020-02-22 20:07:08 -05: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-19 18:15:32 -05:00
*
2020-02-25 15:08:07 -05:00
* If the option does not exist , it will be created .
2019-09-14 21:29:54 -04:00
2019-09-14 22:07:55 -04:00
* This function is designed to work with or without a logged - in user . In terms of security ,
2019-09-14 21:29:54 -04:00
* plugin developers should check the current user ' s capabilities before updating any options .
2011-12-19 18:15:32 -05:00
*
* @ since 1.0 . 0
2015-03-05 14:13:25 -05:00
* @ since 4.2 . 0 The `$autoload` parameter was added .
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ since 6.7 . 0 The autoload values 'yes' and 'no' are deprecated .
2011-12-19 18:15:32 -05:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* @ param string $option Name of the option to update . Expected to not be SQL - escaped .
* @ param mixed $value Option value . Must be serializable if non - scalar . Expected to not be SQL - escaped .
* @ param bool | null $autoload Optional . Whether to load the option when WordPress starts up .
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* Accepts a boolean , or `null` to stick with the initial value or , if no initial value is
* set , to leave the decision up to default heuristics in WordPress .
* For existing options , `$autoload` can only be updated using `update_option()` if `$value`
* is also changed .
* For backward compatibility 'yes' and 'no' are also accepted , though using these values is
* deprecated .
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* Autoloading too many options can lead to performance problems , especially if the
* options are not frequently used . For options which are accessed across several places
* in the frontend , it is recommended to autoload them , by using true .
* For options which are accessed only on few specific URLs , it is recommended
* to not autoload them , by using false .
* For non - existent options , the default is null , which means WordPress will determine
* the autoload value .
2020-07-05 10:46:03 -04:00
* @ return bool True if the value was updated , false otherwise .
2011-12-19 18:15:32 -05:00
*/
2015-03-06 08:57:26 -05:00
function update_option ( $option , $value , $autoload = null ) {
2011-12-19 18:15:32 -05: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-15 18:19:58 -04:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-11-30 18:11:00 -05:00
if ( empty ( $option ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05: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-22 23:14:06 -04: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' ,
);
2022-08-19 20:27:12 -04:00
if ( isset ( $deprecated_keys [ $option ] ) && ! wp_installing () ) {
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-22 23:14:06 -04:00
_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-19 18:15:32 -05:00
wp_protect_special_option ( $option );
2017-11-30 18:11:00 -05:00
if ( is_object ( $value ) ) {
2013-10-02 16:43:10 -04:00
$value = clone $value ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2017-11-30 18:11:00 -05:00
$value = sanitize_option ( $option , $value );
2013-10-02 16:43:10 -04:00
$old_value = get_option ( $option );
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters a specific option before its value is ( maybe ) serialized and updated .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.6 . 0
2015-08-28 11:22:20 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04:00
* @ param mixed $value The new , unserialized option value .
* @ param mixed $old_value The old option value .
* @ param string $option Option name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
$value = apply_filters ( " pre_update_option_ { $option } " , $value , $old_value , $option );
2011-12-19 18:15:32 -05:00
2014-03-28 09:57:14 -04:00
/**
2016-05-22 14:34:26 -04:00
* Filters an option before its value is ( maybe ) serialized and updated .
2014-03-28 09:57:14 -04: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 16:43:43 -05:00
/*
* If the new and old values are the same , no need to update .
*
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
* 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 .
2016-12-11 16:43:43 -05:00
*
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
* See https :// core . trac . wordpress . org / ticket / 38903
2016-12-11 16:43:43 -05:00
*/
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
if ( $value === $old_value || maybe_serialize ( $value ) === maybe_serialize ( $old_value ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2016-12-11 16:43:43 -05:00
}
2011-12-19 18:15:32 -05:00
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
/** This filter is documented in wp-includes/option.php */
if ( apply_filters ( " default_option_ { $option } " , false , $option , false ) === $old_value ) {
2015-03-05 14:13:25 -05:00
return add_option ( $option , $value , '' , $autoload );
}
2013-10-02 16:43:10 -04:00
$serialized_value = maybe_serialize ( $value );
2014-03-02 18:35:13 -05: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-25 22:57:09 -04:00
do_action ( 'update_option' , $option , $old_value , $value );
2014-03-02 18:35:13 -05:00
2015-03-06 08:57:26 -05:00
$update_args = array (
'option_value' => $serialized_value ,
);
if ( null !== $autoload ) {
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
$update_args [ 'autoload' ] = wp_determine_option_autoload_value ( $option , $value , $serialized_value , $autoload );
} else {
// Retrieve the current autoload value to reevaluate it in case it was set automatically.
$raw_autoload = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT autoload FROM $wpdb->options WHERE option_name = %s LIMIT 1 " , $option ) );
$allow_values = array ( 'auto-on' , 'auto-off' , 'auto' );
if ( in_array ( $raw_autoload , $allow_values , true ) ) {
$autoload = wp_determine_option_autoload_value ( $option , $value , $serialized_value , $autoload );
if ( $autoload !== $raw_autoload ) {
$update_args [ 'autoload' ] = $autoload ;
}
}
2015-03-06 08:57:26 -05:00
}
$result = $wpdb -> update ( $wpdb -> options , $update_args , array ( 'option_name' => $option ) );
2017-11-30 18:11:00 -05:00
if ( ! $result ) {
2013-10-02 16:43:10 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
2020-06-27 12:56:02 -04:00
2017-11-30 18:11:00 -05:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
2011-12-19 18:15:32 -05: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 11:06:28 -04:00
if ( ! wp_installing () ) {
Options, Meta APIs: Fix bug with `update_option()` updating the wrong cache, leading to potentially stale values being returned.
When using the `$autoload` parameter of `update_option()` alongside an option value update, prior to this changeset the function would update the incorrect cache, not respecting the new autoload value. This could have severe implications such as returning a stale option value when the option in fact had already been deleted.
This changeset fixes the bug alongside test coverage that failed with `trunk` but now passes.
Props kkmuffme, pentatonicfunk, SergeyBiryukov, oglekler, azaozz, spacedmonkey, nicolefurlan, joemcgill, flixos90.
Fixes #51352.
Built from https://develop.svn.wordpress.org/trunk@56796
git-svn-id: http://core.svn.wordpress.org/trunk@56308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-06 12:33:25 -04:00
if ( ! isset ( $update_args [ 'autoload' ] ) ) {
// Update the cached value based on where it is currently cached.
$alloptions = wp_load_alloptions ( true );
2023-11-01 20:04:24 -04:00
Options, Meta APIs: Fix bug with `update_option()` updating the wrong cache, leading to potentially stale values being returned.
When using the `$autoload` parameter of `update_option()` alongside an option value update, prior to this changeset the function would update the incorrect cache, not respecting the new autoload value. This could have severe implications such as returning a stale option value when the option in fact had already been deleted.
This changeset fixes the bug alongside test coverage that failed with `trunk` but now passes.
Props kkmuffme, pentatonicfunk, SergeyBiryukov, oglekler, azaozz, spacedmonkey, nicolefurlan, joemcgill, flixos90.
Fixes #51352.
Built from https://develop.svn.wordpress.org/trunk@56796
git-svn-id: http://core.svn.wordpress.org/trunk@56308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-06 12:33:25 -04:00
if ( isset ( $alloptions [ $option ] ) ) {
$alloptions [ $option ] = $serialized_value ;
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
} else {
wp_cache_set ( $option , $serialized_value , 'options' );
}
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
} elseif ( in_array ( $update_args [ 'autoload' ], wp_autoload_values_to_autoload (), true ) ) {
Options, Meta APIs: Fix bug with `update_option()` updating the wrong cache, leading to potentially stale values being returned.
When using the `$autoload` parameter of `update_option()` alongside an option value update, prior to this changeset the function would update the incorrect cache, not respecting the new autoload value. This could have severe implications such as returning a stale option value when the option in fact had already been deleted.
This changeset fixes the bug alongside test coverage that failed with `trunk` but now passes.
Props kkmuffme, pentatonicfunk, SergeyBiryukov, oglekler, azaozz, spacedmonkey, nicolefurlan, joemcgill, flixos90.
Fixes #51352.
Built from https://develop.svn.wordpress.org/trunk@56796
git-svn-id: http://core.svn.wordpress.org/trunk@56308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-06 12:33:25 -04:00
// Delete the individual cache, then set in alloptions cache.
wp_cache_delete ( $option , 'options' );
$alloptions = wp_load_alloptions ( true );
2023-11-01 20:04:24 -04:00
2013-10-02 16:43:10 -04:00
$alloptions [ $option ] = $serialized_value ;
2011-12-19 18:15:32 -05:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
} else {
Options, Meta APIs: Fix bug with `update_option()` updating the wrong cache, leading to potentially stale values being returned.
When using the `$autoload` parameter of `update_option()` alongside an option value update, prior to this changeset the function would update the incorrect cache, not respecting the new autoload value. This could have severe implications such as returning a stale option value when the option in fact had already been deleted.
This changeset fixes the bug alongside test coverage that failed with `trunk` but now passes.
Props kkmuffme, pentatonicfunk, SergeyBiryukov, oglekler, azaozz, spacedmonkey, nicolefurlan, joemcgill, flixos90.
Fixes #51352.
Built from https://develop.svn.wordpress.org/trunk@56796
git-svn-id: http://core.svn.wordpress.org/trunk@56308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-06 12:33:25 -04:00
// Delete the alloptions cache, then set the individual cache.
$alloptions = wp_load_alloptions ( true );
2023-11-01 20:04:24 -04:00
Options, Meta APIs: Fix bug with `update_option()` updating the wrong cache, leading to potentially stale values being returned.
When using the `$autoload` parameter of `update_option()` alongside an option value update, prior to this changeset the function would update the incorrect cache, not respecting the new autoload value. This could have severe implications such as returning a stale option value when the option in fact had already been deleted.
This changeset fixes the bug alongside test coverage that failed with `trunk` but now passes.
Props kkmuffme, pentatonicfunk, SergeyBiryukov, oglekler, azaozz, spacedmonkey, nicolefurlan, joemcgill, flixos90.
Fixes #51352.
Built from https://develop.svn.wordpress.org/trunk@56796
git-svn-id: http://core.svn.wordpress.org/trunk@56308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-06 12:33:25 -04:00
if ( isset ( $alloptions [ $option ] ) ) {
unset ( $alloptions [ $option ] );
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
}
2013-10-02 16:43:10 -04:00
wp_cache_set ( $option , $serialized_value , 'options' );
2011-12-19 18:15:32 -05:00
}
}
2014-03-02 18:35:13 -05:00
/**
* Fires after the value of a specific option has been successfully updated .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.0 . 1
2015-08-28 11:24:21 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04:00
* @ param mixed $old_value The old option value .
* @ param mixed $value The new option value .
* @ param string $option Option name .
2014-03-02 18:35:13 -05:00
*/
2015-08-25 17:42:20 -04:00
do_action ( " update_option_ { $option } " , $old_value , $value , $option );
2014-03-02 18:35:13 -05: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 16:43:10 -04:00
do_action ( 'updated_option' , $option , $old_value , $value );
2020-06-27 12:56:02 -04:00
2013-10-02 16:43:10 -04:00
return true ;
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Adds a new option .
2011-12-19 18:15:32 -05:00
*
2020-02-22 20:07:08 -05: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-19 18:15:32 -05: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
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* @ since 6.6 . 0 The $autoload parameter ' s default value was changed to null .
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* @ since 6.7 . 0 The autoload values 'yes' and 'no' are deprecated .
2011-12-19 18:15:32 -05:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04: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 bool | null $autoload Optional . Whether to load the option when WordPress starts up .
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* Accepts a boolean , or `null` to leave the decision up to default heuristics in
* WordPress . For backward compatibility 'yes' and 'no' are also accepted , though using
* these values is deprecated .
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* Autoloading too many options can lead to performance problems , especially if the
* options are not frequently used . For options which are accessed across several places
Options, Meta APIs: Soft-deprecate use of 'yes' and 'no' as `$autoload` parameter.
WordPress 6.6 option autoload enhancements included discouraging the use of 'yes' and 'no' to indicate whether to autoload an option when calling `add_option()` or `update_option()`. Instead, a boolean should be used.
This changeset brings the newer autoload related functions `wp_set_option_autoload_values()`, `wp_set_options_autoload()`, and `wp_set_option_autoload()` in line with those changes. Additionally, it soft-deprecates the values more formally, as they should no longer be used. No PHP warnings will be emitted though as this is not a hard deprecation. This change is purely about documentation.
Props flixos90, joemcgill, jrf, mukesh27.
Fixes #61929.
See #61103, #61939.
Built from https://develop.svn.wordpress.org/trunk@58949
git-svn-id: http://core.svn.wordpress.org/trunk@58345 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-08-28 18:48:18 -04:00
* in the frontend , it is recommended to autoload them , by using true .
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* For options which are accessed only on few specific URLs , it is recommended
* to not autoload them , by using false .
* Default is null , which means WordPress will determine the autoload value .
2020-07-05 10:46:03 -04:00
* @ return bool True if the option was added , false otherwise .
2011-12-19 18:15:32 -05:00
*/
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
function add_option ( $option , $value = '' , $deprecated = '' , $autoload = null ) {
2011-12-19 18:15:32 -05:00
global $wpdb ;
2017-11-30 18:11:00 -05:00
if ( ! empty ( $deprecated ) ) {
2016-07-06 08:40:29 -04:00
_deprecated_argument ( __FUNCTION__ , '2.3.0' );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05: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-15 18:19:58 -04:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-11-30 18:11:00 -05:00
if ( empty ( $option ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05: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-22 23:14:06 -04: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' ,
);
2022-08-19 20:27:12 -04:00
if ( isset ( $deprecated_keys [ $option ] ) && ! wp_installing () ) {
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-22 23:14:06 -04:00
_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-19 18:15:32 -05:00
wp_protect_special_option ( $option );
2017-11-30 18:11:00 -05:00
if ( is_object ( $value ) ) {
2011-12-19 18:15:32 -05:00
$value = clone $value ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
$value = sanitize_option ( $option , $value );
2023-07-10 18:48:22 -04:00
/*
* Make sure the option doesn ' t already exist .
* We can check the 'notoptions' cache before we ask for a DB query .
*/
2011-12-19 18:15:32 -05:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
2020-06-27 12:56:02 -04:00
2017-11-30 18:11:00 -05:00
if ( ! is_array ( $notoptions ) || ! isset ( $notoptions [ $option ] ) ) {
2015-02-18 14:14:27 -05:00
/** This filter is documented in wp-includes/option.php */
2017-11-30 18:11:00 -05:00
if ( apply_filters ( " default_option_ { $option } " , false , $option , false ) !== get_option ( $option ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
}
2011-12-19 18:15:32 -05:00
2013-10-02 16:43:10 -04:00
$serialized_value = maybe_serialize ( $value );
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
$autoload = wp_determine_option_autoload_value ( $option , $value , $serialized_value , $autoload );
2014-03-02 18:35:13 -05: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 16:43:10 -04: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-11-30 18:11:00 -05:00
if ( ! $result ) {
2013-10-02 16:43:10 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2013-10-02 16:43:10 -04: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 11:06:28 -04:00
if ( ! wp_installing () ) {
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
if ( in_array ( $autoload , wp_autoload_values_to_autoload (), true ) ) {
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 08:42:03 -05:00
$alloptions = wp_load_alloptions ( true );
2013-10-02 16:43:10 -04:00
$alloptions [ $option ] = $serialized_value ;
2011-12-19 18:15:32 -05:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
} else {
2013-10-02 16:43:10 -04:00
wp_cache_set ( $option , $serialized_value , 'options' );
2011-12-19 18:15:32 -05:00
}
}
2020-01-28 19:45:18 -05:00
// This option exists now.
$notoptions = wp_cache_get ( 'notoptions' , 'options' ); // Yes, again... we need it to be fresh.
2020-06-27 12:56:02 -04:00
2017-11-30 18:11:00 -05:00
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
2011-12-19 18:15:32 -05:00
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
}
2014-03-02 18:35:13 -05:00
/**
* Fires after a specific option has been added .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05: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 16:43:10 -04:00
do_action ( " add_option_ { $option } " , $option , $value );
2014-03-02 18:35:13 -05: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 16:43:10 -04:00
do_action ( 'added_option' , $option , $value );
2020-06-27 12:56:02 -04:00
2013-10-02 16:43:10 -04:00
return true ;
2011-12-19 18:15:32 -05:00
}
/**
Docs: Fix a few more typos in Docblocks.
Follow-up to [6779], [10565], [12023], [25224], [27533], [32806], [34777], [45262], [46594], [55823], [55824], [55827].
Props nazmulhudadev, mukesh27.
Fixes #58338.
See #57840.
Built from https://develop.svn.wordpress.org/trunk@55884
git-svn-id: http://core.svn.wordpress.org/trunk@55396 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-06-06 11:09:28 -04:00
* Removes an option by name . Prevents removal of protected WordPress options .
2011-12-19 18:15:32 -05:00
*
* @ since 1.2 . 0
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
2020-07-05 10:46:03 -04: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-19 18:15:32 -05: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-15 18:19:58 -04:00
if ( is_scalar ( $option ) ) {
$option = trim ( $option );
}
2017-11-30 18:11:00 -05:00
if ( empty ( $option ) ) {
2013-02-28 11:49:20 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2013-02-28 11:49:20 -05:00
2011-12-19 18:15:32 -05:00
wp_protect_special_option ( $option );
2020-01-28 19:45:18 -05:00
// Get the ID, if no ID then return.
2011-12-19 18:15:32 -05:00
$row = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT autoload FROM $wpdb->options WHERE option_name = %s " , $option ) );
2017-11-30 18:11:00 -05:00
if ( is_null ( $row ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2014-03-02 18:35:13 -05:00
/**
* Fires immediately before an option is deleted .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the option to delete .
*/
2011-12-19 18:15:32 -05:00
do_action ( 'delete_option' , $option );
2014-03-02 18:35:13 -05:00
2012-03-24 11:24:31 -04:00
$result = $wpdb -> delete ( $wpdb -> options , array ( 'option_name' => $option ) );
2020-06-27 12:56:02 -04: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 11:06:28 -04:00
if ( ! wp_installing () ) {
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
if ( in_array ( $row -> autoload , wp_autoload_values_to_autoload (), true ) ) {
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 08:42:03 -05:00
$alloptions = wp_load_alloptions ( true );
2023-11-01 20:04:24 -04:00
2017-11-30 18:11:00 -05:00
if ( is_array ( $alloptions ) && isset ( $alloptions [ $option ] ) ) {
unset ( $alloptions [ $option ] );
2011-12-19 18:15:32 -05:00
wp_cache_set ( 'alloptions' , $alloptions , 'options' );
}
} else {
wp_cache_delete ( $option , 'options' );
}
2024-07-22 20:27:15 -04:00
$notoptions = wp_cache_get ( 'notoptions' , 'options' );
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
}
$notoptions [ $option ] = true ;
wp_cache_set ( 'notoptions' , $notoptions , 'options' );
2011-12-19 18:15:32 -05:00
}
2020-06-27 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
if ( $result ) {
2014-03-02 18:35:13 -05:00
/**
* Fires after a specific option has been deleted .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
*
* @ param string $option Name of the deleted option .
*/
2016-08-22 14:25:31 -04:00
do_action ( " delete_option_ { $option } " , $option );
2014-03-02 18:35:13 -05:00
/**
* Fires after an option has been deleted .
*
* @ since 2.9 . 0
*
* @ param string $option Name of the deleted option .
*/
2011-12-19 18:15:32 -05:00
do_action ( 'deleted_option' , $option );
2020-06-27 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
return true ;
}
2020-06-27 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
return false ;
}
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
/**
* Determines the appropriate autoload value for an option based on input .
*
* This function checks the provided autoload value and returns a standardized value
* ( 'on' , 'off' , 'auto-on' , 'auto-off' , or 'auto' ) based on specific conditions .
*
* If no explicit autoload value is provided , the function will check for certain heuristics around the given option .
* It will return `auto-on` to indicate autoloading , `auto-off` to indicate not autoloading , or `auto` if no clear
* decision could be made .
*
* @ since 6.6 . 0
* @ access private
*
* @ param string $option The name of the option .
* @ param mixed $value The value of the option to check its autoload value .
* @ param mixed $serialized_value The serialized value of the option to check its autoload value .
* @ param bool | null $autoload The autoload value to check .
* Accepts 'on' | true to enable or 'off' | false to disable , or
* 'auto-on' , 'auto-off' , or 'auto' for internal purposes .
* Any other autoload value will be forced to either 'auto-on' ,
* 'auto-off' , or 'auto' .
* 'yes' and 'no' are supported for backward compatibility .
* @ return string Returns the original $autoload value if explicit , or 'auto-on' , 'auto-off' ,
* or 'auto' depending on default heuristics .
*/
function wp_determine_option_autoload_value ( $option , $value , $serialized_value , $autoload ) {
// Check if autoload is a boolean.
if ( is_bool ( $autoload ) ) {
return $autoload ? 'on' : 'off' ;
}
switch ( $autoload ) {
case 'on' :
case 'yes' :
return 'on' ;
case 'off' :
case 'no' :
return 'off' ;
}
/**
* Allows to determine the default autoload value for an option where no explicit value is passed .
*
* @ since 6.6 . 0
*
* @ param bool | null $autoload The default autoload value to set . Returning true will be set as 'auto-on' in the
* database , false will be set as 'auto-off' , and null will be set as 'auto' .
* @ param string $option The passed option name .
* @ param mixed $value The passed option value to be saved .
*/
$autoload = apply_filters ( 'wp_default_autoload_value' , null , $option , $value , $serialized_value );
if ( is_bool ( $autoload ) ) {
return $autoload ? 'auto-on' : 'auto-off' ;
}
return 'auto' ;
}
/**
* Filters the default autoload value to disable autoloading if the option value is too large .
*
* @ since 6.6 . 0
* @ access private
*
* @ param bool | null $autoload The default autoload value to set .
* @ param string $option The passed option name .
* @ param mixed $value The passed option value to be saved .
* @ param mixed $serialized_value The passed option value to be saved , in serialized form .
* @ return bool | null Potentially modified $default .
*/
function wp_filter_default_autoload_value_via_option_size ( $autoload , $option , $value , $serialized_value ) {
/**
* Filters the maximum size of option value in bytes .
*
* @ since 6.6 . 0
*
* @ param int $max_option_size The option - size threshold , in bytes . Default 150000.
* @ param string $option The name of the option .
*/
$max_option_size = ( int ) apply_filters ( 'wp_max_autoloaded_option_size' , 150000 , $option );
$size = ! empty ( $serialized_value ) ? strlen ( $serialized_value ) : 0 ;
if ( $size > $max_option_size ) {
return false ;
}
return $autoload ;
}
2011-12-19 18:15:32 -05:00
/**
2020-02-22 20:07:08 -05:00
* Deletes a transient .
2011-12-19 18:15:32 -05:00
*
* @ since 2.8 . 0
*
* @ param string $transient Transient name . Expected to not be SQL - escaped .
2020-07-05 10:46:03 -04:00
* @ return bool True if the transient was deleted , false otherwise .
2011-12-19 18:15:32 -05:00
*/
function delete_transient ( $transient ) {
2014-03-02 18:35:13 -05:00
/**
* Fires immediately before a specific transient is deleted .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
*
* @ param string $transient Transient name .
*/
2016-08-22 14:25:31 -04:00
do_action ( " delete_transient_ { $transient } " , $transient );
2011-12-19 18:15:32 -05:00
2022-02-08 18:30:03 -05:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-19 18:15:32 -05:00
$result = wp_cache_delete ( $transient , 'transient' );
} else {
$option_timeout = '_transient_timeout_' . $transient ;
2017-11-30 18:11:00 -05:00
$option = '_transient_' . $transient ;
$result = delete_option ( $option );
2020-06-27 12:56:02 -04:00
2017-11-30 18:11:00 -05:00
if ( $result ) {
2011-12-19 18:15:32 -05:00
delete_option ( $option_timeout );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
}
2014-03-02 18:35:13 -05:00
if ( $result ) {
/**
* Fires after a transient is deleted .
*
* @ since 3.0 . 0
*
* @ param string $transient Deleted transient name .
*/
2011-12-19 18:15:32 -05:00
do_action ( 'deleted_transient' , $transient );
2014-03-02 18:35:13 -05:00
}
2011-12-19 18:15:32 -05:00
return $result ;
}
/**
2020-02-22 20:07:08 -05:00
* Retrieves the value of a transient .
2011-12-19 18:15:32 -05:00
*
2014-06-05 11:34:14 -04:00
* If the transient does not exist , does not have a value , or has expired ,
* then the return value will be false .
2011-12-19 18:15:32 -05:00
*
* @ since 2.8 . 0
*
2014-06-05 11:34:14 -04:00
* @ param string $transient Transient name . Expected to not be SQL - escaped .
* @ return mixed Value of transient .
2011-12-19 18:15:32 -05:00
*/
function get_transient ( $transient ) {
2014-03-02 18:35:13 -05:00
2015-08-25 17:42:20 -04:00
/**
2020-06-27 12:56:02 -04:00
* Filters the value of an existing transient before it is retrieved .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
2022-08-04 10:52:11 -04:00
* Returning a value other than false from the filter will short - circuit retrieval
* and return that value instead .
2014-03-02 18:35:13 -05:00
*
* @ since 2.8 . 0
2015-08-28 11:25:21 -04:00
* @ since 4.4 . 0 The `$transient` parameter was added
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04: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 12:56:02 -04:00
* of the transient , and return that value .
2015-08-25 17:42:20 -04:00
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
$pre = apply_filters ( " pre_transient_ { $transient } " , false , $transient );
2020-06-27 12:56:02 -04:00
2017-11-30 18:11:00 -05:00
if ( false !== $pre ) {
2011-12-19 18:15:32 -05:00
return $pre ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2022-02-08 18:30:03 -05:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-19 18:15:32 -05: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 11:06:28 -04:00
if ( ! wp_installing () ) {
2020-01-28 19:45:18 -05:00
// If option is not in alloptions, it is not autoloaded and thus has a timeout.
2011-12-19 18:15:32 -05:00
$alloptions = wp_load_alloptions ();
2023-11-01 20:04:24 -04:00
2017-11-30 18:11:00 -05:00
if ( ! isset ( $alloptions [ $transient_option ] ) ) {
2011-12-19 18:15:32 -05:00
$transient_timeout = '_transient_timeout_' . $transient ;
2024-05-11 19:53:15 -04:00
wp_prime_option_caches ( array ( $transient_option , $transient_timeout ) );
$timeout = get_option ( $transient_timeout );
2015-07-07 12:45:26 -04:00
if ( false !== $timeout && $timeout < time () ) {
2017-11-30 18:11:00 -05:00
delete_option ( $transient_option );
2011-12-19 18:15:32 -05:00
delete_option ( $transient_timeout );
2013-08-21 15:14:09 -04:00
$value = false ;
2011-12-19 18:15:32 -05:00
}
}
}
2017-11-30 18:11:00 -05:00
if ( ! isset ( $value ) ) {
2013-08-21 15:14:09 -04:00
$value = get_option ( $transient_option );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
}
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters an existing transient ' s value .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.8 . 0
2015-08-28 11:27:20 -04:00
* @ since 4.4 . 0 The `$transient` parameter was added
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04:00
* @ param mixed $value Value of transient .
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
return apply_filters ( " transient_ { $transient } " , $value , $transient );
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Sets / updates the value of a transient .
2011-12-19 18:15:32 -05:00
*
2020-02-22 20:07:08 -05: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-19 18:15:32 -05:00
*
* @ since 2.8 . 0
*
2020-04-22 06:31:09 -04:00
* @ param string $transient Transient name . Expected to not be SQL - escaped .
* Must be 172 characters or fewer in length .
2014-06-11 12:33:15 -04:00
* @ param mixed $value Transient value . Must be serializable if non - scalar .
* Expected to not be SQL - escaped .
2015-10-13 17:31:25 -04:00
* @ param int $expiration Optional . Time until expiration in seconds . Default 0 ( no expiration ) .
2020-07-05 10:46:03 -04:00
* @ return bool True if the value was set , false otherwise .
2011-12-19 18:15:32 -05:00
*/
function set_transient ( $transient , $value , $expiration = 0 ) {
2014-03-02 18:35:13 -05:00
2015-02-11 12:12:26 -05:00
$expiration = ( int ) $expiration ;
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters a specific transient before its value is set .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2015-08-28 11:29:21 -04:00
* @ since 4.2 . 0 The `$expiration` parameter was added .
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04:00
* @ param mixed $value New value of transient .
* @ param int $expiration Time until expiration in seconds .
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
$value = apply_filters ( " pre_set_transient_ { $transient } " , $value , $expiration , $transient );
2011-12-19 18:15:32 -05:00
2015-10-06 10:10:25 -04:00
/**
2016-05-22 14:34:26 -04:00
* Filters the expiration for a transient before its value is set .
2015-10-06 10:10:25 -04:00
*
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
*
* @ since 4.4 . 0
*
2015-10-13 17:31:25 -04:00
* @ param int $expiration Time until expiration in seconds . Use 0 for no expiration .
2015-10-06 13:59:25 -04:00
* @ param mixed $value New value of transient .
2015-10-06 10:10:25 -04:00
* @ param string $transient Transient name .
*/
2016-08-22 14:25:31 -04:00
$expiration = apply_filters ( " expiration_of_transient_ { $transient } " , $expiration , $value , $transient );
2015-10-06 10:10:25 -04:00
2022-02-08 18:30:03 -05:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-19 18:15:32 -05:00
$result = wp_cache_set ( $transient , $value , 'transient' , $expiration );
} else {
$transient_timeout = '_transient_timeout_' . $transient ;
2017-11-30 18:11:00 -05:00
$transient_option = '_transient_' . $transient ;
2024-05-11 19:53:15 -04:00
wp_prime_option_caches ( array ( $transient_option , $transient_timeout ) );
2020-06-27 12:56:02 -04:00
2015-10-29 07:52:28 -04:00
if ( false === get_option ( $transient_option ) ) {
2024-06-14 11:21:10 -04:00
$autoload = true ;
2011-12-19 18:15:32 -05:00
if ( $expiration ) {
2024-06-14 11:21:10 -04:00
$autoload = false ;
add_option ( $transient_timeout , time () + $expiration , '' , false );
2011-12-19 18:15:32 -05:00
}
2015-10-29 07:52:28 -04:00
$result = add_option ( $transient_option , $value , '' , $autoload );
2011-12-19 18:15:32 -05:00
} else {
2023-07-10 18:48:22 -04:00
/*
* If expiration is requested , but the transient has no timeout option ,
* delete , then re - create transient rather than update .
*/
2014-03-25 14:23:14 -04:00
$update = true ;
2020-06-27 12:56:02 -04:00
2014-03-25 14:23:14 -04:00
if ( $expiration ) {
if ( false === get_option ( $transient_timeout ) ) {
2015-10-29 07:52:28 -04:00
delete_option ( $transient_option );
2024-06-14 11:21:10 -04:00
add_option ( $transient_timeout , time () + $expiration , '' , false );
$result = add_option ( $transient_option , $value , '' , false );
2014-03-25 14:23:14 -04:00
$update = false ;
} else {
update_option ( $transient_timeout , time () + $expiration );
}
}
2020-06-27 12:56:02 -04:00
2014-03-25 14:23:14 -04:00
if ( $update ) {
2015-10-29 07:52:28 -04:00
$result = update_option ( $transient_option , $value );
2014-03-25 14:23:14 -04:00
}
2011-12-19 18:15:32 -05:00
}
}
2014-03-02 18:35:13 -05:00
2011-12-19 18:15:32 -05:00
if ( $result ) {
2014-03-02 18:35:13 -05:00
/**
* Fires after the value for a specific transient has been set .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2015-10-12 17:02:25 -04:00
* @ since 3.6 . 0 The `$value` and `$expiration` parameters were added .
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-10-12 17:02:25 -04:00
* @ param mixed $value Transient value .
2015-10-13 17:31:25 -04:00
* @ param int $expiration Time until expiration in seconds .
2015-10-12 17:02:25 -04:00
* @ param string $transient The name of the transient .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
do_action ( " set_transient_ { $transient } " , $value , $expiration , $transient );
2014-03-02 18:35:13 -05:00
/**
* Fires after the value for a transient has been set .
*
* @ since 3.0 . 0
2015-10-12 17:02:25 -04:00
* @ since 3.6 . 0 The `$value` and `$expiration` parameters were added .
2014-03-02 18:35:13 -05:00
*
* @ param string $transient The name of the transient .
* @ param mixed $value Transient value .
2015-10-13 17:31:25 -04:00
* @ param int $expiration Time until expiration in seconds .
2014-03-02 18:35:13 -05:00
*/
2013-06-16 00:06:12 -04:00
do_action ( 'setted_transient' , $transient , $value , $expiration );
2011-12-19 18:15:32 -05:00
}
2020-06-27 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
return $result ;
}
2017-10-21 09:22:49 -04:00
/**
* Deletes all expired transients .
*
2022-08-04 10:52:11 -04:00
* Note that this function won ' t do anything if an external object cache is in use .
*
2017-10-21 09:22:49 -04:00
* The multi - table delete syntax is used to delete the transient record
2017-10-24 19:00:47 -04:00
* from table a , and the corresponding transient_timeout record from table b .
2017-10-21 09:22:49 -04:00
*
2022-12-09 06:54:13 -05:00
* @ global wpdb $wpdb WordPress database abstraction object .
*
2017-10-21 09:22:49 -04: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-24 19:00:47 -04:00
function delete_expired_transients ( $force_db = false ) {
2017-10-21 09:22:49 -04:00
global $wpdb ;
if ( ! $force_db && wp_using_ext_object_cache () ) {
return ;
}
2017-11-30 18:11:00 -05:00
$wpdb -> query (
$wpdb -> prepare (
" DELETE a, b FROM { $wpdb -> options } a, { $wpdb -> options } b
2017-10-21 09:22:49 -04: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-11-30 18:11:00 -05:00
$wpdb -> esc_like ( '_transient_' ) . '%' ,
$wpdb -> esc_like ( '_transient_timeout_' ) . '%' ,
time ()
)
);
2017-10-21 09:22:49 -04:00
if ( ! is_multisite () ) {
2020-01-28 19:45:18 -05:00
// Single site stores site transients in the options table.
2017-11-30 18:11:00 -05:00
$wpdb -> query (
$wpdb -> prepare (
" DELETE a, b FROM { $wpdb -> options } a, { $wpdb -> options } b
2017-10-21 09:22:49 -04: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-11-30 18:11:00 -05:00
$wpdb -> esc_like ( '_site_transient_' ) . '%' ,
$wpdb -> esc_like ( '_site_transient_timeout_' ) . '%' ,
time ()
)
);
2017-10-21 09:22:49 -04:00
} elseif ( is_multisite () && is_main_site () && is_main_network () ) {
// Multisite stores site transients in the sitemeta table.
2017-11-30 18:11:00 -05:00
$wpdb -> query (
$wpdb -> prepare (
" DELETE a, b FROM { $wpdb -> sitemeta } a, { $wpdb -> sitemeta } b
2017-10-21 09:22:49 -04: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-11-30 18:11:00 -05:00
$wpdb -> esc_like ( '_site_transient_' ) . '%' ,
$wpdb -> esc_like ( '_site_transient_timeout_' ) . '%' ,
time ()
)
);
2017-10-21 09:22:49 -04:00
}
}
2011-12-19 18:15:32 -05: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 10:33:30 -04:00
if ( ! is_admin () || wp_doing_ajax () ) {
2011-12-19 18:15:32 -05:00
return ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2019-07-02 19:42:58 -04:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-19 18:15:32 -05:00
return ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2017-01-20 12:33:41 -05:00
if ( ! is_user_member_of_blog () ) {
2012-10-17 14:58:09 -04:00
return ;
2014-08-02 16:09:16 -04:00
}
2012-10-17 14:58:09 -04:00
2013-08-23 17:43:09 -04:00
$settings = ( string ) get_user_option ( 'user-settings' , $user_id );
2011-12-19 18:15:32 -05:00
2017-11-30 18:11:00 -05:00
if ( isset ( $_COOKIE [ 'wp-settings-' . $user_id ] ) ) {
$cookie = preg_replace ( '/[^A-Za-z0-9=&_]/' , '' , $_COOKIE [ 'wp-settings-' . $user_id ] );
2011-12-19 18:15:32 -05:00
2020-01-28 19:45:18 -05:00
// No change or both empty.
2023-08-01 07:01:28 -04:00
if ( $cookie === $settings ) {
2013-08-23 17:43:09 -04:00
return ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2013-08-23 17:43:09 -04:00
$last_saved = ( int ) get_user_option ( 'user-settings-time' , $user_id );
2024-11-07 18:47:16 -05:00
$current = 0 ;
if ( isset ( $_COOKIE [ 'wp-settings-time-' . $user_id ] ) ) {
$current = ( int ) preg_replace ( '/[^0-9]/' , '' , $_COOKIE [ 'wp-settings-time-' . $user_id ] );
}
2011-12-19 18:15:32 -05:00
2020-01-28 19:45:18 -05:00
// The cookie is newer than the saved value. Update the user_option and leave the cookie as-is.
2013-08-23 17:43:09 -04: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-19 18:15:32 -05:00
}
}
2013-08-23 17:43:09 -04:00
// The cookie is not set in the current browser or the saved value is newer.
2015-10-07 23:05:25 -04:00
$secure = ( 'https' === parse_url ( admin_url (), PHP_URL_SCHEME ) );
2022-06-12 07:11:11 -04:00
setcookie ( 'wp-settings-' . $user_id , $settings , time () + YEAR_IN_SECONDS , SITECOOKIEPATH , '' , $secure );
setcookie ( 'wp-settings-time-' . $user_id , time (), time () + YEAR_IN_SECONDS , SITECOOKIEPATH , '' , $secure );
2017-11-30 18:11:00 -05:00
$_COOKIE [ 'wp-settings-' . $user_id ] = $settings ;
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Retrieves user interface setting value based on setting name .
2011-12-19 18:15:32 -05:00
*
* @ since 2.7 . 0
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ param string $name The name of the setting .
* @ param string | false $default_value Optional . Default value to return when $name is not set . Default false .
2020-07-05 10:46:03 -04:00
* @ return mixed The last saved user setting or the default value / false if it doesn ' t exist .
2011-12-19 18:15:32 -05:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
function get_user_setting ( $name , $default_value = false ) {
2013-08-23 17:43:09 -04:00
$all_user_settings = get_all_user_settings ();
2011-12-19 18:15:32 -05:00
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return isset ( $all_user_settings [ $name ] ) ? $all_user_settings [ $name ] : $default_value ;
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Adds or updates user interface setting .
2011-12-19 18:15:32 -05:00
*
2022-08-04 10:52:11 -04:00
* Both `$name` and `$value` can contain only ASCII letters , numbers , hyphens , and underscores .
2016-04-20 11:47:26 -04:00
*
2022-08-04 10:52:11 -04:00
* This function has to be used before any output has started as it calls `setcookie()` .
2011-12-19 18:15:32 -05:00
*
* @ since 2.8 . 0
*
2015-05-26 18:17:25 -04:00
* @ param string $name The name of the setting .
2011-12-19 18:15:32 -05:00
* @ param string $value The value for the setting .
2020-07-05 10:46:03 -04:00
* @ return bool | null True if set successfully , false otherwise .
* Null if the current user is not a member of the site .
2011-12-19 18:15:32 -05:00
*/
function set_user_setting ( $name , $value ) {
2014-08-02 16:09:16 -04:00
if ( headers_sent () ) {
2011-12-19 18:15:32 -05:00
return false ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2017-11-30 18:11:00 -05:00
$all_user_settings = get_all_user_settings ();
$all_user_settings [ $name ] = $value ;
2011-12-19 18:15:32 -05:00
2013-08-23 17:43:09 -04:00
return wp_set_all_user_settings ( $all_user_settings );
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Deletes user interface settings .
2011-12-19 18:15:32 -05:00
*
* Deleting settings would reset them to the defaults .
2016-04-20 11:47:26 -04:00
*
2022-08-04 10:52:11 -04:00
* This function has to be used before any output has started as it calls `setcookie()` .
2011-12-19 18:15:32 -05:00
*
* @ since 2.7 . 0
*
2014-11-30 17:56:25 -05:00
* @ param string $names The name or array of names of the setting to be deleted .
2020-07-05 10:46:03 -04:00
* @ return bool | null True if deleted successfully , false otherwise .
* Null if the current user is not a member of the site .
2011-12-19 18:15:32 -05:00
*/
function delete_user_setting ( $names ) {
2014-08-02 16:09:16 -04:00
if ( headers_sent () ) {
2011-12-19 18:15:32 -05:00
return false ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2013-08-23 17:43:09 -04:00
$all_user_settings = get_all_user_settings ();
2017-11-30 18:11:00 -05:00
$names = ( array ) $names ;
$deleted = false ;
2011-12-19 18:15:32 -05:00
foreach ( $names as $name ) {
2017-11-30 18:11:00 -05:00
if ( isset ( $all_user_settings [ $name ] ) ) {
unset ( $all_user_settings [ $name ] );
2011-12-19 18:15:32 -05:00
$deleted = true ;
}
}
2014-08-02 16:09:16 -04:00
if ( $deleted ) {
2013-08-23 17:43:09 -04:00
return wp_set_all_user_settings ( $all_user_settings );
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
return false ;
}
/**
2020-02-22 20:07:08 -05:00
* Retrieves all user interface settings .
2011-12-19 18:15:32 -05:00
*
* @ since 2.7 . 0
*
2015-05-26 18:17:25 -04:00
* @ global array $_updated_user_settings
*
2020-07-05 10:46:03 -04:00
* @ return array The last saved user settings or empty array .
2011-12-19 18:15:32 -05:00
*/
function get_all_user_settings () {
global $_updated_user_settings ;
2019-07-02 19:42:58 -04:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-19 18:15:32 -05:00
return array ();
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2014-08-02 16:09:16 -04:00
if ( isset ( $_updated_user_settings ) && is_array ( $_updated_user_settings ) ) {
2011-12-19 18:15:32 -05:00
return $_updated_user_settings ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2013-08-23 17:43:09 -04:00
$user_settings = array ();
2011-12-19 18:15:32 -05:00
2017-11-30 18:11:00 -05:00
if ( isset ( $_COOKIE [ 'wp-settings-' . $user_id ] ) ) {
$cookie = preg_replace ( '/[^A-Za-z0-9=&_-]/' , '' , $_COOKIE [ 'wp-settings-' . $user_id ] );
2011-12-19 18:15:32 -05:00
2020-01-28 19:45:18 -05:00
if ( strpos ( $cookie , '=' ) ) { // '=' cannot be 1st char.
2014-08-12 22:47:16 -04:00
parse_str ( $cookie , $user_settings );
}
2011-12-19 18:15:32 -05:00
} else {
2013-08-23 17:43:09 -04:00
$option = get_user_option ( 'user-settings' , $user_id );
2014-08-12 22:47:16 -04:00
if ( $option && is_string ( $option ) ) {
2013-08-23 17:43:09 -04:00
parse_str ( $option , $user_settings );
2014-08-12 22:47:16 -04:00
}
2011-12-19 18:15:32 -05:00
}
2013-08-23 17:43:09 -04:00
$_updated_user_settings = $user_settings ;
return $user_settings ;
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Private . Sets all user interface settings .
2011-12-19 18:15:32 -05:00
*
* @ since 2.8 . 0
2016-04-20 11:45:29 -04:00
* @ access private
2011-12-19 18:15:32 -05:00
*
2015-05-26 18:17:25 -04:00
* @ global array $_updated_user_settings
*
2016-04-20 11:45:29 -04:00
* @ param array $user_settings User settings .
2020-07-05 10:46:03 -04: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-19 18:15:32 -05:00
*/
2013-08-23 17:43:09 -04:00
function wp_set_all_user_settings ( $user_settings ) {
2011-12-19 18:15:32 -05:00
global $_updated_user_settings ;
2019-07-02 19:42:58 -04:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-19 18:15:32 -05:00
return false ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2017-01-20 12:33:41 -05:00
if ( ! is_user_member_of_blog () ) {
2012-10-17 14:58:09 -04:00
return ;
2014-08-02 16:09:16 -04:00
}
2012-10-17 14:58:09 -04:00
2011-12-19 18:15:32 -05:00
$settings = '' ;
2013-08-23 17:43:09 -04:00
foreach ( $user_settings as $name => $value ) {
2017-11-30 18:11:00 -05:00
$_name = preg_replace ( '/[^A-Za-z0-9_-]+/' , '' , $name );
2015-08-31 23:57:21 -04:00
$_value = preg_replace ( '/[^A-Za-z0-9_-]+/' , '' , $value );
2013-08-23 17:43:09 -04:00
2014-08-02 16:09:16 -04:00
if ( ! empty ( $_name ) ) {
2013-08-23 17:43:09 -04:00
$settings .= $_name . '=' . $_value . '&' ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
}
2014-08-02 16:09:16 -04:00
$settings = rtrim ( $settings , '&' );
2013-08-23 17:43:09 -04:00
parse_str ( $settings , $_updated_user_settings );
2011-12-19 18:15:32 -05:00
2013-08-23 17:43:09 -04:00
update_user_option ( $user_id , 'user-settings' , $settings , false );
update_user_option ( $user_id , 'user-settings-time' , time (), false );
2011-12-19 18:15:32 -05:00
return true ;
}
/**
2020-02-22 20:07:08 -05:00
* Deletes the user settings of the current user .
2011-12-19 18:15:32 -05:00
*
* @ since 2.7 . 0
*/
function delete_all_user_settings () {
2019-07-02 19:42:58 -04:00
$user_id = get_current_user_id ();
if ( ! $user_id ) {
2011-12-19 18:15:32 -05:00
return ;
2014-08-02 16:09:16 -04:00
}
2011-12-19 18:15:32 -05:00
2013-08-23 17:43:09 -04:00
update_user_option ( $user_id , 'user-settings' , '' , false );
2014-08-12 22:47:16 -04:00
setcookie ( 'wp-settings-' . $user_id , ' ' , time () - YEAR_IN_SECONDS , SITECOOKIEPATH );
2011-12-19 18:15:32 -05:00
}
/**
2015-10-02 14:01:27 -04:00
* Retrieve an option value for the current network based on name of option .
2011-12-19 18:15:32 -05:00
*
* @ since 2.8 . 0
2015-10-02 15:32:30 -04:00
* @ since 4.4 . 0 The `$use_cache` parameter was deprecated .
2015-10-02 14:01:27 -04:00
* @ since 4.4 . 0 Modified into wrapper for get_network_option ()
*
* @ see get_network_option ()
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ param string $option Name of the option to retrieve . Expected to not be SQL - escaped .
* @ param mixed $default_value Optional . Value to return if the option doesn ' t exist . Default false .
* @ param bool $deprecated Whether to use cache . Multisite only . Always set to true .
2015-10-02 14:01:27 -04:00
* @ return mixed Value set for the option .
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
function get_site_option ( $option , $default_value = false , $deprecated = true ) {
return get_network_option ( null , $option , $default_value );
2015-10-02 14:01:27 -04:00
}
/**
2020-02-22 20:07:08 -05:00
* Adds a new option for the current network .
2015-10-02 14:01:27 -04: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 10:46:03 -04:00
* @ param string $option Name of the option to add . Expected to not be SQL - escaped .
2015-10-02 14:01:27 -04:00
* @ param mixed $value Option value , can be anything . Expected to not be SQL - escaped .
2020-07-05 10:46:03 -04:00
* @ return bool True if the option was added , false otherwise .
2015-10-02 14:01:27 -04:00
*/
function add_site_option ( $option , $value ) {
2015-10-11 18:44:27 -04:00
return add_network_option ( null , $option , $value );
2015-10-02 14:01:27 -04:00
}
/**
Docs: Fix a few more typos in DocBlocks and inline comments.
Follow-up to [6779], [10565], [12023], [25224], [27533], [32806], [34777], [45262], [46594], [55823], [55824].
Props Presskopp.
See #57840.
Built from https://develop.svn.wordpress.org/trunk@55827
git-svn-id: http://core.svn.wordpress.org/trunk@55339 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-19 09:27:20 -04:00
* Removes an option by name for the current network .
2015-10-02 14:01:27 -04:00
*
* @ since 2.8 . 0
* @ since 4.4 . 0 Modified into wrapper for delete_network_option ()
*
* @ see delete_network_option ()
*
2020-07-05 10:46:03 -04: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 14:01:27 -04:00
*/
function delete_site_option ( $option ) {
2015-10-11 18:44:27 -04:00
return delete_network_option ( null , $option );
2015-10-02 14:01:27 -04:00
}
/**
2020-02-22 20:07:08 -05:00
* Updates the value of an option that was already added for the current network .
2015-10-02 14:01:27 -04:00
*
* @ since 2.8 . 0
* @ since 4.4 . 0 Modified into wrapper for update_network_option ()
*
* @ see update_network_option ()
*
2020-07-05 10:46:03 -04:00
* @ param string $option Name of the option . Expected to not be SQL - escaped .
2015-10-02 14:01:27 -04:00
* @ param mixed $value Option value . Expected to not be SQL - escaped .
2020-07-05 10:46:03 -04:00
* @ return bool True if the value was updated , false otherwise .
2015-10-02 14:01:27 -04:00
*/
function update_site_option ( $option , $value ) {
2015-10-11 18:44:27 -04:00
return update_network_option ( null , $option , $value );
2015-10-02 14:01:27 -04:00
}
/**
2020-02-22 20:07:08 -05:00
* Retrieves a network ' s option value based on the option name .
2015-10-02 14:01:27 -04:00
*
* @ since 4.4 . 0
2011-12-19 18:15:32 -05:00
*
2014-03-02 18:35:13 -05:00
* @ see get_option ()
2022-10-18 14:16:16 -04:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05: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_value Optional . Value to return if the option doesn ' t exist . Default false .
2011-12-19 18:15:32 -05:00
* @ return mixed Value set for the option .
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
function get_network_option ( $network_id , $option , $default_value = false ) {
2022-10-18 14:16:16 -04:00
global $wpdb ;
2015-10-11 19:30:24 -04:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 14:01:27 -04:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 00:47:30 -04:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 14:01:27 -04:00
}
2011-12-19 18:15:32 -05:00
2014-03-02 18:35:13 -05:00
/**
2020-06-27 12:56:02 -04:00
* Filters the value of an existing network option before it is retrieved .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
2022-08-04 10:52:11 -04:00
* Returning a value other than false from the filter will short - circuit retrieval
* and return that value instead .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As 'pre_site_option_' . $key
* @ since 3.0 . 0
2016-10-19 00:54:29 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ since 4.9 . 0 The `$default_value` parameter was added .
*
2024-09-04 17:10:14 -04:00
* @ param mixed $pre_site_option The value to return instead of the option value . This differs from
* `$default_value` , 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 ) .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
* @ param mixed $default_value The fallback value to return if the option does not exist .
* Default false .
2014-03-02 18:35:13 -05:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
$pre = apply_filters ( " pre_site_option_ { $option } " , false , $option , $network_id , $default_value );
2014-03-02 18:35:13 -05:00
2015-10-02 14:01:27 -04:00
if ( false !== $pre ) {
return $pre ;
}
2011-12-19 18:15:32 -05:00
2022-10-18 14:16:16 -04:00
// Prevent non-existent options from triggering multiple queries.
$notoptions_key = " $network_id :notoptions " ;
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
2014-03-02 18:35:13 -05:00
/**
2022-08-04 10:52:11 -04:00
* Filters the value of a specific default network option .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.4 . 0
2015-08-28 11:31:21 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
2016-10-19 00:54:29 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ param mixed $default_value 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-02 18:35:13 -05:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return apply_filters ( " default_site_option_ { $option } " , $default_value , $option , $network_id );
2022-10-18 14:16:16 -04:00
}
if ( ! is_multisite () ) {
/** This filter is documented in wp-includes/option.php */
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
$default_value = apply_filters ( 'default_site_option_' . $option , $default_value , $option , $network_id );
2023-01-05 10:27:16 -05:00
$value = get_option ( $option , $default_value );
2011-12-19 18:15:32 -05:00
} else {
2022-10-18 14:16:16 -04:00
$cache_key = " $network_id : $option " ;
$value = wp_cache_get ( $cache_key , 'site-options' );
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 ) );
// Has to be get_row() instead of get_var() because of funkiness with 0, false, null values.
if ( is_object ( $row ) ) {
$value = $row -> meta_value ;
$value = maybe_unserialize ( $value );
wp_cache_set ( $cache_key , $value , 'site-options' );
} else {
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
}
$notoptions [ $option ] = true ;
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
2014-03-02 18:35:13 -05:00
2022-10-18 14:16:16 -04:00
/** This filter is documented in wp-includes/option.php */
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
$value = apply_filters ( 'default_site_option_' . $option , $default_value , $option , $network_id );
2022-10-18 14:16:16 -04:00
}
2011-12-19 18:15:32 -05:00
}
}
2022-10-18 14:16:16 -04:00
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
}
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters the value of an existing network option .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As 'site_option_' . $key
* @ since 3.0 . 0
2016-10-19 00:54:29 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 00:54:29 -04:00
* @ param mixed $value Value of network option .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-02 18:35:13 -05:00
*/
2016-10-19 00:54:29 -04:00
return apply_filters ( " site_option_ { $option } " , $value , $option , $network_id );
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Adds a new network option .
2011-12-19 18:15:32 -05:00
*
2015-10-02 14:01:27 -04:00
* Existing options will not be updated .
2011-12-19 18:15:32 -05:00
*
2015-10-02 14:01:27 -04:00
* @ since 4.4 . 0
2011-12-19 18:15:32 -05:00
*
2014-03-02 18:35:13 -05:00
* @ see add_option ()
2022-10-18 14:16:16 -04:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
2015-10-11 18:44:27 -04:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
2020-07-05 10:46:03 -04:00
* @ param string $option Name of the option to add . Expected to not be SQL - escaped .
2015-10-11 18:44:27 -04:00
* @ param mixed $value Option value , can be anything . Expected to not be SQL - escaped .
2020-07-05 10:46:03 -04:00
* @ return bool True if the option was added , false otherwise .
2011-12-19 18:15:32 -05:00
*/
2015-10-11 18:44:27 -04:00
function add_network_option ( $network_id , $option , $value ) {
2022-10-18 14:16:16 -04:00
global $wpdb ;
2015-10-11 19:30:24 -04:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 14:01:27 -04:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 00:47:30 -04:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 14:01:27 -04:00
}
2011-12-19 18:15:32 -05:00
2013-08-16 18:42:09 -04:00
wp_protect_special_option ( $option );
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters the value of a specific network option before it is added .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As 'pre_add_site_option_' . $key
* @ since 3.0 . 0
2016-10-19 00:56:28 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 00:56:28 -04:00
* @ param mixed $value Value of network option .
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-02 18:35:13 -05:00
*/
2016-10-19 00:56:28 -04:00
$value = apply_filters ( " pre_add_site_option_ { $option } " , $value , $option , $network_id );
2014-03-02 18:35:13 -05:00
2022-10-18 14:16:16 -04:00
$notoptions_key = " $network_id :notoptions " ;
2015-10-02 14:01:27 -04:00
if ( ! is_multisite () ) {
2024-06-14 11:21:10 -04:00
$result = add_option ( $option , $value , '' , false );
2011-12-19 18:15:32 -05:00
} else {
2022-10-18 14:16:16 -04:00
$cache_key = " $network_id : $option " ;
2023-07-10 18:48:22 -04:00
/*
* Make sure the option doesn ' t already exist .
* We can check the 'notoptions' cache before we ask for a DB query .
*/
2022-10-18 14:16:16 -04:00
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
if ( ! is_array ( $notoptions ) || ! isset ( $notoptions [ $option ] ) ) {
if ( false !== get_network_option ( $network_id , $option , false ) ) {
return false ;
}
}
$value = sanitize_option ( $option , $value );
$serialized_value = maybe_serialize ( $value );
$result = $wpdb -> insert (
$wpdb -> sitemeta ,
array (
'site_id' => $network_id ,
'meta_key' => $option ,
'meta_value' => $serialized_value ,
)
);
if ( ! $result ) {
return false ;
}
wp_cache_set ( $cache_key , $value , 'site-options' );
// This option exists now.
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' ); // Yes, again... we need it to be fresh.
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
}
2011-12-19 18:15:32 -05:00
}
if ( $result ) {
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires after a specific network option has been successfully added .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As " add_site_option_ { $key } "
* @ since 3.0 . 0
2016-10-19 00:56:28 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 00:56:28 -04: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-02 18:35:13 -05:00
*/
2016-10-19 00:56:28 -04:00
do_action ( " add_site_option_ { $option } " , $option , $value , $network_id );
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires after a network option has been successfully added .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2016-10-19 00:56:28 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 00:56:28 -04: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-02 18:35:13 -05:00
*/
2016-10-19 00:56:28 -04:00
do_action ( 'add_site_option' , $option , $value , $network_id );
2014-03-02 18:35:13 -05:00
2011-12-19 18:15:32 -05:00
return true ;
}
2015-10-02 14:01:27 -04:00
2011-12-19 18:15:32 -05:00
return false ;
}
/**
2015-10-02 14:01:27 -04:00
* Removes a network option by name .
2011-12-19 18:15:32 -05:00
*
2015-10-02 14:01:27 -04:00
* @ since 4.4 . 0
2011-12-19 18:15:32 -05:00
*
2014-03-02 18:35:13 -05:00
* @ see delete_option ()
2011-12-19 18:15:32 -05:00
*
2019-01-08 01:00:50 -05:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
2015-10-11 18:44:27 -04:00
* @ param int $network_id ID of the network . Can be null to default to the current network ID .
2020-07-05 10:46:03 -04: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-19 18:15:32 -05:00
*/
2015-10-11 18:44:27 -04:00
function delete_network_option ( $network_id , $option ) {
2022-10-18 14:16:16 -04:00
global $wpdb ;
2015-10-11 19:30:24 -04:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 14:01:27 -04:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 00:47:30 -04:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 14:01:27 -04:00
}
2011-12-19 18:15:32 -05:00
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires immediately before a specific network option is deleted .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2016-10-19 01:02:29 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2015-08-25 17:42:20 -04:00
*
2016-10-19 01:02:29 -04:00
* @ param string $option Option name .
* @ param int $network_id ID of the network .
2014-03-02 18:35:13 -05:00
*/
2016-10-19 01:02:29 -04:00
do_action ( " pre_delete_site_option_ { $option } " , $option , $network_id );
2011-12-19 18:15:32 -05:00
2015-10-02 14:01:27 -04:00
if ( ! is_multisite () ) {
2011-12-19 18:15:32 -05:00
$result = delete_option ( $option );
} else {
2022-10-18 14:16:16 -04: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 ) {
return false ;
}
$cache_key = " $network_id : $option " ;
wp_cache_delete ( $cache_key , 'site-options' );
$result = $wpdb -> delete (
$wpdb -> sitemeta ,
array (
'meta_key' => $option ,
'site_id' => $network_id ,
)
);
2024-07-25 19:04:12 -04:00
if ( $result ) {
$notoptions_key = " $network_id :notoptions " ;
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
if ( ! is_array ( $notoptions ) ) {
$notoptions = array ();
}
$notoptions [ $option ] = true ;
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
}
2011-12-19 18:15:32 -05:00
}
if ( $result ) {
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires after a specific network option has been deleted .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As " delete_site_option_ { $key } "
* @ since 3.0 . 0
2016-10-19 01:02:29 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 01:02:29 -04:00
* @ param string $option Name of the network option .
* @ param int $network_id ID of the network .
2014-03-02 18:35:13 -05:00
*/
2016-10-19 01:02:29 -04:00
do_action ( " delete_site_option_ { $option } " , $option , $network_id );
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires after a network option has been deleted .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2016-10-19 01:02:29 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 01:02:29 -04:00
* @ param string $option Name of the network option .
* @ param int $network_id ID of the network .
2014-03-02 18:35:13 -05:00
*/
2016-10-19 01:02:29 -04:00
do_action ( 'delete_site_option' , $option , $network_id );
2014-03-02 18:35:13 -05:00
2011-12-19 18:15:32 -05:00
return true ;
}
2015-10-02 14:01:27 -04:00
2011-12-19 18:15:32 -05:00
return false ;
}
/**
2020-02-22 20:07:08 -05:00
* Updates the value of a network option that was already added .
2011-12-19 18:15:32 -05:00
*
2015-10-02 14:01:27 -04:00
* @ since 4.4 . 0
2011-12-19 18:15:32 -05:00
*
2014-03-02 18:35:13 -05:00
* @ see update_option ()
2022-10-18 14:16:16 -04:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 18:17:25 -04:00
*
2020-07-23 17:11:05 -04: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 10:46:03 -04:00
* @ return bool True if the value was updated , false otherwise .
2011-12-19 18:15:32 -05:00
*/
2015-10-11 18:44:27 -04:00
function update_network_option ( $network_id , $option , $value ) {
2022-10-18 14:16:16 -04:00
global $wpdb ;
2015-10-11 19:30:24 -04:00
if ( $network_id && ! is_numeric ( $network_id ) ) {
return false ;
}
2015-10-02 14:01:27 -04:00
$network_id = ( int ) $network_id ;
// Fallback to the current network if a network ID is not specified.
2016-10-19 00:47:30 -04:00
if ( ! $network_id ) {
$network_id = get_current_network_id ();
2015-10-02 14:01:27 -04:00
}
2011-12-19 18:15:32 -05:00
2013-08-16 18:42:09 -04:00
wp_protect_special_option ( $option );
Options, Meta APIs: Prevent unnecessary database updates caused by strict comparisons in update_network_option.
Previously, in the update_network_option function, strict comparisons between old and new values could erroneously trigger updates in cases where there was no actual change in values. Building upon the groundwork laid in #22192, this commit introduces the use of the _is_equal_database_value function to accurately compare values before initiating any database updates. This change ensures consistency between the behaviors of `update_option` and `update_network_option`.
Furthermore, we have incorporated similar workarounds that were previously implemented in [56717]. These changes ensure that the raw version of network option values is considered in the comparisons, enhancing the overall reliability of the update process.
Props mukesh27, flixos90, joemcgill, costdev, spacedmonkey.
Fixes #59360.
Built from https://develop.svn.wordpress.org/trunk@56814
git-svn-id: http://core.svn.wordpress.org/trunk@56326 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-10 05:37:22 -04:00
$old_value = get_network_option ( $network_id , $option );
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters a specific network option before its value is updated .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As 'pre_update_site_option_' . $key
* @ since 3.0 . 0
2016-10-19 01:00:29 -04:00
* @ since 4.4 . 0 The `$option` parameter was added .
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 01:00:29 -04: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-02 18:35:13 -05:00
*/
2016-10-19 01:00:29 -04:00
$value = apply_filters ( " pre_update_site_option_ { $option } " , $value , $old_value , $option , $network_id );
2011-12-19 18:15:32 -05:00
2019-01-20 23:27:51 -05:00
/*
* If the new and old values are the same , no need to update .
*
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
* 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 .
2019-01-20 23:27:51 -05:00
*
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
* See https :// core . trac . wordpress . org / ticket / 44956
2019-01-20 23:27:51 -05:00
*/
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
if ( $value === $old_value || maybe_serialize ( $value ) === maybe_serialize ( $old_value ) ) {
2011-12-19 18:15:32 -05:00
return false ;
2015-10-02 14:01:27 -04:00
}
2011-12-19 18:15:32 -05:00
Options, Meta APIs: Revert update_option changes.
This reverts changes from [56648], [56681], [56717], [56762], [56788], [56797], and [56814] to restore the behavior for `update_option()` and `update_network_option()` to their prior state as of 6.3.X due to the discovery of various backwards compatibility issues found late in the 6.4 release cycle.
Props mukesh27, costdev, flixos90, spacedmonkey, snicco, jrf, joemcgill.
See #22192, #59360.
Built from https://develop.svn.wordpress.org/trunk@56946
git-svn-id: http://core.svn.wordpress.org/trunk@56457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-16 16:37:23 -04:00
if ( false === $old_value ) {
2015-10-11 18:44:27 -04:00
return add_network_option ( $network_id , $option , $value );
2015-10-02 14:01:27 -04:00
}
2011-12-19 18:15:32 -05:00
2022-10-18 14:16:16 -04:00
$notoptions_key = " $network_id :notoptions " ;
$notoptions = wp_cache_get ( $notoptions_key , 'site-options' );
if ( is_array ( $notoptions ) && isset ( $notoptions [ $option ] ) ) {
unset ( $notoptions [ $option ] );
wp_cache_set ( $notoptions_key , $notoptions , 'site-options' );
}
2015-10-02 14:01:27 -04:00
if ( ! is_multisite () ) {
2024-06-14 11:21:10 -04:00
$result = update_option ( $option , $value , false );
2011-12-19 18:15:32 -05:00
} else {
2022-10-18 14:16:16 -04:00
$value = sanitize_option ( $option , $value );
$serialized_value = maybe_serialize ( $value );
$result = $wpdb -> update (
$wpdb -> sitemeta ,
array ( 'meta_value' => $serialized_value ),
array (
'site_id' => $network_id ,
'meta_key' => $option ,
)
);
if ( $result ) {
$cache_key = " $network_id : $option " ;
wp_cache_set ( $cache_key , $value , 'site-options' );
}
2011-12-19 18:15:32 -05:00
}
if ( $result ) {
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires after the value of a specific network option has been successfully updated .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$option` , refers to the option name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0 As " update_site_option_ { $key } "
* @ since 3.0 . 0
2016-10-19 01:00:29 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 01:00:29 -04: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-02 18:35:13 -05:00
*/
2016-10-19 01:00:29 -04:00
do_action ( " update_site_option_ { $option } " , $option , $value , $old_value , $network_id );
2014-03-02 18:35:13 -05:00
/**
2015-10-02 14:01:27 -04:00
* Fires after the value of a network option has been successfully updated .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2016-10-19 01:00:29 -04:00
* @ since 4.7 . 0 The `$network_id` parameter was added .
2014-03-02 18:35:13 -05:00
*
2016-10-19 01:00:29 -04: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-02 18:35:13 -05:00
*/
2016-10-19 01:00:29 -04:00
do_action ( 'update_site_option' , $option , $value , $old_value , $network_id );
2014-03-02 18:35:13 -05:00
2011-12-19 18:15:32 -05:00
return true ;
}
2015-10-02 14:01:27 -04:00
2011-12-19 18:15:32 -05:00
return false ;
}
/**
2020-02-22 20:07:08 -05:00
* Deletes a site transient .
2011-12-19 18:15:32 -05:00
*
* @ since 2.9 . 0
*
* @ param string $transient Transient name . Expected to not be SQL - escaped .
2020-07-05 10:46:03 -04:00
* @ return bool True if the transient was deleted , false otherwise .
2011-12-19 18:15:32 -05:00
*/
function delete_site_transient ( $transient ) {
2014-03-02 18:35:13 -05:00
/**
* Fires immediately before a specific site transient is deleted .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
*
* @ param string $transient Transient name .
*/
2016-08-22 14:25:31 -04:00
do_action ( " delete_site_transient_ { $transient } " , $transient );
2014-03-02 18:35:13 -05:00
2022-02-08 18:30:03 -05:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-19 18:15:32 -05:00
$result = wp_cache_delete ( $transient , 'site-transient' );
} else {
$option_timeout = '_site_transient_timeout_' . $transient ;
2017-11-30 18:11:00 -05:00
$option = '_site_transient_' . $transient ;
$result = delete_site_option ( $option );
2020-06-27 12:56:02 -04:00
2017-11-30 18:11:00 -05:00
if ( $result ) {
2015-10-07 13:11:25 -04:00
delete_site_option ( $option_timeout );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
}
2020-06-27 12:56:02 -04:00
2014-03-02 18:35:13 -05:00
if ( $result ) {
/**
* Fires after a transient is deleted .
*
* @ since 3.0 . 0
*
* @ param string $transient Deleted transient name .
*/
2011-12-19 18:15:32 -05:00
do_action ( 'deleted_site_transient' , $transient );
2014-03-02 18:35:13 -05:00
}
2011-12-19 18:15:32 -05:00
return $result ;
}
/**
2020-02-22 20:07:08 -05:00
* Retrieves the value of a site transient .
2011-12-19 18:15:32 -05:00
*
2014-06-05 11:34:14 -04:00
* If the transient does not exist , does not have a value , or has expired ,
* then the return value will be false .
2011-12-19 18:15:32 -05:00
*
* @ since 2.9 . 0
*
2014-03-02 18:35:13 -05:00
* @ see get_transient ()
2011-12-19 18:15:32 -05:00
*
* @ param string $transient Transient name . Expected to not be SQL - escaped .
2014-06-05 11:34:14 -04:00
* @ return mixed Value of transient .
2011-12-19 18:15:32 -05:00
*/
function get_site_transient ( $transient ) {
2014-03-02 18:35:13 -05:00
/**
2020-06-27 12:56:02 -04:00
* Filters the value of an existing site transient before it is retrieved .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
2022-09-20 16:32:09 -04:00
* Returning a value other than boolean false will short - circuit retrieval and
* return that value instead .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0
2015-10-06 13:59:25 -04:00
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04: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 12:56:02 -04:00
* of the transient , and return that value .
2015-08-25 17:42:20 -04:00
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
$pre = apply_filters ( " pre_site_transient_ { $transient } " , false , $transient );
2014-03-02 18:35:13 -05:00
2017-11-30 18:11:00 -05:00
if ( false !== $pre ) {
2011-12-19 18:15:32 -05:00
return $pre ;
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
2022-02-08 18:30:03 -05:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-19 18:15:32 -05: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-11-30 18:11:00 -05:00
$no_timeout = array ( 'update_core' , 'update_plugins' , 'update_themes' );
2011-12-19 18:15:32 -05:00
$transient_option = '_site_transient_' . $transient ;
2020-04-04 23:02:11 -04:00
if ( ! in_array ( $transient , $no_timeout , true ) ) {
2011-12-19 18:15:32 -05:00
$transient_timeout = '_site_transient_timeout_' . $transient ;
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
wp_prime_site_option_caches ( array ( $transient_option , $transient_timeout ) );
$timeout = get_site_option ( $transient_timeout );
2011-12-19 18:15:32 -05:00
if ( false !== $timeout && $timeout < time () ) {
2017-11-30 18:11:00 -05:00
delete_site_option ( $transient_option );
2015-10-07 13:11:25 -04:00
delete_site_option ( $transient_timeout );
2013-08-21 15:14:09 -04:00
$value = false ;
2011-12-19 18:15:32 -05:00
}
}
2017-11-30 18:11:00 -05:00
if ( ! isset ( $value ) ) {
2015-10-07 13:11:25 -04:00
$value = get_site_option ( $transient_option );
2017-11-30 18:11:00 -05:00
}
2011-12-19 18:15:32 -05:00
}
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters the value of an existing site transient .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 2.9 . 0
2015-10-06 13:59:25 -04:00
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04:00
* @ param mixed $value Value of site transient .
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
return apply_filters ( " site_transient_ { $transient } " , $value , $transient );
2011-12-19 18:15:32 -05:00
}
/**
2020-02-22 20:07:08 -05:00
* Sets / updates the value of a site transient .
2011-12-19 18:15:32 -05:00
*
2020-02-22 20:07:08 -05: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-19 18:15:32 -05:00
*
* @ since 2.9 . 0
*
2014-03-02 18:35:13 -05:00
* @ see set_transient ()
2011-12-19 18:15:32 -05:00
*
2014-06-11 12:33:15 -04:00
* @ param string $transient Transient name . Expected to not be SQL - escaped . Must be
2017-04-15 05:28:43 -04:00
* 167 characters or fewer in length .
2014-06-11 12:33:15 -04:00
* @ param mixed $value Transient value . Expected to not be SQL - escaped .
2015-10-13 17:31:25 -04:00
* @ param int $expiration Optional . Time until expiration in seconds . Default 0 ( no expiration ) .
2020-07-05 10:46:03 -04:00
* @ return bool True if the value was set , false otherwise .
2011-12-19 18:15:32 -05:00
*/
function set_site_transient ( $transient , $value , $expiration = 0 ) {
2014-03-02 18:35:13 -05:00
/**
2016-05-22 14:34:26 -04:00
* Filters the value of a specific site transient before it is set .
2014-03-02 18:35:13 -05:00
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2015-10-06 13:59:25 -04:00
* @ since 4.4 . 0 The `$transient` parameter was added .
2014-03-02 18:35:13 -05:00
*
2015-10-06 13:59:25 -04:00
* @ param mixed $value New value of site transient .
2015-08-25 17:42:20 -04:00
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
$value = apply_filters ( " pre_set_site_transient_ { $transient } " , $value , $transient );
2014-03-02 18:35:13 -05:00
2013-09-16 13:43:09 -04:00
$expiration = ( int ) $expiration ;
2011-12-19 18:15:32 -05:00
2015-10-06 10:10:25 -04:00
/**
2016-05-22 14:34:26 -04:00
* Filters the expiration for a site transient before its value is set .
2015-10-06 10:10:25 -04:00
*
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
*
* @ since 4.4 . 0
*
2015-10-13 17:31:25 -04:00
* @ param int $expiration Time until expiration in seconds . Use 0 for no expiration .
2015-10-06 13:59:25 -04:00
* @ param mixed $value New value of site transient .
2015-10-06 10:10:25 -04:00
* @ param string $transient Transient name .
*/
2016-08-22 14:25:31 -04:00
$expiration = apply_filters ( " expiration_of_site_transient_ { $transient } " , $expiration , $value , $transient );
2015-10-06 10:10:25 -04:00
2022-02-08 18:30:03 -05:00
if ( wp_using_ext_object_cache () || wp_installing () ) {
2011-12-19 18:15:32 -05:00
$result = wp_cache_set ( $transient , $value , 'site-transient' , $expiration );
} else {
$transient_timeout = '_site_transient_timeout_' . $transient ;
2017-11-30 18:11:00 -05:00
$option = '_site_transient_' . $transient ;
Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.
WordPress's `get_network_option` function generally makes individual database requests for each network option. While some options are preloaded in `wp_load_core_site_options`, many still require single database calls to the network options table.
Building on the work done in [56445], [56990], and [57013], which introduced the `wp_prime_option_caches` function, this commit adds two new functions: `wp_prime_network_option_caches` and `wp_prime_site_option_caches`. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.
The function `wp_prime_site_option_caches` is similar to `get_site_option`, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.
These functions have been implemented in `wp_load_core_site_options`, `get_site_transient`, and `set_site_transient`.
Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.
Built from https://develop.svn.wordpress.org/trunk@58182
git-svn-id: http://core.svn.wordpress.org/trunk@57645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-05-21 17:38:12 -04:00
wp_prime_site_option_caches ( array ( $option , $transient_timeout ) );
2020-06-27 12:56:02 -04:00
2015-10-07 13:11:25 -04:00
if ( false === get_site_option ( $option ) ) {
2017-11-30 18:11:00 -05:00
if ( $expiration ) {
2015-10-07 13:11:25 -04:00
add_site_option ( $transient_timeout , time () + $expiration );
2017-11-30 18:11:00 -05:00
}
2015-10-07 13:11:25 -04:00
$result = add_site_option ( $option , $value );
2011-12-19 18:15:32 -05:00
} else {
2017-11-30 18:11:00 -05:00
if ( $expiration ) {
2015-10-07 13:11:25 -04:00
update_site_option ( $transient_timeout , time () + $expiration );
2017-11-30 18:11:00 -05:00
}
2015-10-07 13:11:25 -04:00
$result = update_site_option ( $option , $value );
2011-12-19 18:15:32 -05:00
}
}
2020-06-27 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
if ( $result ) {
2014-03-02 18:35:13 -05:00
/**
* Fires after the value for a specific site transient has been set .
*
2014-11-30 06:53:22 -05:00
* The dynamic portion of the hook name , `$transient` , refers to the transient name .
2014-03-02 18:35:13 -05:00
*
* @ since 3.0 . 0
2015-08-28 11:41:21 -04:00
* @ since 4.4 . 0 The `$transient` parameter was added
2014-03-02 18:35:13 -05:00
*
2015-08-25 17:42:20 -04:00
* @ param mixed $value Site transient value .
2015-10-13 17:31:25 -04:00
* @ param int $expiration Time until expiration in seconds .
2015-08-25 17:42:20 -04:00
* @ param string $transient Transient name .
2014-03-02 18:35:13 -05:00
*/
2016-08-22 14:25:31 -04:00
do_action ( " set_site_transient_ { $transient } " , $value , $expiration , $transient );
2014-03-02 18:35:13 -05: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 17:31:25 -04:00
* @ param int $expiration Time until expiration in seconds .
2014-03-02 18:35:13 -05:00
*/
2013-06-16 00:06:12 -04:00
do_action ( 'setted_site_transient' , $transient , $value , $expiration );
2011-12-19 18:15:32 -05:00
}
2020-06-27 12:56:02 -04:00
2011-12-19 18:15:32 -05:00
return $result ;
2015-10-06 13:59:25 -04:00
}
2016-09-30 11:53:29 -04: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-19 22:55:32 -04:00
/**
2020-02-22 20:07:08 -05: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-19 22:55:32 -04: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
2022-07-15 12:00:10 -04:00
* @ since 6.0 . 1 The `show_on_front` , `page_on_front` , and `page_for_posts` options were added .
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-19 22:55:32 -04:00
*/
function register_initial_settings () {
2017-11-30 18:11:00 -05:00
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'blogname' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => array (
'name' => 'title' ,
),
'type' => 'string' ,
2024-05-29 04:53:09 -04:00
'label' => __ ( 'Title' ),
2017-11-30 18:11:00 -05:00
'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-19 22:55:32 -04:00
2017-11-30 18:11:00 -05:00
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'blogdescription' ,
array (
2016-12-03 00:16:44 -05:00
'show_in_rest' => array (
2017-11-30 18:11:00 -05: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-19 22:55:32 -04:00
),
2016-12-03 00:16:44 -05:00
'type' => 'string' ,
2024-05-29 04:53:09 -04:00
'label' => __ ( 'Tagline' ),
2017-11-30 18:11:00 -05:00
'description' => __ ( 'Site tagline.' ),
)
);
if ( ! is_multisite () ) {
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'siteurl' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => array (
'name' => 'url' ,
'schema' => array (
'format' => 'uri' ,
),
),
'type' => 'string' ,
'description' => __ ( 'Site URL.' ),
)
);
2016-12-03 00:16:44 -05: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-19 22:55:32 -04:00
2016-12-03 00:39:42 -05:00
if ( ! is_multisite () ) {
2017-11-30 18:11:00 -05:00
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'admin_email' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => array (
'name' => 'email' ,
'schema' => array (
'format' => 'email' ,
),
2016-12-03 00:39:42 -05:00
),
2017-11-30 18:11:00 -05:00
'type' => 'string' ,
'description' => __ ( 'This address is used for admin purposes, like new user notification.' ),
)
);
}
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'timezone_string' ,
array (
2017-11-30 18:11:00 -05: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-19 22:55:32 -04:00
),
2016-12-03 00:39:42 -05:00
'type' => 'string' ,
2017-11-30 18:11:00 -05:00
'description' => __ ( 'A city in the same timezone as you.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'date_format' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'string' ,
'description' => __ ( 'A date format for all date strings.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'time_format' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'string' ,
'description' => __ ( 'A time format for all time strings.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'start_of_week' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'integer' ,
'description' => __ ( 'A day number of the week that the week should start on.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'general' ,
'WPLANG' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => array (
'name' => 'language' ,
),
'type' => 'string' ,
'description' => __ ( 'WordPress locale code.' ),
'default' => 'en_US' ,
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'writing' ,
'use_smilies' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'boolean' ,
'description' => __ ( 'Convert emoticons like :-) and :-P to graphics on display.' ),
'default' => true ,
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'writing' ,
'default_category' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'integer' ,
'description' => __ ( 'Default post category.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'writing' ,
'default_post_format' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'string' ,
'description' => __ ( 'Default post format.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'reading' ,
'posts_per_page' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => true ,
'type' => 'integer' ,
2024-05-29 04:53:09 -04:00
'label' => __ ( 'Maximum posts per page' ),
2017-11-30 18:11:00 -05:00
'description' => __ ( 'Blog pages show at most.' ),
'default' => 10 ,
)
);
2022-06-29 09:48:14 -04:00
register_setting (
'reading' ,
'show_on_front' ,
array (
'show_in_rest' => true ,
'type' => 'string' ,
2024-05-29 04:53:09 -04:00
'label' => __ ( 'Show on front' ),
2022-06-29 09:48:14 -04:00
'description' => __ ( 'What to show on the front page' ),
)
);
register_setting (
'reading' ,
'page_on_front' ,
array (
'show_in_rest' => true ,
2022-06-29 10:17:16 -04:00
'type' => 'integer' ,
2024-05-29 04:53:09 -04:00
'label' => __ ( 'Page on front' ),
2022-06-29 09:48:14 -04:00
'description' => __ ( 'The ID of the page that should be displayed on the front page' ),
)
);
register_setting (
'reading' ,
'page_for_posts' ,
array (
'show_in_rest' => true ,
2022-06-29 10:17:16 -04:00
'type' => 'integer' ,
2022-06-29 09:48:14 -04:00
'description' => __ ( 'The ID of the page that should display the latest posts' ),
)
);
2017-11-30 18:11:00 -05:00
register_setting (
2018-08-16 21:51:36 -04:00
'discussion' ,
'default_ping_status' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => array (
'schema' => array (
'enum' => array ( 'open' , 'closed' ),
),
2016-10-26 18:21:01 -04:00
),
2017-11-30 18:11:00 -05:00
'type' => 'string' ,
'description' => __ ( 'Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.' ),
)
);
register_setting (
2018-08-16 21:51:36 -04:00
'discussion' ,
'default_comment_status' ,
array (
2017-11-30 18:11:00 -05:00
'show_in_rest' => array (
'schema' => array (
'enum' => array ( 'open' , 'closed' ),
),
2016-10-26 18:21:01 -04:00
),
2017-11-30 18:11:00 -05:00
'type' => 'string' ,
2024-05-29 04:53:09 -04:00
'label' => __ ( 'Allow comments on new posts' ),
2019-05-26 14:51:52 -04:00
'description' => __ ( 'Allow people to submit comments on new posts.' ),
2017-11-30 18:11:00 -05: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-19 22:55:32 -04:00
}
2016-09-30 11:53:29 -04:00
/**
2020-02-22 20:07:08 -05:00
* Registers a setting and its data .
2016-09-30 11:53:29 -04:00
*
* @ since 2.7 . 0
2021-09-21 09:22:01 -04:00
* @ since 3.0 . 0 The `misc` option group was deprecated .
* @ since 3.5 . 0 The `privacy` option group was deprecated .
2016-09-30 11:53:29 -04:00
* @ since 4.7 . 0 `$args` can be passed to set flags on the setting , similar to `register_meta()` .
2020-07-14 08:33:02 -04:00
* @ since 5.5 . 0 `$new_whitelist_options` was renamed to `$new_allowed_options` .
* Please consider writing more inclusive code .
2024-05-29 04:53:09 -04:00
* @ since 6.6 . 0 Added the `label` argument .
2016-09-30 11:53:29 -04:00
*
2020-07-14 08:33:02 -04:00
* @ global array $new_allowed_options
2016-09-30 11:53:29 -04: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 13:26:13 -04: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 12:20:00 -04:00
* 'reading' , 'writing' , and 'options' .
2016-09-30 11:53:29 -04: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 17:56:07 -05:00
* @ type string $type The type of data associated with this setting .
* Valid values are 'string' , 'boolean' , 'integer' , 'number' , 'array' , and 'object' .
2024-05-29 04:53:09 -04:00
* @ type string $label A label of the data attached to this setting .
2020-02-19 17:56:07 -05:00
* @ 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 11:53:29 -04:00
* }
*/
function register_setting ( $option_group , $option_name , $args = array () ) {
2020-07-14 08:33:02 -04: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 11:53:29 -04:00
$defaults = array (
'type' => 'string' ,
'group' => $option_group ,
2024-05-29 04:53:09 -04:00
'label' => '' ,
2016-09-30 11:53:29 -04:00
'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 12:56:02 -04:00
2016-09-30 11:53:29 -04:00
$args = wp_parse_args ( $args , $defaults );
2020-02-19 17:56:07 -05: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 11:53:29 -04:00
if ( ! is_array ( $wp_registered_settings ) ) {
$wp_registered_settings = array ();
}
2020-05-16 14:42:12 -04:00
if ( 'misc' === $option_group ) {
2017-11-30 18:11:00 -05:00
_deprecated_argument (
2018-08-16 21:51:36 -04:00
__FUNCTION__ ,
'3.0.0' ,
2017-11-30 18:11:00 -05: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 13:13:59 -04:00
/* translators: %s: misc */
2017-11-30 18:11:00 -05:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 06:50:41 -05:00
'misc'
)
);
2016-09-30 11:53:29 -04:00
$option_group = 'general' ;
}
2020-05-16 14:42:12 -04:00
if ( 'privacy' === $option_group ) {
2017-11-30 18:11:00 -05:00
_deprecated_argument (
2018-08-16 21:51:36 -04:00
__FUNCTION__ ,
'3.5.0' ,
2017-11-30 18:11:00 -05: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 13:13:59 -04:00
/* translators: %s: privacy */
2017-11-30 18:11:00 -05:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 06:50:41 -05:00
'privacy'
)
);
2016-09-30 11:53:29 -04:00
$option_group = 'reading' ;
}
2020-07-14 08:33:02 -04:00
$new_allowed_options [ $option_group ][] = $option_name ;
2020-07-05 11:07:06 -04:00
2016-09-30 11:53:29 -04:00
if ( ! empty ( $args [ 'sanitize_callback' ] ) ) {
add_filter ( " sanitize_option_ { $option_name } " , $args [ 'sanitize_callback' ] );
}
2016-10-25 13:08:29 -04:00
if ( array_key_exists ( 'default' , $args ) ) {
add_filter ( " default_option_ { $option_name } " , 'filter_default_option' , 10 , 3 );
}
2016-09-30 11:53:29 -04:00
2020-07-05 11:07:06 -04: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 11:53:29 -04:00
$wp_registered_settings [ $option_name ] = $args ;
}
/**
2020-02-22 20:07:08 -05:00
* Unregisters a setting .
2016-09-30 11:53:29 -04: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 08:33:02 -04:00
* @ since 5.5 . 0 `$new_whitelist_options` was renamed to `$new_allowed_options` .
* Please consider writing more inclusive code .
2016-09-30 11:53:29 -04:00
*
2020-07-14 08:33:02 -04:00
* @ global array $new_allowed_options
2019-01-08 01:00:50 -05:00
* @ global array $wp_registered_settings
2016-09-30 11:53:29 -04:00
*
2021-11-08 05:48:59 -05: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 11:53:29 -04:00
*/
function unregister_setting ( $option_group , $option_name , $deprecated = '' ) {
2020-07-14 08:33:02 -04: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 11:53:29 -04:00
2020-05-16 14:42:12 -04:00
if ( 'misc' === $option_group ) {
2017-11-30 18:11:00 -05:00
_deprecated_argument (
2018-08-16 21:51:36 -04:00
__FUNCTION__ ,
'3.0.0' ,
2017-11-30 18:11:00 -05: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 13:13:59 -04:00
/* translators: %s: misc */
2017-11-30 18:11:00 -05:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 06:50:41 -05:00
'misc'
)
);
2016-09-30 11:53:29 -04:00
$option_group = 'general' ;
}
2020-05-16 14:42:12 -04:00
if ( 'privacy' === $option_group ) {
2017-11-30 18:11:00 -05:00
_deprecated_argument (
2018-08-16 21:51:36 -04:00
__FUNCTION__ ,
'3.5.0' ,
2017-11-30 18:11:00 -05: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 13:13:59 -04:00
/* translators: %s: privacy */
2017-11-30 18:11:00 -05:00
__ ( 'The "%s" options group has been removed. Use another settings group.' ),
2017-01-29 06:50:41 -05:00
'privacy'
)
);
2016-09-30 11:53:29 -04:00
$option_group = 'reading' ;
}
Options, Meta APIs: Check setting group exists before search in unregister_setting().
Checks if the given `$option_group` exists before searching for the `$option_name`. Sets the `$pos` to `false`, as `array_search()` returns `false` if the option name (needle) does not exist.
This changeset fixes 2 different PHP Warning|Notice scenarios:
1. When the global `$new_allowed_options` is `null`, fixes raising `Trying to access array offset on value of type null` PHP Notice (PHP 7.4) | Warning (on PHP 8).
2. When the global `$new_allowed_options` is an `array` and the setting group key does not exist, fixes raising "Undefined index: unknown_setting_group" PHP Notice (PHP 7) | Warning (on PHP 8).
For both scenarios, the `array_search()` is skipped and the `$pos` is set to a default of `false`, i.e. which is the value returned when `array_search()` is unsuccessful.
Props xknown, hellofromTonya, nicolefurlan, oglekler, SergeyBiryukov, shailu25.
Fixes #57674.
Built from https://develop.svn.wordpress.org/trunk@56817
git-svn-id: http://core.svn.wordpress.org/trunk@56329 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-10 08:52:25 -04:00
$pos = false ;
if ( isset ( $new_allowed_options [ $option_group ] ) ) {
$pos = array_search ( $option_name , ( array ) $new_allowed_options [ $option_group ], true );
}
2020-07-05 11:07:06 -04:00
2020-02-09 11:55:09 -05:00
if ( false !== $pos ) {
2020-07-14 08:33:02 -04:00
unset ( $new_allowed_options [ $option_group ][ $pos ] );
2016-09-30 11:53:29 -04:00
}
2020-07-05 11:07:06 -04:00
2016-09-30 11:53:29 -04:00
if ( '' !== $deprecated ) {
2017-11-30 18:11:00 -05:00
_deprecated_argument (
2018-08-16 21:51:36 -04:00
__FUNCTION__ ,
'4.7.0' ,
2017-11-30 18:11:00 -05: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 13:13:59 -04:00
/* translators: 1: $sanitize_callback, 2: register_setting() */
2017-11-30 18:11:00 -05:00
__ ( '%1$s is deprecated. The callback from %2$s is used instead.' ),
2017-01-29 06:50:41 -05:00
'<code>$sanitize_callback</code>' ,
'<code>register_setting()</code>'
)
);
2016-09-30 11:53:29 -04: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 09:49:32 -05: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 11:07:06 -04: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 11:53:29 -04:00
unset ( $wp_registered_settings [ $option_name ] );
}
}
/**
* Retrieves an array of registered settings .
*
* @ since 4.7 . 0
*
2019-01-08 01:00:50 -05:00
* @ global array $wp_registered_settings
*
2016-09-30 11:53:29 -04: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 13:08:29 -04:00
/**
2020-02-22 20:07:08 -05:00
* Filters the default value for the option .
2016-10-25 13:08:29 -04: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
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
* @ param mixed $default_value Existing default value to return .
2020-07-23 17:11:05 -04:00
* @ param string $option Option name .
* @ param bool $passed_default Was `get_option()` passed a default value ?
2016-10-25 13:08:29 -04:00
* @ return mixed Filtered default value .
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
function filter_default_option ( $default_value , $option , $passed_default ) {
2016-10-25 13:08:29 -04:00
if ( $passed_default ) {
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return $default_value ;
2016-10-25 13:08:29 -04:00
}
$registered = get_registered_settings ();
if ( empty ( $registered [ $option ] ) ) {
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54948
git-svn-id: http://core.svn.wordpress.org/trunk@54500 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-07 16:32:15 -05:00
return $default_value ;
2016-10-25 13:08:29 -04:00
}
return $registered [ $option ][ 'default' ];
}
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
/**
* Returns the values that trigger autoloading from the options table .
*
* @ since 6.6 . 0
*
2024-05-02 09:19:14 -04:00
* @ return string [] The values that trigger autoloading .
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
*/
function wp_autoload_values_to_autoload () {
$autoload_values = array ( 'yes' , 'on' , 'auto-on' , 'auto' );
/**
* Filters the autoload values that should be considered for autoloading from the options table .
*
* The filter can only be used to remove autoload values from the default list .
*
* @ since 6.6 . 0
*
2024-05-02 09:19:14 -04:00
* @ param string [] $autoload_values Autoload values used to autoload option .
Options, Meta APIs: Use more sensible default for autoloading options which allows WordPress core to make a decision.
An excessive amount of autoloaded options is a common cause for slow database responses, sometimes caused by very large individual autoloaded options. As it is not mandatory to provide an autoload value when adding an option to the database, it tends to be ignored, which in combination with a default value of "yes" and lack of documentation can lead to the aforementioned problem.
This changeset enhances the option autoloading behavior in several ways:
* Update the function documentation to encourage the use of boolean `true` or `false` to explicitly provide an autoload value for an option.
* Use new string values `on` and `off` for explicitly provided values stored in the database, to distinguish them from `yes` and `no`, since `yes` does not allow determining whether it was set intentionally by the developer or only as a default.
* Effectively deprecate the values `yes` and `no`. They are still supported for backward compatibility, but now discouraged.
* Use `null` as new default autoload value for `add_option()`. If the developer does not provide an explicit value, this will now trigger WordPress logic to determine an autoload value to use:
* If WordPress determines that the option should not be autoloaded, it is stored in the database as `auto-off`. As part of this changeset, the single heuristic introduced for that is to check whether the option size is larger than a threshold of 150k bytes. This threshold is filterable via a new `wp_max_autoloaded_option_size` filter.
* If WordPress determines that the option should be autoloaded, it is stored in the database as `auto-on`. No logic to make such a decision is introduced as part of this changeset, but a new filter `wp_default_autoload_value` can be used to define such heuristics, e.g. by optimization plugins.
* If WordPress cannot determine whether or not to autoload the option, it is stored in the database as `auto`.
* This effectively means that any option without an explicit autoload value provided by the developer will be stored with an autoload value of `auto`, unless the option's size exceeds the aforementioned threshold. Options with a value of `auto` are still autoloaded as of today, most importantly for backward compatibility. A new function `wp_autoload_values_to_autoload()` returns the list of autolaod values that dictate for an option to be autoloaded, and a new filter `wp_autoload_values_to_autoload` can be used to alter that list.
These behavioral changes encourage developers to be more mindful of autoloading, while providing WordPress core and optimization plugins with additional control over heuristics for autoloading options where no explicit autoload value was provided.
At the same time, the changes are fully backward compatible from a functionality perspective, with the only exception being that very large options will now no longer be autoloaded if the developer did not explicitly request for them to be autoloaded. Neither WordPress core nor plugins are able to override an explicitly provided value, which is intentional to continue giving developers full control over their own options.
Props pbearne, flixos90, joemcgill, azaozz, spacedmonkey, swissspidy, mukesh27, markjaquith.
Fixes #42441.
Built from https://develop.svn.wordpress.org/trunk@57920
git-svn-id: http://core.svn.wordpress.org/trunk@57421 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-04-03 17:31:15 -04:00
* Default list contains 'yes' , 'on' , 'auto-on' , and 'auto' .
*/
$filtered_values = apply_filters ( 'wp_autoload_values_to_autoload' , $autoload_values );
return array_intersect ( $filtered_values , $autoload_values );
}