深入理解 WordPress `rest_after_insert_block` 钩子源码：在区块插入后执行自定义逻辑。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位掘金的靓仔俊女们，晚上好！我是你们的老朋友，今天咱们来聊聊 WordPress 里面一个挺有意思的钩子：rest_after_insert_block。这玩意儿就像个小精灵，在你往 WordPress 内容里插入一个区块之后，它会跳出来，让你有机会做点自己想做的事情。

说白了，你可以理解为，当你用 Gutenberg 编辑器添加一个段落、一张图片，或者任何奇奇怪怪的区块的时候，这个钩子就会被触发。这意味着你可以用它来干很多事情，例如自动更新其他数据，触发邮件通知，或者执行一些清理工作。

那么，这个“小精灵”到底是怎么工作的呢？让我们一起深入源码，看看它背后藏着哪些秘密。

一、rest_after_insert_block 钩子的来龙去脉

要理解 rest_after_insert_block，我们首先要了解 WordPress 的 REST API 和区块编辑器（Gutenberg）。

REST API： WordPress 允许你通过一套标准化的 HTTP 请求（GET, POST, PUT, DELETE）来访问和操作网站的数据。这就像是给你的网站开了一扇后门，让你可以用程序的方式来控制它。
区块编辑器 (Gutenberg)： 这是 WordPress 的默认编辑器，它把内容拆分成一个个独立的“区块”。每一个区块都有自己的属性和设置，你可以像搭积木一样把它们组合起来，形成最终的内容。

rest_after_insert_block 钩子就是在你通过 REST API 插入一个区块之后被触发的。更具体地说，它是在 WP_REST_Posts_Controller 类的 create_item() 方法中被触发的。这个方法负责处理通过 REST API 创建新文章或页面的请求，并且在插入区块之后，它会调用 do_action() 函数来触发这个钩子。

二、源码剖析：WP_REST_Posts_Controller::create_item()

让我们来看看 WP_REST_Posts_Controller 类中 create_item() 方法的关键部分：

/**
 * Creates a single post.
 *
 * @param WP_REST_Request $request Full details about the request.
 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
 */
public function create_item( $request ) {
    // ... 一些验证和权限检查的代码 ...

    $prepared_post = $this->prepare_item_for_database( $request );

    // ... 插入文章或页面的代码 ...

    $post_id = wp_insert_post( wp_slash( (array) $prepared_post ), true );

    if ( is_wp_error( $post_id ) ) {
        return $post_id;
    }

    // ... 更新文章元数据的代码 ...

    $post = get_post( $post_id );

    // 在这里，我们插入区块和处理内容
    $content = isset( $request['content'] ) ? $request['content'] : '';

    if ( ! empty( $content ) ) {
        // 将内容解析为区块
        $blocks = parse_blocks( $content );

        // 保存区块
        update_post_meta( $post_id, '_wp_blocks', $blocks );

        // 触发 rest_after_insert_block 钩子
        foreach ( $blocks as $block ) {
          /**
         * Fires immediately after a single block is inserted via the REST API.
         *
         * @since 5.6.0
         *
         * @param WP_Block $block  Inserted block object.
         * @param WP_Post  $post Post object.
         * @param WP_REST_Request $request  Request object.
         */
          do_action( 'rest_after_insert_block', $block, $post, $request );
        }
    }

    // ... 返回响应的代码 ...

    return rest_ensure_response( $response );
}

从上面的代码片段中，我们可以看到以下关键点：

$request['content'] 包含了文章或页面的内容，这些内容通常是区块的 JSON 序列化表示。
parse_blocks() 函数将内容解析成一个区块数组。
update_post_meta() 函数将区块数组保存到文章的元数据中，键名为 _wp_blocks。
最重要的是，do_action( 'rest_after_insert_block', $block, $post, $request ) 这一行代码触发了 rest_after_insert_block 钩子。传递的参数包括：
- $block：插入的区块对象 (WP_Block)。
- $post：文章对象 (WP_Post)。
- $request：REST 请求对象 (WP_REST_Request)。

三、如何使用 rest_after_insert_block 钩子

要使用 rest_after_insert_block 钩子，你需要在你的主题或插件的代码中添加一个函数，并将其绑定到这个钩子上。就像这样：

add_action( 'rest_after_insert_block', 'my_custom_function', 10, 3 );

function my_custom_function( $block, $post, $request ) {
    // 在这里编写你的自定义逻辑
    // 你可以使用 $block, $post, $request 这三个参数
    // 来访问区块、文章和请求的信息

    // 举个例子，你可以根据区块的类型来执行不同的操作
    if ( $block['blockName'] === 'core/paragraph' ) {
        // 如果插入的是段落区块，则执行一些操作
        // 例如，记录日志或发送通知
        error_log( 'A paragraph block was inserted into post ID: ' . $post->ID );
    }
}

上面的代码片段展示了一个简单的例子。它定义了一个名为 my_custom_function 的函数，并将其绑定到 rest_after_insert_block 钩子上。当一个区块被插入时，这个函数就会被调用。在这个函数中，你可以访问 $block、$post 和 $request 这三个参数，并根据你的需求来执行自定义逻辑。

