Moments

Data filter

Allows modifying form field data before it's shown in the Block Editor or output on the frontend.

Useful if, for example, you want to ensure that all fields fit into a 2-column layout.

Overrides any Block Editor changes!

add_filter('es_forms_integrations_moments_data', 'getIntegrationFilterData', 10, 2);

/**
 * Manipulate form fields data before it is sent to the Block Editor.
 *
 * @param array<mixed> $data Form fields data.
 * @param string $formId Form ID.
 *
 * @return array<mixed>
 */
function getIntegrationFilterData(array $data, string $formId): array
{
	foreach ($data as $index => $field) {
		$component = $field['component'] ?? '';

		if (!$component) {
			continue;
		}

		$name = $field["{$component}Name"] ?? '';

		if (!$name) {
			continue;
		}

		switch ($name) {
			case 'firstname':
			case 'lastname':
				$data[$index]["{$component}FieldWidthMobile"] = 12;
				$data[$index]["{$component}FieldWidthLarge"] = 6;
				$data[$index]["{$component}DisabledOptions"] = array_merge(
					$data[$index]["{$component}DisabledOptions"],
					[
						"{$component}FieldWidthMobile",
						"{$component}FieldWidthLarge",
					]
				);
				break;
		}
	}

	return $data;
}

Order filter

Forces a form field order, regardless of how it's set in the Block editor. Fields not modified through the filter will use order in which they're set in the Block editor.

Not all fields need to have an order defined. For example, you may want to make sure firstname, lastname and email are displayed first, but other fields follow their Block editor order.

add_filter('es_forms_integrations_moments_order', 'getIntegrationOrder');

/**
 * Forces form field order for the provided fields. For other fields, Block editor order is used.
 *
 * @return array<string>
 */
function getIntegrationOrder(): array
{
	return [
		'firstname',
		'lastname',
		'email',
	];
}

Pre-post ID filter

Allows updating item IDs sent to external integrations to which the form data is sent.

add_filter('es_forms_integrations_moments_pre_post_id', 'getIntegrationPrePostId', 10, 3);

/**
 * Modifies integration item ID.
 *
 * @param string $itemId Integration item ID.
 * @param array<mixed> $params Params to be sent to the integration.
 * @param string $formId Form ID.
 *
 * @return string
 */
function getIntegrationPrePostId(string $itemId, array $params, string $formId): string
{
	return $itemId;
}

Override post request filter

Allows completely bypassing the integration's API request and returning a custom response instead. If the filter returns a non-empty array, it is used as the response and the API call is skipped.

Useful for testing, mocking responses, or conditionally short-circuiting submissions.

add_filter('es_forms_integrations_moments_override_post_request', 'getIntegrationOverridePostRequest', 10, 5);

/**
 * Override the integration API request with a custom response.
 *
 * @param array<mixed> $response Default response (empty array).
 * @param string $itemId Integration item/list ID.
 * @param array<string, mixed> $params Form submission parameters.
 * @param array<mixed> $files Uploaded files.
 * @param string $formId Form ID.
 *
 * @return array<mixed>
 */
function getIntegrationOverridePostRequest(array $response, string $itemId, array $params, array $files, string $formId): array
{
	// Return a mock success response to bypass the API call.
	return [
		'status' => 'success',
		'code' => 200,
	];
}

Pre-post parameters filter

Allows modifying form field data before it's sent to external integration. Useful if you want to make values derived from the sent data, or add new fields.

add_filter('es_forms_integrations_moments_pre_post_params', 'getIntegrationPrePostParams', 10, 2);

/**
 * Modifies form field data before it's sent to external integration.
 *
 * @param array<string, mixed> $params Array of params.
 * @param string $formId Form ID.
 *
 * @return array<string, mixed>
 */
function getIntegrationPrePostParams(array $params, string $formId): array
{
	$formSubmissionPageLt = $params['form_submission_page_lt']['value'] ?? '';

	if ($formSubmissionPageLt) {
		$params['ib-submission-source'] = [
			'name' => 'ib-submission-source',
			'value' => $formSubmissionPageLt,
			'type' => 'text',
			'internalType' => '',
		];
	}

	return $params;
}

Before success response filter

Allows modifying the response data before it is sent back to the client after a successful form submission. Runs after all internal processing (entries, variations, redirects) is complete.

add_filter('es_forms_integrations_moments_before_success_response', 'getIntegrationBeforeSuccessResponse', 10, 3);

/**
 * Modify the response before it is sent to the client.
 *
 * @param array<string, mixed> $response Response data with 'private', 'public', and 'additional' keys.
 * @param array<string, mixed> $formDetails Full form submission details.
 * @param string $formId Form ID.
 *
 * @return array<string, mixed>
 */
function getIntegrationBeforeSuccessResponse(array $response, array $formDetails, string $formId): array
{
	$response['additional']['myCustomKey'] = 'myCustomValue';

	return $response;
}

After custom result output process filter

Allows modifying the processed custom result output data after it has been prepared. Useful when using the custom result output feature to adjust the final output structure.

add_filter('es_forms_integrations_moments_after_custom_result_output_process', 'getIntegrationAfterCustomResultOutputProcess', 10, 3);

/**
 * Modify the custom result output data after processing.
 *
 * @param array<string, mixed> $output Processed output with 't' (title), 'st' (subtitle), and 'd' (data) keys.
 * @param array<string, mixed> $formDetails Full form submission details.
 * @param string $formId Form ID.
 *
 * @return array<string, mixed>
 */
function getIntegrationAfterCustomResultOutputProcess(array $output, array $formDetails, string $formId): array
{
	$output['t'] = __('Custom title', 'text-domain');

	return $output;
}

Pre-Post Event Params

This filter will allow you to add additional params to the body of the Moments integration payload before forms is done preparing the form params.

\add_filter('es_forms_integrations_moments_pre_post_event_params', 'getMomentsPrePostEventParams', 10, 4);

/**
 * Moments pre post event params before process.
 *
 * This filter will allow you to add additional params to the body of the Moments integration payload before forms is done preparing the form params.
 *
 * @param array<string, mixed> $params Form fields params.
 * @param string $eventName Event name value.
 * @param array<string, mixed> $map Map value.
 * @param string $formId FormId value.
 *
 * @return array<mixed>
 */
public function getMomentsPrePostEventParams(array $params, string $eventName, array $map, string $formId): array
{
	$params['ib-submission-source'] = [
		'name' => 'ib-submission-source',
		'value' => 'value',
		'type' => 'text',
		'internalType' => '',
	];

	return $params;
}

Pre-Post Event Params After

This filter will allow you to add additional params to the body of the Moments integration payload after forms is done preparing the form params.

\add_filter('es_forms_integrations_moments_pre_post_event_params_after', 'getMomentsPrePostEventParamsAfter', 10, 4);

/**
 * Moments pre post event params after process.
 *
 * This filter will allow you to add additional params to the body of the Moments integration payload after forms is done preparing the form params.
 *
 * @param array<string, mixed> $output Output data.
 * @param array<string, mixed> $params Params original list.
 * @param string $eventName Event name value.
 * @param string $formId FormId value.
 *
 * @return array<mixed>
 */
public function getMomentsPrePostEventParamsAfter(array $output, array $params, string $eventName, string $formId): array
{
	$output['properties']["testKey"] = 'testValue';

	return $output;
}