Skip to content

Commit 8f5147a

Browse files
committed
Update readme.txt with WPML/Polylang compatibility details
1 parent 5e4501f commit 8f5147a

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

readme.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Perfect for:
3636
- __Built-in Breadcrumbs__: Improve UX and SEO with breadcrumb navigation.
3737
- __Widgets Included__: WZKB Articles, WZKB Sections, and WZKB Breadcrumbs widgets.
3838
- __Built-in Caching__: Speed up your Knowledge Base without extra plugins.
39+
- __Multilingual Ready__: Full WPML and Polylang compatibility — translate articles, sections, products, and tags; language-aware caching and widgets included out of the box.
3940

4041
### Pro features
4142

@@ -135,6 +136,20 @@ Yes. You can use the [knowledgebase] shortcode in any page builder. The plugin a
135136

136137
Yes. The plugin includes a built-in search form (via the [wzkb_search] shortcode and a Search block for Gutenberg). The Pro version also adds a floating Help Widget with live search and suggested articles.
137138

139+
= Is it compatible with WPML or Polylang? =
140+
141+
Yes. Knowledge Base has built-in support for both WPML and Polylang:
142+
143+
* **Articles, sections, products, and tags** are all translatable. WPML uses `wpml-config.xml` (bundled with the plugin) for automatic configuration. Polylang auto-detects the public post type and taxonomies.
144+
* **Widgets** (Articles, Sections, Products) translate stored term IDs to the current language automatically, so you can save a term ID in the default language and the widget will display the correct translation.
145+
* **Archive URLs** resolve to the language-aware URL via `get_post_type_archive_link()`, which both WPML and Polylang filter automatically.
146+
* **Caching** is language-aware — cached output is keyed per language so visitors never see content from the wrong locale.
147+
148+
**Known limitations:**
149+
150+
* The Pro Custom Permalinks feature builds URL structures using `home_url()`. With WPML you may need to set the *Language URL format* to *Directory* (e.g. `/en/`, `/fr/`) for custom permalink structures to resolve correctly per language.
151+
* The built-in search form posts to `home_url( '/' )` — this is the standard WordPress search pattern and is handled correctly by both plugins' URL routing.
152+
138153
= How can I report security bugs? =
139154

140155
You can report security bugs through the Patchstack Vulnerability Disclosure Program. The Patchstack team help validate, triage and handle any security vulnerabilities. [Report a security vulnerability.](https://patchstack.com/database/vdp/knowledgebase)

0 commit comments

Comments
 (0)