四、使用场景举例

rest_after_insert_block 钩子有很多实用的使用场景。让我们来看几个例子：

自动更新相关数据： 假设你有一个自定义的区块，它与一些外部数据相关联。当这个区块被插入时，你可以使用 rest_after_insert_block 钩子来自动更新这些外部数据。

例如，你可能有一个“产品展示”区块，它会显示一些产品的图片和价格。当这个区块被插入时，你可以使用钩子来检查这些产品的信息是否是最新的，并自动更新它们。

add_action( 'rest_after_insert_block', 'update_product_data', 10, 3 );

function update_product_data( $block, $post, $request ) {
    if ( $block['blockName'] === 'my-plugin/product-display' ) {
        // 获取产品 ID
        $product_id = $block['attrs']['productId'];

        // 从外部 API 获取最新的产品信息
        $product_data = get_latest_product_data( $product_id );

        // 更新产品的元数据
        update_post_meta( $post->ID, '_product_' . $product_id, $product_data );
    }
}

触发邮件通知： 当特定的区块被插入时，你可以使用 rest_after_insert_block 钩子来发送邮件通知。

例如，你可能有一个“联系表单”区块。当这个区块被插入时，你可以发送一封邮件给网站管理员，通知他们新的联系表单已经添加到页面中。

add_action( 'rest_after_insert_block', 'send_notification_email', 10, 3 );

function send_notification_email( $block, $post, $request ) {
    if ( $block['blockName'] === 'my-plugin/contact-form' ) {
        // 发送邮件给网站管理员
        $to = get_option( 'admin_email' );
        $subject = 'New Contact Form Added';
        $message = 'A contact form has been added to post ID: ' . $post->ID;
        wp_mail( $to, $subject, $message );
    }
}

执行清理工作： 有时候，在插入区块之后，你可能需要执行一些清理工作，例如删除一些临时文件或更新缓存。

例如，你可能有一个“图库”区块。当这个区块被插入时，你可以使用钩子来删除上传的临时图片文件。

add_action( 'rest_after_insert_block', 'cleanup_temporary_files', 10, 3 );

function cleanup_temporary_files( $block, $post, $request ) {
    if ( $block['blockName'] === 'core/gallery' ) {
        // 获取上传的临时图片文件
        $temporary_files = get_post_meta( $post->ID, '_temporary_files' );

        // 删除临时文件
        foreach ( $temporary_files as $file ) {
            unlink( $file );
        }

        // 删除元数据
        delete_post_meta( $post->ID, '_temporary_files' );
    }
}

五、注意事项

在使用 rest_after_insert_block 钩子时，你需要注意以下几点：

性能： 你的自定义逻辑应该尽可能地高效。因为这个钩子会在每次插入区块时都被触发，所以如果你的逻辑运行时间过长，可能会影响网站的性能。
错误处理： 你的自定义逻辑应该包含完善的错误处理机制。这样可以防止意外错误导致网站崩溃。
安全性： 如果你的自定义逻辑涉及到用户输入或外部数据，你需要确保对这些数据进行适当的验证和清理，以防止安全漏洞。
区块类型判断: 确保你的函数只在特定的区块类型被插入时才执行。使用 $block['blockName'] 来判断区块类型，避免不必要的计算。
避免无限循环: 某些操作可能会导致区块的再次插入，从而触发无限循环。确保你的逻辑不会导致这种情况发生。

六、rest_after_insert_block 钩子的参数详解

参数	类型	描述
`$block`	`WP_Block`	代表插入的区块的对象。它包含了区块的所有信息，例如区块的名称 (`blockName`)、属性 (`attrs`) 和内容 (`innerHTML`)。你可以使用 `$block['blockName']` 来判断区块的类型，使用 `$block['attrs']` 来访问区块的属性。
`$post`	`WP_Post`	代表文章或页面的对象。它包含了文章或页面的所有信息，例如文章的 ID (`ID`)、标题 (`post_title`)、内容 (`post_content`) 和状态 (`post_status`)。你可以使用 `$post->ID` 来获取文章的 ID，使用 `$post->post_title` 来获取文章的标题。
`$request`	`WP_REST_Request`	代表 REST 请求的对象。它包含了请求的所有信息，例如请求的方法 (`get_method()`)、参数 (`get_params()`) 和头部 (`get_headers()`)。你可以使用 `$request->get_param( 'param_name' )` 来获取请求的参数，使用 `$request->get_header( 'header_name' )` 来获取请求的头部。

七、总结

rest_after_insert_block 钩子是一个非常强大的工具，它可以让你在区块插入后执行自定义逻辑。通过它可以实现各种各样的功能，例如自动更新相关数据、触发邮件通知和执行清理工作。但是，在使用它的时候，你需要注意性能、错误处理和安全性等问题。

希望今天的讲座能帮助你更好地理解 rest_after_insert_block 钩子。如果你还有其他问题，欢迎随时提问。

祝大家编程愉快！

发表回复 取消回复

发表回复取消回复