探究 WordPress `get_post_block_type()` 函数源码：如何从文章内容中提取区块类型。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

嘿，各位代码爱好者！今天咱们来聊聊 WordPress 里的一个“寻宝猎人”—— get_post_block_type() 函数。这哥们儿的任务就是从文章内容里挖出各种区块的类型，像个考古学家一样。

咱们今天这堂“区块挖掘”讲座，目标是彻底搞清楚 get_post_block_type() 的工作原理。我会尽量用大白话，配合代码示例，让大家听得明白、学得会，以后遇到类似的需求也能自己动手丰衣足食。

一、初探宝藏：get_post_block_type() 的基本用法

首先，咱们先看看这货的基本用法，混个眼熟。

<?php
$post_content = get_post_field( 'post_content', get_the_ID() ); // 获取文章内容
$block_type = get_post_block_type( $post_content );

if ( $block_type ) {
    echo '文章的第一个区块类型是：' . esc_html( $block_type );
} else {
    echo '文章里好像没有区块，或者出错了。';
}
?>

这段代码很简单：

get_post_field( 'post_content', get_the_ID() ): 从当前文章获取 post_content 字段，也就是文章的内容。
get_post_block_type( $post_content ): 把文章内容喂给 get_post_block_type() 函数，让它去寻宝。
if ( $block_type ): 如果找到了区块类型，就显示出来；否则，就说明没找到或者出问题了。

二、深入矿洞：get_post_block_type() 源码分析

好了，光知道怎么用还不够，咱们得深入矿洞，看看这函数是怎么工作的。打开 WordPress 的核心文件（通常在 wp-includes/block-template-utils.php），找到 get_post_block_type() 函数的定义。

<?php
/**
 * Retrieves the block type of the first block in the post content.
 *
 * @since 5.0.0
 *
 * @param string $post_content Post content.
 * @return string|null The block type, or null if not found.
 */
function get_post_block_type( $post_content ) {
    $blocks = parse_blocks( $post_content );

    if ( empty( $blocks ) ) {
        return null;
    }

    $first_block = $blocks[0];

    if ( isset( $first_block['blockName'] ) ) {
        return $first_block['blockName'];
    }

    return null;
}

这段代码看起来也不复杂，主要就做了三件事：

parse_blocks( $post_content ): 这是个关键函数，它的作用是将文章内容解析成一个区块数组。
if ( empty( $blocks ) ): 如果解析出来的区块数组是空的，说明文章里没有区块，直接返回 null。
$first_block = $blocks[0]: 获取第一个区块。
if ( isset( $first_block['blockName'] ) ): 如果第一个区块有 blockName 属性，就返回这个属性的值，也就是区块类型。

所以，get_post_block_type() 其实只是个“包装工”，它把文章内容丢给 parse_blocks() 函数处理，然后从结果里提取第一个区块的类型。真正的核心在于 parse_blocks() 函数。

三、核心引擎：parse_blocks() 函数的奥秘

parse_blocks() 函数才是真正的“区块解析引擎”。它能识别文章内容中的各种区块，并把它们转换成一个结构化的数组。这个函数同样定义在 wp-includes/block-template-utils.php 文件中。由于 parse_blocks() 的代码比较长，我们只分析其中关键的部分，并结合示例来说明。

parse_blocks() 的大致工作流程如下：

预处理: 对文章内容进行一些预处理，比如去除一些HTML注释，标准化换行符等。
扫描区块: 使用正则表达式扫描文章内容，查找区块的起始和结束标记。区块的起始标记通常是 ，结束标记是 。
解析属性: 如果区块有属性，就解析属性，将其转换为一个PHP数组。
递归处理: 如果区块内部还包含其他区块（嵌套区块），就递归调用 parse_blocks() 函数来处理内部区块。
构建数组: 将解析出来的区块信息，包括区块类型、属性、内容等，构建成一个PHP数组。

为了方便理解，我们举个例子。假设文章内容如下：

<!-- wp:paragraph -->
<p>这是一个段落区块。</p>
<!-- /wp:paragraph -->

<!-- wp:image {"id":123,"sizeSlug":"large"} -->
<figure class="wp-block-image size-large"><img src="image.jpg" alt="" class="wp-image-123"/></figure>
<!-- /wp:image -->

经过 parse_blocks() 函数处理后，会得到一个类似这样的数组：

