发布于 由admin

解释 `wp_get_document_title()` 函数的源码，它是如何通过过滤器动态生成页面标题的？

大家好，我是老码，今天咱们来聊聊WordPress的 wp_get_document_title() 这个函数，它可是网站页面标题生成的大管家。这标题看似简单，实则关乎SEO，用户体验，可不能马虎。

开场白：标题的重要性，以及wp_get_document_title()的地位

想象一下，你在浩瀚的网络海洋里冲浪，搜索引擎就是你的指南针。而页面标题，就是指南针上最醒目的坐标。一个好的标题，能让搜索引擎一眼相中你，也能让用户迅速get到页面的核心内容。

在WordPress的世界里，wp_get_document_title() 就是负责生成这些关键坐标的“GPS”。它不是直接硬编码标题，而是通过一系列的过滤器（Filters），让你有机会自定义，动态生成页面标题。这就像给GPS装上了各种插件，能根据不同的情况，显示不同的信息。

wp_get_document_title()源码剖析：一层一层揭开它的面纱

咱们直接上代码，看看这“GPS”内部是怎么运作的：

<?php
/**
 * Retrieves the document title.
 *
 * @since 4.4.0
 *
 * @return string The page title.
 */
function wp_get_document_title() {
    $title = '';

    $title_array = array();

    if ( is_front_page() && is_home() ) {

        /*
         * If the front page is a page, the front page display option is honored.
         * In that case, use the values from the 'wp_title' filter.
         */
        if ( 'page' == get_option( 'show_on_front' ) ) {
            $title_array['title'] = get_the_title( get_option( 'page_on_front' ) );
        } else {
            $title_array['title'] = get_bloginfo( 'name' );
            $title_array['tagline'] = get_bloginfo( 'description' );
        }

    } elseif ( is_front_page() ) {
        $title_array['title'] = get_the_title( get_queried_object_id() );

    } elseif ( is_home() ) {
        $title_array['title'] = get_bloginfo( 'name' );
        $title_array['tagline'] = get_bloginfo( 'description' );

    } elseif ( is_singular() ) {
        $title_array['title'] = single_post_title( '', false );

    } elseif ( is_category() ) {
        $title_array['title'] = single_cat_title( '', false );

    } elseif ( is_tag() ) {
        $title_array['title'] = single_tag_title( '', false );

    } elseif ( is_tax() ) {
        $term = get_queried_object();
        if ( $term ) {
            $title_array['title'] = single_term_title( '', false );
        }

    } elseif ( is_archive() ) {
        if ( is_post_type_archive() ) {
            $title_array['title'] = post_type_archive_title( '', false );
        } elseif ( is_date() ) {
            $title_array['title'] = get_the_date();
        } elseif ( is_author() ) {
            $title_array['title'] = get_the_author();
        } else {
            $title_array['title'] = __( 'Archives', 'default' );
        }

    } elseif ( is_search() ) {
        /* translators: %s: Search query. */
        $title_array['title'] = sprintf( __( 'Search Results for “%s”', 'default' ), get_search_query() );

    } elseif ( is_404() ) {
        $title_array['title'] = __( 'Page Not Found', 'default' );

    } else {
        $title_array['title'] = get_bloginfo( 'name' );
    }

    /**
     * Filters the parts of the document title.
     *
     * @since 4.4.0
     *
     * @param string[] $title_array An associative array of the document title parts.
     */
    $title_array = apply_filters( 'document_title_parts', $title_array );

    /**
     * Filters the separator for the document title.
     *
     * @since 4.4.0
     *
     * @param string $sep Document title separator.
     */
    $sep = apply_filters( 'document_title_separator', '|' );

    if ( ! empty( $title_array['title'] ) ) {
        $title = $title_array['title'];
        unset( $title_array['title'] );
    }

    $title = trim( $title );

    if ( ! empty( $title_array ) ) {
        $title .= ' ' . $sep . ' ' . implode( " $sep ", $title_array );
    }

    /**
     * Filters the document title.
     *
     * @since 4.4.0
     *
     * @param string $title The complete document title.
     */
    return apply_filters( 'wp_title', $title, '' ); // The second parameter is deprecated since 4.4.
}

别被代码吓到，咱们把它拆解成几个关键部分：

  1. 判断页面类型 (Conditional Tags)：

    • is_front_page()、is_home()、is_singular()、is_category() 等等，这些都是WordPress内置的条件判断函数。它们就像侦察兵，根据当前页面的类型，给出不同的信号。
    • 根据不同的页面类型，$title_array 会被赋予不同的初始值。例如，如果是首页，就可能获取站点名称和描述；如果是文章页，就获取文章标题。
    页面类型 默认标题来源
    首页 (Front Page) 站点名称/描述，或者指定的页面标题
    文章页 (Singular) 文章标题
    分类页 (Category) 分类标题
    标签页 (Tag) 标签标题
    搜索页 (Search) "Search Results for…" + 搜索关键词
    404页 "Page Not Found"

  2. document_title_parts 过滤器：

    • 这是第一个关键的过滤器。它允许你修改 $title_array 数组的内容。你可以添加、删除、修改数组中的元素，从而改变标题的组成部分。
    • 这个过滤器提供了一个机会，让你在标题生成的最早期介入，进行精细的控制。

  3. document_title_separator 过滤器：

    • 这个过滤器允许你修改标题各个部分之间的分隔符。默认是 |，你可以改成 -、»，或者任何你喜欢的符号。

  4. 组装标题：

    • 根据 $title_array 中的内容，以及分隔符，将各个部分组装成最终的标题字符串。

  5. wp_title 过滤器：

    • 这是第二个关键的过滤器，也是历史最悠久的。它允许你对最终生成的标题字符串进行修改。
    • 虽然名字是 wp_title，但它实际上是 wp_get_document_title() 函数的最后一道防线，负责返回最终的标题。

