Search Knowledge Base by Keyword

This KB documentation is using Advanced Search, Links Editor and Elegant Layouts add-ons.

Print

Setup WPML for Knowledge Base

Created OnDecember 16, 2018
Updated OnJanuary 12, 2025
By:Dave
5 out Of 5 Stars

1 rating

5 Stars 100%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
Views647

Introduction

Copy the URL link to this section to share

It is important to read the following instructions carefully and complete each step. If you encounter any issues, refer to the troubleshooting tips at the end of this article.

Please Note:

Ensure that you have the latest version of the WPML software installed.

Note: If you have questions about WPML options or encounter errors with WPML plugin please contact their support team. If you have questions or need help with WPML related to KB and its articles and categories, please contact KB support.

For more details on individual functions for WPML and configurations beyond the Knowledge Base, see WPML help:

Warning:

WPML offers many ways to setup a multilingual site. Some configuration options might not work with Echo KB and will not be supported. However, the following configuration has been tested successfully.

Access Manager Not Supported
Note that Access Manager does not support WPML.

Step by Step Instructions

Copy the URL link to this section to share
Step

Enable Polylang or WPML in the Echo Knowledge Base

Copy link to this section: Enable Polylang or WPML in the Echo Knowledge Base

Before configuring your multilingual setup, be sure to enable the "Polylang and WPML" setting in the Knowledge Base (KB). Once the setting is enabled, you can proceed with the rest of your multilingual configuration.

How to Enable Polylang / WPML:

  1. Go to KB Configurations.
  2. Click on the Tools tab.
  3. Select the Other tab.
  4. Toggle on Polylang and WPML. setting.

"

Screenshot showing the KB configurations page with Tools and Other tabs selected, highlighting the toggle switches for Polylang and WPML.
Click to Zoom
Step

WPML Setup Wizard

Copy link to this section: WPML Setup Wizard

To set up WPML on your site for multilingual functionality, follow these steps:

Launch the WPML plugin Setup Wizard – After installing WPML plugin, run its Setup Wizard to begin configuration.

  1. Select Your Default Language – Choose the primary language for your website. In this example, we will use English.
  2. Choose Additional Languages – Pick any other languages you would like to translate your website into. We will use French as an example.
  3. Click “Continue” – Proceed with the rest of the wizard steps to finalize your WPML setup.
WPML setup wizard interface showing default and additional language settings.
Click to Zoom
Step

WPML Setup Wizard - URL Format

Copy link to this section: WPML Setup Wizard - URL Format
  1. Choose Your URL Format
    In this example, we use the “Different languages in directories” option.
  2. Click the Continue Button
    Follow additional on-screen instructions to complete the setup.

Note: If you have selected a different URL format and ran into issues, please contact WPML support. They specialize in troubleshooting their WPML product and can guide you through alternative set ups.

Screenshot of the WPML settings page with “Different languages in directories” selected.
Click to Zoom
Step

WPML Setup Wizard - Plugins

Copy link to this section: WPML Setup Wizard - Plugins

Next, install and activate the WPML String Translation plugin. This plugin is essential for enabling the features outlined in the documentation.

Screenshot showing the WPML String Translation plugin installation in the WordPress dashboard.
Click to Zoom
Step

Creating a French Version of the Knowledge Base Main Page

Copy link to this section: Creating a French Version of the Knowledge Base Main Page
  1. In your WordPress Dashboard, go to All Pages.
  2. Locate the page you created for the Knowledge Base main page. It should display "Knowledge Base #1" beside its name. Click the plus icon (+) to begin adding the French translation.
“WordPress ‘All Pages’ screen highlighting the Knowledge Base #1 entry with a plus icon for translation”
Click to Zoom
Step

Translate all Categories and Tags

Copy link to this section: Translate all Categories and Tags

Translate all English categories into French:

  1. Go to WPML → Taxonomy Translation in your WordPress dashboard.
  2. From the dropdown menu, select Categories. It is usually the last option. Verify that these categories match the ones in your knowledge base. If they don’t, choose the correct option from the list.
  3. Next to each category, click the plus (+) icon to create its French translation.
  4.  

Note: The same steps above are for tags.

WPML Taxonomy Translation screen showing category translation options
Click to Zoom
Step

Translate All Articles

Copy link to this section: Translate All Articles

Translate all English Knowledge Base articles into French.

  1. Go to the All Articles page.
  2. Next to each article, click the plus (+) icon to create its French translation.
Screenshot of the WordPress Knowledge Base interface highlighting the plus icon to create a French translation.
Click to Zoom
Step

Main Page - Slug Translation

Copy link to this section: Main Page - Slug Translation

Update the main page URL slug of your Knowledge Base in WPML:

  1. Go to WPML → Settings.
  2. Scroll down to Post Types Translation. Locate your Knowledge Base slug, which will typically appear in parentheses for example, (epkb_post_type_1). Update the corresponding slug(s) for any additional languages.
  3. Click Save to finalize your changes.
