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

$default_valuemixedrequired

Existing default value to return.

$optionstringrequired

Option name.

$passed_defaultboolrequired

Was get_option() passed a default value?

Return

Source

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'];
}

View all references View on Trac View on GitHub

Changelog