Hooks and filters in the FormMaster plugin

The FormMaster plugin offers a variety of hooks and filters allowing developers to customize and extend its functionality. The hooks and filters are interception points in the plugin’s execution flow, where you can add or modify behaviors without directly touching the plugin’s source code.

Hooks

wpformmaster_addhiddenfields

The hook is used to add hidden fields to the form. It is executed at the start of form rendering.

Parameters

Parameter	Type	Description
$postID	int	Form ID.

Use

PHP

add_action("wpformmaster_addhiddenfields", function ($postID) {
	?>
	<input type="hidden" value="test" name="_customhiddenfield" />
	<?php
}, 11, 1);

wpformmaster_addoptinfields

The hook adds optin fields to the form. It is executed at the end of form rendering.

Parameters

Parameter	Type	Description
$postID	int	Form ID.

Use

PHP

add_action("wpformmaster_addoptinfields", function ($postID) {
  ?>
  <div class="formmaster-field" datatype="radio" dataname="wpformmaster-option">
    <div>
      <div class="formmaster-checkbox-row">
        <input type="checkbox" name="custom-optin" id="custom-optin" value="1" required>
        <label for="custom-optin">Custom optin</label>
      </div>
    </div>
  </div>
  <?php
}, 11, 1);

wpformmaster_insertpost

The hook allows you to perform an action once the form has been sent and validated.

Parameters

Parameter	Type	Description
$formID	int	Form ID.
$spam	bool	`true` if the form is considered spam.
$name	string	Contains the name generated from the form results.
$fields	array	Contains form fields.
$posts	array	Contains `$_POST` parameters.
$files	array	Contains `$_FILES` parameters.

Use

PHP

add_action("wpformmaster_insertpost", function ($formID, $spam, $name, $fields, $posts, $files) {
	if(!$spam){
		$counter = get_option("custom_option_counter", 0);
		update_option("custom_option_counter", $counter+1);
	}
}, 11, 6);

Filters

wpformmaster_block_row_allowed_blocks

This filter is used to define the sub-blocks allowed in the “Line” block.

Parameters

Parameter	Type	Description
$allowed_blocks	array	Array of authorized blocks.

Return

Parameter	Type	Description
$allowed_blocks	array	Tableau contenant les blocs autorisés.

Use

PHP

add_filter("wpformmaster_block_row_allowed_blocks", function ($allowed_blocks) {
	if ($allowed_blocks) {
		$key = array_search('core/paragraph', $allowed_blocks);
		if ($key !== false) {
			unset($allowed_blocks[$key]);
		}
		$allowed_blocks = array_values($allowed_blocks);
	}
	return $allowed_blocks;
}, 11, 1);

wpfmaster_form_validate_field

This filter is used to validate fields when sending the form.

Parameters

Parameter	Type	Description
$error	string	Contains reason for error
$formID	int	Form ID.
$key	string	Corresponds to the “name” attribute of the field.
$type	string	Contains the field type.
$field	array	Contains the various field parameters.
$errors	array	Contains the list of errors, indexed by the “name” attributes of fields with errors.
$posts	array	Contains `$_POST` parameters.
$files	array	Contains `$_FILES` parameters.

Return

Parameter	Type	Description
$error	string	Contains reason for error

Use

PHP

add_filter("wpfmaster_form_validate_field", function ($error, $formID, $key, $type, $field, $errors, $posts, $files) {
	if (!$error) {
		if ($key === "your-email") {
			if (isset($posts[$key])){
				if($posts[$key]!="custom@info.ch"){
					$error = "Custom error";
        		}
      		}
    	}
  	}
  	return $error;
}, 11, 8);

wpfmaster_form_validate_additionnals

This filter adds an error message to the form after all fields have been validated.

Parameters

Parameter	Type	Description
$errors	array	Contains the list of errors, indexed by the “name” attributes of fields with errors.
$formID	int	Form ID.
$posts	array	Contains `$_POST` parameters.
$files	array	Contains `$_FILES` parameters.

Return

Parameter	Type	Description
$errors	array	Contient la liste des erreurs, avec comme index les attributs “name” des champs avec erreur.

Use

PHP

add_filter("addAdditionnalsErrors", function ($errors, $formID, $posts, $files) {
	if (!isset($posts["custom-optin"]) || !$posts["custom-optin"]) {
		$errors["custom-optin"] = "Invalid custom";
	}
	return $errors;
}, 11, 4);

wpfmaster_form_isvalid

This filter is used to define whether or not a form is considered spam.

Parameters

Parameter	Type	Description
$valid	bool	`true` if it’s not spam.
$postID	int	Form ID.
$posts	array	Contains `$_POST` parameters.
$files	array	Contains `$_FILES` parameters.

Return

Parameter	Type	Description
$valid	bool	`true` if it’s not spam.

Use

PHP

add_filter("wpfmaster_form_isvalid", function ($valid, $formID, $posts, $files) {
	if ($valid) {
        $value = isset( $posts["custom-honeypot"] ) ? $posts["custom-honeypot"] : '';
		return $value=="";
	}
    return $valid;
}, 10, 4);

wpfmaster_form_mails_counter

This filter lets you modify the number of manageable e-mails in the back office. The default setting is 2.

Parameters

Parameter	Type	Description
$counter	int	Number of e-mails

Return

Parameter	Type	Description
$counter	int	Number of e-mails

Use

PHP

add_filter("wpfmaster_form_mails_counter", function ($counter) {
	return 3;
}, 11, 1);

wpfmaster_form_messages

This filter is used to add a manageable feedback message.

Parameters

Parameter	Type	Description
$messages	array	Array containing messages.

Return

Parameter	Type	Description
$messages	array	Array containing messages.

Use

PHP

add_filter("wpfmaster_form_messages", function ($messages) {
    if (!isset($messages["test"])) {
        $messages["test"] = ["label" => "Test", "default" => "Default value"];
    }
    return $messages;
}, 11, 1);

wpfmaster_form_extractfields

This filter extracts fields from a form.

Parameters

Parameter	Type	Description
$fields	array	Array containing fields.
$postID	int	Form ID.
$posts	array	Contains `$_POST` parameters.
$files	array	Contains `$_FILES` parameters.

Return

Parameter	Type	Description
$fields	array	Array containing fields.

Use

Example for adding a new field:

PHP

add_filter("wpfmaster_form_extractfields", function ($fields, $postID, $posts, $files) {
    return array_merge($fields, [
		[
			"attrs" => [
				"type" => "select-opticien",
				"name" => "choice-select-opticien"
			]
		]
	]);
}, 11, 4);