infinite_scroll_archive_supported

Allow plugins to filter what archives Infinite Scroll supports.

Description

apply_filters( 'infinite_scroll_archive_supported', (bool) $supported, $self ); 

Parameters (2)

0. $supported (bool)
Does the Archive page support Infinite Scroll.
1. $self
Self::get_settings() IS settings provided by theme.

Usage

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

Defined (1)

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

/modules/infinite-scroll/infinity.php  
  1. return (bool) apply_filters( 'infinite_scroll_archive_supported', $supported, self::get_settings() );