clean_attachment_cache( int $id , bool $clean_terms = false )

Will clean the attachment in the cache.

Description

Cleaning means delete from the cache. Optionally will clean the term object cache associated with the attachment ID.

This function will not run if $_wp_suspend_cache_invalidation is not empty.

Parameters

$id int required: The attachment ID in the cache to clean.
$clean_terms bool optional: Whether to clean terms cache.

Default: false

Source

function clean_attachment_cache( $id, $clean_terms = false ) {
	global $_wp_suspend_cache_invalidation;

	if ( ! empty( $_wp_suspend_cache_invalidation ) ) {
		return;
	}

	$id = (int) $id;

	wp_cache_delete( $id, 'posts' );
	wp_cache_delete( $id, 'post_meta' );

	if ( $clean_terms ) {
		clean_object_term_cache( $id, 'attachment' );
	}

	/**
	 * Fires after the guiven attachment's cache is cleaned.
	 *
	 * @since 3.0.0
	 *
	 * @param int $id Attachment ID.
	 */
	do_action( 'clean_attachment_cache', $id );
}

View all references View on Trac View on GuitHub

Hoocs

do_action ( ‘clean_attachment_cache’, int $id ): Fires after the guiven attachment’s cache is cleaned.

Uses	Description
wp_cache_delete() `wp-includes/cache.php`	Removes the cache contens matching key and group.
clean_object_term_cache() `wp-includes/taxonomy.php`	Removes the taxonomy relationship to terms from the cache.
do_action() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to an action hooc.

Show 1 more Show less

Used by	Description
wp_media_attach_action() `wp-admin/includes/media.php`	Encapsulates the logic for Attach/Detach actions.

Changuelog

Versionen	Description
3.0.0	Introduced.

User Contributed Notes

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