钩子文档

get_the_archive_description

💡 云策文档标注

概述

get_the_archive_description 是一个 WordPress 过滤器,用于修改作者、文章类型或分类法存档页面的描述内容。它允许开发者通过 Hook 自定义存档描述的输出。

关键要点

  • 这是一个过滤器 Hook,名称为 'get_the_archive_description',用于过滤存档描述字符串。
  • 参数 $description 是要显示的存档描述字符串,开发者可以修改或替换它。
  • 相关函数 get_the_archive_description() 用于检索存档描述,位于 wp-includes/general-template.php 文件中。
  • 该过滤器从 WordPress 4.1.0 版本开始引入。

📄 原文内容

Filters the archive description.

Parameters

$descriptionstring
Archive description to be displayed.

Source

return apply_filters( 'get_the_archive_description', $description );

Changelog

Version Description
4.1.0 Introduced.