Screenshot showing WPML’s Post Types Translation section with the Knowledge Base slug highlighted.
Click to Zoom
Step

Categories / Tags - Slug Translation

Copy link to this section: Categories / Tags - Slug Translation

Update your Knowledge Base Category URL slug in WPML:

  1. Go to WPML → Settings.
  2. Scroll down to Taxonomies Translation and locate the knowledge base category slug which typically appears as (epkb_post_type_1_category) in brackets. Update the slug for each of your other languages, ensuring they follow the same format as the original. For example, if your main page slug is followed by the category slug in the default language, the translated slugs should mirror this structure.
  3. Click Save to confirm your changes.

 

Note: Follow similar steps above for Tags

Screenshot of WPML Settings page highlighting how to update the Knowledge Base Category URL slug.
Click to Zoom

Main Page String Translation - Blocks

Copy the URL link to this section to share

If you are using the KB Main Page blocks, you must edit each KB Main Page individually to set the block text to specific language. There is no need to use WPML string translations for this process.

Main Page String Translation - Shortcode

Copy the URL link to this section to share

If you are using the KB Main Page shortcode [ epkb-knowledge-base id=1 ] for your main page, these instructions will show you how to translate the associated strings.

Step

Scan for Strings

Copy link to this section: Scan for Strings

To ensure all strings are properly detected and processed by WPML for the next steps, begin by running the Scan strings in themes, plugins, and WordPress function within WPML.

  1. Go to WPML → Theme and Plugins Localization.
  2. Select the Knowledge Base for Documents and FAQs checkbox.
  3. Click Scan selected components for strings.
Screenshot of the WPML interface showing the checkbox for Knowledge Base for Documents and FAQs selected and the button to scan for new strings
Click to Zoom
Step

Main Page String Translation - Search Box

Copy link to this section: Main Page String Translation - Search Box

To translate the text for the search box:

  1. Go to WPML → String Translation.
  2. Locate the string you want to modify.  Click the plus icon to add the translation for your alternate language.

Main Page Search String Translations

  • search_results_msg
  • search_button_name
  • search_box_hint
  • search_title

Article Page Search String Translations

  • article_search_results_msg
  • article_search_button_name
  • article_search_box_hint
  • article_search_title
WPML String Translation interface showing the search box strings.
Click to Zoom
Step

Main Page String Translation - Other Elements

Copy link to this section: Main Page String Translation - Other Elements

To translate the text for Featured Articles and FAQs, navigate to the WPML menu and select "String Translation." Locate the specific string you wish to translate (see the screenshot example for guidance).

Click the plus icon to add the translation for the alternative language.

Click to Zoom

FAQs Translation

Copy the URL link to this section to share

The Knowledge Base (KB) configuration does not currently support managing FAQs for multiple languages within a single FAQ group. As a workaround, create a separate FAQ group for each language and note the group’s unique ID. Then, include the ID for the relevant language’s FAQ group in the shortcode. Finally, place this FAQ shortcode below the main KB shortcode on your page to properly display the FAQ.

  1. French Group Created
  2. English Group Created
  3. FAQs Shortcode with ID to display FAQs groups
Screenshot of separate FAQ groups for each language with the corresponding shortcodes."
Click to Zoom

Above is an example of the KB main page in both English and French, with the FAQ shortcodes displayed beneath each main page.

Click to Zoom

Category Name in KB URL

Copy the URL link to this section to share

If you choose to enable the “Category Name in KB URL” option, you will need to update the relevant string translations in WPML to reflect this change. Please follow these steps:

  1. Navigate to WPML → String Translation.
  2. Locate the URL slug labeled  URL slug: epkb_post_type_1.
  3. Update the string to match the original language’s structure, ensuring it includes /%category% in both instances. This ensures the KB URL structure remains consistent and fully localized for each language.
Screenshot showing the WPML String Translation page with a highlighted URL slug for epkb_post_type_1.
Click to Zoom

Troubleshooting – read before submitting a ticket

Copy the URL link to this section to share

Problem: Category Archive Page shows 404 or nothing found message.

Solution: The category has no articles assigned to it. Assign article to the category or handle case where category has no articles assigned.

Problem: On the All Articles page, if you do not see any KB Articles or are missing KB Articles, you can try to refresh WPML tables.

Solution:

  1. Backup your database
  2. Go to WPML -> Support -> Troubleshooting Page -> click on button called “Set language information”.

Problem: Translations are not working.

Solution: Ensure that you have installed the latest version of WPML plugins.

Problem: Some strings, like those in the Search box, are in English rather than in my default language.

Solution: Ensure that your strings are in the default language in frontened Editor -> Content tab (select the text on the screen right side and edit it in the left sidebar of the Editor).

Problem: For users that did not log-in, the search in one language is not working.

Solution: If the search works for logged in users then enable the following option in WPML languages:

Was this article helpful?
5 out Of 5 Stars

1 rating

5 Stars 100%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Need help?
Tags:
Table of Contents

Copyright © 2024 Echo Plugins. All Rights Reserved.