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

Adds objects to the metadata lazy-load queue.

Parameters

$object_typestringrequired
Type of object whose meta is to be lazy-loaded. Accepts 'term' or 'comment'.
$object_idsarrayrequired
Array of object IDs.

Return

void|WP_Error WP_Error on failure.

Source

public function queue_objects( $object_type, $object_ids ) {
	if ( ! isset( $this->settings[ $object_type ] ) ) {
		return new WP_Error( 'invalid_object_type', __( 'Invalid object type.' ) );
	}

	$type_settings = $this->settings[ $object_type ];

	if ( ! isset( $this->pending_objects[ $object_type ] ) ) {
		$this->pending_objects[ $object_type ] = array();
	}

	foreach ( $object_ids as $object_id ) {
		// Keyed by ID for faster lookup.
		if ( ! isset( $this->pending_objects[ $object_type ][ $object_id ] ) ) {
			$this->pending_objects[ $object_type ][ $object_id ] = 1;
		}
	}

	add_filter( $type_settings['filter'], $type_settings['callback'], 10, 5 );

	/**
	 * Fires after objects are added to the metadata lazy-load queue.
	 *
	 * @since 4.5.0
	 *
	 * @param array                  $object_ids  Array of object IDs.
	 * @param string                 $object_type Type of object being queued.
	 * @param WP_Metadata_Lazyloader $lazyloader  The lazy-loader object.
	 */
	do_action( 'metadata_lazyloader_queued_objects', $object_ids, $object_type, $this );
}

Hooks

do_action( ‘metadata_lazyloader_queued_objects’, array $object_ids, string $object_type, WP_Metadata_Lazyloader $lazyloader )

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

Changelog

VersionDescription
4.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.