Appearance
Upgrading to 5.0
5.0.0 is a major release. Most sites update without changes, but read this page before you update. All changes are in the changelog.
Follow the update instructions. Make a backup of the files and the database first, and test the update on a copy of your site when you can.
Requirements
5.0.0 requires ExpressionEngine 7.3+ and PHP 8.2+, see the prerequisites. For ExpressionEngine 6 and lower use the legacy package in the download (legacy/ee_maps-v4.4.0.zip).
Geocoder API
Only when you call the Geocoder API yourself, from outside a page with a map (e.g. from another app or your own Javascript with a hard-coded URL):
- The API now has its own
apiaction. Look up the new action ID in theexp_actionstable (classReinos_maps, methodapi); the oldact_routeaction is removed. - Remove
&method=apifrom the URL:index.php?ACT=[action_id]&type=[type].
Maps itself and REINOS_MAPS.api_path use the new URL automatically.
Maps Fieldtype
The Maps Fieldtype is now part of Maps, the separate Maps Fieldtype add-on is no longer needed. The field type is now called reinos_maps (it was reinos_maps_fieldtype). When you use the Maps Fieldtype:
- Update Maps. The update moves your Maps fields over to the new field type: channel fields, Grid and Fluid columns, Low Variables and Bloqs. The data in the fields, the field settings and your templates stay the same.
- Uninstall Maps Fieldtype in Add-Ons. ExpressionEngine should not warn that the fieldtype is in use; when it does, don't uninstall it and contact support.
- Delete the folder
system/user/addons/reinos_maps_fieldtype. Keepthemes/user/reinos_maps_fieldtype: it comes with Maps and has the marker icons your entries use.
Uninstall the old add-on before you delete its folder. When the folder is already gone, the old add-on only leaves an unused row and table in the database; put the folder back and uninstall it to clean that up. Content Elements is no longer supported.
Other add-ons that work with the Maps Fieldtype need their version for Maps 5.0.0: Maps Locator and the Maps Importer.
Maps Route
The routes are part of Maps: the route tags and the route providers (Add-Ons → Maps → Route Providers) come with Maps, the separate Maps Route add-on is no longer needed. There is nothing to migrate: your templates and route providers keep working.
- Update Maps.
- Uninstall Maps Route in Add-Ons.
- Delete the folder
system/user/addons/reinos_maps_route(andthemes/user/reinos_maps_routewhen it exists).
Google Maps route provider
When you use Google Maps as route provider: Maps now uses the Google Routes API instead of the Directions API. Enable the Routes API for your API key in the Google Cloud Console (APIs & Services → Library → Routes API), otherwise no route is shown and the Maps log says "Routes API has not been used in project ... or it is disabled". Use the Test button on the Diagnostics page to check the key.
The step instructions ({direction:steps:instruction}) are text now, without the HTML (e.g. <b>) of the Directions API.
Multi-site (MSM)
The geocoding providers, route providers and tiles are now set per site. Before 5.0.0 all sites shared them, and saving them on one site replaced them for all sites. The update gives every site a copy of the current set, so nothing changes until you save them on a site.
For developers
- The installer uses the ExpressionEngine 7 add-on installer and migrations.
- The unused control panel CSS action and the
sessions_startandcp_js_endhooks are removed.
