default_option_(option) │ filter-hook │ WP 3.4.0

Filters the default value for an option.

The dynamic portion of the hook name, $option, refers to the option name.

Usage

add_filter( 'default_option_(option)', 'wp_kama_default_option_filter', 10, 3 );

/**
 * Function for `default_option_(option)` filter-hook.
 * 
 * @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 mixed
 */
function wp_kama_default_option_filter( $default_value, $option, $passed_default ){

	// filter...
	return $default_value;
}

$default_value(mixed)

The default value to return if the option does not exist in the database.

$option(string)

Option name.

$passed_default(true|false)

Was get_option() passed a default value?

Changelog

Where the hook is called

return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );

return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );

return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );

if ( apply_filters( "default_option_{$option}", false, $option, false ) === $old_value ) {

if ( apply_filters( "default_option_{$option}", false, $option, false ) !== get_option( $option ) ) {

Where the hook is used in WordPress

add_filter( "default_option_{$id_base}", $multidimensional_filter );

add_filter( 'default_option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );

add_filter( 'default_option_link_manager_enabled', '__return_true' );

add_filter( "default_option_{$option_name}", 'filter_default_option', 10, 3 );

remove_filter( "default_option_{$option_name}", 'filter_default_option', 10 );