| @@ -1,8 +1,599 @@ | ||
| 1 | 1 | == Changelog == |
| 2 | 2 | |
| 3 | 3 | **This is a list detailing changes for past BeyondWords releases. For more information about the current release, see readme.txt.** |
| 4 | 4 | |
| 5 | += 6.3.0 = | |
| 6 | + | |
| 7 | +Release date: 12th April 2026 | |
| 8 | + | |
| 9 | +**Enhancements** | |
| 10 | + | |
| 11 | +* [#500](https://github.com/beyondwords-io/wordpress-plugin/pull/500) Editable content ID field. | |
| 12 | + * Adds a new "Content ID" feature, allowing users to input and fetch audio metadata by Content ID directly from the editor and classic metabox. | |
| 13 | + | |
| 14 | +**Codebase Enhancements** | |
| 15 | + | |
| 16 | +* Bump BeyondWords Player block `apiVersion` to fix failing Plugin Check jobs in CI. | |
| 17 | +* Various dependency updates to clear Dependabot security warnings. | |
| 18 | + | |
| 19 | += 6.2.0 = | |
| 20 | + | |
| 21 | +Release date: 11th March 2026 | |
| 22 | + | |
| 23 | +**Enhancements** | |
| 24 | + | |
| 25 | +* [#498](https://github.com/beyondwords-io/wordpress-plugin/pull/498) "Generate Audio" component improvements. | |
| 26 | + * Stability and performance updates for the Generate Audio component in the block editor. | |
| 27 | + | |
| 28 | +**Codebase Enhancements** | |
| 29 | + | |
| 30 | +* [#474](https://github.com/beyondwords-io/wordpress-plugin/pull/474) Replace Mock API responses with pre_http_request filter. | |
| 31 | + * Mockoon has been replaced with WordPress HTTP filters, and completely removed. | |
| 32 | + | |
| 33 | += 6.1.0 = | |
| 34 | + | |
| 35 | +Release date: 2nd March 2026 | |
| 36 | + | |
| 37 | +**Fixes** | |
| 38 | + | |
| 39 | +* [#483](https://github.com/beyondwords-io/wordpress-plugin/pull/483) and [#494](https://github.com/beyondwords-io/wordpress-plugin/pull/494) Fix reported REST API 404 responses. | |
| 40 | + * Skip the second `wp_after_insert_post` triggered by Gutenberg's meta box save. | |
| 41 | + * If the audio update request to our REST API results in a 404 then clear the stale content ID in WordPress and create new audio. | |
| 42 | + * `hasContent()` guard on `onTrashPost()` / `onDeletePost()` now skips posts without BeyondWords content IDs e.g. revisions. | |
| 43 | + | |
| 44 | +**Enhancements** | |
| 45 | + | |
| 46 | +* [#481](https://github.com/beyondwords-io/wordpress-plugin/pull/481) Add `$context` param to `beyondwords_player_html` filter. | |
| 47 | + * Use the `$context` param to enable filtering of the player HTML based on whether it was auto-prepended to `the_content` or added manually using a shortcode. | |
| 48 | + * This filter can be used to hide only the auto-prepended players, enabling the shortcode to be used effectively in PHP template files. | |
| 49 | + * Check the [Examples](https://docs.beyondwords.io/docs-and-guides/integrations/wordpress/filters?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin#beyondwords_player_html) in our docs for further information. | |
| 50 | + | |
| 51 | += 6.0.4 = | |
| 52 | + | |
| 53 | +Release date: 7th January 2026 | |
| 54 | + | |
| 55 | +**Fixes** | |
| 56 | + | |
| 57 | +* [#477](https://github.com/beyondwords-io/wordpress-plugin/pull/477) Fix `saveErrorMessage()` bug. | |
| 58 | + * In the error message saving method we were incorrectly checking the integration method for the plugin instead of the post, which may explain a reported problem where unexpected 404 error messages were being saved. | |
| 59 | + | |
| 60 | +**Codebase Enhancements** | |
| 61 | + | |
| 62 | +* Improve the Cypress test suite by adding more assertions and testing more post statuses. | |
| 63 | +* Check for `ABSPATH` at the top of all PHP files. | |
| 64 | + | |
| 65 | += 6.0.3 = | |
| 66 | + | |
| 67 | +Release date: 16th December 2025 | |
| 68 | + | |
| 69 | +**Compatibility** | |
| 70 | + | |
| 71 | +* [#473](https://github.com/beyondwords-io/wordpress-plugin/pull/473) Reintroduce support for **PHP 8.0**. | |
| 72 | + | |
| 73 | += 6.0.2 = | |
| 74 | + | |
| 75 | +Release date: 3rd December 2025 | |
| 76 | + | |
| 77 | +**Enhancements and Features** | |
| 78 | + | |
| 79 | +* [#468](https://github.com/beyondwords-io/wordpress-plugin/pull/468) Tested up to WordPress 6.9. | |
| 80 | + | |
| 81 | +**Fixes** | |
| 82 | + | |
| 83 | +* [#469](https://github.com/beyondwords-io/wordpress-plugin/pull/469) Add `beyondwords_integration_method` into Inspect Panel copied data. | |
| 84 | +* [#466](https://github.com/beyondwords-io/wordpress-plugin/pull/466) Removed PHP type hints from methods hooked directly into WordPress `add_action`/`add_filter`. | |
| 85 | + | |
| 86 | += 6.0.1 = | |
| 87 | + | |
| 88 | +Release date: 26th November 2025 | |
| 89 | + | |
| 90 | +**Fixes** | |
| 91 | + | |
| 92 | +* [#464](https://github.com/beyondwords-io/wordpress-plugin/pull/464) Use `CoreUtils::getPostMetaKeys` to get all keys for removal. | |
| 93 | +* [#461](https://github.com/beyondwords-io/wordpress-plugin/pull/461) Accept `null` params from WP Core for `isProtectedMeta`. | |
| 94 | +* [#460](https://github.com/beyondwords-io/wordpress-plugin/pull/460) Accept a `null` parameter in `getLangCodeFromJsonIfEmpty`. | |
| 95 | + | |
| 96 | += 6.0.0 = | |
| 97 | + | |
| 98 | +Release date: 10th November 2025 | |
| 99 | + | |
| 100 | +**Enhancements and Features** | |
| 101 | + | |
| 102 | +* [#449](https://github.com/beyondwords-io/wordpress-plugin/pull/449) Added support for Magic Embed integration within the plugin. | |
| 103 | + * A new **"Magic Embed"** option has been added under **Content > Integration method** in the plugin settings. | |
| 104 | + * This option is intended for users working with **page builders such as Elementor**, who may have experienced issues getting the **REST API** to function correctly during initial setup. | |
| 105 | + * **Enabling Magic Embed** will automatically add the Magic Embed script to each of your posts. | |
| 106 | + * For correct functionality: | |
| 107 | + * Magic Embed must be **selected in the WordPress plugin**. | |
| 108 | + * Magic Embed must also be **[enabled and configured](https://docs.beyondwords.io/docs-and-guides/integrations/magic-embed/overview?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin#setup) in your BeyondWords dashboard**. | |
| 109 | + * Posts previously created using the **REST API** will continue to use that method. | |
| 110 | + * Refer to our [Magic Embed documentation](https://docs.beyondwords.io/docs-and-guides/integrations/magic-embed/overview?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin) for more information. | |
| 111 | + | |
| 112 | +***If your plugin is already working as expected with the REST API, we recommend continuing to use that integration.*** | |
| 113 | + | |
| 114 | +**Fixes** | |
| 115 | + | |
| 116 | +* [#457](https://github.com/beyondwords-io/wordpress-plugin/pull/457) Removed segment marker assignment. | |
| 117 | + * Fixes a reported JS issue where the block editor "+" button was not being displayed. | |
| 118 | + | |
| 119 | +**Code Coverage** | |
| 120 | + | |
| 121 | +* [#455](https://github.com/beyondwords-io/wordpress-plugin/pull/455) Increased PHPUnit test coverage. | |
| 122 | + | |
| 123 | +**Refactoring** | |
| 124 | + | |
| 125 | +* [#454](https://github.com/beyondwords-io/wordpress-plugin/pull/454) PHP type declarations. | |
| 126 | +* [#447](https://github.com/beyondwords-io/wordpress-plugin/pull/447) Make PHP methods static. | |
| 127 | + | |
| 128 | +**Compatibility** | |
| 129 | + | |
| 130 | +* ~~**PHP 8.1** is now our minimum supported version.~~ | |
| 131 | + | |
| 132 | += 5.5.0 = | |
| 133 | + | |
| 134 | +Release date: 2nd July 2025 | |
| 135 | + | |
| 136 | +**Enhancements and Features:** | |
| 137 | + | |
| 138 | +* [#446](https://github.com/beyondwords-io/wordpress-plugin/pull/446) Fetch button for Block Editor Inspect panel. | |
| 139 | + * We've added a Fetch option to the Inspect panel in the BeyondWords Block Editor sidebar. | |
| 140 | + * This allows users to retrieve audio that has already been generated in BeyondWords, helping to quickly restore a missing or broken link between the audio and WordPress post, without needing to regenerate the audio. | |
| 141 | +* Always show the **Generate audio** checkbox in the Block Editor. | |
| 142 | + * As part of the Fetch button update the **Generate audio** checkbox is now always shown in the Block Editor. | |
| 143 | + * If **Generate audio** is unchecked before a post is saved then audio **will not** be regenerated from the updated post content. | |
| 144 | +* [#444](https://github.com/beyondwords-io/wordpress-plugin/pull/444) PHP 8.4 support. | |
| 145 | + * Run unit and e2e tests against PHP 8.1 and PHP 8.4 in GitHub Actions. | |
| 146 | + | |
| 147 | += 5.4.0 = | |
| 148 | + | |
| 149 | +Release date: 22nd April 2025 | |
| 150 | + | |
| 151 | +**Fixes:** | |
| 152 | + | |
| 153 | +* [#436](https://github.com/beyondwords-io/wordpress-plugin/pull/436) Article language support in WordPress. | |
| 154 | + * Each `POST` and `PUT` request to the BeyondWords REST API now includes the article language. | |
| 155 | + * This update ensures compatibility with recent REST API changes and improves support for multilingual websites. | |
| 156 | +* [#432](https://github.com/beyondwords-io/wordpress-plugin/pull/432) Delete audio and post meta when posts are trashed or deleted. | |
| 157 | + * When a post is moved into the trash in WordPress it is now deleted from the BeyondWords dashboard, and all associated BeyondWords post meta data (e.g. the content ID) is also deleted. | |
| 158 | + * This resolves REST API error messages caused by `DELETE` requests for content that no longer exists. | |
| 159 | + * After this update you will need to regenerate audio again if you restore posts from the trash. | |
| 160 | + | |
| 161 | +**Enhancements and Features:** | |
| 162 | + | |
| 163 | +* Tested up to WordPress 6.8. | |
| 164 | +* [#405](https://github.com/beyondwords-io/wordpress-plugin/pull/405) "Post a review" notice in WordPress admin. | |
| 165 | + * A new notice prompts you to review our plugin on the WordPress Plugin Directory. | |
| 166 | + * The notice will appear 14 days after activating the plugin, or 14 days after updating to this version (or later) . | |
| 167 | + * The message is permanently dismissed once you close it or follow the link to leave a review. | |
| 168 | +* [#434](https://github.com/beyondwords-io/wordpress-plugin/pull/434) Update Cypress to version 14. | |
| 169 | + | |
| 170 | += 5.3.1 = | |
| 171 | + | |
| 172 | +Release date: 11th February 2025 | |
| 173 | + | |
| 174 | +**Fixes:** | |
| 175 | + | |
| 176 | +* Replace `esc_js` with `esc_attr` for the player `onload` attribute. | |
| 177 | + * Fixes a reported issue where UTF-8 characters in the *Call to Action* setting were not being output correctly. | |
| 178 | + | |
| 179 | += 5.3.0 = | |
| 180 | + | |
| 181 | +Release date: 3rd February 2025 | |
| 182 | + | |
| 183 | +**Enhancements and Features:** | |
| 184 | + | |
| 185 | +* [426](https://github.com/beyondwords-io/wordpress-plugin/pull/426) Add support for article summarisation. | |
| 186 | + * A new "Player Content" field has been added to the post edit screens for both the Block Editor and Classic Editor. | |
| 187 | + * Selecting "Summary" in the BeyondWords side panel loads the summarised audio into the player. | |
| 188 | + * The default value, "Article," continues to load the full article content. | |
| 189 | + * To use this feature, ensure that summarisation is included in your plan and enabled in your BeyondWords dashboard. | |
| 190 | +* [429](https://github.com/beyondwords-io/wordpress-plugin/pull/429) Add Summarization tab in plugin settings. | |
| 191 | + * Adds a link to manage summarization settings for your project, including the summarization voice. | |
| 192 | + | |
| 193 | +**Fixes** | |
| 194 | + | |
| 195 | +* Prioritise post-specific player settings. | |
| 196 | + * It was previously possible for the plugin settings in the "Player" tab to overwrite any post-specific settings such as the player style. | |
| 197 | + * The priority has now been corrected so any post-specific settings will overwrite the plugin settings. | |
| 198 | +* Fix Clipboard.js error. | |
| 199 | + * Replace Clipboard.js script with the WordPress core version to address a console error in the block editor. | |
| 200 | +* [425](https://github.com/beyondwords-io/wordpress-plugin/pull/425) Update asset URL to Azure Storage. | |
| 201 | + * The AMP logo image has been moved from AWS S3 to Azure Storage. | |
| 202 | + | |
| 203 | +**Codebase Enhancements** | |
| 204 | + | |
| 205 | +* Refactor React code for the player. | |
| 206 | + * Updated the block editor player embed script to align with React players we use in other BeyondWords projects. | |
| 207 | + * This included removing the `react-script-tag` dependency. | |
| 208 | +* Added the `__nextHasNoMarginBottom` property to various components. | |
| 209 | + * `__nextHasNoMarginBottom` has been set in various places to address a console warning from WordPress core. | |
| 210 | +* Updated dependencies. | |
| 211 | + * Updated several dependencies including `@mockoon/cli`, `@wordpress/env`, `@wordpress/eslint-plugin`, `@wordpress/scripts`, and `uuid`. | |
| 212 | + * Removed unused dependencies. | |
| 213 | + | |
| 214 | += 5.2.2 = | |
| 215 | + | |
| 216 | +Release date: 10th December 2024 | |
| 217 | + | |
| 218 | +**Fixes** | |
| 219 | + | |
| 220 | +* [423](https://github.com/beyondwords-io/wordpress-plugin/pull/423) Optimise WordPress HTTP calls to BeyondWords REST API. | |
| 221 | + * Increase the WordPress default `timeout` param from `5` to `30`. This is to address a reported issue where REST API calls are sometimes timing out in WordPress/PHP before the REST API is able to respond. | |
| 222 | + * Also removed the `sslverify` param for API calls. This is no longer recommended. | |
| 223 | + | |
| 224 | += 5.2.1 = | |
| 225 | + | |
| 226 | +Release date: 28th November 2024 | |
| 227 | + | |
| 228 | +**Fixes** | |
| 229 | + | |
| 230 | +* [#421](https://github.com/beyondwords-io/wordpress-plugin/pull/421) Update WordPress GET voice queries to use scopes. | |
| 231 | + * Fixes the issue where multilingual voices were not being shown in voices dropdown menus. | |
| 232 | +* [#417](https://github.com/beyondwords-io/wordpress-plugin/pull/417) Improve handling of failed REST API requests when syncing settings. | |
| 233 | + * Add HTTP status code into failed API credentials validation message to improve debugging for empty response body. | |
| 234 | + * Fix the undefined index errors that are logged when REST API responses do not contain the expected structure. | |
| 235 | + * Replace transients with object cache to reduce db writes. | |
| 236 | + * Add Query Monitor plugin to wp-env local dev config to help with debugging. | |
| 237 | + | |
| 238 | += 5.2.0 = | |
| 239 | + | |
| 240 | +Release date: 22nd November 2024 | |
| 241 | + | |
| 242 | +**Enhancements** | |
| 243 | + | |
| 244 | +* [#414](https://github.com/beyondwords-io/wordpress-plugin/pull/414) Tested up to WordPress 6.7. | |
| 245 | +* [#409](https://github.com/beyondwords-io/wordpress-plugin/pull/409) Support the [recommended inline script tag method](https://github.com/beyondwords-io/player/blob/main/doc/getting-started.md) to embed players. | |
| 246 | + * ***This opt-in feature is experimental and may change, or be removed, in the near future***. | |
| 247 | + * Opt-in to the inline `<script>` tag method of auto-embedding audio players by defining the constant `BEYONDWORDS_PLAYER_INLINE_SCRIPT_TAG` as `true` in your `wp-config.php`. | |
| 248 | + * This was added because the recent removal of the deprecated `beyondwords_content_id` filter caused problems for a publisher who had been using it to display an audio player from another post on their homepage. | |
| 249 | + * After opting-in, audio players that are auto-prepended to the post body should now use the `beyondwords_content_id` and `beyondwords_project_id` from the associated post being queried within The Loop. | |
| 250 | + * A known-issue is the current implementation is currently incompatible with both the *BeyondWords shortcode* and the *BeyondWords player block*. Compatibility will be ensured before this experimental opt-in feature is shipped to all users. In the meantime players added using either the shortcode or player block are unlikely to appear when the `BEYONDWORDS_PLAYER_INLINE_SCRIPT_TAG` is `true`. | |
| 251 | + | |
| 252 | +**Fixes** | |
| 253 | + | |
| 254 | +* [#413](https://github.com/beyondwords-io/wordpress-plugin/pull/413) Refactor API calls to prevent "invalid creds" messages | |
| 255 | + * Since upgrading to version 5 a few publishers have reported problems with their valid API credentials being flagged as invalid, so the checks we had in place to validate the API Key and Project ID have been updated. | |
| 256 | + * API calls to create/update BeyondWords content can now be made with potentially invalid credentials. If this happens (e.g. if your API Key has been revoked) the 401 Unauthorized error code and error message will be stored for your requests and visible in WordPress admin. | |
| 257 | + | |
| 258 | += 5.1.0 = | |
| 259 | + | |
| 260 | +Release date: 30th October 2024 | |
| 261 | + | |
| 262 | +**Fixes** | |
| 263 | + | |
| 264 | +* [#404](https://github.com/beyondwords-io/wordpress-plugin/pull/404) Bring auto-publish setting into WordPress to fix auto-publishing. | |
| 265 | + * In some cases WordPress was publishing audio regardless of the auto-publish setting in the dashboard. | |
| 266 | + * After this update any content created with the WordPress plugin will need to be published in the BeyondWords dashboard. | |
| 267 | +* [#407](https://github.com/beyondwords-io/wordpress-plugin/pull/407) Regenerate audio for all post statuses | |
| 268 | + * If a post has a content ID for audio then we now *always* make PUT requests to the BeyondWords REST API when the post is updated. | |
| 269 | + * This fixes an issue where the `published` property of audio was not set to `false` when WordPress posts were moved back to `draft` status. | |
| 270 | +* [#408](https://github.com/beyondwords-io/wordpress-plugin/pull/408) Generate Audio checkbox in Classic Editor doesn't reflect the "Preselect" setting | |
| 271 | + * A change in the `v5.0` update meant the "Preselect generate audio" JS script was no longer being enqueued. This should now be fixed. | |
| 272 | + | |
| 273 | += 5.0.0 = | |
| 274 | + | |
| 275 | +Release date: 15th October 2024 | |
| 276 | + | |
| 277 | +**Enhancements** | |
| 278 | + | |
| 279 | +* [#385](https://github.com/beyondwords-io/wordpress-plugin/pull/385) Extend plugin settings using a tabbed interface. | |
| 280 | + * The plugin settings screen has been expanded to include settings from the BeyondWords dashboard, allowing you to set various BeyondWords settings without leaving WordPress. | |
| 281 | + * Changes made in WordPress will be immediately copied over to the BeyondWords dashboard when "Save settings" is pressed. | |
| 282 | + * Changes made in the BeyondWords dashboard will be copied over to WordPress when you visit the relevant plugin settings tab. | |
| 283 | + | |
| 284 | +**Breaking changes** | |
| 285 | + | |
| 286 | +* Legacy audio player support has been removed. | |
| 287 | + * The legacy BeyondWords player is no longer natively supported in the WordPress plugin. | |
| 288 | + * The standard [BeyondWords Player](https://docs.beyondwords.io/docs-and-guides/player/overview) is now the only built-in option for the audio player. | |
| 289 | +* Remove built-in Elementor compatibility. | |
| 290 | + * Basic support for audio generation and auto-player embeds should still work for posts that are created with Elementor, although you will be unable to see a BeyondWords player in the Elementor post edit screens. To view our player in WordPress admin you can temporarily switch to the Block or Classic editors. | |
| 291 | + * Refer to our [WordPress filters](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters) docs and the [Elementor hooks](https://developers.elementor.com/docs/hooks/) docs if you wish to add Elementor support to your site. | |
| 292 | +* Stop saving the legacy `beyondwords_podcast_id` param. | |
| 293 | + * This change means that posts generated with versions `v5.0.0` and later will not play audio if the plugin is downgraded to `v3.x` or below. | |
| 294 | + * If you need to downgrade to `v3.x` after using `v5.x` please contact us for support. | |
| 295 | +* Remove deprecated filters. | |
| 296 | + * A number of deprecated filters have now been removed from the source code. | |
| 297 | + * Refer to our [WordPress Filters](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters) documentation to view the current filters we provide. | |
| 298 | + | |
| 299 | += 4.7.0 = | |
| 300 | + | |
| 301 | +Release date: 2nd May 2024 | |
| 302 | + | |
| 303 | +**Fixes** | |
| 304 | + | |
| 305 | +* [#388](https://github.com/beyondwords-io/wordpress-plugin/pull/388) If the post body [has_blocks](https://developer.wordpress.org/reference/functions/has_blocks/) then remove the `wpautop` filter before sending it to our REST API. This filter was stripping closing `</p>` tags from empty paragraph blocks. | |
| 306 | + | |
| 307 | +**Enhancements** | |
| 308 | + | |
| 309 | +* [#386](https://github.com/beyondwords-io/wordpress-plugin/pull/386) Prepend custom plugin links instead of appending them | |
| 310 | +* [#384](https://github.com/beyondwords-io/wordpress-plugin/pull/384) Refactoring to improve code quality | |
| 311 | +* [#388](https://github.com/beyondwords-io/wordpress-plugin/pull/388) Unit tests for empty paragraphs | |
| 312 | +* Prevent empty `data-beyondwords-marker` attributes | |
| 313 | + | |
| 314 | += 4.6.2 = | |
| 315 | + | |
| 316 | +Release date: 11th April 2024 | |
| 317 | + | |
| 318 | +**Enhancements** | |
| 319 | + | |
| 320 | +* Tested up to WordPress 6.5. | |
| 321 | +* PHPUnit code coverage badge and report. | |
| 322 | + | |
| 323 | += 4.6.1 = | |
| 324 | + | |
| 325 | +Release date: 28th March 2024 | |
| 326 | + | |
| 327 | +**Fixes** | |
| 328 | + | |
| 329 | +* [#378](https://github.com/beyondwords-io/wordpress-plugin/pull/378) Only auto-prepend player for [is_singular](https://developer.wordpress.org/reference/functions/is_singular/) queries. | |
| 330 | + | |
| 331 | +**Enhancements** | |
| 332 | + | |
| 333 | +* [#373](https://github.com/beyondwords-io/wordpress-plugin/pull/373) Run [Plugin Check (PCP)](https://wordpress.org/plugins/plugin-check/) in our GitHub Actions workflow to check we meet the WordPress.org plugin directory coding standards. | |
| 334 | + * Includes various minor code updates to resolve the reported errors and warnings. | |
| 335 | + | |
| 336 | += 4.6.0 = | |
| 337 | + | |
| 338 | +Release date: 28th March 2024 | |
| 339 | + | |
| 340 | +**Enhancements** | |
| 341 | + | |
| 342 | +* To support BeyondWords’ upcoming summarization product, the BeyondWords REST API now expects the post excerpt to be prepended to the body for API requests. | |
| 343 | + * If you have enabled "Use excerpts for summaries" in the plugin settings we will now automatically combine the fields. You should not see a difference, or need to make any changes. | |
| 344 | + * If you are currently passing a `summary` field to us using another method (e.g. our [beyondwords_content_params](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_content_params) filter) then we should have provided advance notice of this change to you. If this change affects you, and you didn’t hear from us in advance, then please contact [[email protected]](mailto:[email protected]). | |
| 345 | + | |
| 346 | += 4.5.1 = | |
| 347 | + | |
| 348 | +Release date: 14th March 2024 | |
| 349 | + | |
| 350 | +**Enhancements** | |
| 351 | + | |
| 352 | +* Make the BeyondWords column in WP admin sortable. | |
| 353 | + | |
| 354 | +**Fixes** | |
| 355 | + | |
| 356 | +* We now only render plugin components on the Post edit screens if the REST API credentials have been validated. | |
| 357 | +* Improved handling for REST API calls that fail while editing posts. This fixes the following issues: | |
| 358 | + * The block editor crashed if the API Key and/or Project ID had not been entered in the plugin settings. | |
| 359 | + * The block editor crashed if REST API calls failed for other reasons e.g. network problems. | |
| 360 | +* Removed a console log intended for debugging. | |
| 361 | + | |
| 362 | += 4.5.0 = | |
| 363 | + | |
| 364 | +Release date: 1st March 2024 | |
| 365 | + | |
| 366 | +**Enhancements** | |
| 367 | + | |
| 368 | +* Audio content for posts created with a future publish date is now available to preview in the WordPress admin players. To achieve this we handle a `preview_token` returned from the BeyondWords REST API. | |
| 369 | +* In Site Health and throughout the code, replace "Allowed post types" and "Supported post types" with "Compatible post types" and "Incompatible post types" to improve clarity. | |
| 370 | + | |
| 371 | +**Code Refactoring** | |
| 372 | + | |
| 373 | +* A general tidy-up of all code and docs for the public open-source release of our plugin repo at https://github.com/beyondwords-io/wordpress-plugin. | |
| 374 | +* Remove `BEYONDWORDS_DEBUG` constant throughout the code - this was only ever used internally for the legacy player, so it has been removed for the public repo release. | |
| 375 | +* Prevent side-effects in PHP constructors. | |
| 376 | + | |
| 377 | += 4.4.0 = | |
| 378 | + | |
| 379 | +Release date: 11th January 2024 | |
| 380 | + | |
| 381 | +**Enhancements** | |
| 382 | + | |
| 383 | +* Tested up to WordPress 6.4. | |
| 384 | +* Tested up to PHP 8.3. | |
| 385 | +* Delete audio when *Remove* feature is used. When you *Remove* audio using the Inspect panel we now make a DELETE request to the BeyondWords API to keep WordPress and the BeyondWords dashboard in sync. | |
| 386 | +* Add BeyondWords version and WordPress version into copied Inspect Panel data. | |
| 387 | + | |
| 388 | +**Fixes** | |
| 389 | + | |
| 390 | +* Use optional chaining before accessing properties. This fixes an undefined error when the sidebar is loaded. The issue was reported by Cypress testing in our CI pipeline. | |
| 391 | + | |
| 392 | += 4.3.0 = | |
| 393 | + | |
| 394 | +Release date: 7th December 2023 | |
| 395 | + | |
| 396 | +**Deprecations** | |
| 397 | + | |
| 398 | +We have renamed and removed some of our WordPress filters to make them simpler to understand and to implement. | |
| 399 | + | |
| 400 | +The deprecated filters listed below are scheduled to be removed from the code in plugin v5.0, so please migrate to any replacements as soon as possible. | |
| 401 | + | |
| 402 | +* Filters we have simply renamed (the functionality remains exactly the same): | |
| 403 | + * `beyondwords_body_params`: Renamed to `beyondwords_content_params` | |
| 404 | + * `beyondwords_player_styles`: Renamed to `beyondwords_settings_player_styles` | |
| 405 | + * `beyondwords_post_types`: Renamed to `beyondwords_settings_post_types` | |
| 406 | + * `beyondwords_post_statuses`: Renamed to `beyondwords_settings_post_statuses` | |
| 407 | +* Filters we have removed because there are suitable alternatives: | |
| 408 | + * `beyondwords_amp_player_html`: Instead, use the `beyondwords_player_html` filter which is now applied to the player HTML for AMP and non-AMP content. | |
| 409 | + * `beyondwords_content`: Instead, set the `body` key in the `beyondwords_content_params` filter | |
| 410 | + * `beyondwords_post_metadata`: Instead, set the `metadata` key in the `beyondwords_content_params` filter | |
| 411 | + * `beyondwords_post_audio_enabled_blocks`: Instead, refer to our [Filter content](https://docs.beyondwords.io/docs-and-guides/content/filter-content) docs for an alternative. | |
| 412 | + * `beyondwords_post_player_enabled`: Instead, return an empty string in the `beyondwords_player_html` filter to hide the player. Alternatively, you can set `published` to `false` in the BeyondWords dashboard. | |
| 413 | +* Filters we have deprecated because the functionality is no longer required: | |
| 414 | + * `beyondwords_js_player_params`: This only applies to the Legacy player which will be removed in plugin v5.0 | |
| 415 | + * `beyondwords_content_id`: We believe this is not being used, please contact [[email protected]](mailto:[email protected]) if you are using this filter. | |
| 416 | + * `beyondwords_project_id`: We believe this is not being used, please contact [[email protected]](mailto:[email protected]) if you are using this filter. | |
| 417 | + | |
| 418 | +We have also renamed `PostContentUtils::getBodyJson` to `PostContentUtils::getContentParams`, to match the `beyondwords_content_params` filter name. | |
| 419 | + | |
| 420 | += 4.2.4 = | |
| 421 | + | |
| 422 | +Release date: 15th November 2023 | |
| 423 | + | |
| 424 | +**Fixes** | |
| 425 | + | |
| 426 | +* Ensure the `$content` param of `Beyondwords\Wordpress\Core\Player\Player::hasCustomPlayer` is a string before using `strpos`. | |
| 427 | + | |
| 428 | += 4.2.3 = | |
| 429 | + | |
| 430 | +Release date: 2nd November 2023 | |
| 431 | + | |
| 432 | +**Fixes** | |
| 433 | + | |
| 434 | +* Pass full-size (originally uploaded) featured image to the BeyondWords API instead of a cropped thumbnail. The 240x240 thumbnail we replaced was not suitable for some styles of the latest player. | |
| 435 | + | |
| 436 | += 4.2.2 = | |
| 437 | + | |
| 438 | +Release date: 27th October 2023 | |
| 439 | + | |
| 440 | +**Fixes** | |
| 441 | + | |
| 442 | +* Ensure segment markers are added to the HTML body before we pass it to our REST API. This fixes an issue where "Playback from paragraph" was not working in some cases. | |
| 443 | +* Update the block control restrictions. This is to fix an issue where the block controls – including the "Audio processing enabled/diabled" toggle – sometimes did not appear when a block was clicked. | |
| 444 | + | |
| 445 | += 4.2.1 = | |
| 446 | + | |
| 447 | +Release date: 12th October 2023 | |
| 448 | + | |
| 449 | +**Enhancements** | |
| 450 | + | |
| 451 | +* Prevent player analytics events from being recorded in WordPress admin by setting the `{ analyticsConsent: 'none' }` param for admin players. | |
| 452 | + | |
| 453 | += 4.2.0 = | |
| 454 | + | |
| 455 | +Release date: 10th October 2023 | |
| 456 | + | |
| 457 | +**Enhancements** | |
| 458 | + | |
| 459 | +* Add `[beyondwords_player]` shortcode. See our "WordPress shortcode" docs at [https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress]. | |
| 460 | + | |
| 461 | +**Fixes** | |
| 462 | + | |
| 463 | +* Ensure an array is always returned for `PlayerStyle::getCachedPlayerStyles()` to prevent PHP warnings. | |
| 464 | +* For AMP content, the player is no longer auto-prepended if a custom player is found in the content. | |
| 465 | +* Clean up 'beyondwords_player_style' option on plugin uninstall. | |
| 466 | + | |
| 467 | += 4.1.2 = | |
| 468 | + | |
| 469 | +Release date: 21st September 2023 | |
| 470 | + | |
| 471 | +**Enhancements** | |
| 472 | + | |
| 473 | +* Added "Large" option into "Player style" plugin setting. | |
| 474 | + | |
| 475 | += 4.1.1 = | |
| 476 | + | |
| 477 | +Release date: 15th September 2023 | |
| 478 | + | |
| 479 | +**Enhancements** | |
| 480 | + | |
| 481 | +* Tested up to WordPress 6.3. | |
| 482 | + | |
| 483 | += 4.1.0 = | |
| 484 | + | |
| 485 | +Release date: 15th September 2023 | |
| 486 | + | |
| 487 | +**Enhancements** | |
| 488 | + | |
| 489 | +* "Player style" support. | |
| 490 | + * A "Player style" setting has been added to the plugin settings screen where you can assign the default player style for your audio players. | |
| 491 | + * The default style can be overridden for each post on the post edit screen. | |
| 492 | + * A `beyondwords_player_styles` filter is available so you can modify the options of the "Player style" select boxes in WordPress admin. | |
| 493 | + * We are currently beta testing a video. To discuss enabling this for your project please contact [[email protected]](mailto:[email protected]). | |
| 494 | + * For more information on the supported styles see `playerStyle` at [https://github.com/beyondwords-io/player/blob/main/doc/player-settings.md]. | |
| 495 | +* "Delete audio" option added into "Bulk actions". | |
| 496 | + | |
| 497 | +**Fixes** | |
| 498 | + | |
| 499 | +* Fixed the "Remove" button for the Inspect panel in Classic Editor. | |
| 500 | +* BeyondWords errors now show in the Classic Editor metabox. | |
| 501 | +* The "Language" and "Voice" selectors now show in the Classic Editor metabox. | |
| 502 | + | |
| 503 | += 4.0.6 = | |
| 504 | + | |
| 505 | +Release date: 7th September 2023 | |
| 506 | + | |
| 507 | +**Fixes** | |
| 508 | + | |
| 509 | +* Always call `setAttributes` for `beyondwordsMarker` in the `editor.BlockEdit` filter. Previously this was only being called when the BeyondWords sidebar panel was open. | |
| 510 | +* Remove the unwanted `blocks.getSaveContent.props` filter. This was doing nothing because the filter name was incorrect (it was a typo for `blocks.getSaveContent.extraProps` which we don't need). | |
| 511 | + | |
| 512 | += 4.0.5 = | |
| 513 | + | |
| 514 | +Release date: 24th August 2023 | |
| 515 | + | |
| 516 | +**Fixes** | |
| 517 | + | |
| 518 | +* Fix reported PHP Warnings by checking that [get_current_screen](https://developer.wordpress.org/reference/functions/get_current_screen/) return value is truthy. | |
| 519 | + | |
| 520 | += 4.0.4 = | |
| 521 | + | |
| 522 | +Release date: 17th August 2023 | |
| 523 | + | |
| 524 | +**Fixes** | |
| 525 | + | |
| 526 | +* Fix an intermittent issue where segment markers are not always assigned to blocks. Our `blocks.registerBlockType` filter now matches [the example in the official WordPress docs](https://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#blocks-registerblocktype). | |
| 527 | +* Hide the audio player widget (the player docked to the bottom of the screen when you scroll) in WordPress admin screens. | |
| 528 | + | |
| 529 | += 4.0.3 = | |
| 530 | + | |
| 531 | +Release date: 4th August 2023 | |
| 532 | + | |
| 533 | +**Fixes** | |
| 534 | + | |
| 535 | +* Cast the return value of [get_the_post_thumbnail_url](https://developer.wordpress.org/reference/functions/get_the_post_thumbnail_url/) to string before sending to the BeyondWords API. This fixes an issue where we were sending boolean `false` as the `image_url` field for posts without a featured image. | |
| 536 | + | |
| 537 | += 4.0.2 = | |
| 538 | + | |
| 539 | +Release date: 3rd August 2023 | |
| 540 | + | |
| 541 | +**Fixes** | |
| 542 | + | |
| 543 | +* Prefix `/languages` and `/voices` endpoints with `/organization` to reflect recent changes in API. This fixes the issue where no languages or voices could be found. | |
| 544 | + | |
| 545 | += 4.0.1 = | |
| 546 | + | |
| 547 | +Release date: 30th July 2023 | |
| 548 | + | |
| 549 | +**Fixes** | |
| 550 | + | |
| 551 | +* Set minimum supported versions to PHP 7.4 and WordPress 5.8. | |
| 552 | +* Fix issue where the audio player was disappearing in Classic Editor when the Player UI setting was "Headless" or "Disabled". | |
| 553 | +* Remove unwanted console logs. | |
| 554 | + | |
| 555 | += 4.0.0 = | |
| 556 | + | |
| 557 | +Release date: 26th July 2023 | |
| 558 | + | |
| 559 | +**Fixes** | |
| 560 | + | |
| 561 | +* Fixed broken "Copy" button in Block editor Inspect panel. | |
| 562 | + | |
| 563 | +**Improvements** | |
| 564 | + | |
| 565 | +* API calls are now made to the new BeyondWords REST API at [api.beyondwords.io](https://api.beyondwords.io). | |
| 566 | +* Custom languages and voices for your audio. [Docs here](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/add-languages?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin). | |
| 567 | +* Our advanced "Latest" audio player is available. [Docs here](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/updating-to-the-latest-player?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin). | |
| 568 | +* Using "Headless mode" you can take advantage of audio processing and the audio CMS whilst building their own front-end players. [Docs here](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/headless-mode?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin). | |
| 569 | +* The following new filters have been added. | |
| 570 | + * [beyondwords_body_params](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_body_params?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin). | |
| 571 | + * [beyondwords_content_id](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_content_id?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin) | |
| 572 | + * [beyondwords_player_script_onload](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_player_script_onload?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin) | |
| 573 | + * [beyondwords_player_sdk_params](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_player_sdk_params?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin) | |
| 574 | + * [beyondwords_post_audio_enabled_blocks](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_post_audio_enabled_blocks?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin) | |
| 575 | + * [beyondwords_project_id](https://docs.beyondwords.io/docs-and-guides/content/connect-cms/wordpress/wordpress-filters/beyondwords_project_id?utm_source=wordpress&utm_medium=referral&utm_campaign=&utm_content=plugin) | |
| 576 | + | |
| 577 | +**Breaking changes** | |
| 578 | + | |
| 579 | +* `beyondwords_podcast_id` is now stored and retrieved as `beyondwords_content_id`. | |
| 580 | + * This should not affect most websites, but if your site has custom PHP that uses the `beyondwords_podcast_id` custom field then you need to update your code to prefer `beyondwords_content_id`. | |
| 581 | + * Existing `beyondwords_podcast_id` post metadata will be updated to `beyondwords_content_id` automatically as each post is queried in WordPress requests. | |
| 582 | +* For WpGraphQL, `beyondwords.podcastId` was defined as type: `Int`. We have changed the type to `String` to support the new ID format (UUID). Your code may need to be updated to handle this change. | |
| 583 | +* Removed built-in WPML support (our compatibility unfortunately failed over time). Support for translation plugins can now be achieved using the following WordPress hooks: | |
| 584 | + * `beyondwords_body_params` | |
| 585 | + * `beyondwords_project_id` | |
| 586 | +* Some older deprecated filters have been removed: | |
| 587 | + * `speechkit_post_types`: Migrate to `beyondwords_post_types` | |
| 588 | + * `speechkit_post_statuses`: Migrate to `beyondwords_post_statuses` | |
| 589 | + * `sk_player_before`: Migrate to beyondwords_js_player_html / beyondwords_amp_player_html | |
| 590 | + * `sk_the_content`: Migrate to `beyondwords_js_player_html` / `beyondwords_amp_player_html` | |
| 591 | + * `sk_player_after` Migrate to `beyondwords_js_player_html` / `beyondwords_amp_player_html` | |
| 592 | + * `speechkit_js_player_html` Migrate to `beyondwords_js_player_html` | |
| 593 | + * `speechkit_amp_player_html` Migrate to `beyondwords_amp_player_html` | |
| 594 | + * `speechkit_post_player_enabled` Migrate to `beyondwords_post_player_enabled` | |
| 595 | + | |
| 5 | 596 | = 3.10.5 = |
| 6 | 597 | |
| 7 | 598 | Release date: 9th June 2023 |
| 8 | 599 | |
