<taxonomy>_<field>

Filters the taxonomy field sanitized for display.

Description

apply_filters( '<taxonomy>_<field>', (mixed) $value, (int) $term_id, (string) $context ); 

The dynamic portions of the filter name, $taxonomy,, and $field, refer to the taxonomy slug and taxonomy field, respectively.

Parameters (3)

0. $value (mixed)
Value of the taxonomy field.
1. $term_id (int)
The term id.
2. $context (string)
Context to retrieve the taxonomy field value.

Usage

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

Defined (1)

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

/wp-includes/taxonomy.php  
  1. $value = apply_filters( "{$taxonomy}_{$field}", $value, $term_id, $context );