ninja_forms_get_fields_sorted

If a filter is registered to modify field order, then use that filter.

Description

apply_filters( 'ninja_forms_get_fields_sorted', (array) $array, (unknown) $fields, (unknown) $fields_by_key, (unknown) $this_form_id ); 

Parameters (4)

0. $array (array) => array()
The array.
1. $fields (unknown)
The fields.
2. $fields_by_key (unknown)
The fields by key.
3. $this_form_id (unknown)
The this form id.

Usage

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

Defined (3)

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

/includes/MergeTags/Fields.php  
  1. $fields = apply_filters( 'ninja_forms_get_fields_sorted', array(), $fields, $fields_by_key, $this->form_id ); 
/includes/Actions/Email.php  
  1. $data[ 'fields' ] = apply_filters( 'ninja_forms_get_fields_sorted', array(), $data[ 'fields' ], $fields_by_key, $form_id ); 
/includes/Abstracts/ModelFactory.php  
  1. $order = apply_filters( 'ninja_forms_get_fields_sorted', array(), $this->_fields, $field_by_key, $form_id );