Helpers

Eightshift Forms offers static helpers that can be implemented in your project. The key difference between these helpers and filters is that you can use the former in your theme or plugin code regardless of the load cycle.

All helpers can be found here.

esFormsGetFormIdByName

This function retrieves the custom, unique name of a form, as set in the Form settings, from the provided form ID. It's useful when applying specific settings to one or more forms using filters in your project.

Form identification by name (instead of the default "by ID"), can be useful if switching environments when the form ID could change.

if (\function_exists('esFormsGetFormIdByName')) {
  echo esFormsGetFormIdByName('<form-id>');
}

esFormsDecryptor

This helper provides decrypt and encrypt methods for variations set in the Form settings, passed to the "Thank you" page after form submission.

if (\function_exists('esFormsDecryptor')) {
  $variation = isset($_GET['es-variation']) ? \esFormsDecryptor(\sanitize_text_field(\wp_unslash($_GET['es-variation']))) : '';
}

esFormsGeolocationCountriesList

This method generates a list of countries available in the geolocation API and country fields.

if (\function_exists('esFormsGeolocationCountriesList')) {
  $countriesList = esFormsGeolocationCountriesList();
}

esFormsGetUsersGeolocation

This helper returns the current user's detected geolocation country code.

if (\function_exists('esFormsGetUsersGeolocation')) {
  $country = esFormsGetUsersGeolocation();
}

esFormsGetSelectOptionsArrayFromString

This helper parses the block grammar output (that the Gutenberg editor generates) for block options, making it easy to use them in your projects.

if (\function_exists('esFormsGetSelectOptionsArrayFromString')) {
  $select = esFormsGetSelectOptionsArrayFromString('<options>');
}

esFormsGetComponentsRender

This helper allows you to access the Eightshift Forms component render method, enabling you to utilize all Forms components in your projects. If you already have a style set for the selected component, you can use this helper to render it with all the necessary data and styling applied.

A list of all components can be found here.

if (\function_exists('esFormsGetComponentsRender')) {
  $render = esFormsGetComponentsRender('<component>', '[<attributes>]');
}

esFormRenderForm

If you want to output a form in a custom template or block, you can use this helper to do so.

Please note that not all functionalities are available, and certain options might not be available.

if (\function_exists('esFormRenderForm')) {
  echo esFormRenderForm('<formId>', '[<attributes>]');
}

esFormGetEntry

If you need to retrieve form entry data, you can use this helper by providing entry unique ID.

if (\function_exists('esFormGetEntry')) {
  $entry = esFormGetEntry('<entryId>');
}

esFormUpdateEntry

If you need to update form entry data, you can use this helper by providing the data array and the entry unique ID.

if (\function_exists('esFormUpdateEntry')) {
  $updated = esFormUpdateEntry(['<key>' => '<value>'], '<entryId>');
}

getFormsGetCountryList

This helper returns the countries data set, taking into account any active filters and the default set configured in the settings.

if (\function_exists('getFormsGetCountryList')) {
  $countries = getFormsGetCountryList();
}

getFormUsageLocation

This helper returns a list of locations (posts/pages) where a given form is used.

if (\function_exists('getFormUsageLocation')) {
  $locations = getFormUsageLocation('<formId>');
}

getParamValue

This helper retrieves the value of a specific parameter by key from a params array.

if (\function_exists('getParamValue')) {
  $value = getParamValue('<key>', $params);
}

getFormDetails

This helper returns the full details array for a given form by its ID.

if (\function_exists('getFormDetails')) {
  $details = getFormDetails('<formId>');
}