PluginProbe
CBX Map for Google Map & OpenStreetMap / trunk
CBX Map for Google Map & OpenStreetMap vtrunk
trunk 1.1.10 1.1.11 1.1.12 1.1.5 1.1.6 1.1.7 1.1.8 1.1.9 2.0.0 2.0.1 2.0.2 2.0.3 2.0.4 2.0.5
cbxgooglemap / readme.txt

readme.txt in CBX Map for Google Map & OpenStreetMap trunk, at readme.txt

244 lines 9.1 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === CBX Map for Google Map & OpenStreetMap ===
2 Contributors: codeboxr, manchumahara
3 Donate link: https://codeboxr.com
4 Tags: google map, openstreetmap, map, gutenberg, elementor
5 Requires at least: 5.3
6 Tested up to: 7.1
7 Stable tag: 2.0.5
8 License: GPLv2 or later
9 License URI: https://www.gnu.org/licenses/gpl-2.0.html
10
11 Display responsive Google Maps or OpenStreetMap maps in WordPress with shortcodes, custom maps, Gutenberg, Elementor, or widgets.
12
13 == Description ==
14
15 **CBX Map for Google Map & OpenStreetMap** makes it easy to add responsive maps to your WordPress website.
16
17 Choose between **Google Maps** and **OpenStreetMap**, create reusable map locations from the WordPress admin, or display a map directly with a simple shortcode.
18
19 The plugin is designed to keep map creation simple. You can search for a location, set the marker position, configure the map, and copy the shortcode with just a few clicks.
20
21 OpenStreetMap is supported as an alternative to Google Maps and can be used without a Google Maps API key.
22
23 ### CBX Map for Google Map & OpenStreetMap by [Codeboxr](https://codeboxr.com/product/cbx-google-map-for-wordpress/)
24
25 > 📺 [Live Demo](https://codeboxr.net/wordpress/cbxgooglemap/codeboxr/) | 🌟 [Upgrade to PRO](https://codeboxr.com/product/cbx-google-map-for-wordpress/#downloadarea) | 📋 [Documentation](https://codeboxr.com/doc/cbxmap-doc/) | 👨‍💻 [Free Support](https://wordpress.org/support/plugin/cbxgooglemap/) | 🤴 [Pro Support](https://codeboxr.com/contact-us) | 📱 [Contact](https://codeboxr.com/contact-us/)
26
27 == Features ==
28
29 * Google Maps support
30 * OpenStreetMap support with no Google Maps API key required
31 * Create and manage reusable maps from the WordPress admin
32 * Custom post type for saved maps
33 * Simple `[cbxgooglemap]` shortcode
34 * Display maps without creating a custom map post
35 * Responsive map layout
36 * Automatic map resizing with the browser window
37 * Configurable map zoom and map type
38 * Marker and information window support
39 * Custom information window title and content
40 * Optional website link in the information window
41 * Custom map marker icon
42 * Global default settings
43 * Map-specific settings through custom fields
44 * Location search and easy marker positioning
45 * Easy shortcode copying from the map editor
46 * Gutenberg block support
47 * Elementor widget support
48 * Classic WordPress widget support
49 * WPBakery Page Builder support
50
51 **▶️ Watch the Video**
52
53 [youtube https://www.youtube.com/watch?v=pxeGCNc9Be0]
54
55 == Gutenberg, Elementor & Widget Support ==
56
57 CBX Map integrates with popular WordPress content-building tools.
58
59 * **Gutenberg Block** — Add maps directly from the WordPress block editor.
60 * **Elementor** — Add maps using an Elementor widget.
61 * **Classic Widget** — Add maps through the traditional WordPress widget.
62 * **WPBakery Page Builder** — Add maps using a WPBakery element.
63
64 == Shortcode ==
65
66 The simplest way to display a saved map is:
67
68 `[cbxgooglemap id="123"]`
69
70 Replace `123` with the ID of a map created using the **CBX Maps** custom post type.
71
72 === Display a Saved Map ===
73
74 Once you create a map from the WordPress admin, copy its shortcode and place it anywhere that supports WordPress shortcodes.
75
76 Example:
77
78 `[cbxgooglemap id="123"]`
79
80 Only the `id` attribute is required when displaying a saved map.
81
82 === Display a Map Without a Saved Map ===
83
84 You can also create a map directly from shortcode attributes without creating a CBX Map custom post.
85
86 Example:
87
88 `[cbxgooglemap lat="23.8103" lng="90.4125"]`
89
90 === Shortcode Attributes ===
91
92 * `id` — Saved CBX Map post ID. Optional.
93 * `maptype` — Map type. Default: `roadmap`. Available values: `roadmap`, `satellite`, `hybrid`, `terrain`.
94 * `width` — Map width. Numeric values are treated as pixels. Percentage values such as `100%` are also supported.
95 * `height` — Map height in pixels.
96 * `zoom` — Initial map zoom level. Default: `8`.
97 * `lat` — Latitude of the map location. Required when using a map without a saved map post.
98 * `lng` — Longitude of the map location. Required when using a map without a saved map post.
99 * `heading` — Title displayed in the information window.
100 * `website` — Website URL linked from the place name in the information window. Leave empty to disable the link.
101 * `address` — Content displayed inside the information window.
102 * `scrollwheel` — Enable or disable mouse-wheel zooming. `1` = enabled, `0` = disabled.
103 * `showinfo` — Show or hide the information window. `1` = enabled, `0` = disabled.
104 * `infow_open` — Control whether the information window is initially open. `1` = open, `0` = closed.
105 * `mapicon` — Custom marker icon URL. Leave empty to use the default marker.
106
107 Example:
108
109 `[cbxgooglemap lat="23.8103" lng="90.4125" zoom="12" maptype="roadmap" width="100%" height="400"]`
110
111 For complete shortcode documentation and Pro features, see the [CBX Map documentation](https://codeboxr.com/doc/cbxmap-doc/).
112
113 == CBX Map Pro ==
114
115 [Get CBX Map Pro](https://codeboxr.com/product/cbx-google-map-for-wordpress/#downloadarea)
116
117 Upgrade to **CBX Map Pro** to add advanced mapping and location features.
118
119 ### Pro Features
120
121 * Distance search shortcode
122 * Distance-based map and list display
123 * Display multiple map locations on a single map
124 * Use saved map posts as multiple markers
125 * Make individual maps public or private
126 * Map categories
127 * Additional shortcode options and advanced functionality
128
129 **▶️ Watch the Pro Video**
130
131 [youtube https://www.youtube.com/watch?v=bTuysIg-mho]
132
133 For complete Pro documentation and shortcode options, visit the [CBX Map documentation](https://codeboxr.com/doc/cbxmap-doc/).
134
135 == Installation ==
136
137 === Automatic Installation ===
138
139 1. From your WordPress dashboard, go to **Plugins → Add New**.
140 2. Search for **CBX Map for Google Map & OpenStreetMap**.
141 3. Install the plugin.
142 4. Activate the plugin.
143 5. Go to the CBX Map settings and configure your preferred map provider.
144 6. Create a map or use the `[cbxgooglemap]` shortcode to display a map.
145
146 === Manual Installation ===
147
148 1. Download the plugin.
149 2. Upload the `cbxgooglemap` folder to `/wp-content/plugins/`.
150 3. Activate the plugin from the **Plugins** menu in WordPress.
151 4. Open the CBX Map settings.
152 5. Configure your map provider and settings.
153 6. Create a map or add the shortcode to your desired page, post, widget, or supported page builder.
154
155 === Google Maps API ===
156
157 If you use **Google Maps**, configure the required Google Maps API credentials according to Google's current API requirements.
158
159 If you use **OpenStreetMap**, a Google Maps API key is not required.
160
161 == Frequently Asked Questions ==
162
163 = Does CBX Map support OpenStreetMap? =
164
165 Yes. CBX Map supports both **Google Maps** and **OpenStreetMap**.
166
167 = Do I need a Google Maps API key? =
168
169 A Google Maps API key is required when using Google Maps, according to Google's API requirements.
170
171 If you use OpenStreetMap, you do not need a Google Maps API key.
172
173 = Can I display a map without creating a map from the admin? =
174
175 Yes. You can display a map directly using shortcode attributes such as `lat`, `lng`, `zoom`, `maptype`, `width`, and `height`.
176
177 = Can I create reusable maps? =
178
179 Yes. CBX Map provides a custom post type that allows you to create and manage reusable map locations from the WordPress admin.
180
181 = Is the map responsive? =
182
183 Yes. Maps are designed to be responsive and adapt to the available browser width.
184
185 = Does CBX Map support Gutenberg? =
186
187 Yes. CBX Map provides a Gutenberg block for adding maps directly from the WordPress block editor.
188
189 = Does CBX Map support Elementor? =
190
191 Yes. CBX Map provides an Elementor widget.
192
193 = Does CBX Map support WPBakery? =
194
195 Yes. CBX Map provides WPBakery Page Builder support.
196
197 = Is there a custom PHP function to display a map directly? =
198
199 The recommended method for displaying maps is the `[cbxgooglemap]` shortcode or the available Gutenberg, Elementor, and widget integrations.
200
201 For advanced customization, please refer to the [documentation](https://codeboxr.com/doc/cbxmap-doc/) or contact [Codeboxr support](https://codeboxr.com/contact-us).
202
203 == Screenshots ==
204
205 1. CBX Map global settings
206 2. CBX Map global settings — map configuration
207 3. CBX Maps admin listing
208 4. CBX Map editor
209 5. CBX Map editor — location and marker settings
210 6. CBX Map frontend
211 7. CBX Map Gutenberg block
212 8. CBX Map Elementor widget
213 9. CBX Map shortcode configuration
214 10. CBX Map information window
215 11. CBX Map OpenStreetMap display
216 12. CBX Map responsive frontend display
217
218 == Support ==
219
220 Need help with CBX Map?
221
222 * [Free Support](https://wordpress.org/support/plugin/cbxgooglemap/)
223 * [Documentation](https://codeboxr.com/doc/cbxmap-doc/)
224 * [Pro Support](https://codeboxr.com/contact-us)
225 * [Contact Codeboxr](https://codeboxr.com/contact-us)
226
227 == Changelog ==
228
229 = 2.0.5 =
230 * [improvement] WordPress 7.1 compatibility.
231 * [updated] Plugin Check 2.1.0 compatibility.
232 * [updated] Pro addon 2.0.5 released.
233
234 = 2.0.4 =
235 * [improvement] Improved JavaScript loading when the Google Maps API key is missing.
236 * [updated] Plugin Check 1.8.0 compatibility.
237 * [updated] Pro addon 2.0.4 released.
238 * [updated] Miscellaneous improvements.
239
240 = 2.0.3 =
241 * [improvement] Improved Pro and other plugin activation checks.
242 * [improvement] Improved Pro addon deactivation notice.
243 * [updated] Pro addon 2.0.3 released.
244 * [updated] Miscellaneous improvements.