beee4life / woocommerce-city-selector

Woocommerce City Selector

Welcome to the Woocommerce City Selector plugin, which is an extension for the Woocommerce Wordpress plugin. This is not a stand-alone plugin, you'll need Woocommerce (active) for it to run.

• Version
• Description
• Impact
• Installation
• Setup
• Cities
• Actions
• Filters
• Functions
• Compatibility
• Support
• Changelog

Version

0.1 - released xx.03.22

Description

This plugin allows you to select a city, based on country and province/state on a Woocommerce address field (checkout and account).

Impact

The plugin adds a database table named {$wpdb->prefix}cities upon plugin activation and imports cities from 2 different countries.

Installation

1. Download the latest release zip file.
2. In your WordPress admin, go to Plugins -> Add New
3. Click Upload Plugin
4. Upload the zip file that you just downloaded.
5. Activate the Woocommerce City Selector plugin via the plugins page.

If you use a composer file to add any plugins/libraries. Add the following to your composer.json:

  "repositories": [
    {
      "type": "composer",
      "url": "https://wpackagist.org"
    }
  ]

Then run composer require "wpackagist-plugin/woocommerce-city-selector"

Setup

1. @TODO
2. (optional) Import new cities with help of the included Excel sheet.
3. (optional) Import new cities by csv (available on the website).

Cities

The plugin comes with all cities in Belgium and the Netherlands pre-installed.

You can also add more countries yourself, through SQL or CSV import. There's a simple Excel sheet included in the plugin and can be found in the import folder. With this sheet, you can easily create an SQL insert statement or a CSV data set.

The explanation on how to do this, can be found on the first tab/sheet of the excel file.

There are a few country packages (csv files) available. These packages can be imported as is. These are available through the ACFCS website.

Actions

There are a few actions available to add your own custom actions.

Find all actions here.

Filters

Find all filters here.

Functions

A few custom functions are available for you to easily retrieve data.

Find all functions and their info here.

Compatibility

This plugin has been tested with Wordpress 5.9.1 and Woocommerce 6.2.1.

Support

If you need support, please turn to Github. It's faster than the Wordpress support.

Changelog

0.1

• initial setup