Plugin integration: Gravity Forms

Integrates Gravity Forms with the theme.

Capabilities and extension points

Minimum supported Gravity Forms version.

• var string

Cached feature configuration.

• var array|null

Initializes the Gravity Forms integration.

Registers Gravity Forms hooks.

Gets Gravity Forms integration submodules.

• return array Module class names.

Gets the semantic form registry.

• return Gravity_Forms\Form_Registry Registry instance.

Gets the developer callback registry.

• return Gravity_Forms\Developer_Registry Registry instance.

Gets the locale profile controller.

• return Gravity_Forms\Locale_Profiles Locale profile controller.

Gets the ISO country provider.

• return Gravity_Forms\Countries Country provider.

Gets the regional validator controller.

• return Gravity_Forms\Regional_Validators Validator controller.

Gets the address lookup registry.

• return Gravity_Forms\Address_Lookup Address lookup registry.

Registers a semantic form definition.

• param string $handle Semantic form handle.
• param int|array $definition Form ID or definition.
• return bool Whether registration succeeded.

Resolves a semantic form handle or numeric form ID.

• param string|int $form Semantic handle or form ID.
• return int|null Form ID, or null when unresolved.

Gets a Gravity Forms form by semantic handle or ID.

• param string|int $form Semantic handle or form ID.
• return array|null Form configuration, or null when unresolved.

Determines whether a semantic form handle or ID exists.

• param string|int $form Semantic handle or form ID.
• return bool Whether the form exists.

Displays a form using its semantic handle or numeric ID.

• param string|int $form Semantic handle or form ID.
• param array $overrides Per-render setting overrides.
• return string|null Form markup when echo is disabled, otherwise null.

Determines whether Gravity Forms is available.

• return bool Whether Gravity Forms is loaded.

Gets the installed Gravity Forms version.

• return string|null Installed version, or null when unavailable.

Determines whether the installed Gravity Forms version is supported.

• return bool Whether Gravity Forms meets the minimum version.

Warns administrators when Gravity Forms is too old for this integration.

Gets integration feature settings.

Potentially disruptive behavior remains disabled until a project opts in through the feature filter.

• return array Feature settings keyed by identifier.

Determines whether an integration feature is enabled.

• param string $feature Feature identifier.
• return bool Whether the feature is enabled.

Enables the notification CC setting.

• param bool $enabled Current setting.
• param array $notification Notification configuration.
• param array $form Form configuration.
• return bool Filtered setting.

Enables the honeypot while a new form's metadata is first saved.

• param array $form Form configuration.
• param int $form_id Form ID.
• param string $meta_name Form metadata column.
• return array Filtered form configuration.

Gets UTM entry metadata definitions.

• return array Definitions keyed by entry metadata key.

Registers UTM fields as Gravity Forms entry metadata.

• param array $entry_meta Existing entry metadata.
• param int $form_id Form ID.
• return array Filtered entry metadata.

Gets a UTM value while Gravity Forms creates entry metadata.

UTM parameters are user-controlled attribution data. They are sanitized before storage, but must never be used for authorization or other trusted decisions. Values are read from the landing-page query string rather than accepting an independently submitted POST value.

• param string $key Entry metadata key.
• param array $entry Entry data.
• param array $form Form configuration.
• return string Sanitized attribution value.

Adds UTM data to the Gravity Forms entry detail screen.

• param array $meta_boxes Existing entry-detail meta boxes.
• param array $entry Entry data.
• param array $form Form configuration.
• return array Filtered meta boxes.

Gets populated UTM values for an entry.

• param array $entry Entry data.
• return array Populated values and labels.

Displays UTM values in an entry-detail meta box.

• param mixed $object Current screen object.
• param array $box Meta box configuration.

Removes unwanted paragraph wrappers around processed shortcodes.

This callback is only registered when the shortcodes feature is enabled.

• param string $form_string Rendered form markup.
• return string Filtered form markup.

Processes WordPress shortcodes in rendered form markup.

This callback is only registered when the shortcodes feature is enabled.

• param string $form_string Rendered form markup.
• return string Filtered form markup.

Disables the automatically generated default notification.

This callback is only registered when the feature is explicitly enabled.

• param bool $enabled Whether Gravity Forms creates its default notification.
• return bool False when the callback is active.

Source reference

This editable reference page is based on the PHP documentation in plugins/class-gravity-forms.php.