Action: Custom

Features Modules Forms Action: Custom

Custom Action

The Custom Action is a canvas for developers that want to trigger a custom script on form submission. Out-of-the-box, this action will do nothing on form submission.

Dynamic Form

Add actions on form submission

Click the "Add action" button below to start creating your layout
0 Custom action
Documentation
Action

Set a unique action slug.

0 Email action
0 Option action
Documentation
Action

(Optional) Target this action using hooks.

Save

Choose which ACF fields should be saved to this option

Load

Fill inputs with values

Choose which ACF fields should have their values loaded

0 Post action
Documentation
Action

(Optional) Target this action using hooks.

Save
Click to initialize TinyMCE

Choose which ACF fields should be saved to this post

Load

Fill inputs with values

Choose which ACF fields should have their values loaded

0 Redirect action
Documentation
Action

(Optional) Target this action using hooks.

The URL to redirect to. See "Cheatsheet" tab for all available template tags.

0 Term action
Documentation
Action

(Optional) Target this action using hooks.

Save
Click to initialize TinyMCE

Choose which ACF fields should be saved to this term

Load

Fill inputs with values

Choose which ACF fields should have their values loaded

0 User action
Documentation
Action

(Optional) Target this action using hooks.

Save
Click to initialize TinyMCE

Choose which ACF fields should be saved to this user

Load

Fill inputs with values

Choose which ACF fields should have their values loaded

1 Custom action
Documentation
Action

Set a unique action slug.

Add action

Action Settings

Setting nameDescription
Action nameAlias name allowing to use targeted hook. It cannot be named custom, email, post or term.

Validation

By default, there is no validation for this Action. You can use the acf/validate_value hook to validate each fields individually.

To validate the whole form, you can use the acfe/form/validation/my-action hook and throw errors with the acfe_add_validation_error() function. Usage example:

/*
 * Custom Validation
 * 
 * @array   $form     Form settings
 * @string  $post_id  Post ID (where the form is displayed)
 * @string  $action   Action name
 */
 
action('acfe/form/validation/my-action',              $form, $post_id, $action);
action('acfe/form/validation/my-action/form=my-form', $form, $post_id, $action);
add_action('acfe/form/validation/my-action', 'my_form_validation', 10, 3);
function my_form_validation($form, $post_id, $action){
    
    // Get field input value
    $my_field = get_field('my_field');
    
    if($my_field === 'Company'){
        
        // Add validation error
        acfe_add_validation_error('my_field', 'The value Company is not allowed');
        
    }
    
}

Prepare

The preparation phase is triggered after the form validation and before its submission. Returning false will stop the Action and go to the next one. Usage example:

/*
 * Custom Prepare
 * 
 * @bool    $prepare  True/false
 * @array   $form     Form settings
 * @string  $post_id  Post ID (where the form is displayed)
 * @string  $action   Action name
 */
 
filter('acfe/form/prepare/my-action',              $prepare, $form, $post_id, $action);
filter('acfe/form/prepare/my-action/form=my-form', $prepare, $form, $post_id, $action);
add_filter('acfe/form/prepare/my-action', 'my_form_prepare', 10, 4);
function my_form_prepare($prepare, $form, $post_id, $action){
    
    // Do not process the action if user isn't logged in
    if(!is_user_logged_in()){
        
        $prepare = false;
        
    }
    
    // return
    return $prepare;
    
}

Submit

Trigger a custom action after the e-mail was sent using the acfe/form/submit/my-action hook. Usage example:

/*
 * Custom Submit
 * 
 * @array   $form    Form settings
 * @string  $action  Action name
 */
 
action('acfe/form/submit/my-action',              $form, $action);
action('acfe/form/submit/my-action/form=my-form', $form, $action);
add_action('acfe/form/submit/my-action', 'my_form_submit', 10, 2);
function my_form_submit($form, $action){
    
    /*
     * Get the form input value named 'my_field'
     */
    $my_field = get_field('my_field');

    if($my_field === 'Company'){

        // do_something();

    }

    /*
     * Get previous Post Action output
     */
    $prev_post_action = acfe_form_get_action('post');

    if(!empty($prev_post_action)){
    
        if($prev_post_action['post_title'] === 'Company'){
            
            // do_something();
            
        }

    }
    
}
Field Groups Field Settings Fields Modules
Block Types PRO Classic Editor PRO Developer Mode PRO Forms PRO
Action: Custom Action: E-mail Action: Option PRO Action: Post Action: Redirect Action: Term Action: User Integration PRO Cheatsheet Helpers Hooks
Options Pages PRO Post Types PRO Rewrite Rules PRO Settings UI PRO Single Meta Taxonomies PRO Templates PRO
WordPress Hooks & Helpers