函数文档

wxr_category_description()

💡 云策文档标注

概述

wxr_category_description() 函数用于从给定的分类对象中输出一个 category_description XML 标签,主要用于 WordPress 导出功能。

关键要点

  • 函数接受一个 WP_Term 类型的分类对象作为必需参数。
  • 如果分类对象的 description 属性为空,函数将不输出任何内容。
  • 输出时使用 wxr_cdata() 函数将描述文本包装在 XML CDATA 标签中。
  • 该函数在 WordPress 2.1.0 版本中引入,是导出系统的一部分。

代码示例

function wxr_category_description( $category ) {
    if ( empty( $category->description ) ) {
        return;
    }

    echo '' . wxr_cdata( $category->description ) . "n";
}

注意事项

  • 函数直接输出 XML 标签,不返回任何值,适用于导出文件生成场景。
  • 相关函数包括 wxr_cdata() 和 export_wp(),共同支持 WXR 导出功能。

📄 原文内容

Outputs a category_description XML tag from a given category object.

Parameters

$categoryWP_Termrequired
Category Object.

Source

function wxr_category_description( $category ) {
	if ( empty( $category->description ) ) {
		return;
	}

	echo '<wp:category_description>' . wxr_cdata( $category->description ) . "</wp:category_description>n";
}

Changelog

Version Description
2.1.0 Introduced.