This document is intended for developers that want to translate their shortcode-based page builders using WPML. We use Visual Composer as an example, but you may use the same technique stated below to add support for any page builder that uses shortcodes.
How to obtain the WPML plugin?
First, you will need to have an account on WPML.org. If you do not have one yet and you are a theme or plugin developer, contact our Go Global program and receive your complimentary account and assistance.
Received your account? Next, install WPML, Translation Management, and String Translation.
* Support for translating page builders is new in WPML version 3.6.0. If you are using an older version of WPML, please update first.
How it works?
Let us create an example page using the page builder. We use Visual Composer for this example. You may use your own shortcode-based page builder.
Create a new WordPress page and design it using the builder. Include elements that have text that needs translation. Most builders have ‘text’ elements. Other elements include text attributes, like ‘title’.
The following is an example page that we have created using Visual Composer. It uses a text cell and other different types of cells with textual attributes.
When we look at the source of the page (in the HTML mode), we can see the shortcodes that make up the page design and texts.
Our objective is to configure WPML to find these texts in the page source.
Creating a language configuration file for your page builder
Fortunately, WPML can extract texts for translation from pages that you design with page builders (which use shortcodes). We only need to configure WPML to identify which shortcodes and attributes contain texts that require translation. We do this using a file called wpml-config.xml, which needs to be placed in the root folder of your theme or plugin.
This language configuration file can also be used to guide WPML on other things about your theme or plugin.
As an example, see the Visual composer language configuration file that we have created:
<wpml-config> <shortcodes> <shortcode> <tag>vc_column_text</tag> </shortcode> <shortcode> <tag>vc_text_separator</tag> <attributes> <attribute>title</attribute> </attributes> </shortcode> … </wpml-config>
There is an entry for every shortcode that you want WPML to identify. Therein, there is an entry for attributes that contain text.
In the example above, WPML extracts texts from shortcodes such as:
[vc_column_text]Some text for translation[/vc_column_text]
[vc_text_separator title=”some text for translation”]
You know which shortcodes your builder uses and which attributes have text that requires translation. Create the XML file to match these shortcodes and their attributes. When the XML file is ready, save it in the root folder of your theme or plugin. You have to name the file wpml-config.xml.
After you create or update the wpml-config.xml file for your theme or plugin, you need to force WPML to load it. Disable the theme/plugin and enable it. WPML loads the config files when the themes and plugins are activated or updated.
Translating pages created with the page builders
Once you have created the wpml-config.xml file, you should test the translation of content created with your page builder.
Watch the following video for an overview of the translation process with the Visual Composer example.
First, you need to configure WPML to use the Translation Editor (which offers support for page builders). After you have installed the required plugin (WPML, Translation Management, String Translation) and fully configured WPML, go to WPML -> Translation Management -> Multilingual Content Setup. There, select the option “Use the translation editor” under the How to translate posts and pages section and Save.
Now, you are ready to translate.
- Create a WordPress page and design it with your builder. Save the page.
- When editing the page, click on the + icon under the language box (this creates a new translation).
- Now, you can see the translation editor screen. You should see fields for each of the texts in the page that you created. There will always be a ‘title’ field and there should be fields for each of the text elements in the page-builder design.
- Add your translated texts to the fields and choose the Translation is complete option.
- Click on the Save & Close button.
In the page editor, the + icon should change to a ‘pencil’ icon, indicating that the translation is complete (and you can now edit it).
You can see the translated page by visiting the page on the front-end and switching the page’s language.
Let us edit the page to see how the translation works. In the admin bar, click on ‘Edit page’. Then, go to the HTML mode to see the page source.
Distributing your page builder with WPML support
If your page builder uses shortcodes, the only thing that you need to add to it is the wpml-config.xml file. This file does nothing if WPML is not active. It tells WPML how to translate pages created using your builder.
You are welcome to receive help from the WPML compatibility team (use the contact you received from the Go Global program). You are free to use our general support forum as well.
We are also working on adding compatibility with page builders that do not use shortcodes. Please contact us for more details and availability of development versions.