WP_Customize_Widgets::is_wide_widget( string $widget_id ): bool
- Since
- 3.9.0
- Source
wp-includes/class-wp-customize-widgets.php:600
Description
Core widgets which may have controls wider than 250, but can still be shown in the narrow Customizer panel. The RSS and Text widgets in Core, for example, have widths of 400 and yet they still render fine in the Customizer panel.
This method will return all Core widgets as being not wide, but this can be overridden with the 'is_wide_widget_in_customizer' filter.
Compatibility
- WordPress
- since 3.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$widget_idstring- Widget ID.
Return value
bool- Whether or not the widget is a "wide" widget.
Performance profile
How much work a call to WP_Customize_Widgets::is_wide_widget() 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
- Scaling
- Constant
- Instructions
- 21–22
- Plugin surface
- 1 hook
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 22.
Third-party callbacks on 'is_wide_widget_in_customizer' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_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::is_wide_widget() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 21–22 | ->parse_widget_id(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 22 | 21–22 | 1 | |
| 8.5 | 22 | 21–22 | 1 | |
| 8.4 | 22 | 21–22 | 1 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 25 | 24–25 | 1 | |
| 8.2 | 25 | 24–25 | 1 | |
| 8.1 | 25 | 24–25 | 1 | |
| 7.4 | 25 | 24–25 | 1 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while WP_Customize_Widgets::is_wide_widget() runs, in this order:
- apply_filters( is_wide_widget_in_customizer )filterline 616 (+16 into the body)
Filters whether the given widget is considered "wide".
Uses · 2
- apply_filters()Calls the callback functions that have been added to a filter hook.
- WP_Customize_Widgets::parse_widget_id()Converts a widget ID into its id_base and number components.
Used by · 2
- WP_Customize_Widgets::customize_register()Registers Customizer settings and controls for all sidebars and widgets.
- WP_Customize_Widgets::get_available_widgets()Builds up an index of all available widgets for use in Backbone models.
Source code
public function is_wide_widget( $widget_id ) { global $wp_registered_widget_controls; $parsed_widget_id = $this->parse_widget_id( $widget_id ); $width = $wp_registered_widget_controls[ $widget_id ]['width']; $is_core = in_array( $parsed_widget_id['id_base'], $this->core_widget_id_bases, true ); $is_wide = ( $width > 250 && ! $is_core ); /** * Filters whether the given widget is considered "wide". * * @since 3.9.0 * * @param bool $is_wide Whether the widget is wide, Default false. * @param string $widget_id Widget ID. */ return apply_filters( 'is_wide_widget_in_customizer', $is_wide, $widget_id ); }Changelog
Introduced in 3.9.0. Unchanged from 6.7.7 through 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-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.