发布于 由admin

阐述 WordPress `WP_Block_Patterns_Registry` 类的源码：它如何利用缓存来提升区块模式的加载速度。

各位观众，晚上好！今天咱们聊聊 WordPress 里面一个挺酷的东西：WP_Block_Patterns_Registry 类。这玩意儿专门负责管理区块模式，让咱们用起来更方便，更快。更重要的是，它还懂得用缓存来提速，简直就是个精打细算的居家好男人。

什么是区块模式？为什么要用它？

首先，简单回顾一下区块模式。想象一下，你经常需要在文章里插入一个包含标题、副标题和一段文字的固定布局。如果没有区块模式，你每次都得手动添加这些区块，调整样式，累不累？

区块模式就是用来解决这个问题的。你可以把这个布局保存成一个“模式”，下次直接插入，省时省力，而且还能保证风格统一。这玩意儿就像积木一样，把常用的模块预先搭好，需要的时候直接拿来用。

WP_Block_Patterns_Registry：区块模式的大管家

好，现在主角登场了。WP_Block_Patterns_Registry 类，顾名思义，就是一个用来注册和管理区块模式的类。它负责把各种区块模式的信息（比如名称、描述、内容）都登记在册，方便 WordPress 查找和使用。

源码剖析：WP_Block_Patterns_Registry 的核心方法

咱们先来看看这个类里面几个关键的方法，别害怕，代码就在眼前，一点点啃，没啥难的。

  1. register( string $pattern_name, array $pattern_properties ): void

    这个方法是用来注册区块模式的。你需要提供一个模式名称（$pattern_name）和一个包含模式属性的数组（$pattern_properties）。

    /**
 * Registers a block pattern.
 *
 * @since 5.5.0
 *
 * @param string $pattern_name     Pattern name including namespace.
 * @param array  $pattern_properties Array containing the properties for the block pattern.
 *
 * @return void
 */
public function register( $pattern_name, $pattern_properties ) {
    if ( ! is_string( $pattern_name ) ) {
        _doing_it_wrong(
            __METHOD__,
            '$pattern_name must be a string.',
            '5.5.0'
        );
        return;
    }

    if ( ! is_array( $pattern_properties ) ) {
        _doing_it_wrong(
            __METHOD__,
            '$pattern_properties must be an array.',
            '5.5.0'
        );
        return;
    }

    if ( isset( $this->registered_patterns[ $pattern_name ] ) ) {
        _doing_it_wrong(
            __METHOD__,
            sprintf(
                /* translators: %s: Pattern name. */
                __( 'The pattern "%s" is already registered.' ),
                $pattern_name
            ),
            '5.5.0'
        );
        return;
    }

    $this->registered_patterns[ $pattern_name ] = $pattern_properties;
}

    这里要注意的是，$pattern_name 必须包含命名空间，比如 my-theme/my-pattern。$pattern_properties 数组里面可以包含以下属性：

    属性 类型 描述
    title string 模式的标题，会显示在区块编辑器里面。
    content string 模式的内容，也就是 HTML 代码。
    description string 模式的描述，方便用户了解模式的作用。
    categories array 模式所属的分类，可以用来筛选模式。
    keywords array 模式的关键词，方便用户搜索模式。
    viewportWidth int 模式的视口宽度，用于在区块编辑器中预览模式。

    举个例子：

    register_block_pattern(
    'my-theme/my-awesome-pattern',
    array(
        'title'       => __( 'Awesome Pattern', 'my-theme' ),
        'content'     => '<!-- wp:paragraph --><p>This is an awesome pattern!</p><!-- /wp:paragraph -->',
        'description' => __( 'A simple pattern with a paragraph.', 'my-theme' ),
        'categories'  => array( 'text' ),
    )
);

  2. unregister( string $pattern_name ): void

    这个方法用来注销已经注册的区块模式。

    /**
 * Unregisters a block pattern.
 *
 * @since 5.5.0
 *
 * @param string $pattern_name Pattern name including namespace.
 *
 * @return void
 */
public function unregister( $pattern_name ) {
    if ( ! is_string( $pattern_name ) ) {
        _doing_it_wrong(
            __METHOD__,
            '$pattern_name must be a string.',
            '5.5.0'
        );
        return;
    }

    unset( $this->registered_patterns[ $pattern_name ] );
}

    使用起来也很简单：

    unregister_block_pattern( 'my-theme/my-awesome-pattern' );

  3. get_all_registered(): array

    这个方法会返回所有已经注册的区块模式。

    /**
 * Returns all registered block patterns.
 *
 * @since 5.5.0
 *
 * @return array Registered block patterns.
 */
public function get_all_registered() {
    return $this->registered_patterns;
}

    你可以用它来获取所有模式的信息，比如：

    $patterns = WP_Block_Patterns_Registry::get_instance()->get_all_registered();
foreach ( $patterns as $pattern_name => $pattern_properties ) {
    echo 'Pattern Name: ' . esc_html( $pattern_name ) . '<br>';
    echo 'Pattern Title: ' . esc_html( $pattern_properties['title'] ) . '<br>';
}

缓存机制：让区块模式飞起来

现在，重头戏来了！WP_Block_Patterns_Registry 类是如何利用缓存来提高区块模式的加载速度的呢？

