Releases: gsarig/ootb-openstreetmap
Release 2.8.6
This version adds support for more AI providers, besides OpenAI. OpenAI is kept as the default, but you can now set your own API Provider and Model in the settings.
👉 Read more 👈
Release 2.8.5
This release ensures that the plugin passes the checks of Plugin Check (PCP).
Also, drops support for old PHP versions, with the minimum supported being PHP 8.1.
Finally, an improvement to the workflow pipelines was made, to include a proper zip of the plugin in the Release's attachments, for anyone who wants to download the plugin as a zip and install it from here.
Release 2.8.4
This is a security update. Also, the last version that supports PHP 7.4
.
Release 2.8.3
Version 2.8.3
makes changes to the way the scripts are loaded and bumps the minimum WordPress version to 6.5. If you are using an older WordPress version, please update WordPress first, before trying to update the plugin.
Changes
- Bumps support to WordPress 6.7.
- Bumps minimum supported WordPress version to 6.5.
- Fixes a tagging issue in the wordpress.org repo.
- Partially fixes a bug where the block wouldn't display on the Full Site Editor's template parts. There is still a bug where dragging doesn't work well when the block is used in a template part, and was disabled as a temporary workaround.
- Improves the way the frontend scripts are loaded (requires at least WordPress v.6.5 and above).
Release 2.8.2
Version 2.8.2
is a follow-up to the new feature of the "Location" custom field, introduced in version 2.8.0, following the request on #49. It adds two new hooks, which allow you to fully change the contents of a marker's modal box as well as its icon, when the new "OpenStreetMap from custom fields" block is used. This can be very powerful, as it allows you to fully modify the content displayed in your markers' modals, even using your own custom fields to display extra information. The hooks are:
ootb_cf_modal_content
Allows you to change the content of the modal that appears when you query posts based on their "Location" custom fields. By default, it will display the value set in the Address field. For example, the following code will display the post's title, thumbnail, excerpt and a link to the post:
add_filter( 'ootb_cf_modal_content', 'my_modal_content', 10, 2 );
function my_modal_content( $address, $post_id ) {
return sprintf(
'<div>
<h3>%1$s</h3>
<figure>%2$s</figure>
<p>%3$s</p>
<p><a href="%4$s">View post</a></p>
</div>',
get_the_title( $post_id ),
get_the_post_thumbnail( $post_id, 'thumbnail' ),
has_excerpt( $post_id ) ? get_the_excerpt( $post_id ) : $address,
get_the_permalink( $post_id )
);
}
ootb_cf_marker_icon
Allows you to change the marker icon for posts that have a "Location" custom field. By default, it will use the default marker. For example, the following code will use a custom marker for a post with ID 123
:
add_filter( 'ootb_cf_marker_icon', 'my_marker_icon', 10, 2 );
function my_marker_icon( $icon_url, $post_id ){
if( 123 === $post_id ) {
$icon_url = 'https://example.com/my-marker.jpg';
}
return $icon_url;
}
For the most up to date info about the available hooks, see the 🪝hooks section.
Release 2.8.1
Release 2.8.1
is a follow-up fix for Release 2.8.0.
Release 2.8.0
Custom field support
The highlight of version 2.8.0
is the support of a "Location" custom field, which allows you to store a post's or a post type's location. The data are stored following the official guidelines.
You can enable the custom field via Settings → OOTB OpenStreetMap → Custom Fields:
To display a map with all the locations, a new block "OpenStreetMap from custom fields" has been created:
Bugfixes
Other fixes and improvements introduced in version 2.8.0
include:
- [FIX] Fixes a PHP warning (see the report).
- [FIX] Fixes a bug which caused an editor crash (see the report).
- [FIX] Fixes an issue where the plugin was triggering unnecessary post updates.
- [MAINTENANCE] Updates the build scripts and the plugin's assets.
Release 2.7.2
Version 2.7.2 adds support for Mapbox styles (see #42). You can find the style URL on Mapbox Studio. There, use the "Share" button, and under "Developer resources", copy the "Style URL". It should look like that: mapbox://styles/username/style-id
.
You can declare a global style on the plugin's settings (Settings → OOTB OpenStreetMap), to be used as a default for all the maps, or you can set a custom style for each individual map, by using the block's settings panel.
To use the feature, you need to have a valid Mapbox API key.
Release 2.6.0
Version 2.6.0 adds the option to query maps: This allows you to create a map consisting of other maps, added on other posts or post types. This can be quite powerful when, for example, you have a custom post type for "Places" with each place having its own map, and you want to dynamically gather-up all the places on a single map. A shortcode has also been added as an alternative way to use this feature.
FAQ
How can I query maps from other posts or post types?
On the block's side panel, Select the "Map data" panel and click on the "Fetch locations" button. This will automatically retrieve on the frontend all the markers from your posts (you can also select a specific post type from the dropdown). The block will be locked from editing, as the markers will be dynamically retrieved from the selected posts. If you don't want that, there is a "Stop syncing" button that will unlock the block, drop the markers on the map and allow you to edit.
How can I use the shortcode?
The shortcode [ootb_query]
allows you to display a dynamic map, which retrieves markers from other posts or post types. Just add it to a post or page and you're good to go. By default, it will fetch the markers from the 100 most recent posts. The shortcode supports the following attributes:
- post_type: (Optional) The type of post to query. By default, it is set to
post
. - posts_per_page: (Optional) The number of posts to be displayed on page. Default value is
100
. - post_ids: (Optional) Comma-separated IDs of the posts to include in the query.
- height: (Optional) The desired height for the map. Default value is empty, which falls back to
400px
. - provider: (Optional) Specifies the map provider. Options are:
openstreetmap
,mapbox
andstamen
. The default value is an empty string which falls back toopenstreetmap
. - maptype: (Optional) Specifies the type of map. Options are:
markers
,polygon
andpolyline
. The default value is an empty string, which will fall back tomarkers
. - touchzoom: (Optional) If set, touch zoom will be enabled on the map. It can be either
true
orfalse
. The default value is an empty string, which falls back totrue
. - scrollwheelzoom: (Optional) If set, enables zooming on the map with mouse scroll wheel. It can be either
true
orfalse
. The default value is an empty string, which falls back totrue
. - dragging: (Optional) If set, dragging is enabled on the map. It can be either
true
orfalse
. The default value is an empty string, which falls back totrue
. - doubleclickzoom: (Optional) If set, allows zooming in on the map with a double click. It can be either
true
orfalse
. The default value is an empty string, which falls back totrue
. - marker: (Optional) Specifies the marker for the map. This should correspond to the URL of the image that you want to use as the marker's icon (example:
https://www.example.com/my-custom-icon.png
). The default value is an empty string, which retrieves the default marker.
Here's an example of how you can use it:
[ootb_query post_type="post" post_ids="1,2,3,4" height="400px" provider="mapbox" maptype="polygon" touchzoom="true" scrollwheelzoom="true" dragging="true" doubleclickzoom="true" marker="https://www.example.com/my-custom-icon.png"]
I want more control. Are there any hooks that I could use?
Glad you asked! There are a few hooks that you can use to further customize the plugin's behavior. Here they are:
ootb_query_post_type
: Allows you to change the post type that the plugin will query for markers. By default, it is set topost
. You can pass multiple post types as an array. Example:
add_filter( 'ootb_query_post_type', function() { return array( 'post', 'page' ); } );
ootb_query_posts_per_page
: Allows you to change the number of posts that the plugin will query for markers. By default, it is set to100
. Example:
add_filter( 'ootb_query_posts_per_page', function() { return 500; } );
ootb_query_extra_args
: Allows you to add extra arguments to the query that the plugin will use to retrieve markers. By default, it is set to an empty array. Example:
add_filter(
'ootb_query_extra_args',
function() {
return [
'tax_query' => [
[
'taxonomy' => 'people',
'field' => 'slug',
'terms' => 'bob'
]
];
}
);
Keep in mind that the extra args will be merged with the default ones, so you don't have to worry about overriding them. In fact, the args that are required for the query to work, cannot be overridden.
Release 2.5.0
Version 2.5.0 introduces OpenAI integration, which allows you to add markers by using commands in natural language. To use, you will need to create an account to OpenAI and get an API key. Then, go to the plugin’s settings page and paste your key there. After that, you can start adding markers by using commands in natural language.
Just say “please” to activate (e.g. “Please, show me where GOT was filmed”). Please keep in mind, though, that it’s like asking ChatGPT: the answers you get might not always be 100% reliable, and you should always double-check to confirm their accuracy. Read more.