WP_Customize_Widgets::get_setting_args( string $id, array $overrides = array() ): array

Compatibility

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

Parameters

$idstring

Widget setting ID.

$overridesarrayoptional

Array of setting overrides.Default: array()

Return value

array

Possibly modified setting arguments.

Performance profile

How much work a call to WP_Customize_Widgets::get_setting_args() 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

7

Executed per call on PHP 8.5. The body compiles to 84.

Plugin surface

1 hook

Third-party callbacks on 'widget_customizer_setting_args' 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 · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while WP_Customize_Widgets::get_setting_args() runs, in this order:

1. 1
   apply_filters( widget_customizer_setting_args )filterline 1030 (+34 into the body)

   Filters the common arguments supplied when constructing a Customizer setting.

Uses · 5

• current_theme_supports()Checks a theme's support for a given feature.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Customize_Widgets::sanitize_widget_instance()Sanitizes a widget instance.
• WP_Customize_Widgets::sanitize_widget_js_instance()Converts a widget instance into JSON-representable format.
• WP_Customize_Widgets::is_widget_selective_refreshable()Determines if a widget supports selective refresh.

Used by · 2

• WP_Customize_Widgets::customize_register()Registers Customizer settings and controls for all sidebars and widgets.
• WP_Customize_Widgets::filter_customize_dynamic_setting_args()Determines the arguments for a dynamically-created setting.

Source code

View on Trac ↗View on GitHub ↗

996	public function get_setting_args( $id, $overrides = array() ) {997		$args = array(998			'type'       => 'option',999			'capability' => 'edit_theme_options',1000			'default'    => array(),1001		);1002 1003		if ( preg_match( $this->setting_id_patterns['sidebar_widgets'], $id, $matches ) ) {1004			$args['sanitize_callback']    = array( $this, 'sanitize_sidebar_widgets' );1005			$args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' );1006			$args['transport']            = current_theme_supports( 'customize-selective-refresh-widgets' ) ? 'postMessage' : 'refresh';1007		} elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) {1008			$id_base                      = $matches['id_base'];1009			$args['sanitize_callback']    = function ( $value ) use ( $id_base ) {1010				return $this->sanitize_widget_instance( $value, $id_base );1011			};1012			$args['sanitize_js_callback'] = function ( $value ) use ( $id_base ) {1013				return $this->sanitize_widget_js_instance( $value, $id_base );1014			};1015			$args['transport']            = $this->is_widget_selective_refreshable( $matches['id_base'] ) ? 'postMessage' : 'refresh';1016		}1017 1018		$args = array_merge( $args, $overrides );1019 1020		/**1021		 * Filters the common arguments supplied when constructing a Customizer setting.1022		 *1023		 * @since 3.9.01024		 *1025		 * @see WP_Customize_Setting1026		 *1027		 * @param array  $args Array of Customizer setting arguments.1028		 * @param string $id   Widget setting ID.1029		 */1030		return apply_filters( 'widget_customizer_setting_args', $args, $id );1031	}

Changelog

Introduced in 3.9.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 6.9.7 tag, from src/wp-includes/class-wp-customize-widgets.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.