阐述 WordPress `the_blocks_content()` 函数源码：如何仅输出文章中的区块内容。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

嘿，各位代码界的探险家们，欢迎来到今天的WordPress区块内容寻宝之旅！今天我们的主角是 the_blocks_content() 这个函数，它就像一把锋利的剪刀，能帮你从WordPress文章中精准地提取区块内容，让你的主题开发更加灵活。准备好，我们这就开始解剖它的秘密！

第一幕：the_blocks_content() 的身世之谜

首先，我们要搞清楚 the_blocks_content() 究竟是何方神圣。简单来说，它是 WordPress 5.0 版本引入的，专门用来输出文章的区块内容的。在古老的（指 Gutenberg 编辑器出现之前）WordPress 世界里，我们通常用 the_content() 来输出文章的全部内容，包括文本、HTML标签等等。但现在，有了区块编辑器，文章的内容被切割成一个个独立的区块，the_blocks_content() 就应运而生，专门负责处理这些区块。

第二幕：源码探险，抽丝剥茧

让我们深入 the_blocks_content() 的源码，看看它究竟是如何工作的。

/**
 * Displays the content of the current post, excluding the title, but including blocks.
 *
 * @since 5.0.0
 *
 * @param string|WP_Post|null $post Post ID or WP_Post object.  Defaults to global $post.
 */
function the_blocks_content( $post = null ) {
    echo apply_filters( 'the_blocks_content', get_the_blocks_content( $post ) );
}

/**
 * Retrieves the content of the current post, excluding the title, but including blocks.
 *
 * @since 5.0.0
 *
 * @param string|WP_Post|null $post Post ID or WP_Post object.  Defaults to global $post.
 * @return string Block content of the current post.
 */
function get_the_blocks_content( $post = null ) {
    $post = get_post( $post );

    if ( ! $post ) {
        return '';
    }

    $content = $post->post_content;

    if ( ! post_password_required( $post ) ) {
        $content = do_blocks( $content );
        $content = str_replace( '<!--more-->', '', $content );
    } else {
        $content = get_the_password_form( $post );
    }

    /**
     * Filters the content of the post, excluding the title, but including blocks.
     *
     * @since 5.0.0
     *
     * @param string      $content Content of the post.
     * @param WP_Post $post      Post object.
     */
    return apply_filters( 'get_the_blocks_content', $content, $post );
}

看起来有点复杂，但别慌，我们一步步来解析：

the_blocks_content( $post = null ): 这是我们直接调用的函数。它接收一个可选的 $post 参数，用于指定要输出区块内容的文章。如果没有传递参数，它会使用全局 $post 对象（也就是当前文章）。它调用了 get_the_blocks_content() 函数获取区块内容，然后通过 apply_filters( 'the_blocks_content', ... ) 应用一个过滤器，最后用 echo 输出结果。
get_the_blocks_content( $post = null ): 这个函数才是真正干活的。
- 获取文章对象: 首先，它使用 get_post( $post ) 获取文章对象。如果文章不存在，直接返回空字符串。
- 获取文章内容: 从文章对象中获取 post_content 属性，这就是文章的原始内容，包括区块标记。
- 密码保护判断: 如果文章设置了密码保护，它会使用 get_the_password_form( $post ) 获取密码输入表单，并将其作为内容返回。
- 区块解析: 如果文章没有密码保护，关键的一步来了！它使用 do_blocks( $content ) 函数来解析文章内容中的区块标记，将它们转换成 HTML。
- 移除  标记: str_replace( '', '', $content ) 移除文章中的  标记，这个标记通常用于文章摘要功能，在这里我们不需要它。
- 应用过滤器: 最后，它通过 apply_filters( 'get_the_blocks_content', $content, $post ) 应用一个过滤器，允许开发者修改最终的区块内容。

第三幕： do_blocks() 函数的深度剖析

do_blocks() 函数是整个流程中的核心，它负责将文章内容中的区块标记转换成 HTML。我们来看看它的简化版工作原理：

识别区块: do_blocks() 函数会扫描文章内容，寻找区块的开始和结束标记。区块标记通常以  开始，以  结束。
解析属性: 对于每个区块，do_blocks() 函数会解析区块标记中的属性，这些属性定义了区块的各种设置。
渲染区块: do_blocks() 函数会根据区块的名称和属性，调用相应的渲染函数来生成 HTML。每个区块类型都有自己的渲染函数，负责将区块数据转换成最终的 HTML 输出。
嵌套区块处理: do_blocks() 函数可以处理嵌套的区块，也就是在一个区块内部包含其他区块。它会递归地解析和渲染嵌套的区块。

第四幕：实战演练，代码示例

说了这么多理论，现在让我们来看一些实际的代码示例，演示如何使用 the_blocks_content() 函数。

示例 1：在主题模板中输出文章的区块内容

在你的主题模板文件（比如 single.php）中，你可以这样使用 the_blocks_content() 函数：

<?php
if ( have_posts() ) {
    while ( have_posts() ) {
        the_post();
        ?>
        <article id="post-<?php the_ID(); ?>" <?php post_class(); ?>>
            <header class="entry-header">
                <h1 class="entry-title"><?php the_title(); ?></h1>
            </header><!-- .entry-header -->

            <div class="entry-content">
                <?php the_blocks_content(); ?>
            </div><!-- .entry-content -->

        </article><!-- #post-<?php the_ID(); ?> -->
        <?php
    }
}
?>

