This module provides a robust way to store, validate, and display international postal addresses. It includes features for country and address formats for over 200 countries, along with detailed subdivisions for many of them, and supports the creation of custom zones for shipping or tax purposes. The address data model follows the OASIS eXtensible Address Language (xAL) standard.
Provides functionality for storing, validating and displaying international postal addresses.
The Drupal 8 heir to the addressfield module, powered by the commerceguys/addressing library.
Features:
- Address field type and form element
- Country field type and form element
- Zone field type and form element
- Address formats for 200 countries
- Subdivisions (administrative areas, localities, dependent localities) for 60 countries
- Subdivision translations for all of the parent country's (i.e Canada, Switzerland) official languages.
- Country list with translations for over 200 locales, provided by CLDR
Zones are territorial groupings often used for shipping or tax purposes. They can match countries, subdivisions (states/provinces/municipalities), postal codes. For example: "California and Nevada", "France and Monaco", "Germany and a set of Austrian postal codes".
Address data model
Each address can have the following properties:
- Given name (First name)
- Additional name (Middle name / Patronymic)
- Family name (Last name)
- Organization
- Address line 1
- Address line 2
- Address line 3 (2.0.x only)
- Postal code
- Sorting code
- Dependent Locality (Neighborhood / Suburb)
- Locality (City)
- Administrative area (State / Province)
- Country
Property names follow the OASIS eXtensible Address Language (xAL) standard.
Installation
Since the module requires an external library, Composer or Ludwig must be used.
Composer
If your site is managed via Composer, use Composer to download the module, which will also download the required library:
composer require "drupal/address ^2.0"
^2.0 downloads the latest release, use 2.0.x-dev to get the -dev release instead.
Use composer update drupal/address --with-dependencies to update to a new release.
Ludwig
Otherwise, use Ludwig which will allow you to manage the required libraries without Composer:
Ludwig Installation and Usage
Maintenance of Ludwig managed modules
Note that Composer is recommended whenever possible.