documentation_ignore_functions

Filters the list of functions and classes to be ignored from the documentation lookup.

Description

apply_filters( 'documentation_ignore_functions', (array) $ignore_functions ); 

Parameters (1)

0. $ignore_functions (array)
Functions and classes to be ignored.

Usage

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

Defined (1)

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

/wp-admin/includes/misc.php  
  1. $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );