函数文档

sanitize_title_for_query()

💡 云策文档标注

概述

sanitize_title_for_query() 函数用于在查询上下文中清理标题字符串,以便安全地用于数据库查询。它基于 sanitize_title() 实现,并应用了 'query' 上下文。

关键要点

  • 函数 sanitize_title_for_query() 接受一个字符串参数 $title,返回清理后的字符串。
  • 它内部调用 sanitize_title() 函数,并传递 'query' 作为上下文参数。
  • 由于调用 sanitize_title(),sanitize_title 过滤器会以 'query' 上下文被应用。
  • 该函数自 WordPress 3.1.0 版本引入,常用于 WP_Query::get_posts() 等查询操作中。

代码示例

sanitize_title_for_query( $title );

注意事项

sanitize_title_for_query() 依赖于 sanitize_title() 的清理逻辑,开发者应了解 sanitize_title 过滤器的行为以进行自定义调整。


📄 原文内容

Sanitizes a title with the ‘query’ context.

Description

Used for querying the database for a value from URL.

Parameters

$titlestringrequired
The string to be sanitized.

Return

string The sanitized string.

More Information

Usage:
sanitize_title_for_query( $title );
Notes:

Since sanitize_title_for_query() calls sanitize_title() , the sanitize_title filter is applied with a context of ‘query’.

Source

function sanitize_title_for_query( $title ) {
	return sanitize_title( $title, '', 'query' );
}

Changelog

Version Description
3.1.0 Introduced.