函数文档

_register_remote_theme_patterns()

💡 云策文档标注

概述

_register_remote_theme_patterns() 函数用于从 Pattern Directory 注册由主题的 theme.json 文件提供的远程块模式。它通过 REST API 获取模式数据,并注册到 WordPress 系统中。

关键要点

  • 函数仅在 should_load_remote_block_patterns 过滤器返回 true 且主题有 theme.json 文件时执行。
  • 使用 wp_get_theme_directory_pattern_slugs() 获取主题指定的模式 slug 列表。
  • 通过 WP_REST_Request 和 rest_do_request() 从 Pattern Directory API 获取模式数据。
  • 使用 wp_normalize_remote_block_pattern() 将 API 返回的 snake_case 格式转换为 camelCase。
  • 通过 WP_Block_Patterns_Registry 检查模式是否已注册,避免重复注册。
  • 最终使用 register_block_pattern() 注册模式,并设置 source 为 'pattern-directory/theme'。

代码示例

function _register_remote_theme_patterns() {
    if ( ! apply_filters( 'should_load_remote_block_patterns', true ) ) {
        return;
    }
    if ( ! wp_theme_has_theme_json() ) {
        return;
    }
    $pattern_settings = wp_get_theme_directory_pattern_slugs();
    if ( empty( $pattern_settings ) ) {
        return;
    }
    $request         = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
    $request['slug'] = $pattern_settings;
    $response        = rest_do_request( $request );
    if ( $response->is_error() ) {
        return;
    }
    $patterns          = $response->get_data();
    $patterns_registry = WP_Block_Patterns_Registry::get_instance();
    foreach ( $patterns as $pattern ) {
        $pattern['source']  = 'pattern-directory/theme';
        $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
        $pattern_name       = sanitize_title( $normalized_pattern['title'] );
        $is_registered = $patterns_registry->is_registered( $pattern_name ) || $patterns_registry->is_registered( "core/$pattern_name" );
        if ( ! $is_registered ) {
            register_block_pattern( $pattern_name, $normalized_pattern );
        }
    }
}

注意事项

  • 可通过 should_load_remote_block_patterns 过滤器禁用远程块模式加载。
  • 模式 slug 需在主题的 theme.json 中定义,否则函数会提前返回。
  • 注册时会检查模式是否已存在,包括核心模式(带 'core/' 前缀),避免冲突。
  • 函数自 WordPress 6.0.0 引入,后续版本有更新如模式源标识和格式规范化。

📄 原文内容

Registers patterns from Pattern Directory provided by a theme’s theme.json file.

Source

function _register_remote_theme_patterns() {
	/** This filter is documented in wp-includes/block-patterns.php */
	if ( ! apply_filters( 'should_load_remote_block_patterns', true ) ) {
		return;
	}

	if ( ! wp_theme_has_theme_json() ) {
		return;
	}

	$pattern_settings = wp_get_theme_directory_pattern_slugs();
	if ( empty( $pattern_settings ) ) {
		return;
	}

	$request         = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
	$request['slug'] = $pattern_settings;
	$response        = rest_do_request( $request );
	if ( $response->is_error() ) {
		return;
	}
	$patterns          = $response->get_data();
	$patterns_registry = WP_Block_Patterns_Registry::get_instance();
	foreach ( $patterns as $pattern ) {
		$pattern['source']  = 'pattern-directory/theme';
		$normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
		$pattern_name       = sanitize_title( $normalized_pattern['title'] );
		// Some patterns might be already registered as core patterns with the `core` prefix.
		$is_registered = $patterns_registry->is_registered( $pattern_name ) || $patterns_registry->is_registered( "core/$pattern_name" );
		if ( ! $is_registered ) {
			register_block_pattern( $pattern_name, $normalized_pattern );
		}
	}
}

Hooks

apply_filters( ‘should_load_remote_block_patterns’, bool $should_load_remote )

Filter to disable remote block patterns.

Changelog

Version Description
6.3.0 Add 'pattern-directory/theme' to the pattern’s 'source'.
6.2.0 Normalized the pattern from the API (snake_case) to the format expected by register_block_pattern() (camelCase).
6.0.0 Introduced.