bbp_number_format

The bbPress bbp number format hook.

Description

apply_filters( 'bbp_number_format', (number) $number_format, (number) $number, (unknown) $decimals, (unknown) $dec_point, (unknown) $thousands_sep ); 

Parameters (5)

0. $number_format (number) => number_format( $number, $decimals, $dec_point, $thousands_sep )
The number format.
1. $number (number)
The number.
2. $decimals (unknown)
The decimals.
3. $dec_point (unknown)
The dec point.
4. $thousands_sep (unknown)
The thousands sep.

Usage

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

Defined (1)

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

/includes/common/functions.php  
  1. return apply_filters( 'bbp_number_format', number_format( $number, $decimals, $dec_point, $thousands_sep ), $number, $decimals, $dec_point, $thousands_sep );