WP_Metadata_Lazyloader::queue_objects( string $object_type, array $object_ids ): void|WP_Error

Compatibility

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

Parameters

$object_typestring

Type of object whose meta is to be lazy-loaded. Accepts 'term' or 'comment'.

$object_idsarray

Array of object IDs.

Return value

void|WP_Error

WP_Error on failure.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

13–34

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

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_Metadata_Lazyloader::queue_objects() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Metadata_Lazyloader::queue_objects() runs, in this order:

1. 1
   do_action( metadata_lazyloader_queued_objects )actionline 109 (+29 into the body)

   Fires after objects are added to the metadata lazy-load queue.

Uses · 4

• __()Retrieves the translation of $text.
• add_filter()Adds a callback function to a filter hook.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

80	public function queue_objects( $object_type, $object_ids ) {81		if ( ! isset( $this->settings[ $object_type ] ) ) {82			return new WP_Error( 'invalid_object_type', __( 'Invalid object type.' ) );83		}84 85		$type_settings = $this->settings[ $object_type ];86 87		if ( ! isset( $this->pending_objects[ $object_type ] ) ) {88			$this->pending_objects[ $object_type ] = array();89		}90 91		foreach ( $object_ids as $object_id ) {92			// Keyed by ID for faster lookup.93			if ( ! isset( $this->pending_objects[ $object_type ][ $object_id ] ) ) {94				$this->pending_objects[ $object_type ][ $object_id ] = 1;95			}96		}97 98		add_filter( $type_settings['filter'], $type_settings['callback'], 10, 5 );99 100		/**101		 * Fires after objects are added to the metadata lazy-load queue.102		 *103		 * @since 4.5.0104		 *105		 * @param array                  $object_ids  Array of object IDs.106		 * @param string                 $object_type Type of object being queued.107		 * @param WP_Metadata_Lazyloader $lazyloader  The lazy-loader object.108		 */109		do_action( 'metadata_lazyloader_queued_objects', $object_ids, $object_type, $this );110	}

Changelog

Introduced in 4.5.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.7.7 tag, from src/wp-includes/class-wp-metadata-lazyloader.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.