函数文档

wxr_term_description()

💡 云策文档标注

概述

wxr_term_description() 函数用于从给定的 WP_Term 对象输出 term_description XML 标签,主要用于 WordPress 导出功能中生成 WXR 文件。

关键要点

  • 函数接受一个必需的 WP_Term 对象参数 $term,用于获取分类术语的描述信息。
  • 如果 $term->description 为空,函数将直接返回,不输出任何内容。
  • 输出时,使用 wxr_cdata() 函数将描述文本包装在 XML CDATA 标签中,并添加制表符和换行符以格式化 XML 结构。
  • 该函数是 export_wp() 函数的一部分,用于生成 WordPress 导出文件。

代码示例

function wxr_term_description( $term ) {
    if ( empty( $term->description ) ) {
        return;
    }

    echo "tt" . wxr_cdata( $term->description ) . "n";
}

注意事项

  • 函数自 WordPress 2.9.0 版本引入,属于 wp-admin/includes/export.php 文件的一部分。
  • 相关函数包括 wxr_cdata() 和 export_wp(),前者用于 XML CDATA 包装,后者负责整体导出逻辑。

📄 原文内容

Outputs a term_description XML tag from a given term object.

Parameters

$termWP_Termrequired
Term Object.

Source

function wxr_term_description( $term ) {
	if ( empty( $term->description ) ) {
		return;
	}

	echo "tt<wp:term_description>" . wxr_cdata( $term->description ) . "</wp:term_description>n";
}

Changelog

Version Description
2.9.0 Introduced.