函数文档

wp_get_global_stylesheet()

💡 云策文档标注

概述

wp_get_global_stylesheet() 函数用于生成合并核心、主题和用户数据的全局样式表。它根据主题是否支持 theme.json 文件,动态加载不同类型的样式,并支持缓存机制以提高性能。

关键要点

  • 函数返回合并后的样式表字符串,参数 $types 可选,指定要加载的样式类型,如 'variables'、'presets'、'styles' 或 'base-layout-styles'。
  • 当 $types 为空时,默认加载类型取决于主题是否支持 theme.json:支持时加载 'variables'、'presets'、'styles';不支持时加载 'variables'、'presets'、'base-layout-styles'。
  • 函数使用非持久化缓存(组 'theme_json')来优化性能,但在开发模式为 'theme' 时忽略缓存,以确保样式表能反映动态修改。
  • 样式来源(origins)包括 'default'、'theme' 和 'custom','blocks' 来源的样式在渲染阶段单独处理。
  • 对于不支持 theme.json 但支持外观工具或颜色调色板的主题,会调整来源以包含主题预设。

代码示例

// 获取全局样式表
$stylesheet = wp_get_global_stylesheet();
// 或指定类型
$stylesheet = wp_get_global_stylesheet( array( 'variables', 'presets' ) );

注意事项

  • 缓存机制旨在提高性能,但开发模式下应禁用缓存以避免干扰主题开发工作流。
  • 函数内部调用 WP_Theme_JSON::get_stylesheet 来生成样式,确保与 theme.json 数据一致。
  • 相关函数如 wp_theme_has_theme_json() 和 current_theme_supports() 用于检测主题特性,影响样式加载逻辑。

📄 原文内容

Returns the stylesheet resulting of merging core, theme, and user data.

Parameters

$typesarrayoptional
Types of styles to load.
See ‘WP_Theme_JSON::get_stylesheet’ for all valid types.
If empty, it’ll load the following:

  • for themes without theme.json: 'variables', 'presets', 'base-layout-styles'.
  • for themes with theme.json: 'variables', 'presets', 'styles'.

Default:array()

Return

string Stylesheet.

Source

function wp_get_global_stylesheet( $types = array() ) {
	/*
	 * Ignore cache when the development mode is set to 'theme', so it doesn't interfere with the theme
	 * developer's workflow.
	 */
	$can_use_cached = empty( $types ) && ! wp_is_development_mode( 'theme' );

	/*
	 * By using the 'theme_json' group, this data is marked to be non-persistent across requests.
	 * @see `wp_cache_add_non_persistent_groups()`.
	 *
	 * The rationale for this is to make sure derived data from theme.json
	 * is always fresh from the potential modifications done via hooks
	 * that can use dynamic data (modify the stylesheet depending on some option,
	 * settings depending on user permissions, etc.).
	 * See some of the existing hooks to modify theme.json behavior:
	 * @see https://make.wordpress.org/core/2022/10/10/filters-for-theme-json-data/
	 *
	 * A different alternative considered was to invalidate the cache upon certain
	 * events such as options add/update/delete, user meta, etc.
	 * It was judged not enough, hence this approach.
	 * @see https://github.com/WordPress/gutenberg/pull/45372
	 */
	$cache_group = 'theme_json';
	$cache_key   = 'wp_get_global_stylesheet';
	if ( $can_use_cached ) {
		$cached = wp_cache_get( $cache_key, $cache_group );
		if ( $cached ) {
			return $cached;
		}
	}

	$tree                = WP_Theme_JSON_Resolver::resolve_theme_file_uris( WP_Theme_JSON_Resolver::get_merged_data() );
	$supports_theme_json = wp_theme_has_theme_json();

	if ( empty( $types ) && ! $supports_theme_json ) {
		$types = array( 'variables', 'presets', 'base-layout-styles' );
	} elseif ( empty( $types ) ) {
		$types = array( 'variables', 'styles', 'presets' );
	}

	/*
	 * If variables are part of the stylesheet, then add them.
	 * This is so themes without a theme.json still work as before 5.9:
	 * they can override the default presets.
	 * See https://core.trac.wordpress.org/ticket/54782
	 */
	$styles_variables = '';
	if ( in_array( 'variables', $types, true ) ) {
		/*
		 * Only use the default, theme, and custom origins. Why?
		 * Because styles for `blocks` origin are added at a later phase
		 * (i.e. in the render cycle). Here, only the ones in use are rendered.
		 * @see wp_add_global_styles_for_blocks
		 */
		$origins          = array( 'default', 'theme', 'custom' );
		$styles_variables = $tree->get_stylesheet( array( 'variables' ), $origins );
		$types            = array_diff( $types, array( 'variables' ) );
	}

	/*
	 * For the remaining types (presets, styles), we do consider origins:
	 *
	 * - themes without theme.json: only the classes for the presets defined by core
	 * - themes with theme.json: the presets and styles classes, both from core and the theme
	 */
	$styles_rest = '';
	if ( ! empty( $types ) ) {
		/*
		 * Only use the default, theme, and custom origins. Why?
		 * Because styles for `blocks` origin are added at a later phase
		 * (i.e. in the render cycle). Here, only the ones in use are rendered.
		 * @see wp_add_global_styles_for_blocks
		 */
		$origins = array( 'default', 'theme', 'custom' );
		/*
		 * If the theme doesn't have theme.json but supports both appearance tools and color palette,
		 * the 'theme' origin should be included so color palette presets are also output.
		 */
		if ( ! $supports_theme_json && ( current_theme_supports( 'appearance-tools' ) || current_theme_supports( 'border' ) ) && current_theme_supports( 'editor-color-palette' ) ) {
			$origins = array( 'default', 'theme' );
		} elseif ( ! $supports_theme_json ) {
			$origins = array( 'default' );
		}
		$styles_rest = $tree->get_stylesheet( $types, $origins );
	}

	$stylesheet = $styles_variables . $styles_rest;
	if ( $can_use_cached ) {
		wp_cache_set( $cache_key, $stylesheet, $cache_group );
	}

	return $stylesheet;
}

Changelog

Version Description
6.6.0 Resolves relative paths in theme.json styles to theme absolute paths.
6.1.0 Added 'base-layout-styles' support.
5.9.0 Introduced.