customize_dynamic_setting_args │ filter-hook │ WP 4.2.0

Filters a dynamic setting's constructor args.

For a dynamic setting to be registered, this filter must be employed to override the default false value with an array of args to pass to the WP_Customize_Setting constructor.

Usage

add_filter( 'customize_dynamic_setting_args', 'wp_kama_customize_dynamic_setting_args_filter', 10, 2 );

/**
 * Function for `customize_dynamic_setting_args` filter-hook.
 * 
 * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor.
 * @param string      $setting_id   ID for dynamic setting, usually coming from `$_POST['customized']`.
 *
 * @return false|array
 */
function wp_kama_customize_dynamic_setting_args_filter( $setting_args, $setting_id ){

	// filter...
	return $setting_args;
}

$setting_args(false|array)

The arguments to the WP_Customize_Setting constructor.

$setting_id(string)

ID for dynamic setting, usually coming from $_POST['customized'].

Changelog

Where the hook is called

$setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id );

$args = apply_filters( 'customize_dynamic_setting_args', $args, $id );

Where the hook is used in WordPress

add_filter( 'customize_dynamic_setting_args', array( $this, 'filter_dynamic_setting_args' ), 10, 2 );

add_filter( 'customize_dynamic_setting_args', array( $this, 'filter_customize_dynamic_setting_args' ), 10, 2 );