Question

get_search_query( bool $escaped = true )

Retrieves the contents of the search WordPress query variable.

---

description

The search query string is passed through esc_attr() to ensure that it is safe for placing in an html attribute.

---

参数

$escaped

(bool) (Optional) Whether the result is escaped. Only use when you are later escaping it. Do not use unescaped.

Default value: true

---

返回值

(string)

---

源代码

File: wp-includes/general-template.php

function get_search_query( $escaped = true ) {
	/**
	 * Filters the contents of the search query variable.
	 *
	 * @since 2.3.0
	 *
	 * @param mixed $search Contents of the search query variable.
	 */
	$query = apply_filters( 'get_search_query', get_query_var( 's' ) );

	if ( $escaped )
		$query = esc_attr( $query );
	return $query;
}

---

更新日志

Version	description
2.3.0	Introduced.

---

相关函数

Uses

• wp-includes/formatting.php: esc_attr()
• wp-includes/general-template.php: get_search_query
• wp-includes/query.php: get_query_var()
• wp-includes/plugin.php: apply_filters()

---

Used By

• wp-includes/general-template.php: wp_get_document_title()
• wp-includes/general-template.php: the_search_query()
• wp-includes/general-template.php: feed_links_extra()
• wp-includes/general-template.php: get_search_form()
• wp-includes/link-template.php: get_search_link()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   Different usage methods

   
   <?php echo get_search_query(); ?>
   
   <?php $search_query = get_search_query(); ?>