WordPress 使用了对象缓存（Object Cache）来缓存各种数据，包括区块模式的信息。对象缓存可以把数据存储在内存中，下次需要的时候直接从内存读取，比从数据库读取快多了。

WP_Block_Patterns_Registry 类本身并没有直接操作缓存的代码，但是它返回的数据会被 WordPress 的其他部分缓存起来。具体来说，当 WordPress 需要获取所有注册的区块模式时，它会调用 WP_Block_Patterns_Registry::get_instance()->get_all_registered() 方法。这个方法返回的结果会被 WordPress 使用 wp_cache_get 和 wp_cache_set 函数缓存起来。

  1. wp_cache_get( string $key, string $group = '', bool $force = false, &$found = null ): mixed

    这个函数用来从缓存中获取数据。$key 是缓存的键名，$group 是缓存的分组，$force 表示是否强制从数据库读取数据（忽略缓存）。

  2. wp_cache_set( string $key, mixed $data, string $group = '', int $expire = 0 ): bool

    这个函数用来把数据存储到缓存中。$key 是缓存的键名，$data 是要缓存的数据，$group 是缓存的分组，$expire 是缓存的过期时间（秒）。

缓存的流程

  1. 当 WordPress 第一次需要获取所有注册的区块模式时，它会尝试从缓存中读取数据。由于缓存中还没有数据，所以 wp_cache_get 函数会返回 false。
  2. WordPress 接着会调用 WP_Block_Patterns_Registry::get_instance()->get_all_registered() 方法，获取所有注册的区块模式。
  3. WordPress 会把获取到的数据使用 wp_cache_set 函数存储到缓存中，以便下次使用。
  4. 下次 WordPress 需要获取所有注册的区块模式时，它会再次尝试从缓存中读取数据。这次 wp_cache_get 函数会成功返回缓存中的数据，避免了重新调用 WP_Block_Patterns_Registry::get_instance()->get_all_registered() 方法，从而提高了加载速度。

缓存分组和键名

WordPress 通常会使用一个特定的缓存分组和键名来存储区块模式的信息。虽然具体的实现可能会有所不同，但是一般来说，缓存分组可能是 block_patterns，缓存键名可能是 all_registered_patterns。

代码示例：缓存的模拟

为了更好地理解缓存的工作原理，咱们可以模拟一下缓存的流程：

// 模拟缓存
$cache = array();

// 缓存键名和分组
$cache_key = 'all_registered_patterns';
$cache_group = 'block_patterns';

// 尝试从缓存中获取数据
if ( isset( $cache[ $cache_group ][ $cache_key ] ) ) {
    echo "从缓存中读取数据<br>";
    $patterns = $cache[ $cache_group ][ $cache_key ];
} else {
    echo "从数据库中读取数据<br>";

    // 模拟从数据库中读取数据
    $patterns = WP_Block_Patterns_Registry::get_instance()->get_all_registered();

    // 将数据存储到缓存中
    $cache[ $cache_group ][ $cache_key ] = $patterns;
}

// 输出模式信息
foreach ( $patterns as $pattern_name => $pattern_properties ) {
    echo 'Pattern Name: ' . esc_html( $pattern_name ) . '<br>';
    echo 'Pattern Title: ' . esc_html( $pattern_properties['title'] ) . '<br>';
}

这段代码模拟了从缓存中读取数据和将数据存储到缓存中的过程。第一次运行这段代码时，会显示 "从数据库中读取数据"，然后将数据存储到 $cache 数组中。下次运行这段代码时，会显示 "从缓存中读取数据"，直接从 $cache 数组中读取数据，而不需要重新调用 WP_Block_Patterns_Registry::get_instance()->get_all_registered() 方法。

如何利用缓存提升区块模式的性能

  1. 使用对象缓存： 确保你的 WordPress 站点启用了对象缓存。可以使用 Memcached、Redis 等缓存系统来提高性能。
  2. 合理设置缓存过期时间： 根据实际情况设置缓存的过期时间。如果区块模式很少更新，可以设置较长的过期时间。
  3. 手动清除缓存： 如果你修改了区块模式，可以手动清除缓存，确保用户看到最新的内容。可以使用 WordPress 的缓存插件来清除缓存。
  4. 检查插件冲突： 有些插件可能会干扰缓存的工作，导致区块模式加载缓慢。可以尝试禁用一些插件，看看是否能解决问题。

缓存失效策略

当区块模式被注册、注销或者修改时，缓存需要失效，以确保用户看到最新的数据。WordPress 会在以下情况下清除区块模式的缓存：

  • 注册新的区块模式：register_block_pattern() 函数被调用。
  • 注销已有的区块模式：unregister_block_pattern() 函数被调用。
  • 主题切换：主题切换可能会改变区块模式的定义。
  • 插件更新：插件更新可能会改变区块模式的定义。

总结

WP_Block_Patterns_Registry 类是 WordPress 中一个非常重要的类，它负责管理区块模式，并利用缓存来提高区块模式的加载速度。通过理解 WP_Block_Patterns_Registry 类的源码和缓存机制，咱们可以更好地利用区块模式，构建更高效、更快速的 WordPress 站点。希望今天的讲解能够帮助大家更好地理解 WordPress 的区块模式和缓存机制。 记住，代码的世界就像一个巨大的乐高玩具，只要你敢于拆解，就能发现其中的乐趣！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注