On this page
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
$idint Required-
The attachment ID in the cache to clean.
$clean_termsbool Optional-
Whether to clean terms cache.
Default:
false
Source
File: wp-includes/post.php. View all references
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 );
}
Hooks
- do_action( 'clean_attachment_cache',
int $id ) -
Fires after the given attachment’s cache is cleaned.
Related
Uses
| Uses | Description |
|---|---|
| wp_cache_delete() wp-includes/cache.php | Removes the cache contents 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/plugin.php | Calls the callback functions that have been added to an action hook. |
Used By
| Used By | Description |
|---|---|
| wp_media_attach_action() wp-admin/includes/media.php | Encapsulates the logic for Attach/Detach actions. |
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/clean_attachment_cache