云策 WordPress 开发者社区

函数文档

_admin_search_query()

查看官方原文 ↗
💡 云策文档标注

概述

_admin_search_query() 是一个 WordPress 函数，用于显示 GET URI 中的“s”参数搜索查询，作为 the_search_query() 的替代方案。

关键要点

  • 函数功能：输出 $_REQUEST['s'] 参数的值，经过 wp_unslash() 和 esc_attr() 处理以确保安全。
  • 使用场景：当 the_search_query() 无法使用时，用于在管理界面显示搜索查询。
  • 相关函数：依赖 wp_unslash() 移除反斜杠和 esc_attr() 进行 HTML 属性转义。
  • 版本历史：自 WordPress 2.7.0 版本引入。
📄 原文内容

Displays the search query.

Description

A simple wrapper to display the “s” parameter in a GET URI. This function should only be used when the_search_query() cannot.

Source

function _admin_search_query() {
	echo isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';
}

View all references View on Trac View on GitHub

Uses Description
wp_unslash()wp-includes/formatting.php

Removes slashes from a string or recursively removes slashes from strings within an array.
esc_attr()wp-includes/formatting.php

Escaping for HTML attributes.
Used by Description
WP_Plugins_List_Table::search_box()wp-admin/includes/class-wp-plugins-list-table.php

Displays the search box.
WP_Media_List_Table::views()wp-admin/includes/class-wp-media-list-table.php

Overrides parent views to use the filter bar display.
WP_List_Table::search_box()wp-admin/includes/class-wp-list-table.php

Displays the search box.

Changelog

Version Description
2.7.0 Introduced.