过滤器 (Filters)：标题的魔术师

现在，我们来重点聊聊过滤器，它们才是真正让标题“动起来”的关键。

过滤器是WordPress提供的一种钩子机制，允许你在特定的时间点，修改某个变量的值。它们就像一个“拦截器”，在数据传递的过程中，给你一个机会“动手脚”。

在 wp_get_document_title() 函数中，我们看到了两个关键的过滤器：

  • document_title_parts
  • document_title_separator
  • wp_title

document_title_parts过滤器实战：添加站点名称

假设我们想在所有页面的标题后面，都加上站点名称。我们可以使用 document_title_parts 过滤器来实现：

<?php
/**
 * Adds the site name to the document title parts.
 *
 * @param string[] $title_array Array of document title parts.
 * @return string[] Modified array.
 */
function my_theme_add_site_name_to_title( $title_array ) {
    $title_array['site_name'] = get_bloginfo( 'name' );
    return $title_array;
}
add_filter( 'document_title_parts', 'my_theme_add_site_name_to_title' );

这段代码做了什么？

  1. 定义了一个名为 my_theme_add_site_name_to_title 的函数。这个函数接收一个参数 $title_array，它就是 document_title_parts 过滤器传递过来的数组。
  2. 在函数内部，我们向 $title_array 数组中添加了一个新的元素，键名为 site_name，值为站点名称。
  3. 使用 add_filter() 函数，将 my_theme_add_site_name_to_title 函数挂载到 document_title_parts 过滤器上。

现在，所有页面的标题都会自动加上站点名称了。

document_title_separator过滤器实战：修改分隔符

如果我们不喜欢默认的 | 分隔符，想改成 -，可以使用 document_title_separator 过滤器：

<?php
/**
 * Filters the document title separator.
 *
 * @param string $sep The separator.
 * @return string The modified separator.
 */
function my_theme_change_title_separator( $sep ) {
    return '-';
}
add_filter( 'document_title_separator', 'my_theme_change_title_separator' );

这段代码非常简单，就是将默认的分隔符 | 替换成了 -。

wp_title过滤器实战：终极标题修改

wp_title 过滤器是最后的“关卡”，你可以对最终生成的标题字符串进行修改。例如，我们可以限制标题的长度：

<?php
/**
 * Filters the document title.
 *
 * @param string $title The complete document title.
 * @return string The modified title.
 */
function my_theme_limit_title_length( $title ) {
    $max_length = 60; // Maximum title length
    if ( strlen( $title ) > $max_length ) {
        $title = substr( $title, 0, $max_length ) . '...';
    }
    return $title;
}
add_filter( 'wp_title', 'my_theme_limit_title_length' );

这段代码将标题的长度限制在 60 个字符以内，如果超过了，就截断并加上省略号。

总结：wp_get_document_title()的优势与灵活运用

wp_get_document_title() 函数的核心优势在于它的灵活性。通过过滤器，你可以根据自己的需求，定制各种各样的标题生成规则。

优势 说明
灵活性 可以根据不同的页面类型，生成不同的标题。
可定制性 可以通过过滤器，修改标题的组成部分、分隔符、长度等等。
SEO友好 可以根据SEO最佳实践，优化标题内容，提高网站在搜索引擎中的排名。
用户体验 可以根据用户需求，定制清晰、简洁的标题，提高用户体验。
代码可维护性 通过过滤器，将标题生成逻辑与主题代码分离，提高代码的可维护性。

一些高级技巧：

  • 根据自定义字段修改标题： 你可以使用自定义字段（Custom Fields）来存储页面的额外信息，然后在过滤器中，根据这些信息来修改标题。
  • 根据用户角色修改标题： 你可以使用用户角色（User Roles）来判断当前用户的身份，然后根据身份来修改标题。例如，你可以给管理员显示更详细的标题信息。
  • 使用第三方插件： 市面上有很多优秀的WordPress SEO插件，它们通常会提供更强大的标题管理功能。

注意事项：

  • 不要滥用过滤器： 过多的过滤器会影响网站的性能。
  • 注意SEO最佳实践： 标题应该简洁、清晰、包含关键词。
  • 测试你的代码： 在修改标题生成规则之后，一定要进行测试，确保一切正常。

结束语：标题，不仅仅是标题

页面标题，虽然只是小小的一行字，但它却承载着重要的信息，影响着SEO、用户体验，甚至网站的品牌形象。掌握 wp_get_document_title() 函数，善用过滤器，你就能成为真正的标题大师，让你的网站在网络海洋里脱颖而出！

好了，今天的讲座就到这里。希望大家有所收获，咱们下次再见！记住，编程的乐趣在于不断探索，不断学习！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注