Use the following hooks to extend Ninja Forms in conjunction with the Forms API.
- Filter: nf_register_fields
- Filter: nf_register_actions
- Filter: nf_localize_fields
| <?php | |
| // Returns a Field Model for Field ID 1 | |
| $model = Ninja_Forms()->form()->field( 1 )->get(); | |
| // Returns a Field Model for Field ID 1 | |
| $model = Ninja_Forms()->form()->get_field( 1 ); | |
| // Returns an array of Field Models for Form ID 1 | |
| $models = Ninja_Forms()->form( 1 )->get_fields(); |
| <?php | |
| // Returns an Action Model for Action ID 1 | |
| Ninja_Forms()->form()->action( 1 )->get(); | |
| // Returns an Action Model for Action ID 1 | |
| Ninja_Forms()->form()->get_action( 1 ); | |
| // Returns an array of Action Models for Form ID 1 | |
| Ninja_Forms()->form( 1 )->get_actions(); |
| <?php | |
| // Returns an Submission Model for Submission ID 1 | |
| Ninja_Forms()->form()->sub( 1 )->get(); | |
| // Returns an Submission Model for Submission ID 1 | |
| Ninja_Forms()->form()->get_sub( 1 ); | |
| // Returns an array of Submission Models for Form ID 1 | |
| Ninja_Forms()->form( 1 )->get_subs(); |
| <?php | |
| // Returns an Object Model for Object ID 1 | |
| Ninja_Forms()->form()->object( 1 )->get(); | |
| // Returns an Object Model for Object ID 1 | |
| Ninja_Forms()->form()->get_object( 1 ); | |
| // Returns an array of Object Models for Form ID 1 | |
| Ninja_Forms()->form( 1 )->get_objects(); |
| <?php | |
| // Returns an Form Model for Form ID 1 | |
| Ninja_Forms()->form( 1 )->get(); | |
| // Returns an array of Form Models for All Forms | |
| Ninja_Forms()->form()->get_forms(); | |
| // Returns an array of Field Models for Form ID 1 | |
| Ninja_Forms()->form( 1 )->get_fields(); |
| <?php | |
| // Get the ID for a Model | |
| $id = $model->get_id(); | |
| // Get a single setting for a Model by key | |
| $setting = $model->get_setting( 'key' ); | |
| // Get all settings for a model | |
| $settings = $model->get_settings(); |
| <?php | |
| /* | |
| * Create a Field | |
| */ | |
| $field = Ninja_Forms()->form( 1 )->field()->get(); | |
| $field->update_settings( 'type', 'textbox' )->save(); |
| <?php | |
| /* | |
| * Create a Form | |
| */ | |
| $form = Ninja_Forms()->form()->get(); | |
| $form->update_setting( 'title', 'Contact Me' ); |
Use the following hooks to extend Ninja Forms in conjunction with the Forms API.
| this.collection = new fieldTypeCollection( [ | |
| { | |
| id: 'textbox', | |
| nicename: 'Textbox', | |
| alias: [ 'input' ], | |
| parentType: '', | |
| settingGroups: new fieldTypeSettingGroupCollection( [ | |
| { | |
| name: '', | |
| display: true, |