=== BeachFinder Widget ===
Contributors: beachfinder
Tags: beach, beaches, weather, travel, widget
Requires at least: 5.8
Tested up to: 6.9
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Embed the official BeachFinder beach conditions widget in WordPress with a shortcode.

== Description ==

BeachFinder Widget adds the `[beachfinder_widget]` shortcode. It renders an iframe pointing to the official BeachFinder widget at `https://getbeachfinder.com/widget/beach-conditions`.

The shortcode accepts optional parameters for location, display text, language, search radius, result limit, theme and height.

== External service ==

This plugin connects to BeachFinder at `https://getbeachfinder.com` to display the beach conditions widget. The widget is loaded in an iframe from `https://getbeachfinder.com/widget/beach-conditions`.

When the iframe loads, the visitor's browser makes a request to BeachFinder. The request can include shortcode settings such as latitude, longitude, radius, result limit, language, title and theme. Standard HTTP request data such as IP address, user agent and referrer may also be received by BeachFinder. BeachFinder may store the host domain, host page path, widget settings, and hashed IP address and user agent for analytics, abuse prevention and service reliability.

No BeachFinder account or API key is required to use this plugin.

BeachFinder privacy policy: https://getbeachfinder.com/privacy.html

BeachFinder terms of service: https://getbeachfinder.com/terms.html

== Installation ==

1. Upload the `beachfinder-widget` folder to `/wp-content/plugins/`.
2. In WordPress admin, open Plugins and activate "BeachFinder Widget".
3. Add a Shortcode block to a page or post.
4. Insert `[beachfinder_widget]` or a configured shortcode.

== Usage ==

Default widget:

`[beachfinder_widget]`

Configured widget:

`[beachfinder_widget lat="45.526" lng="4.919" title="Conditions de baignade autour de Vienne" lang="fr" radius="50" limit="8" theme="light" height="720"]`

Supported parameters:

* `lat` - Latitude for the initial location.
* `lng` - Longitude for the initial location.
* `title` - Widget title and iframe title.
* `lang` - Interface language, for example `fr` or `en`.
* `radius` - Search radius in kilometers. Values are clamped between 5 and 80.
* `limit` - Maximum number of results to display. Values are clamped between 1 and 8.
* `theme` - Widget theme, either `light` or `dark`.
* `height` - Iframe minimum height in pixels. Values are clamped between 420 and 1200.

Empty parameters are ignored. Invalid numeric values are ignored. Non-empty valid parameters are passed to the BeachFinder widget URL as query string values.

== Frequently Asked Questions ==

= Does this plugin require a BeachFinder API key? =

No. The plugin only embeds the public BeachFinder widget.

= Can I use it in a theme template? =

Yes. Use WordPress' `do_shortcode()` function:

`<?php echo do_shortcode('[beachfinder_widget lat="45.526" lng="4.919" lang="fr"]'); ?>`

== Changelog ==

= 1.0.0 =

* Initial shortcode plugin for the official BeachFinder public widget.
