posts_search_orderby

Filters the ORDER BY used when ordering search results.

Description

apply_filters( 'posts_search_orderby', (string) $search_orderby, (WP_Query) $instance ); 

Parameters (2)

0. $search_orderby (string)
The ORDER BY clause.
1. $instance (WP_Query)
The current WP_Query instance.

Usage

To run the hook, copy the example below.
  1. $search_orderby = apply_filters( 'posts_search_orderby', $search_orderby, $instance ); 
  2.  
  3. if ( !empty( $search_orderby ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the posts_search_orderby callback 
  2. function filter_posts_search_orderby( $search_orderby, $instance ) { 
  3. // make filter magic happen here... 
  4. return $search_orderby
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'posts_search_orderby', 'filter_posts_search_orderby', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'posts_search_orderby', 'filter_posts_search_orderby', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/class-wp-query.php  
  1. $search_orderby = apply_filters( 'posts_search_orderby', $search_orderby, $this );