WP_Customize_Manager::add_setting( WP_Customize_Setting|string $id, array $args = array() ): WP_Customize_Setting

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$idWP_Customize_Setting|string

Customize Setting object, or ID.

$argsarrayoptional

Array of properties for the new Setting object.
See WP_Customize_Setting::__construct() for information on accepted arguments. Default empty array.Default: array()

Return value

WP_Customize_Setting

The instance of the setting that was added.

Performance profile

How much work a call to WP_Customize_Manager::add_setting() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–31

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 33.

Plugin surface

2 hooks

Third-party callbacks on 'customize_dynamic_setting_args', 'customize_dynamic_setting_class' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::add_setting() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Customize_Manager::add_setting() runs, in this order:

1. 1
   apply_filters( customize_dynamic_setting_args )filterline 3787 (+7 into the body)

   Filters a dynamic setting's constructor args.

2. 2
   apply_filters( customize_dynamic_setting_class )filterline 3790 (+10 into the body)

   Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Customize_Manager::add_dynamic_settings()Registers any dynamically-created settings, such as those from $_POST['customized'] that have no corresponding setting created.
• WP_Customize_Manager::register_controls()Registers some default controls.

Source code

View on Trac ↗View on GitHub ↗

3780	public function add_setting( $id, $args = array() ) {3781		if ( $id instanceof WP_Customize_Setting ) {3782			$setting = $id;3783		} else {3784			$class = 'WP_Customize_Setting';3785 3786			/** This filter is documented in wp-includes/class-wp-customize-manager.php */3787			$args = apply_filters( 'customize_dynamic_setting_args', $args, $id );3788 3789			/** This filter is documented in wp-includes/class-wp-customize-manager.php */3790			$class = apply_filters( 'customize_dynamic_setting_class', $class, $id, $args );3791 3792			$setting = new $class( $this, $id, $args );3793		}3794 3795		$this->settings[ $setting->id ] = $setting;3796		return $setting;3797	}

Changelog

Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/class-wp-customize-manager.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.