分析 WordPress `wp_get_theme()` 函数的源码：如何从文件系统中解析主题信息。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位程序猿朋友们，晚上好！我是今晚的主讲人，今天咱们来扒一扒 WordPress 里一个非常重要的函数——wp_get_theme()。这函数看起来人畜无害，但实际上它肩负着重任，负责从浩瀚的文件系统中，把主题的信息给挖出来。今天就让我们一起揭开它的神秘面纱，看看它到底是怎么做到的。

一、wp_get_theme() 的基本用法：

首先，咱们先来简单回顾一下 wp_get_theme() 的基本用法。

<?php
$theme = wp_get_theme();

if ( $theme->exists() ) {
    echo '主题名称: ' . $theme->get( 'Name' ) . '<br>';
    echo '主题版本: ' . $theme->get( 'Version' ) . '<br>';
    echo '主题作者: ' . $theme->get( 'Author' ) . '<br>';
} else {
    echo '主题不存在！';
}
?>

这段代码很简单，就是先用 wp_get_theme() 获取当前主题对象，然后判断主题是否存在，如果存在就输出主题的名称、版本和作者。如果主题不存在，就输出一个错误信息。

二、源码剖析：入口在哪儿？

好了，废话不多说，咱们直接进入正题，看看 wp_get_theme() 的源码。在 WordPress 的 wp-includes/theme.php 文件中，你会找到这个函数：

function wp_get_theme( $stylesheet = null, $theme_root = null ) {
    if ( isset( $stylesheet ) ) {
        $theme = WP_Theme::get_instance( $stylesheet, $theme_root );
    } else {
        $theme = WP_Theme::get_instance();
    }
    return $theme;
}

看到没？wp_get_theme() 函数实际上只是一个简单的包装器，它调用了 WP_Theme::get_instance() 方法来获取 WP_Theme 对象。也就是说，真正干活的是 WP_Theme 类。

三、WP_Theme::get_instance()：单例模式显神通

接下来，我们来看看 WP_Theme::get_instance() 方法。这个方法使用了单例模式，保证同一个主题只会被加载一次。

public static function get_instance( $stylesheet = null, $theme_root = null ) {
    static $themes = array();

    if ( isset( $stylesheet ) ) {
        $key = $theme_root . '/' . $stylesheet;
    } else {
        $stylesheet = get_stylesheet();
        $theme_root = get_theme_root();
        $key = $theme_root . '/' . $stylesheet;
    }

    if ( isset( $themes[ $key ] ) ) {
        return $themes[ $key ];
    }

    $themes[ $key ] = new WP_Theme( $stylesheet, $theme_root );
    return $themes[ $key ];
}

这个方法首先检查 $themes 数组中是否已经存在对应的主题对象，如果存在就直接返回，否则就创建一个新的 WP_Theme 对象，并将其存储到 $themes 数组中。

这里有几个关键点：

$themes 数组： 这是一个静态变量，用于存储已经加载的 WP_Theme 对象。
$key： 这是用于在 $themes 数组中查找主题对象的键，由 $theme_root 和 $stylesheet 组成。
get_stylesheet() 和 get_theme_root()： 这两个函数用于获取当前主题的样式表名称和主题根目录。

四、WP_Theme 类的构造函数：核心解析逻辑

现在，我们终于来到了 WP_Theme 类的构造函数，这里是解析主题信息的关键所在。

public function __construct( $stylesheet, $theme_root = null ) {
    $this->stylesheet = $stylesheet;

    if ( isset( $theme_root ) ) {
        $this->theme_root = $theme_root;
        $this->theme_root_uri = str_replace( WP_CONTENT_DIR, WP_CONTENT_URL, $theme_root );
    } else {
        $this->theme_root = get_theme_root( $this->stylesheet );
        $this->theme_root_uri = get_theme_root_uri( $this->stylesheet );
    }

    $this->cache_hash = md5( $this->theme_root . '/' . $this->stylesheet );

    $this->name = $this->parent_theme = $this->version = $this->template = $this->status = $this->stylesheet_dir =
    $this->stylesheet_uri = $this->template_dir = $this->template_uri = $this->screenshot = $this->description =
    $this->author = $this->author_uri = $this->tags = $this->headers = null;

    $this->errors = new WP_Error();

    $this->populate_from_stylesheet();
}

这个构造函数主要做了以下几件事：