array(
    0 => array(
        'blockName' => 'core/paragraph',
        'attrs' => array(),
        'innerBlocks' => array(),
        'innerHTML' => '<p>这是一个段落区块。</p>',
        'innerContent' => array( '<p>这是一个段落区块。</p>' ),
    ),
    1 => array(
        'blockName' => 'core/image',
        'attrs' => array(
            'id' => 123,
            'sizeSlug' => 'large',
        ),
        'innerBlocks' => array(),
        'innerHTML' => '<figure class="wp-block-image size-large"><img src="image.jpg" alt="" class="wp-image-123"/></figure>',
        'innerContent' => array( '<figure class="wp-block-image size-large"><img src="image.jpg" alt="" class="wp-image-123"/></figure>' ),
    ),
)

可以看到，每个区块都被解析成一个数组，包含了区块类型（blockName）、属性（attrs）、内部区块（innerBlocks）、HTML内容（innerHTML）和内部内容（innerContent）等信息。

四、实战演练：自定义函数提取区块信息

现在，我们已经掌握了 get_post_block_type() 和 parse_blocks() 的基本原理。接下来，我们来写一个自定义函数，提取文章内容中所有区块的类型和属性。

<?php
/**
 * 获取文章中所有区块的类型和属性.
 *
 * @param string $post_content 文章内容.
 * @return array  包含所有区块类型和属性的数组.
 */
function get_all_block_info( $post_content ) {
    $blocks = parse_blocks( $post_content );
    $block_info = array();

    foreach ( $blocks as $block ) {
        $block_info[] = array(
            'blockName' => $block['blockName'],
            'attrs' => $block['attrs'],
        );
    }

    return $block_info;
}

// 使用示例
$post_content = get_post_field( 'post_content', get_the_ID() );
$all_blocks = get_all_block_info( $post_content );

echo '<pre>';
print_r( $all_blocks );
echo '</pre>';
?>

这个函数的工作流程如下：

parse_blocks( $post_content ): 使用 parse_blocks() 函数解析文章内容，获取区块数组。
foreach ( $blocks as $block ): 遍历区块数组。
$block_info[] = array(...): 将每个区块的类型和属性提取出来，放到一个新的数组中。
return $block_info: 返回包含所有区块类型和属性的数组。

通过这个函数，我们可以方便地获取文章中所有区块的信息，进行各种自定义操作。

五、注意事项：一些需要留意的细节

在使用 get_post_block_type() 和 parse_blocks() 函数时，有一些细节需要注意：

性能: parse_blocks() 函数会解析整个文章内容，如果文章内容很长，或者包含大量的区块，可能会影响性能。因此，应该尽量避免在前端频繁调用这些函数。
缓存: 可以使用 WordPress 的缓存机制，将解析后的区块数据缓存起来，避免重复解析。
过滤器: WordPress 提供了 the_content 过滤器，可以在文章内容显示之前对其进行修改。如果使用了这个过滤器，可能会影响 parse_blocks() 函数的解析结果。
区块的动态性: 有些区块是动态的，它们的内容是由 PHP 代码生成的。parse_blocks() 函数只能解析静态的区块内容，对于动态区块，可能无法获取到完整的属性信息。

六、进阶应用：结合 Gutenberg API 开发自定义区块

掌握了 get_post_block_type() 和 parse_blocks() 函数，我们可以更深入地了解 Gutenberg 区块的底层机制，为开发自定义区块打下基础。

例如，我们可以利用这些函数来：

验证区块属性: 在保存文章时，验证区块属性是否符合要求。
动态生成区块内容: 根据区块属性，动态生成区块的 HTML 内容。
自定义区块样式: 根据区块类型和属性，自定义区块的 CSS 样式。

七、总结：区块挖掘之旅的收获

今天，我们一起探索了 WordPress 的 get_post_block_type() 函数，深入了解了 parse_blocks() 函数的工作原理。我们还编写了一个自定义函数，提取文章内容中所有区块的类型和属性。

希望通过今天的讲座，大家能够对 WordPress 的区块机制有更深入的理解，并能灵活运用这些知识，开发出更强大的 WordPress 插件和主题。

函数名	功能描述
`get_post_block_type()`	获取文章内容中第一个区块的类型。它依赖于 `parse_blocks()` 函数来解析文章内容。
`parse_blocks()`	将文章内容解析成一个区块数组。这个函数会扫描文章内容，查找区块的起始和结束标记，并解析区块的属性和内容。它是整个区块解析的核心引擎。
`get_post_field()`	获取指定文章的指定字段的值。在本文中，我们使用它来获取文章的 `post_content` 字段，也就是文章的内容。

记住，代码的世界充满了乐趣，只要我们保持好奇心，不断学习，就能发现更多的宝藏！下次再见！

发表回复 取消回复

发表回复取消回复