WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Metadata_Lazyloader::reset_queue()

WP_Metadata_Lazyloader::reset_queue( string $object_type ): void|WP_Error

In this article

Back to top

Resets lazy-load queue for a given object type.

Parameters

$object_typestringrequired
Object type. Accepts 'comment' or 'term'.

Return

void|WP_Error WP_Error on failure.

Source

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

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

	$this->pending_objects[ $object_type ] = array();
	remove_filter( $type_settings['filter'], $type_settings['callback'] );
}

View all references View on Trac View on GitHub

UsesDescription
remove_filter()wp-includes/plugin.php

Removes a callback function from a filter hook.

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

Initializes the error.

Used byDescription
WP_Metadata_Lazyloader::lazyload_meta_callback()wp-includes/class-wp-metadata-lazyloader.php

Lazy-loads meta for queued objects.

Changelog

VersionDescription
4.5.0Introduced.

User Contributed Notes

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