设置主题的样式表和主题根目录： 根据传入的参数设置 $stylesheet、$theme_root 和 $theme_root_uri 属性。
生成缓存哈希： 使用 md5() 函数生成一个缓存哈希，用于缓存主题信息。
初始化属性： 将主题的各种属性（如名称、版本、作者等）初始化为 null。
创建错误对象： 创建一个 WP_Error 对象，用于存储解析主题信息时发生的错误。
调用 populate_from_stylesheet() 方法： 这是最重要的一步，它负责从主题的样式表文件中解析主题信息。

五、populate_from_stylesheet()：解析主题头的功臣

populate_from_stylesheet() 方法是解析主题信息的关键。它会读取主题的 style.css 文件，并从中提取主题头信息。

private function populate_from_stylesheet() {
    $stylesheet_file = $this->get_stylesheet_directory() . '/style.css';

    if ( ! is_readable( $stylesheet_file ) ) {
        $this->errors->add( 'theme_stylesheet_missing', __( 'Stylesheet is missing.' ) );
        return false;
    }

    $this->headers = get_file_data( $stylesheet_file, $this->get_theme_data_fields(), 'theme' );

    if ( empty( $this->headers['Name'] ) ) {
        $this->errors->add( 'theme_name_missing', __( 'Theme is missing the <code>Name:</code> header.' ) );
        return false;
    }

    /*
     * Fill in the values.
     */
    $this->name        = $this->headers['Name'];
    $this->description = $this->headers['Description'];
    $this->author      = $this->headers['Author'];
    $this->author_uri  = $this->headers['AuthorURI'];
    $this->version     = $this->headers['Version'];
    $this->template    = $this->headers['Template'];
    $this->status      = $this->headers['Status'];
    $this->tags        = $this->headers['Tags'];
    $this->theme_uri   = $this->headers['ThemeURI'];

    /*
     * Check for errors.
     */
    if ( $this->template ) {
        $this->parent_theme = wp_get_theme( $this->template, $this->theme_root );
        if ( ! $this->parent_theme->exists() ) {
            $this->errors->add( 'parent_theme_not_found', sprintf( __( 'Failed to load parent theme. Are you sure the <code>Template</code> is correct? <br />Here is the content of <code>Template</code>: %s' ), esc_html( $this->template ) ) );
        }
    }

    if ( is_child_theme() && empty( $this->template ) ) {
        $this->errors->add( 'child_missing_template', __( 'Child theme is missing the <code>Template</code> header.' ) );
    }

    return true;
}

这个方法做了以下几件事：

获取样式表文件路径： 使用 get_stylesheet_directory() 方法获取主题的样式表文件路径。
检查样式表文件是否存在： 使用 is_readable() 函数检查样式表文件是否存在且可读。
使用 get_file_data() 函数解析主题头： 这是最关键的一步，它使用 get_file_data() 函数从样式表文件中提取主题头信息，并将结果存储到 $this->headers 属性中。
检查主题名称是否存在： 检查 $this->headers 数组中是否存在 Name 键，如果不存在则添加一个错误。
填充主题属性： 将 $this->headers 数组中的值填充到主题的各个属性中。
处理父主题： 如果主题指定了父主题（通过 Template 键），则递归调用 wp_get_theme() 函数加载父主题，并检查父主题是否存在。
检查子主题是否缺少 Template 头： 如果是子主题，则检查是否缺少 Template 头。

六、get_file_data()：解析文件数据的利器

get_file_data() 函数是一个通用的文件数据解析函数，它可以从任何文件中提取指定的数据。

function get_file_data( $file, $default_headers, $context = '' ) {
    // We don't need to write to the file, so just use r.
    $fp = fopen( $file, 'r' );

    // Pull out the first 8kiB of the file.
    $file_data = fread( $fp, 8192 );

    // PHP will close file handle, but we are good citizens.
    fclose( $fp );

    // Make sure we catch CR-only line endings.
    $file_data = str_replace( "r", "n", $file_data );

    /**
     * Filter extra file headers assembled by get_file_data().
     *
     * @since 3.4.0
     *
     * @param string[] $default_headers Array of extra headers to find in file.
     * @param string   $file            Full path to the file.
     * @param string   $context         Context of the extra headers.
     */
    $default_headers = apply_filters( 'extra_theme_headers', $default_headers, $file, $context );

    foreach ( $default_headers as $field => $regex ) {
        if ( preg_match( '/' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] ) {
            $value = trim( _cleanup_header_comment( $match[1] ) );
        } else {
            $value = '';
        }
        $all_headers[ $field ] = $value;
    }

    return $all_headers;
}

这个函数主要做了以下几件事：

