https://github.com/nlemoine/acf-country
ACF Country field - Display a select field of all countries, in any language.
https://github.com/nlemoine/acf-country
acf acf-country-field advanced-custom-fields country wordpress wordpress-plugin
Last synced: 29 days ago
JSON representation
ACF Country field - Display a select field of all countries, in any language.
- Host: GitHub
- URL: https://github.com/nlemoine/acf-country
- Owner: nlemoine
- Created: 2014-01-03T10:28:58.000Z (over 11 years ago)
- Default Branch: 3.x
- Last Pushed: 2024-03-15T16:15:36.000Z (about 1 year ago)
- Last Synced: 2025-03-29T13:07:10.117Z (about 1 month ago)
- Topics: acf, acf-country-field, advanced-custom-fields, country, wordpress, wordpress-plugin
- Language: PHP
- Homepage:
- Size: 3.68 MB
- Stars: 120
- Watchers: 7
- Forks: 17
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# ACF Country field
[](https://github.com/nlemoine/acf-country/releases)
[](https://packagist.org/packages/hellonico/acf-country)
[](https://beerpay.io/nlemoine/acf-country)
[](https://paypal.me/hellonico)
Adds a 'Country' field type for the [Advanced Custom Fields](http://wordpress.org/extend/plugins/advanced-custom-fields/) WordPress plugin.
## ⚠️ WARNING ⚠️
**From version 2.0.0, ACF Country introduced some important breaking changes**:
- Dropped support for older PHP & ACF versions, new requirements are:
- ACF 5.7+
- PHP 5.4+
- Return format has changed. To better stick to ACF and make use of ACF functions, ACF Country will now return values the same way select field do. `['FR' => 'France']` will now look like `['label' => 'France', 'value' => 'FR']`
Looking for a ACF pre 5.7 support? Check the [1.0 branch](https://github.com/nlemoine/acf-country/tree/1.0).
### Overview
Display a select list of all countries in your language.
Country names are available in every language ([see available list](https://github.com/umpirsky/country-list/tree/master/data)). By default, country names are localized in your current WordPress language.
Select a single value:
Or multiple ones:
### Compatibility
- ACF 5.7+
- PHP 5.4+
### Field options
| Option | Default | Description |
| ------------- | ------------- | ------------- |
| Default value | emtpy | Set a default value for the country field (as country code) |
| Allow null | `false` | Enable/disable null value |
| Allow multiple | `false` | Enable/disable multiple countries selection |
| Stylised UI | `true` | Enable/disable enhanced select field thanks to [Select2](https://select2.github.io/) |
| Return format | `value` | See [ACF Select field](https://www.advancedcustomfields.com/resources/select/) |
### Filters
You can remove (or add) some countries with the `acf/country/countries` filter, example:
```php
add_filter( 'acf/country/countries', function( $countries ) {
return array_filter( $countries, function( $code ) {
return !in_array( $code, ['IC', 'EA'], true );
}, ARRAY_FILTER_USE_KEY);
} );
```
*Note: PHP5.6+ example*
### Installation
#### Zip
[Download the plugin](https://github.com/nlemoine/acf-country/releases/latest) and extract the archive to your plugins folder.
#### Composer
```bash
composer require hellonico/acf-country
```
### Contributing
See [CONTRIBUTING](CONTRIBUTING.MD).
### Support
This ACF field was originally developed for a personal project I don't use anymore. I still decided to maintain it anyway. If you use it in a commercial project, please consider [buying me a beer](https://beerpay.io/nlemoine/acf-country).