Action and filter hooks

Veldform is built around registries, field types, actions, payment gateways and captcha providers all share the same registration pattern, and your additions are treated exactly like the built-in ones. All hooks are prefixed veldform/.

• Registering your own
• Submission
• Rendering
• Email
• Merge tags
• Payments
• Outgoing HTTP
• Other

Registering your own

Registries are built on init (priority 5), so hook at the default priority or later.

Field type

add_action( 'veldform/register_fields', function ( $fields ) {
    $fields->register( new MyField() ); // implements Veldform\Fields\FieldType
} );

A field type declares its label, schema (the options shown in the builder), sanitization, validation and rendering. Once registered, it shows up in the builder palette automatically, and becomes available to the AI form builder too.

Action

add_action( 'veldform/register_actions', function ( $actions ) {
    $actions->register( new MyAction() ); // implements Veldform\Actions\Action
} );

An action declares its config schema and a run( $context, $config ) method. Whatever run() returns is merged into the outputs, so later actions and the confirmation can use it as {{ output.your_key }}.

Payment gateway

add_action( 'veldform/register_gateways', function ( $gateways ) {
    $gateways->register( new MyGateway() ); // implements Veldform\Payments\PaymentGateway
} );

Captcha provider

add_filter( 'veldform/register_captcha', function ( array $providers ) {
    $provider = new MyCaptcha(); // implements Veldform\Captcha\CaptchaProvider
    $providers[ $provider->id() ] = $provider;
    return $providers;
} );

Other registration hooks

Submission

Rendering

For overriding field markup from your theme, see Customization.

Email

Merge tags

Payments

Outgoing HTTP

These apply to all requests Veldform makes: the external API action, data providers and payment gateways.

Other