描述
_wp_preview_terms_filter
()是一个WordPress私有函数,用于在预览文章时过滤术语(terms)查询,以便设置文章格式(post format)。这个函数主要用于处理文章预览时的术语查询,特别是文章格式的设置。由于它是私有的,通常不建议插件或主题开发者直接使用它。
参数
- $terms (array) (必需) – 当前文章的术语数组。
- $post_id (int) (必需) – 文章ID。
- $taxonomy (string) (必需) – 税收分类(taxonomy)名称。
返回值
- (array) 过滤后的术语数组。
源代码位置
- 文件:
wp-includes/revision.php
函数讲解
function _wp_preview_terms_filter( $terms, $post_id, $taxonomy ) {
// 获取当前文章对象
if ( ! $post = get_post() )
return $terms;
// 检查请求中是否有文章格式参数,并且文章ID匹配,税收分类为文章格式,且文章类型不是修订版本
if ( empty( $_REQUEST['post_format'] ) || $post->ID != $post_id || 'post_format' != $taxonomy || 'revision' == $post->post_type )
return $terms;
// 处理标准格式
if ( 'standard' == $_REQUEST['post_format'] )
$terms = array();
// 处理其他格式
elseif ( $term = get_term_by( 'slug', 'post-format-' . sanitize_key( $_REQUEST['post_format'] ), 'post_format' ) )
$terms = array( $term ); // 只能有一个文章格式
return $terms;
}
注意事项
- 私有函数:由于这是私有函数,不建议在插件或主题中直接调用。如果你需要处理文章格式,建议使用公共的钩子和过滤器。
- 文章格式:文章格式是 WordPress 中的一种特殊税收分类,用于标识文章的显示样式(如标准、链接、引用等)。
- 预览功能:这个函数主要用于文章预览时的术语查询,确保预览的文章格式正确显示。
术语解释
- 术语:在 WordPress 中,术语是指属于某个税收分类的具体条目,例如类别(categories)和标签(tags)。
- 税收分类:税收分类是用于组织文章的一组术语,常见的税收分类包括类别(categories)和标签(tags)。
- 文章格式:文章格式是一种特殊的税收分类,用于标识文章的显示样式,如标准、链接、引用等。
- 预览:预览功能允许用户在发布文章之前查看文章的最终效果。
示例
假设你在编辑一篇文章并选择了“链接”格式,然后点击预览。_wp_preview_terms_filter
函数会检查请求中的 post_format
参数,并确保预览的文章显示为“链接”格式。
相关函数
get_post()
:获取文章对象。get_term_by()
:通过不同的字段获取术语对象。sanitize_key()
:对键名进行清理,确保安全。
未经允许不得转载:445IT之家 » WordPress函数_wp_preview_terms_filter()用法