云策 WordPress 开发者社区

函数文档

clean_post_cache()

查看官方原文 ↗
💡 云策文档标注

概述

clean_post_cache() 函数用于从缓存中清理指定文章的数据，包括文章对象、元数据和相关分类术语缓存。该函数在 $_wp_suspend_cache_invalidation 不为空时不会执行。

关键要点

  • 清理缓存包括删除 posts、post_meta 和 post_parent 缓存条目，以及调用 clean_object_term_cache() 清理相关术语缓存。
  • 函数接受文章 ID 或 WP_Post 对象作为参数，并会触发 clean_post_cache 和 clean_page_cache（针对页面类型）钩子。
  • 执行前会检查 $_wp_suspend_cache_invalidation 全局变量，若不为空则直接返回，避免缓存无效化。

代码示例

function clean_post_cache( $post ) {
	global $_wp_suspend_cache_invalidation;

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

	$post = get_post( $post );

	if ( ! $post ) {
		return;
	}

	wp_cache_delete( $post->ID, 'posts' );
	wp_cache_delete( 'post_parent:' . (string) $post->ID, 'posts' );
	wp_cache_delete( $post->ID, 'post_meta' );

	clean_object_term_cache( $post->ID, $post->post_type );

	wp_cache_delete( 'wp_get_archives', 'general' );

	do_action( 'clean_post_cache', $post->ID, $post );

	if ( 'page' === $post->post_type ) {
		wp_cache_delete( 'all_page_ids', 'posts' );
		do_action( 'clean_page_cache', $post->ID );
	}

	wp_cache_set_posts_last_changed();
}

注意事项

  • 该函数自 WordPress 2.0.0 版本引入，常用于文章更新、删除或状态变更时维护缓存一致性。
  • 相关函数包括 wp_cache_delete()、clean_object_term_cache() 和 do_action()，确保在开发插件或主题时正确调用以避免缓存问题。
📄 原文内容

Will clean the post in the cache.

Description

Cleaning means delete from the cache of the post. Will call to clean the term object cache associated with the post ID.

This function not run if $_wp_suspend_cache_invalidation is not empty. See wp_suspend_cache_invalidation() .

Parameters

$postint|WP_Postrequired
Post ID or post object to remove from the cache.

Source

function clean_post_cache( $post ) {
	global $_wp_suspend_cache_invalidation;

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

	$post = get_post( $post );

	if ( ! $post ) {
		return;
	}

	wp_cache_delete( $post->ID, 'posts' );
	wp_cache_delete( 'post_parent:' . (string) $post->ID, 'posts' );
	wp_cache_delete( $post->ID, 'post_meta' );

	clean_object_term_cache( $post->ID, $post->post_type );

	wp_cache_delete( 'wp_get_archives', 'general' );

	/**
	 * Fires immediately after the given post's cache is cleaned.
	 *
	 * @since 2.5.0
	 *
	 * @param int     $post_id Post ID.
	 * @param WP_Post $post    Post object.
	 */
	do_action( 'clean_post_cache', $post->ID, $post );

	if ( 'page' === $post->post_type ) {
		wp_cache_delete( 'all_page_ids', 'posts' );

		/**
		 * Fires immediately after the given page's cache is cleaned.
		 *
		 * @since 2.5.0
		 *
		 * @param int $post_id Post ID.
		 */
		do_action( 'clean_page_cache', $post->ID );
	}

	wp_cache_set_posts_last_changed();
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘clean_page_cache’, int $post_id )

Fires immediately after the given page’s cache is cleaned.

do_action( ‘clean_post_cache’, int $post_id, WP_Post $post )

Fires immediately after the given post’s cache is cleaned.

Uses Description
wp_cache_set_posts_last_changed()wp-includes/post.php

Sets the last changed time for the ‘posts’ cache group.
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.
get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 2 moreShow less

Used by Description
WP_Customize_Manager::trash_changeset_post()wp-includes/class-wp-customize-manager.php

Trashes or deletes a changeset post.
_wp_keep_alive_customize_changeset_dependent_auto_drafts()wp-includes/theme.php

Makes sure that auto-draft posts get their post_date bumped or status changed to draft to prevent premature garbage-collection.
WP_Customize_Manager::_publish_changeset_values()wp-includes/class-wp-customize-manager.php

Publishes the values of a changeset.
wp_add_trashed_suffix_to_post_name_for_post()wp-includes/post.php

Adds a trashed suffix for a given post.
wp_delete_user()wp-admin/includes/user.php

Delete user and optionally reassign posts and links to another user.
WP_Posts_List_Table::_display_rows_hierarchical()wp-admin/includes/class-wp-posts-list-table.php
clean_page_cache()wp-includes/deprecated.php

Will clean the page in the cache.
wp_delete_attachment()wp-includes/post.php

Trashes or deletes an attachment.
wp_publish_post()wp-includes/post.php

Publishes a post by transitioning the post status.
add_ping()wp-includes/post.php

Adds a URL to those already pinged.
wp_insert_post()wp-includes/post.php

Inserts or update a post.
wp_delete_post()wp-includes/post.php

Trashes or deletes a post or page.
set_post_type()wp-includes/post.php

Updates the post type for the post ID.
wp_update_comment_count_now()wp-includes/comment.php

Updates the comment count for the post.

Show 9 moreShow less

Changelog

Version Description
2.0.0 Introduced.