云策 WordPress 开发者社区

钩子文档

protected_title_format

查看官方原文 ↗
💡 云策文档标注

概述

protected_title_format 是一个 WordPress 过滤器，用于修改受保护文章标题前添加的文本。该过滤器仅在前端应用，允许开发者自定义标题前缀。

关键要点

  • 过滤器名称：protected_title_format
  • 作用：过滤受保护文章标题前的文本，默认格式为 'Protected: %s'
  • 应用范围：仅在前端生效
  • 参数：$prepend（前缀文本，默认值）和 $post（当前文章对象）
  • 相关函数：与 get_the_title() 关联，用于检索文章标题
  • 引入版本：WordPress 2.8.0

代码示例

add_filter( 'protected_title_format', 'spi_remove_protected_protected_from_titles' );

function spi_remove_protected_protected_from_titles( $format, $post ) {
    return '%s';
}

注意事项

  • 用户反馈：在 WordPress 5.7.2 版本中，示例代码可能无效，需注意版本兼容性。
📄 原文内容

Filters the text prepended to the post title for protected posts.

Description

The filter is only applied on the front end.

Parameters

$prependstring
Text displayed before the post title.
Default ‘Protected: %s’.
$postWP_Post
Current post object.

Source

$protected_title_format = apply_filters( 'protected_title_format', $prepend, $post );

View all references View on Trac View on GitHub

Used by Description
get_the_title()wp-includes/post-template.php

Retrieves the post title.

Changelog

Version Description
2.8.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Steven Lin


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Example migrated from Codex:

    Remove protected prefix from post titles

    add_filter( 'protected_title_format', 'spi_remove_protected_protected_from_titles' );

function spi_remove_protected_protected_from_titles( $format, $post ) {
    return '%s';
}