WP_Widget::display_callback( array $args, int|array $widget_args = 1 )
- Since
- 2.8.0
- Source
wp-includes/class-wp-widget.php:360
Description
Finds the instance and calls WP_Widget::widget().
Compatibility
- WordPress
- since 2.8.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
$argsarray- Display arguments. See WP_Widget::widget() for information on accepted arguments.
$widget_argsint|arrayoptional- Internal order number of the widget instance, or array of multi-widget arguments. Default 1.Default:
1$numberintNumber increment used for multiples of the same widget.
Performance profile
How much work a call to WP_Widget::display_callback() 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–55
- Plugin surface
- 1 hook
- Called by
- 0
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 56.
Third-party callbacks on 'widget_display_callback' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Widget::display_callback() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($instances) | 21–23 | wp_parse_args(), ->_set(), ->get_settings() |
isset($instances) && $instance === false | 33–35 | wp_parse_args(), ->_set(), ->get_settings(), apply_filters() |
isset($instances) && $instance !== false && !->is_preview() | 46–49 | wp_parse_args(), ->_set(), ->get_settings(), apply_filters(), wp_suspend_cache_addition(), ->is_preview(), ->widget(), ->is_preview() |
isset($instances) && $instance !== false && ->is_preview() | 49–52 | wp_parse_args(), ->_set(), ->get_settings(), apply_filters(), wp_suspend_cache_addition(), ->is_preview(), ->widget(), ->is_preview(), wp_suspend_cache_addition() |
isset($instances) && $instance !== false | 50–52 | wp_parse_args(), ->_set(), ->get_settings(), apply_filters(), wp_suspend_cache_addition(), ->is_preview(), wp_suspend_cache_addition(), ->widget(), ->is_preview() |
isset($instances) && $instance !== false && ->is_preview() | 53–55 | wp_parse_args(), ->_set(), ->get_settings(), apply_filters(), wp_suspend_cache_addition(), ->is_preview(), wp_suspend_cache_addition(), ->widget(), ->is_preview(), wp_suspend_cache_addition() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 56 | 21–55 | 6 | |
| 8.5 | 56 | 21–55 | 6 | |
| 8.4 | 56 | 21–55 | 6 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 58 | 23–57 | 6 | |
| 8.2 | 58 | 23–57 | 6 | |
| 8.1 | 58 | 23–57 | 6 | |
| 7.4 | 58 | 23–57 | 6 |
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_Widget::display_callback() runs, in this order:
- apply_filters( widget_display_callback )filterline 383 (+23 into the body)
Filters the settings for a particular widget instance.
Uses · 7
- wp_parse_args()Merges user defined arguments into defaults array.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_suspend_cache_addition()Temporarily suspends cache additions.
- WP_Widget::_set()Sets the internal order number for the widget instance.
- WP_Widget::get_settings()Retrieves the settings for all instances of the widget class.
- WP_Widget::is_preview()Determines whether the current request is inside the Customizer preview.
- WP_Widget::widget()Echoes the widget content.
Source code
public function display_callback( $args, $widget_args = 1 ) { if ( is_numeric( $widget_args ) ) { $widget_args = array( 'number' => $widget_args ); } $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) ); $this->_set( $widget_args['number'] ); $instances = $this->get_settings(); if ( isset( $instances[ $this->number ] ) ) { $instance = $instances[ $this->number ]; /** * Filters the settings for a particular widget instance. * * Returning false will effectively short-circuit display of the widget. * * @since 2.8.0 * * @param array $instance The current widget instance's settings. * @param WP_Widget $widget The current widget instance. * @param array $args An array of default widget arguments. */ $instance = apply_filters( 'widget_display_callback', $instance, $this, $args ); if ( false === $instance ) { return; } $was_cache_addition_suspended = wp_suspend_cache_addition(); if ( $this->is_preview() && ! $was_cache_addition_suspended ) { wp_suspend_cache_addition( true ); } $this->widget( $args, $instance ); if ( $this->is_preview() ) { wp_suspend_cache_addition( $was_cache_addition_suspended ); } } }Changelog
Introduced in 2.8.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 6.7.7 tag, from
src/wp-includes/class-wp-widget.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.