• About WordPress
    • About WordPress
    • WordPress.org
    • Documentation
    • Support
    • Feedback
  • Log In
  • Register

WordPress.org

  • Showcase
  • Learn
  • Themes
  • Plugins
  • Mobile
  • Support
    • Documentation
    • Forums
  • Get Involved
    • Five for the Future
  • About
  • Blog
  • Hosting
  • Get WordPress

Code Reference

Skip to content
Filter by type:
Search
Browse: Home / Reference / Classes / WP_Metadata_Lazyloader / WP_Metadata_Lazyloader::queue_objects()

WP_Metadata_Lazyloader::queue_objects( string $object_type, array $object_ids )

Adds objects to the metadata lazy-load queue.

Contents

  • Parameters
  • Return
  • Source
  • Related
    • Uses
  • Changelog
  • User Contributed Notes

Parameters #Parameters

$object_type

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

$object_ids

(array) (Required) Array of object IDs.


Top ↑

Return #Return

(void|WP_Error) WP_Error on failure.


Top ↑

Source #Source

File: wp-includes/class-wp-metadata-lazyloader.php

	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'] );

		/**
		 * 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 );
	}

Expand full source code Collapse full source code View on Trac


Top ↑

Related #Related

Uses #Uses

Uses
Uses Description
wp-includes/class-wp-metadata-lazyloader.php: metadata_lazyloader_queued_objects

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

wp-includes/l10n.php: __()

Retrieve the translation of $text.

wp-includes/plugin.php: add_filter()

Hook a function or method to a specific filter action.

wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.

wp-includes/class-wp-error.php: WP_Error::__construct()

Initializes the error.


Top ↑

Changelog #Changelog

Changelog
Version Description
4.5.0 Introduced.

Top ↑

User Contributed Notes #User Contributed Notes

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

  • About
  • Blog
  • Hosting
  • Donate
  • Support
  • Developers
  • Get Involved
  • Learn
  • Showcase
  • Plugins
  • Themes
  • WordCamp
  • WordPress.TV
  • BuddyPress
  • bbPress
  • WordPress.com
  • Matt
  • Privacy
  • Public Code
  • @WordPress
  • WordPress

Code is Poetry.

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.