acf/format_value_for_api

The Advanced Custom Fields acf format value for api hook.

Description

apply_filters( 'acf/format_value_for_api', (unknown) $field_value, (unknown) $post_id, (unknown) $field ); 

Parameters (3)

0. $field_value (unknown)
The field value.
1. $post_id (unknown)
The post id.
2. $field (unknown)
The field.

Usage

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

Defined (1)

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

/core/api.php  
  1. $field['value'] = apply_filters('acf/format_value_for_api', $field['value'], $post_id, $field);