分析 WordPress `block_has_attr()` 函数的源码：如何检查区块是否具有某个属性。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，大家好！今天咱们不聊风花雪月，只谈代码人生。今天要跟大家伙儿扒一扒 WordPress 里面一个不起眼，但关键时刻能救命的函数：block_has_attr()。别看名字平平无奇，它可是判断 Gutenberg 区块有没有某个属性的利器。准备好了吗？咱们这就开讲！

开场白：区块的世界，属性说了算

在 Gutenberg 编辑器里，一切皆区块。而每个区块呢，又可以拥有各种各样的属性。这些属性决定了区块的样式、行为等等。举个栗子：一个“段落”区块，可以有“内容”属性，规定了段落里显示啥文字；还可以有“对齐方式”属性，规定文字是居左、居中还是居右。

想玩转 Gutenberg，就得学会跟这些属性打交道。而block_has_attr()函数，就是咱们手中的一把钥匙，能打开区块属性的大门。

正文：block_has_attr()源码解析

废话不多说，直接上代码。这是block_has_attr()函数的源码（在 WordPress 的 wp-includes/blocks.php 文件里）：

/**
 * Checks if a block type has the given attribute registered.
 *
 * @since 5.0.0
 *
 * @param string $block_name The name of the block type (e.g. `core/paragraph`).
 * @param string $attribute_name The name of the attribute to check for.
 *
 * @return bool True if the attribute is registered, false otherwise.
 */
function block_has_attr( $block_name, $attribute_name ) {
    $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );

    if ( ! $block_type ) {
        return false;
    }

    if ( ! isset( $block_type->attributes[ $attribute_name ] ) ) {
        return false;
    }

    return true;
}

别慌，一点一点来分析。

函数签名：
```
function block_has_attr( $block_name, $attribute_name )
```
这说明block_has_attr()函数接受两个参数：
- $block_name：区块的名称，比如'core/paragraph'（段落区块）、'core/image'（图片区块）等等。
- $attribute_name：要检查的属性的名称，比如'content'、'align'、'url'等等。
函数返回一个布尔值：true表示区块具有该属性，false表示没有。
获取区块类型：
```
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );
```
这行代码是关键。它利用WP_Block_Type_Registry类（一个单例类，负责管理所有注册的区块类型）来获取指定名称的区块类型对象。简单来说，就是根据 $block_name 去查一下，看看这个区块是不是真的存在。如果不存在，$block_type就会是null。
检查区块类型是否存在：
```
if ( ! $block_type ) {
    return false;
}
```
如果 $block_type 是 null，说明 WordPress 压根就没注册过这个区块，那肯定没有属性可言，直接返回 false。
检查属性是否存在：
```
if ( ! isset( $block_type->attributes[ $attribute_name ] ) ) {
    return false;
}
```
这行代码才是真正检查属性是否存在的地方。每个区块类型对象（$block_type）都有一个attributes属性，它是一个数组，存储着该区块所有注册的属性信息。这行代码使用isset()函数来判断$block_type->attributes数组中是否存在键名为$attribute_name的元素。如果不存在，说明该区块没有注册这个属性，返回false。
返回true：
```
return true;
```
如果前面的检查都通过了，那就说明该区块确实具有该属性，返回true。

举例说明：用block_has_attr()来判断属性

假设我们要判断core/paragraph区块是否具有content属性，我们可以这样写代码：

$block_name = 'core/paragraph';
$attribute_name = 'content';

if ( block_has_attr( $block_name, $attribute_name ) ) {
    echo "core/paragraph 区块具有 content 属性！";
} else {
    echo "core/paragraph 区块没有 content 属性！";
}

运行这段代码，你会看到输出："core/paragraph 区块具有 content 属性！"。

再举个例子，判断core/image区块是否具有nonexistent_attribute属性（一个不存在的属性）：

$block_name = 'core/image';
$attribute_name = 'nonexistent_attribute';

if ( block_has_attr( $block_name, $attribute_name ) ) {
    echo "core/image 区块具有 nonexistent_attribute 属性！";
} else {
    echo "core/image 区块没有 nonexistent_attribute 属性！";
}

运行这段代码，你会看到输出："core/image 区块没有 nonexistent_attribute 属性！"。

block_has_attr()的应用场景

那么，block_has_attr()函数在实际开发中有什么用呢？

动态渲染区块：

在动态渲染区块时，我们可能需要根据区块是否具有某个属性来决定如何渲染。比如，如果某个区块具有“自定义样式”属性，我们就应用自定义样式；如果没有，就使用默认样式。

function my_dynamic_block_render_callback( $attributes, $content ) {
    $block_name = 'my-plugin/my-dynamic-block'; // 假设这是你的动态区块名称

    if ( block_has_attr( $block_name, 'customStyle' ) && ! empty( $attributes['customStyle'] ) ) {
        $style = 'style="' . esc_attr( $attributes['customStyle'] ) . '"';
    } else {
        $style = ''; // 使用默认样式
    }

    return '<div ' . $style . '>' . $content . '</div>';
}

