A WordPress-centric search engine for devs and theme authors



clean_attachment_cache ›

Since3.0.0
Deprecatedn/a
clean_attachment_cache ( $id, $clean_terms = false )
Parameters: (2)
  • (int) $id The attachment ID in the cache to clean.
    Required: Yes
  • (bool) $clean_terms Optional. Whether to clean terms cache. Default false.
    Required: No
    Default: false
Defined at:
Codex:

Will clean the attachment in the cache.

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.



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 given attachment's cache is cleaned.
	 *
	 * @since 3.0.0
	 *
	 * @param int $id Attachment ID.
	 */
	do_action( 'clean_attachment_cache', $id );
}