pre_get_posts

Fires after the query variable object is created, but before the actual query is run.

Description

add_action( 'pre_get_posts', (callback) $array ); 

Parameters (1)

0. $array (callback) => array( $this, 'add_posts_to_loop' )
The array.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'pre_get_posts', $array ); 
The following example is for adding a hook callback.
  1. // define the pre_get_posts callback 
  2. function action_pre_get_posts( $array ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'pre_get_posts', 'action_pre_get_posts', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'pre_get_posts', 'action_pre_get_posts', 10, 1 ); 

Defined (5)

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

/modules/custom-post-types/comics.php  
  1. add_action( 'pre_get_posts', array( $this, 'add_posts_to_loop' ) ); 
  1. add_action( 'pre_get_posts', array( $this, 'include_in_feeds' ) ); 
/modules/infinite-scroll/infinity.php  
  1. add_action( 'pre_get_posts', array( $this, 'posts_per_page_query' ) ); 
/modules/theme-tools/featured-content.php  
  1. add_action( 'pre_get_posts', array( __CLASS__, 'pre_get_posts' ) ); 
/modules/videopress/editor-media-view.php  
  1. add_action( 'pre_get_posts', 'videopress_media_list_table_query' );