这段代码会输出当前文章的标题和区块内容。注意，我们使用了 the_blocks_content() 函数来输出区块内容，而不是 the_content() 函数。

示例 2：自定义区块内容的输出

有时候，你可能需要对区块内容进行一些自定义处理。比如，你可能想要添加一些额外的 HTML 标签，或者修改某些区块的样式。这时，你可以使用 the_blocks_content 或 get_the_blocks_content 过滤器。

/**
 * 自定义区块内容的输出.
 *
 * @param string $content 区块内容.
 *
 * @return string 修改后的区块内容.
 */
function my_custom_blocks_content( $content ) {
    $content = '<div class="my-custom-class">' . $content . '</div>';
    return $content;
}
add_filter( 'the_blocks_content', 'my_custom_blocks_content' );

这段代码会将所有的区块内容包裹在一个 div 元素中，并添加一个 my-custom-class 类名。

示例 3：只输出特定类型的区块

如果你只想输出特定类型的区块，比如只输出段落区块和图片区块，你可以使用 parse_blocks() 函数来解析文章内容，然后筛选出你需要的区块。

/**
 * 只输出特定类型的区块.
 *
 * @param string $content 文章内容.
 *
 * @return string 筛选后的区块内容.
 */
function my_custom_filter_blocks( $content ) {
    $blocks = parse_blocks( get_the_content() ); // 使用 get_the_content() 获取原始内容

    $allowed_blocks = array( 'core/paragraph', 'core/image' );
    $filtered_content = '';

    foreach ( $blocks as $block ) {
        if ( in_array( $block['blockName'], $allowed_blocks, true ) ) {
            $filtered_content .= render_block( $block );
        }
    }

    return $filtered_content;
}

add_filter( 'the_content', 'my_custom_filter_blocks' ); // 使用 the_content 过滤器

这段代码会使用 parse_blocks() 函数将文章内容解析成一个区块数组，然后遍历数组，只保留 core/paragraph 和 core/image 类型的区块。最后，它使用 render_block() 函数将筛选后的区块渲染成 HTML。 注意： 这里我们使用了 the_content 过滤器，因为它是在区块解析之前执行的。我们还需要使用 get_the_content() 获取文章的原始内容，而不是 the_blocks_content() 的输出结果。

第五幕：注意事项和常见问题

在使用 the_blocks_content() 函数时，有一些需要注意的地方：

依赖 Gutenberg 编辑器: the_blocks_content() 函数是为 Gutenberg 编辑器设计的，如果你的文章不是使用 Gutenberg 编辑器创建的，它可能无法正常工作。
主题兼容性: 某些主题可能对区块内容的输出方式有自己的定制，这可能会影响 the_blocks_content() 函数的效果。
性能问题: 解析和渲染区块可能会消耗一定的服务器资源，特别是对于包含大量区块的文章。你应该尽量优化你的代码，避免不必要的性能开销。

常见问题：

为什么我的区块内容没有显示？ 首先，确保你的文章是使用 Gutenberg 编辑器创建的。其次，检查你的主题是否对 the_content() 函数进行了修改，这可能会影响 the_blocks_content() 函数的效果。最后，检查你的代码是否有错误，比如拼写错误或者逻辑错误。
如何修改特定区块的样式？ 你可以使用 CSS 来修改特定区块的样式。每个区块都有自己的 CSS 类名，你可以使用这些类名来定位区块，并应用你想要的样式。你也可以使用 render_block 过滤器来修改区块的 HTML 输出，从而添加自定义的类名或属性。
如何添加自定义区块？ 你可以使用 WordPress 的区块 API 来添加自定义区块。你需要注册你的区块，并定义它的编辑界面和渲染函数。

第六幕：总结与展望

the_blocks_content() 函数是 WordPress 区块编辑器时代的一个重要工具，它可以让你更灵活地控制文章内容的输出。掌握它的使用方法，可以帮助你开发出更加强大和灵活的 WordPress 主题。

希望今天的寻宝之旅对你有所帮助。记住，代码的世界充满了惊喜和挑战，勇敢地探索，你一定能发现更多的宝藏！下次再见！

函数	描述
`the_blocks_content()`	输出文章的区块内容
`get_the_blocks_content()`	获取文章的区块内容，不直接输出
`do_blocks()`	解析文章内容中的区块标记，将它们转换成 HTML
`parse_blocks()`	将文章内容解析成一个区块数组
`render_block()`	将一个区块渲染成 HTML
`apply_filters()`	应用过滤器，允许开发者修改函数的结果
`get_post()`	获取文章对象
`the_content()`	输出文章的全部内容，包括文本、HTML标签和区块内容（在没有特殊处理的情况下）

额外的思考题：

the_blocks_content() 和 the_content() 函数的区别是什么？在什么情况下应该使用哪个函数？
如何使用 render_block 过滤器来修改特定区块的 HTML 输出？
如何使用 JavaScript 来操作区块编辑器中的区块？
了解更多关于 WordPress 区块 API 的知识，并尝试创建一个简单的自定义区块。

希望这些思考题能帮助你更深入地理解 WordPress 区块编辑器的原理和使用方法。祝你编码愉快！

发表回复 取消回复

发表回复取消回复