Gravity Forms: Address Lookup

Coordinates optional regional address lookup providers.

Capabilities and extension points

Programmatically registered providers.

• var array

Cached providers.

• var array|null

Registers an address lookup provider.

• param Provider $provider Provider instance.
• return bool Whether registration succeeded.

Removes a programmatically registered provider.

• param string $name Provider identifier.
• return bool Whether a provider was removed.

Gets registered address lookup providers.

• return array Providers keyed by identifier.

Gets an address lookup provider.

• param string $name Provider identifier.
• return Provider|null Provider instance or null.

Gets the first provider supporting a country.

• param string $country ISO country code.
• return Provider|null Provider instance or null.

Looks up and caches an address.

No providers are bundled. Projects opt in by registering a provider and can select one explicitly or allow country-based resolution.

• param string $postcode Postal code.
• param string $house_number House number.
• param string $addition Optional house-number addition.
• param string $country ISO country code.
• param string|null $provider_name Optional provider identifier.
• return array|\WP_Error Address data or an error.

Source reference

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