clean_attachment_cache
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 (2)
- 0. $id (int)
- The attachment ID in the cache to clean.
- 1. $clean_terms — Optional. (bool) =>
false
- Whether to clean terms cache. Default false.
Usage
if ( !function_exists( 'clean_attachment_cache' ) ) { require_once ABSPATH . WPINC . '/post.php'; } // The attachment ID in the cache to clean. $id = -1; // Optional. Whether to clean terms cache. Default false. $clean_terms = false; // NOTICE! Understand what this does before running. $result = clean_attachment_cache($id, $clean_terms);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/post.php
- 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 );
- }