caldera_forms_api_allow_entry_view

Filter permissions for viewing entries via Caldera Forms REST API.

Description

apply_filters( 'caldera_forms_api_allow_entry_view', (bool) $allowed, (string) $form_id, (WP_REST_Request) $request ); 

Parameters (3)

0. $allowed (bool)
Is request authorized?
1. $form_id (string)
The form id.
2. $request (WP_REST_Request)
The current request

Usage

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

Defined (1)

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

/classes/api/entries.php  
  1. return apply_filters( 'caldera_forms_api_allow_entry_view', $allowed, $form_id, $request );