打开文件： 使用 fopen() 函数以只读模式打开文件。
读取文件内容： 使用 fread() 函数读取文件的前 8KB 内容。
关闭文件： 使用 fclose() 函数关闭文件。
处理换行符： 将文件中的 r 替换为 n，以确保在不同操作系统上的兼容性。
应用过滤器： 应用 extra_theme_headers 过滤器，允许开发者添加自定义的头信息。
使用正则表达式解析头信息： 使用 preg_match() 函数和正则表达式从文件内容中提取头信息。
清理头信息： 使用 _cleanup_header_comment() 函数清理头信息中的注释和空格。
返回头信息数组： 将提取到的头信息存储到一个数组中，并返回该数组。

七、get_theme_data_fields()：定义需要解析的头信息

get_theme_data_fields() 方法定义了需要从主题样式表文件中解析的头信息。

private function get_theme_data_fields() {
    /**
     * Filters the default theme data fields.
     *
     * @since 1.8.0
     *
     * @param string[] $theme_data_fields An array of theme data fields.
     */
    return apply_filters(
        'theme_data_fields',
        array(
            'Name'        => 'Theme Name',
            'ThemeURI'    => 'Theme URI',
            'Description' => 'Description',
            'Author'      => 'Author',
            'AuthorURI'   => 'Author URI',
            'Version'     => 'Version',
            'Template'    => 'Template',
            'Status'      => 'Status',
            'Tags'        => 'Tags',
            'TextDomain'  => 'Text Domain',
            'DomainPath'  => 'Domain Path',
        )
    );
}

这个方法返回一个数组，其中包含了需要解析的头信息的名称和正则表达式。例如，'Name' => 'Theme Name' 表示需要解析 Theme Name 头信息，并将其存储到 Name 键中。

八、总结：wp_get_theme() 的工作流程

现在，我们已经了解了 wp_get_theme() 函数的整个工作流程。总结一下：

wp_get_theme() 函数调用 WP_Theme::get_instance() 方法获取 WP_Theme 对象。
WP_Theme::get_instance() 方法使用单例模式，保证同一个主题只会被加载一次。
WP_Theme 类的构造函数初始化主题的各种属性，并调用 populate_from_stylesheet() 方法解析主题信息。
populate_from_stylesheet() 方法读取主题的 style.css 文件，并使用 get_file_data() 函数提取主题头信息。
get_file_data() 函数使用正则表达式从文件内容中提取头信息，并将其存储到一个数组中。
populate_from_stylesheet() 方法将提取到的头信息填充到主题的各个属性中。

可以用表格总结如下：

函数/方法	作用	关键步骤
`wp_get_theme()`	获取主题对象。	调用 `WP_Theme::get_instance()`。
`WP_Theme::get_instance()`	返回 `WP_Theme` 类的单例实例。	检查缓存中是否存在主题对象，如果存在则直接返回，否则创建新的主题对象并添加到缓存。
`WP_Theme::__construct()`	`WP_Theme` 类的构造函数，初始化主题信息。	设置主题路径信息，初始化属性，调用 `populate_from_stylesheet()`。
`WP_Theme::populate_from_stylesheet()`	从主题的 `style.css` 文件中提取主题头信息。	读取 `style.css` 文件，调用 `get_file_data()` 函数提取主题头，检查父主题是否存在，处理子主题的 `Template` 头。
`get_file_data()`	从文件中提取数据（例如，主题头）。	打开文件，读取文件内容，使用正则表达式匹配预定义的头部信息，返回包含头部信息的数组。
`WP_Theme::get_theme_data_fields()`	定义要从主题 `style.css` 中提取的头部信息和对应的正则表达式。	返回一个包含头部信息名称和对应正则表达式的数组。

九、进阶：缓存机制和钩子

wp_get_theme() 函数还使用了一些缓存机制和钩子，以提高性能和灵活性。

对象缓存： WP_Theme::get_instance() 方法使用 $themes 数组缓存已经加载的主题对象，避免重复加载。
extra_theme_headers 钩子： get_file_data() 函数应用 extra_theme_headers 钩子，允许开发者添加自定义的头信息。
theme_data_fields 钩子： get_theme_data_fields() 方法应用 theme_data_fields 钩子，允许开发者修改需要解析的头信息。

十、总结与思考

通过今天的源码剖析，我们深入了解了 wp_get_theme() 函数的工作原理。它通过一系列巧妙的设计，实现了从文件系统中高效地解析主题信息的功能。

希望通过今天的讲解，大家能够对 WordPress 的主题机制有更深入的理解，并在实际开发中灵活运用。

好了，今天的讲座就到这里，谢谢大家！

发表回复 取消回复

发表回复取消回复