深入理解 WordPress `get_page_template_slug()` 函数的源码：如何获取页面模板的 `slug`。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位未来的 WordPress 大神们，大家好！今天咱们就来扒一扒 WordPress 里一个挺低调，但有时候又挺有用的函数——get_page_template_slug()。这家伙专门负责“刨根问底”，找出页面到底用了哪个模板的 slug。听起来好像很简单，但要真正理解它，还得深入到 WordPress 的源码里溜达一圈。准备好，咱们开始今天的“寻宝之旅”！

一、get_page_template_slug() 是个啥？

首先，咱们得弄清楚 slug 是个什么概念。在 WordPress 的世界里，slug 就像一个东西的“别名”，通常是小写字母、数字和短横线组成，主要用于 URL。比如，一个页面标题是“我的联系方式”，那它的 slug 可能就是 my-contact-info。

对于页面模板来说，slug 其实就是模板文件的文件名（不包括 .php 后缀）。举个例子，如果你的页面模板文件叫 template-contact.php，那么它的 slug 就是 template-contact。

get_page_template_slug() 函数的作用，就是获取当前页面或指定页面使用的模板文件的 slug。

二、源码剖析：一层层揭开它的真面目

接下来，咱们直接钻到 WordPress 源码里，看看 get_page_template_slug() 到底是怎么工作的。这个函数定义在 wp-includes/template.php 文件里。

/**
 * Retrieves the filename of the current page template.
 *
 * @since 1.5.0
 *
 * @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
 * @return string Filename of the template file.
 */
function get_page_template_slug( $post = null ) {
    $post = get_post( $post );

    if ( ! $post ) {
        return '';
    }

    $template = get_post_meta( $post->ID, '_wp_page_template', true );

    if ( 'default' === $template || empty( $template ) ) {
        return '';
    }

    return $template;
}

咱们一行行来解读：

函数定义和参数：
```
function get_page_template_slug( $post = null ) {
```
- 函数名是 get_page_template_slug，接收一个可选参数 $post，它可以是：
  - null：表示使用全局的 $post 对象（也就是当前页面）。
  - 一个整数：表示文章（页面）的 ID。
  - 一个 WP_Post 对象：表示文章（页面）对象。
获取 WP_Post 对象：
```
$post = get_post( $post );

if ( ! $post ) {
    return '';
}
```
- get_post( $post ) 函数的作用是：
  - 如果 $post 是 null，它会尝试获取全局的 $post 对象。
  - 如果 $post 是一个整数，它会根据这个 ID 获取对应的 WP_Post 对象。
  - 如果 $post 已经是 WP_Post 对象，它会直接返回这个对象。
- 如果 get_post() 返回 null（表示没有找到对应的文章/页面），函数会直接返回空字符串 ''。
获取模板信息：
```
$template = get_post_meta( $post->ID, '_wp_page_template', true );
```
- get_post_meta() 函数是 WordPress 里用来获取文章（页面）元数据的。
- $post->ID：表示当前文章（页面）的 ID。
- '_wp_page_template'：这是一个关键的元数据键名。 WordPress 会把页面选择的模板文件名（包括 .php 后缀）存储在这个元数据里。
- true：表示只返回单个值（而不是一个数组）。
简单来说，这行代码就是从当前页面（或指定的页面）的元数据里，取出存储的模板文件名（比如 template-contact.php）。
处理默认模板和空模板：
```
if ( 'default' === $template || empty( $template ) ) {
    return '';
}
```
- 如果 $template 的值是 'default'，或者 $template 是空的（''），表示页面使用了默认模板。这种情况下，函数会返回空字符串 ''。
- 这块逻辑很关键，因为它告诉我们，如果页面没有明确指定模板，get_page_template_slug() 是不会返回默认模板的 slug 的。
返回模板 slug：
```
return $template;
```
- 如果页面使用了自定义模板，并且 $template 里存储了模板文件名（比如 template-contact.php），函数会直接返回这个文件名作为 slug。注意，这里返回的是完整的文件名，包括 .php 后缀！这点和我们一开始对 slug 的定义稍有不同，需要特别注意。

三、使用示例：让代码说话

光说不练假把式。咱们来写几个例子，看看 get_page_template_slug() 在实际开发中怎么用。

示例 1：获取当前页面使用的模板 slug

<?php
$template_slug = get_page_template_slug();

if ( ! empty( $template_slug ) ) {
    echo '当前页面使用的模板 slug 是：' . esc_html( $template_slug );
} else {
    echo '当前页面使用默认模板。';
}
?>

这段代码会获取当前页面使用的模板 slug，然后根据 slug 是否为空来判断页面是否使用了自定义模板。

示例 2：获取指定页面 ID 的模板 slug

<?php
$page_id = 123; // 替换成你想要获取的页面 ID
$template_slug = get_page_template_slug( $page_id );

if ( ! empty( $template_slug ) ) {
    echo '页面 ID 为 ' . $page_id . ' 的页面使用的模板 slug 是：' . esc_html( $template_slug );
} else {
    echo '页面 ID 为 ' . $page_id . ' 的页面使用默认模板。';
}
?>

