On this page
filter_default_option( mixed $default, string $option, bool $passed_default ): mixed
Filters the default value for the option.
Description
For settings which register a default setting in register_setting(), this function is added as a filter to default_option_{$option}.
Parameters
$defaultmixed Required-
Existing default value to return.
$optionstring Required-
Option name.
$passed_defaultbool Required-
Was
get_option()passed a default value?
Return
mixed Filtered default value.
Source
File: wp-includes/option.php. View all references
function filter_default_option( $default, $option, $passed_default ) {
if ( $passed_default ) {
return $default;
}
$registered = get_registered_settings();
if ( empty( $registered[ $option ] ) ) {
return $default;
}
return $registered[ $option ]['default'];
}
Related
Uses
| Uses | Description |
|---|---|
| get_registered_settings() wp-includes/option.php | Retrieves an array of registered settings. |
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/filter_default_option