Documentation

forms_bridge_form

Gets the current submission form.

Arguments

1. mixed $default Default filtered value.
2. integer $form_id If declared, try to return form by ID instead of the current form.

Return

1. array|null Form data or null.

Example

$form_data = apply_filters('forms_bridge_form', null);
if (!empty($form)) {
	// do something
}

forms_bridge_forms

Gets available forms.

Arguments

1. mixed $default Default filtered value.
2. string $integration If declared, filters available forms by integration slug.

Return

1. array Available forms as list of form data.

Example

$forms_data = apply_filters('forms_bridge_forms', []);
foreach ($forms_data as $form_data) {
  // do something
} 

forms_bridge_bridges

Gets available bridges for the current form.

Arguments

1. mixed $default Default filtered value.
2. string|int $form_id If declared, returns bridges from the form with this id. This id should includes the integration slug as prefix if there is more than one active integration.
3. string $integration If declared, filters bridges by API slug.

Return

1. array List of given form available bridge instances.

Example

$bridges = apply_filters('forms_bridge_bridges', [], 'wpcf7:31');
foreach ($bridges as $bridge) {
  // do something
}

forms_bridge_uploads

Gets the current form’s submission uploaded files.

Arguments

1. mixed $default Default filtered value.

Return

1. array|null Current form’s submission uploaded files.

Example

$uploads = apply_filters('forms_bridge_uploads', null);
if ($uploads) {
  // do something
} 

forms_bridge_backends

Gets the registered backend connection settings.

Arguments

1. mixed $default Default filtered value.

Return

1. array List with registered backend settings data.

Example

$backends = apply_filters('forms_bridge_backends', []);
foreach ($backends as $backend) {
  // do something
} 

forms_bridge_backend

Gets a backend connection settings by name.

Arguments

1. mixed $default Default filtered value.
2. string $name Name of the backend.

Return

1. array|null If found, backend connection settings data.

Example

$backend = apply_filters('forms_bridge_backend', null);
if ($backend) {
  // do something
} 

forms_bridge_payload

Filters the submission data to be sent to the backend. If the payload is returned as an array of data, Forms Bridge will encode it as string based on the Conent-Type header of the backend before it is sent.

Arguments

1. array $payload Submission payload.
2. Form_Bridge $bridge Bridge instance.

Return

1. array|string|null Filtered payload. If null is returned, bridge submission will be skipped.

Example

add_filter('forms_bridge_payload', function ($payload, $bridge) {
  return $payload;
}, 10, 2);

forms_bridge_attachments

Filters attached files to be sent to the backend. Attachment files are only supported by backends with multipart/form-data value of the Content-Type header. Otherwise, Forms Bridge will encode the files as base64 strings and append it to the payload.

Arguments

1. array $attachments Submission attached files. An attachment is a key value pair with the attachment name and the path to the file.
2. Form_Bridge $bridge Bridge instance.

Return

1. array Filtered attachments.

Example

add_filter('forms_bridge_attachments', function ($attachments, $bridge) {
  return $attachments;
}, 10, 2);

forms_bridge_backend_headers

Filters the bridge HTTP request headers. The array contains the backend custom headers and a set of default backend headers. Fired on each form bridge submission.

Arguments

1. array $headers Associative array with HTTP headers.
2. Http_Backend $backend Backend instance.

Return

1. array Filtered HTTP headers.

Example

add_filter('forms_bridge_backend_headers', function ($headers, $backend) {
  return $headers;
}, 10, 2);

forms_bridge_backend_url

Filters bridge submission request URL. The URL is the result of the concatenation of the backend base URL and the bridge endpoint. Fired on each form bridge submission.

Arguments

1. string $url Submission request URL.
2. Http_Backend $backend Backend instance.

Return

1. array Filtered HTTP headers.

Example

add_filter('forms_bridge_backend_url', function ($url, $backend) {
  return $url;
}, 10, 2);

forms_bridge_request

Filters the backend request params before it is sent. Forms Bridge use the WP_Http under the hood. Check out the WP_Http::request documentation for more details about the params.

Arguments

1. array $params HTTP request params.

Return

1. array Filtered HTTP request params.

Example

add_filter('forms_bridge_request', function ($request) {
  return $request;
}, 10, 1);

forms_bridge_response

Filters the bridge request request response.

Arguments

1. array|WP_Error $response HTTP request response.

Return

1. array|WP_Error Filtered HTTP request response.

Example

add_filter('forms_bridge_response', function ($response) {
  return $response;
}, 10, 1);

forms_bridge_prune_empties

Controls if Forms Bridge should clean up the submission data and prune its empty fields.

Arguments

1. boolean $prune True by default, use this filter to avoid the payload prune.
2. Form_Bridge $bridge Bridge instance.

Return

1. boolean True value will trigger a prune of the empty values of the submission payload. An empty value is a null value or an empty string.

Example

add_filter('forms_bridge_prune_empties', '__return_false');

forms_bridge_skip_submission

Controls if Forms Bridge should skip the form submission.

Arguments

1. boolean $skip False by default, use this filter to skip bridge submissions.
2. Form_Bridge $bridge Bridge instance.

Return

1. boolean True value will skip the bridge submission.

Example

add_filter('forms_bridge_skip_submission', function ($skip, $bridge) {
  if ($bridge->name === 'skip') {
    return true;
  }

  return $skip;
}, 10, 2);

forms_bridge_before_submission

Action to do just before submission has been sent to the backend.

Arguments

1. Form_Bridge $bridge Bridge instance.
2. array $payload Payload data.
3. array $attachments Attachments list.

Example

add_action('forms_bridge_before_submission', function ($bridge, $payload, $attachments) {
  // do something
}, 10, 3);

forms_bridge_after_submission

Action to do after the submission has been successfully sent to the backend.

Arguments

1. Form_Bridge $bridge Bridge instance.
2. array $response Request response data.
3. array $payload Payload data.
4. array $attachments Attachments list.

Example

add_action('forms_bridge_after_submission', function ($bridge, $response, $payload, $attachments) {
  // do something
}, 10, 4);

forms_bridge_on_failure

Action to do after a bridge submission error.

Arguments

1. Form_Bridge $bridge Bridge instance.
2. WP_Error $error Request error response.
3. array $payload Payload data.
4. array $attachments Attachments list.

Example

add_action('forms_bridge_on_failure', function ($bridge, $error, $payload, $attachments) {
  // do something
}, 10, 4);