About this plugin
Address Lookup field for ACF adds an address lookup field type to Advanced Custom Fields. Users can search for addresses directly within the editor, and the field returns structured address data including coordinates.
The plugin uses Nominatim (OpenStreetMap) as the default lookup provider, and supports registering custom providers.
The plugin also includes support for the Photon geocoding provider out of the box. You can choose between Nominatim and Photon, or register your own providers.
Features
- Live address search — AJAX-powered search as you type, using Select2.
- Structured data — Returns a normalized array with display name, coordinates (lat/lon), house number, road, city, state, postcode, and country.
- Country code filtering — Limit search results to specific countries.
- Language support — Set the preferred language for results.
- Extensible provider system — Register your own address lookup providers via the address_lookup_for_acf/register_providers action.
- REST API support — Field values are exposed in the REST API.
- Photon provider — Use the Photon geocoding service as an alternative to Nominatim.
Usage
- Install and activate the plugin.
- Create or edit an ACF field group.
- Add a new field and select the Address field type.
- Optionally configure country code filtering and language.
- Use get_field() or the_field() in your templates — the value is returned as an associative array.
Template example
$address = get_field('my_address_field');
The returned array has the following structure:
895168'], 'house_number' => '1', 'street' => 'Example Street', 'city' => 'City', 'state' => 'State', 'postcode' => '1234 AB', 'country' => 'Country', ]
Custom providers
You can register a custom address lookup provider by hooking into the jk_address_lookup_for_acf/register_providers action:
add_action('jk_address_lookup_for_acf/register_providers', function ($registry) { $registry->register(new MyCustomProvider()); });
Your provider must extend justinkruit\AddressLookupForAcf\Providers\AbstractProvider and implement the name(), label(), and search() methods.
Filters
- jk_address_lookup_for_acf/nominatim_url — Override the Nominatim API base URL (e.g. to use a self-hosted instance).
- jk_address_lookup_for_acf/nominatim_url_vars — Modify the query parameters sent to the Nominatim API.
- jk_address_lookup_for_acf/photon_url — Override the Photon API base URL (e.g. to use a self-hosted instance).
- jk_address_lookup_for_acf/photon_url_vars — Modify the query parameters sent to the Photon API.
Both filters also support ACF’s field-specific variations by type, name, and key.
External services
This plugin connects to third-party external services to perform address lookups. No data is sent automatically; requests are only made when an admin user actively searches for an address in the ACF field editor. The search query text is sent to the configured provider’s API.
Below is a list of each provider, what additional data is sent, how to override the API URL, and links to their terms and privacy policies.
Nominatim (OpenStreetMap)
Service: Nominatim by the OpenStreetMap Foundation: used for geocoding address searches.
Additional data sent: configured country code(s) and language preference (if set in the field settings).
Override URL: use the jk_address_lookup_for_acf/nominatim_url filter to point to a self-hosted instance.
Policies:
- Nominatim Usage Policy
- OpenStreetMap Foundation Terms of Use
- OpenStreetMap Foundation Privacy Policy
Photon
Service: Photon by Komoot: used for geocoding address searches, powered by OpenStreetMap data.
Additional data sent: configured country code(s) and language preference (if set in the field settings).
Override URL: use the jk_address_lookup_for_acf/photon_url filter to point to a self-hosted instance.
Policies:
- Photon Terms of Service
- Komoot Privacy Policy