filter_default_option( mixed $default_value, 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}.


Top ↑

Parameters

$default_value mixed Required
Existing default value to return.
$option string Required
Option name.
$passed_default bool Required
Was get_option() passed a default value?

Top ↑

Return

mixed Filtered default value.


Top ↑

Source

File: wp-includes/option.php. View all references

function filter_default_option( $default_value, $option, $passed_default ) {
	if ( $passed_default ) {
		return $default_value;
	}

	$registered = get_registered_settings();
	if ( empty( $registered[ $option ] ) ) {
		return $default_value;
	}

	return $registered[ $option ]['default'];
}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.