clean_attachment_cache() WordPress Function
The clean_attachment_cache() function is used to clean up the WordPress attachment cache. This function is typically called when an attachment is deleted or when a plugin is deactivated.
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 value: false
Source
File: 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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |