get_search_link() WordPress Function
The get_search_link() function in WordPress is used to generate a search URL for a given search term. This function can be used in conjunction with the get_search_query() function to create a search URL for the current search query.
get_search_link( string $query = '' ) #
Retrieves the permalink for a search.
Parameters
- $query
(string)(Optional) The query string to use. If empty the current query is used.
Default value: ''
Return
(string) The search permalink.
Source
File: wp-includes/link-template.php
function get_search_link( $query = '' ) { global $wp_rewrite; if ( empty( $query ) ) { $search = get_search_query( false ); } else { $search = stripslashes( $query ); } $permastruct = $wp_rewrite->get_search_permastruct(); if ( empty( $permastruct ) ) { $link = home_url( '?s=' . urlencode( $search ) ); } else { $search = urlencode( $search ); $search = str_replace( '%2F', '/', $search ); // %2F(/) is not valid within a URL, send it un-encoded. $link = str_replace( '%search%', $search, $permastruct ); $link = home_url( user_trailingslashit( $link, 'search' ) ); } /** * Filters the search permalink. * * @since 3.0.0 * * @param string $link Search permalink. * @param string $search The URL-encoded search term. */ return apply_filters( 'search_link', $link, $search ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |