Manage Regions is the place where you will add, update, delete and setup the hierarchy for all of your regions.
Regions are setup in a hierarchy, like:
Continent → Country → State → City
Continent is at the TOP of the hierarchy, City is at the bottom. This hierarchy can be ANYTHING you want, but we create one for you by default (the one above) which you are free to modify.
Regions are used to filter listings using the Region Selector:
And they are also used to search for listings on the Advanced Search page
as well as the Quick Search bar:
Regions are also used to filter listings using the Sidelist:
Clicking on a region name in the sidelist will restrict the listings in the view to that region only.
How to Change the Regions Hierarchy
Modifying the regions hierarchy is done by defining the regions FIRST here in Manage Regions. We found that it was easier to take your data and associate it to a series of fields, than the other way around. If you want to completely rework the default regions into your own setup, we recommend doing it this way:
- Delete all of the regions on this page that you don't plan to use, starting with the PARENT regions you don't want. (in the hierarchy Continent → Country → State → City, Continent is the PARENT of Country, Country is the PARENT of State, but the CHILD of Continent, and so on...). This will help get rid of LOTS of regions you don't want to use
- If you don't want Continent at the top of your hierarchy, you will need to delete ALL REGIONS and start from scratch. This sounds scary, but it's not. You can always reset the data BACK at any time.
- Create the Regions you do want, starting at the TOP. Instructions for that below.
- When you are done, go to Directory → Manage Form Fields
- Delete ALL of the fields that are of type "Region" (again, this sounds scary but it's NOT!)
- Tell Regions to "restore the fields" by returning to Directory → Manage Regions, and clicking the Restore Region Form Fields button. This will create NEW Region fields based on the NEW hierarchy you created.
- Now return to Directory → Manage Form Fields. Your new fields will have names like "Region 1", "Region 2", etc. The numbering is from PARENT → CHILD.
- Rename the new fields based on your new hierarchy. For example, if you ONLY wanted State and City because you're a US-based directory and don't need country, then your Region 1 field becomes State (the parent), and the Region 2 field becomes the City (the child).
Managing the Region Hierarchy
The Region hierarchy comes pre-configured with Continent → Country → State → City as the fields. We also provide the default data of:
- All continents of the world
- All countries on those continents
- All US states in the USA
No city data is available by default, nor do we add all "states" for all countries, as this would make the Region module quite bulky to install, and most people don't need quite that much data in the first place. You can add, change or remove data from this set as you see fit. The important thing to understand is which regions are parents and which are children, and to make the association accordingly.
The Regions Dashboard looks like this:
The left side is where you add new regions. The right side is where you see the results of your added regions.
On the right side, the top level is shown without a dash ("North America"). After the top, each child level of the hierarchy is displayed with a dash in front of it. So first level (country, like "USA" above) regions have a single dash, second level (state, like "Alabama" above) regions have two dashes, and so on.
As you add or delete levels to your regions (3 levels are shown above), the Regions Module will automatically understand that the Form Fields will need to add or remove fields to compensate. If you add a "City" below "Alabama", and a city field didn't exist, Regions would add "Region 4" field on your Manage Form Fields screen. If you removed the "City" level, you would need to manually delete the "City" field in your Manage Form Fields screen. These fields will have default names associated to them, but you can change them to whatever you like. The names of the fields are not important to Regions Module.
The Manage Regions screen primarily uses a list of regions to work with (notice the top level region, Africa (a continent) has several counties (with single dashes) below it:
At the top of this list, you have various filters you can use to hide/show regions that you are interested in. Clicking Enabled will display all active regions (those that can be shown in the Region Selector, Search screen or Submit Listing screen), Disabled will show all inactive ones. On Sidelist will show all regions that have been added to the Sidelist, and Not on Sidelist does the opposite. Clicking All will return you to the master list of regions at any time. Using "Enabled" is a good filter to show precisely what you are actively using.
To the left of the region list, you will find the Add Regions section. You can specify the name, the slug, parent region and optional description of the region you are configuring:
To add a new region, simply type the name of the Region in the Name field, specify the parent region of it, and then click Add New Region. If you do not specify a parent, that region will become a top-level region. By default, top-level regions are Continents. If you do not specify a slug, one will be generated from the name automatically using the same rules that turn page titles into URLs.
When you are working with regions, the operations you can perform on them are found when you hover the mouse over a particular region, like so:
The commands are as follows:
Show Sub Regions: Clicking this link will automatically filter the region list to show ONLY regions that are children of the region you clicked on. For example, if you clicked on Show Sub Regions for North America, you would see the message shown below:
And your list of regions that are "sub regions" under North America, such as USA, Alabama, Arizona, Alaska and so on. This is useful to help you see ONLY certain sections of your regions at a time, like when you're editing a particular country or state and don't want to see EVERYTHING while you're doing it.
Edit: This will allow you to change the region name, slug and description on a separate screen.
Quick Edit: Similar to edit, but allows for in-line editing of the region info above.
Delete: Removes the region from the hierarchy. WARNING: Any child regions will ALSO be deleted as well, so be careful of this operation.
Show/Hide: This will show or hide the region on the sidelist (which was mentioned under Regions Concepts above). A region will not appear on the Sidelist unless you tell it to be there. If you attempt to add a region to the sidelist and it’s parent(s) are not on the sidelist, clicking “Show” will automatically add the parent regions as well. Similarly, hiding a parent region from the sidelist will also hide all of its children as well.
Enable/Disable: This will make a region active or inactive. It's sometimes helpful to deactivate regions you aren't using if you might want to add them in the future (rather than delete them). Only active regions will show up in the Region Selector, the Advanced Search screen, and the Submit a Listing screen. A region must also be active to show on the sidelist or in a selector.
For more information about Sidelists, the Region Selector, or how your settings affect the Regions display, consult the Regions Module Documentation.