submenu_file

Filters the file of an admin menu sub-menu item.

Description

apply_filters( 'submenu_file', (string) $submenu_file, (string) $parent_file ); 

Parameters (2)

0. $submenu_file (string)
The submenu file.
1. $parent_file (string)
The submenu item's parent file.

Usage

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

Defined (1)

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

/wp-admin/menu-header.php  
  1. $submenu_file = apply_filters( 'submenu_file', $submenu_file, $parent_file );