详解 WordPress `wp_cache_delete()` 函数的源码：如何从对象缓存中删除数据。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

晚上好，各位！今天咱们来扒一扒WordPress里一个看似简单，实则暗藏玄机的函数：wp_cache_delete()。别看它名字叫“删除”，里面的门道可不少。咱们争取用最通俗易懂的方式，把它给彻底拆解了，保证你以后用起来得心应手。

1. wp_cache_delete() 的基本概念

首先，我们要搞清楚 wp_cache_delete() 到底干什么的。简单来说，它的作用就是从 WordPress 的对象缓存中删除指定的数据。对象缓存是 WordPress 为了提升性能而设计的一种机制，它把一些常用的数据（比如文章、选项等）保存在内存中，下次需要的时候直接从内存读取，而不用每次都去数据库里捞，这样就大大加快了访问速度。

wp_cache_delete() 函数的作用就是让你能够手动清除缓存中的某些数据，比如当你修改了某个选项，或者更新了某个文章后，就可以用它来清除旧的缓存数据，确保用户看到的是最新的内容。

2. wp_cache_delete() 的函数签名

在深入源码之前，我们先来看看 wp_cache_delete() 函数的签名：

function wp_cache_delete( string $key, string $group = '', string $force = false ): bool {
    // 函数体
}

参数解释：

$key (string): 要删除的缓存数据的键名（Key）。这是必须的，你要告诉 WordPress 你想删除的是什么数据。
$group (string, optional): 缓存数据的分组名（Group）。默认值是空字符串 ''。缓存可以被组织成不同的组，方便管理。比如，你可以把所有文章相关的缓存数据都放在 posts 组里，把所有选项相关的缓存数据都放在 options 组里。
$force (string|bool, optional): 是否强制删除。默认值是 false。如果设置为 true，则会绕过预先检查（比如检查缓存是否已经过期），直接删除数据。注意，这里的数据类型是string|bool，WordPress 6.2及之后版本改为了字符串类型，之前的版本是布尔类型。

返回值：

bool: 如果删除成功，返回 true；如果删除失败，返回 false。

3. wp_cache_delete() 的源码分析（基于 WordPress 6.4）

现在，让我们深入到 wp-includes/cache.php 文件中，看看 wp_cache_delete() 的源码：

function wp_cache_delete( string $key, string $group = '', string $force = false ): bool {
    global $wp_object_cache;

    return $wp_object_cache->delete( $key, $group, $force );
}

你没看错，就是这么简单！ wp_cache_delete() 函数本身只是一个简单的代理，它把删除操作委托给了全局变量 $wp_object_cache 所指向的对象，调用了该对象的 delete() 方法。

那么，$wp_object_cache 到底是什么呢？它其实是一个对象缓存类的实例，通常是 WP_Object_Cache 类或其子类的实例。这个类的作用就是负责管理 WordPress 的对象缓存。

所以，真正干活的是 $wp_object_cache->delete() 方法。我们接着往下看。

4. WP_Object_Cache::delete() 方法的源码分析

WP_Object_Cache::delete() 方法的源码位于 wp-includes/cache.php 文件中。由于 WordPress 支持多种缓存后端（比如 Memcached、Redis 等），WP_Object_Cache 类本身只是一个抽象类，它的 delete() 方法通常会被子类重写，以适应不同的缓存后端。

我们以默认的 WP_Object_Cache 类为例，来看看它的 delete() 方法的实现：

    public function delete( $key, $group = '', $force = false ) {
        if ( empty( $group ) ) {
            $group = 'default';
        }

        $id = $this->key( $key, $group );

        unset( $this->cache[ $group ][ $key ] );
        unset( $this->cache[ 'alloptions' ][ $key ] );

        if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
            wp_cache_switch_to_blog( get_current_blog_id() );
        }

        /**
         * Fires after a cached value is deleted.
         *
         * @since 2.0.0
         *
         * @param int|string $key   The cache key to delete.
         * @param string     $group The cache group identifier.
         */
        do_action( 'delete_transient', $key, $group ); // Legacy hook.
        do_action( 'deleted_transient', $key, $group ); // Legacy hook.
        do_action( 'delete_cache', $key, $group );

        if ( $this->using_redis() ) {
            $this->redis->del( $id );
        }

        return true;
    }

代码分析：

处理分组： 如果 $group 参数为空，则将其设置为 'default'。这意味着所有没有指定分组的缓存数据，都会被放在 default 组里。
生成缓存ID： 调用 $this->key( $key, $group ) 方法生成缓存ID。这个ID是根据键名和分组名生成的，用于在缓存系统中唯一标识一个缓存数据。WP_Object_Cache::key() 方法的实现如下：
```
    public function key( $key, $group ) {
        return $this->multisite ? $this->blog_prefix . $group . ':' . $key : $group . ':' . $key;
    }
```
可以看到，如果 WordPress 启用了多站点模式，缓存ID会包含站点ID（$this->blog_prefix），以区分不同站点的缓存数据。
删除缓存数据：
- unset( $this->cache[ $group ][ $key ] ); 这行代码从 $this->cache 数组中删除指定键名的缓存数据。$this->cache 是 WP_Object_Cache 类内部用于存储缓存数据的数组。
- unset( $this->cache[ 'alloptions' ][ $key ] ); 这行代码是为了兼容旧版本的 WordPress，它会同时从 alloptions 组中删除缓存数据。 alloptions 组用于存储所有选项的缓存数据。
切换站点： 如果定义了 wp_cache_switch_to_blog() 函数（通常在多站点环境中），则调用它来切换到当前站点。这是为了确保删除操作是在正确的站点上下文中进行的。
触发 Action Hook： do_action( 'delete_transient', $key, $group );，do_action( 'deleted_transient', $key, $group );，do_action( 'delete_cache', $key, $group ); 这三行代码触发了三个 Action Hook，允许其他插件或主题在缓存数据被删除后执行一些自定义的操作。注意前两个hook是历史遗留的，现在推荐使用delete_cache hook。
Redis 支持：
```
if ( $this->using_redis() ) {
    $this->redis->del( $id );
}
```
如果启用了 Redis 缓存后端，则调用 $this->redis->del( $id ) 方法从 Redis 中删除缓存数据。$this->redis 是一个 Redis 客户端对象，$id 是之前生成的缓存ID。$this->using_redis() 会检查是否启用了Redis。
返回结果： return true; 无论删除操作是否成功，WP_Object_Cache::delete() 方法都会返回 true。这有点奇怪，但这就是 WordPress 的设计。如果删除失败，可能需要查看日志或调试来确定原因。

5. 使用示例

说了这么多，咱们来几个实际的例子，让你更清楚 wp_cache_delete() 怎么用。

删除某个文章的缓存：
```
$post_id = 123;
wp_cache_delete( $post_id, 'posts' );
```
这行代码会删除 posts 组中键名为 123 的缓存数据，通常对应于 ID 为 123 的文章的缓存。
删除某个选项的缓存：
```
$option_name = 'my_option';
wp_cache_delete( $option_name, 'options' );
```
这行代码会删除 options 组中键名为 my_option 的缓存数据，通常对应于名为 my_option 的选项的缓存。
强制删除某个缓存：
```
$key = 'some_data';
$group = 'my_group';
wp_cache_delete( $key, $group, true );
```
这行代码会强制删除 my_group 组中键名为 some_data 的缓存数据，即使缓存尚未过期。

6. 注意事项

谨慎使用 wp_cache_delete()： 频繁地删除缓存数据可能会降低性能，因为 WordPress 需要重新生成缓存。只有在必要的时候才使用 wp_cache_delete()。
了解你的缓存后端： 不同的缓存后端（比如 Memcached、Redis）可能有不同的删除策略和性能特点。在使用 wp_cache_delete() 时，要了解你的缓存后端的工作方式，以避免出现意外的问题。
多站点环境： 在多站点环境中，要注意缓存数据的站点上下文。确保你删除的是正确的站点上的缓存数据。
调试： 如果你发现 wp_cache_delete() 没有按预期工作，可以使用 WordPress 的调试工具来查看缓存的状态，或者查看缓存后端的日志，以找出问题的原因。

7. 缓存组的选择

合理选择缓存组对于缓存管理至关重要。以下是一些常见的缓存组以及它们的用途：

缓存组	用途
`default`	默认缓存组，用于存储没有明确指定分组的缓存数据。
`options`	存储选项相关的缓存数据，比如通过 `get_option()` 函数获取的选项值。
`posts`	存储文章相关的缓存数据，比如通过 `get_post()` 函数获取的文章对象。
`terms`	存储分类、标签等术语相关的缓存数据，比如通过 `get_term()` 函数获取的术语对象。
`users`	存储用户相关的缓存数据，比如通过 `get_user()` 函数获取的用户对象。
`themes`	存储主题相关的缓存数据。
`plugins`	存储插件相关的缓存数据。
`transient`	存储瞬态数据（transients），瞬态数据是一种带有过期时间的缓存数据，通常用于存储一些临时性的数据，比如 API 响应、计算结果等。可以使用`set_transient()`、`get_transient()`和`delete_transient()` 函数来操作瞬态数据。
自定义缓存组	你可以根据自己的需要创建自定义的缓存组，比如 `my_plugin_data`、`my_theme_settings` 等。使用自定义缓存组可以更好地组织和管理你的缓存数据。

8. WP_Object_Cache 类的其他相关方法

除了 delete() 方法，WP_Object_Cache 类还提供了其他一些常用的方法，用于管理缓存数据：

add( $key, $data, $group = '', $expire = 0 ): 向缓存中添加一个数据项。如果指定的键名已经存在，则不会添加。
get( $key, $group = '', $force = false, &$found = null ): 从缓存中获取一个数据项。
set( $key, $data, $group = '', $expire = 0 ): 向缓存中设置一个数据项。如果指定的键名已经存在，则会覆盖原有的数据。
replace( $key, $data, $group = '', $expire = 0 ): 替换缓存中已有的数据项。如果指定的键名不存在，则不会替换。
flush_group( $group ): 清空指定分组的缓存数据。
flush_all(): 清空所有缓存数据。

9. 总结

wp_cache_delete() 函数是 WordPress 中用于删除对象缓存数据的一个重要工具。它通过委托给 $wp_object_cache 对象来实际执行删除操作。理解 wp_cache_delete() 函数的工作原理，可以帮助你更好地管理 WordPress 的缓存，提升网站的性能。

今天我们深入剖析了 wp_cache_delete() 函数，从函数签名到源码实现，再到使用示例和注意事项，希望能够帮助你更好地理解和使用这个函数。记住，合理使用缓存是提升 WordPress 性能的关键之一，而 wp_cache_delete() 则是你管理缓存的利器。

好了，今天的讲座就到这里。感谢各位的参与，希望对大家有所帮助！下次有机会再和大家一起探讨 WordPress 的其他技术细节。祝大家编码愉快！

发表回复 取消回复

发表回复取消回复