兼容性处理：

在更新区块定义时，可能会添加或删除某些属性。为了保证代码的兼容性，我们可以使用block_has_attr()函数来判断某个属性是否存在，从而采取不同的处理方式。

function my_plugin_update_block( $attributes, $content ) {
    $block_name = 'my-plugin/my-block';

    if ( block_has_attr( $block_name, 'newAttribute' ) ) {
        // 使用新属性的代码
        $new_value = $attributes['newAttribute'];
    } else {
        // 使用旧属性的代码，进行兼容
        $old_value = get_post_meta( get_the_ID(), '_old_attribute', true );
    }

    // ...
}

条件渲染：

在某些情况下，我们可能需要根据区块是否具有某个属性来决定是否渲染某个组件或执行某个操作。

function my_plugin_render_block( $attributes, $content ) {
    $block_name = 'my-plugin/my-block';

    if ( block_has_attr( $block_name, 'showExtraContent' ) && $attributes['showExtraContent'] ) {
        $extra_content = '<p>这是额外的区块内容！</p>';
    } else {
        $extra_content = '';
    }

    return $content . $extra_content;
}

block_has_attr()和isset()的区别

可能有人会问，既然block_has_attr()函数内部使用了isset()函数来判断属性是否存在，那我们直接用isset()函数不就行了吗？

答案是：不行！

block_has_attr()函数的作用不仅仅是判断属性是否存在，它还做了以下两件事：

检查区块类型是否存在： block_has_attr()函数首先会检查指定的区块类型是否已经注册。如果区块类型不存在，它会直接返回false，避免了后续的错误。
确保attributes属性存在： 即使区块类型存在，$block_type->attributes 属性也可能不存在（虽然这种情况很少见，但理论上是可能的）。block_has_attr() 函数确保了 attributes 属性存在后才进行 isset() 判断，避免了潜在的错误。

因此，虽然block_has_attr()函数内部使用了isset()函数，但它提供了更安全、更可靠的属性判断方式。建议始终使用block_has_attr()函数来判断区块是否具有某个属性。

用表格来总结一下：

函数/操作	功能	安全性	推荐程度
`block_has_attr()`	检查区块类型是否存在，检查`attributes`属性是否存在，最后使用`isset()`判断属性是否存在。	高	强烈推荐
`isset()`	直接判断属性是否存在。	低	不推荐

进阶：自定义区块的属性检查

如果你想在自己的自定义区块中使用block_has_attr()函数，你需要确保你的区块已经正确注册，并且定义了相应的属性。

下面是一个简单的自定义区块注册示例：

function my_plugin_register_block() {
    register_block_type( 'my-plugin/my-block', array(
        'attributes'      => array(
            'content'     => array(
                'type'    => 'string',
                'default' => '',
            ),
            'alignment' => array(
                'type'    => 'string',
                'default' => 'left',
            ),
        ),
        'render_callback' => 'my_plugin_render_block',
    ) );
}
add_action( 'init', 'my_plugin_register_block' );

在这个例子中，我们注册了一个名为my-plugin/my-block的区块，并定义了两个属性：content和alignment。

现在，你就可以使用block_has_attr()函数来判断这个区块是否具有这两个属性了：

$block_name = 'my-plugin/my-block';

if ( block_has_attr( $block_name, 'content' ) ) {
    echo "my-plugin/my-block 区块具有 content 属性！";
}

if ( block_has_attr( $block_name, 'alignment' ) ) {
    echo "my-plugin/my-block 区块具有 alignment 属性！";
}

if ( block_has_attr( $block_name, 'nonexistent_attribute' ) ) {
    echo "my-plugin/my-block 区块具有 nonexistent_attribute 属性！"; // 这不会被输出
}

注意事项：

block_has_attr()函数只能判断区块类型是否定义了某个属性，而不能判断属性的值是否为空。如果你需要判断属性的值是否为空，你需要直接访问$attributes数组，并使用empty()函数进行判断。
block_has_attr()函数只能在服务器端使用，不能在客户端（JavaScript）中使用。如果你需要在客户端判断区块是否具有某个属性，你需要将属性信息传递到客户端，并使用JavaScript代码进行判断。

总结：block_has_attr()，小函数，大作用

block_has_attr()函数虽然简单，但在 WordPress Gutenberg 开发中却扮演着重要的角色。它可以帮助我们安全、可靠地判断区块是否具有某个属性，从而实现动态渲染、兼容性处理和条件渲染等功能。

希望今天的讲解能够帮助大家更好地理解和使用block_has_attr()函数。记住，代码的世界充满了乐趣，只要我们用心去探索，就能发现更多的惊喜！感谢各位的观看，咱们下期再见！

发表回复 取消回复

发表回复取消回复