这段代码会获取页面 ID 为 123 的页面使用的模板 slug。

示例 3：在 WP_Query 循环中使用

<?php
$args = array(
    'post_type' => 'page',
    'posts_per_page' => -1, // 获取所有页面
);

$query = new WP_Query( $args );

if ( $query->have_posts() ) {
    while ( $query->have_posts() ) {
        $query->the_post();
        $template_slug = get_page_template_slug();

        echo '页面标题：' . get_the_title() . '<br>';
        if ( ! empty( $template_slug ) ) {
            echo '模板 slug：' . esc_html( $template_slug ) . '<br>';
        } else {
            echo '使用默认模板<br>';
        }
        echo '<hr>';
    }
    wp_reset_postdata();
} else {
    echo '没有找到页面。';
}
?>

这段代码会循环输出所有页面的标题和模板 slug。

四、注意事项：避开那些“坑”

在使用 get_page_template_slug() 的时候，有几个地方需要特别注意：

返回的是完整文件名： 函数返回的是完整的模板文件名（包括 .php 后缀），而不是我们通常理解的 slug（不包括后缀）。所以在实际使用的时候，可能需要用 str_replace() 函数把 .php 后缀去掉。
```
<?php
$template_slug = get_page_template_slug();
if ( ! empty( $template_slug ) ) {
    $template_slug = str_replace( '.php', '', $template_slug ); // 去掉 .php 后缀
    echo '模板 slug (不含 .php)：' . esc_html( $template_slug );
}
?>
```
默认模板返回空字符串： 如果页面使用了默认模板，函数会返回空字符串 ''。这一点需要特别注意，不要误以为页面没有使用任何模板。
只适用于页面模板： get_page_template_slug() 函数是专门为页面模板设计的。它不能用来获取其他类型模板的 slug，比如文章模板、分类模板等等。
主题目录下的模板： get_page_template_slug() 返回的是存储在文章元数据中的模板文件名。它不会自动搜索主题目录下的模板文件。

五、应用场景：让它发挥作用

那么，get_page_template_slug() 在哪些场景下比较有用呢？

应用场景	说明	示例代码
根据模板加载不同的 CSS/JS 文件	可以根据页面使用的模板，加载不同的 CSS 或 JS 文件。比如，如果页面使用了 `template-contact.php` 模板，就加载 `contact.css` 和 `contact.js`。	`php <?php $template_slug = get_page_template_slug(); if ( 'template-contact.php' === $template_slug ) { wp_enqueue_style( 'contact-style', get_template_directory_uri() . '/css/contact.css' ); wp_enqueue_script( 'contact-script', get_template_directory_uri() . '/js/contact.js', array( 'jquery' ), '1.0', true ); } ?>`
根据模板显示不同的内容	可以根据页面使用的模板，显示不同的内容。比如，如果页面使用了 `template-portfolio.php` 模板，就显示作品集的内容；如果使用了 `template-about.php` 模板，就显示关于我们的内容。	`php <?php $template_slug = get_page_template_slug(); if ( 'template-portfolio.php' === $template_slug ) { // 显示作品集内容 get_template_part( 'template-parts/content', 'portfolio' ); } elseif ( 'template-about.php' === $template_slug ) { // 显示关于我们内容 get_template_part( 'template-parts/content', 'about' ); } else { the_content(); } ?>`
自定义模板的特定功能	可以在模板文件中，根据自身的 `slug` 来执行特定的功能。这在开发复杂的、需要高度定制化的主题时非常有用。	`php <?php // template-custom.php if ( basename( get_page_template() ) == 'template-custom.php' ) { // 执行一些自定义功能 echo '<div class="custom-template-content">'; // ... 自定义内容 ... echo '</div>'; } ?>`
动态修改页面标题	可以根据模板名称动态修改页面标题。例如，如果使用了 `template-services.php`，可以将页面标题修改为 "我们的服务"。	`php add_filter( 'the_title', 'custom_page_title' ); function custom_page_title( $title ) { if ( is_page() ) { $template_slug = get_page_template_slug(); if ( 'template-services.php' === $template_slug ) { $title = '我们的服务'; } } return $title; }`
在后台管理界面显示模板信息	可以在 WordPress 后台管理界面，显示页面使用的模板信息，方便管理员了解页面的布局和功能。	这个需要自定义 metabox 来实现，代码较多，可以参考 WordPress metabox 的开发文档。

六、总结：掌握这个小工具

get_page_template_slug() 函数虽然看起来不起眼，但在某些特定的场景下，却能发挥很大的作用。通过深入理解它的源码和使用方法，我们可以更好地控制页面的行为，实现更灵活、更个性化的主题功能。

记住，编程就像探险，只有不断地探索和实践，才能真正掌握那些“宝藏”！希望今天的“寻宝之旅”能帮助你更深入地了解 WordPress。下次再见！

发表回复 取消回复

发表回复取消回复