Register Custom Page Builder Widgets for Translation

Ahmed Mohammed

Updated

November 29, 2023

WPML allows you to register custom page builder widgets for translation using the wpml-config.xml file.

Page builders like Elementor, Beaver Builder, SiteOrigin, and Cornerstone come with a suite of their own widgets. These default widgets work seamlessly with WPML. 

Sometimes, you may create custom widgets intended for use with these or other page builders.

A custom widget is any unique, additional widget that doesn’t come bundled with a page builder. These can be created by your development team, third-party developers, or come from other plugins and themes. 

A custom widget is also any widget that comes from add-on plugins developed specifically for a page builder, like Elementor, by external developers.

On This Page:

• When do I need to register custom widgets for translation?
• How to Register a Custom Elementor Widget for Translation
• How to Find a Widget’s Registration Information
• Registering Simple Widgets
• Registering Widgets with Repeater Fields
• Registering Widgets with Both Simple and Repeater Fields
• Registering Other Types of Page Builder Content
• Additional Resources

When do I need to register custom widgets for translation?

You need to register your custom widget for translation:

• If it’s a widget not originally provided by a page builder
• If you created and added it through another plugin or theme
• If it’s developed for your WordPress websites or a specific page builder by your team or third parties

In the past, the most common way to register custom widgets for translation was using custom PHP code. Now, you can easily register the widget for translation using wpml-config.xml, WPML’s configuration file.

How to Register a Custom Elementor Widget for Translation Using the Multilingual Tools plugin

Our Multilingual Tools plugin includes a WPML – Config Generator for Elementor. This feature allows you to add any custom Elementor widgets you want to register for translation to a page. It then automatically generates the first version of XML code for these custom widgets.

Learn how to register custom Elementor widgets for translation using Multilingual Tools.

How to Find a Widget’s Registration Information

To be able to register a custom widget within the wpml-config.xml file, you first need to find some basic information about it.

You can easily get this information by using a plugin like JSM Show Post Metadata. This plugin shows post metadata and their unserialized values in a metabox at the bottom of post editing pages.

Alternatively, you can use the following steps to get this information:

1. Go to the WPML → Settings page, scroll to the Custom Fields Translation section and click the Show system field link.
2. Set _elementor_data custom field to Translate.
3. Create a new page and add only the Elementor widget you wish to register. Save the page.
4. Go to WPML → Settings and in the Translation Editor section temporarily activate the  Classic Translation Editor option.
5. Try to translate the page you created in Step 3 using the Classic Translation Editor and you’ll notice a serialized array, like this:

6. Copy the content of the serialized array.
7. Use your preferred unserialize tool to better see how the widget is outputting its content. In our case, we used the Unserialize site.

Here is the explanation of the array’s content you will see:

• [widgetType] contains the name inserted in the widget’s tag name attribute.
• The actual fields will be inside an Array and you can find them by searching for [0] which will bring the content of the first element of the array.
• The field value will be the name inside the brackets that will contain the field’s name. For example:[title] => this is a field title. In this case, “title” is the text you need.
• “Items of” will get its value from the element that creates the array. For example: [contents]=> array. In this case, “contents” is the text you need.

Once you have this information, you can proceed with actually registering the widget for translation.

Registering Simple Widgets

The following video walks you through an example of registering a simple Elementor widget:

The following example illustrates how to register a simple widget. A simple widget here means that the widget has no repeater fields.

<wpml-config>
	<elementor-widgets>
		<widget name="heading">
			<conditions>
				<condition key="widgetType">heading</condition>
			</conditions>
			<fields>
				<field type="Heading" editor_type="LINE">title</field>
				<field type="Heading: Link URL" editor_type="LINK">link>url</field>
			</fields>
		</widget>
	</elementor-widgets>
</wpml-config>

Let’s go through the structure of the given example:

1. Start with the <elementor-widgets> tag. This tells WPML which page builder widgets you are going to register. It can be one of these:
   • <elementor-widgets>: this must be used if you’re using Elementor, Elementor PRO or any other Elementor addon.
   • <beaver-builder-widgets>: this must be used if you’re using Beaver Builder Lite, premium Beaver Builder or any other Beaver Builder addon.
   • <siteorigin-widgets>: this must be used if you’re using the SiteOrigin page builder.
   • <cornerstone-widgets>: and this one must be used for Cornerstone page builder that comes with X theme or PRO theme.
2. Add your widgets:
   • <widget name="widget_name"> where widget_name is the name used to register the widget in the page builder.
   • <conditions> (optional): under conditions, you add a condition with a key equal to the widget name. It can be used when the widget name is different from the widget key in the data, but it’s usually not needed.

3. Add the fields of the widgets, wrapping them in a <fields> tag:
   • field: The id of the field. This is the same as the id used when adding a control via the Control_stack::add_control function.
   • type (optional): The type of field. This is the text displayed in the WPML Advanced Translation Editor or Classic Translation Editor to help the translator know what field is being translated.
   • editor_type (optional): This is the type of text field used in the WPML Classic Translation Editor. Valid values are LINE, AREA, LINK, and VISUAL. It defaults to LINE if missing.
   • key_of (optional): This is only used for <field> tags that have an array inside a <fields-in-item> tag. 

You can use these elements to register a simple widget with any number of fields. 

Registering Widgets with Repeater Fields

The following video walks you through an example of registering an advanced Elementor widget with repeater fields:

For the widgets that have repeater fields, you need to wrap the fields in <fields-in-item items_of="tabs"> tag (where tabs is the name of the widget with repeated fields). Check out this example:

<widget name="accordion">
	<fields-in-item items_of="tabs">
		<field type="Accordion: Title" editor_type="LINE">tab_title</field>
		<field type="Accordion: Content" editor_type="VISUAL">tab_content</field>
	</fields-in-item>
</widget>

In some cases, the widget can have multiple repeater fields. Consider the following data structure from the Table widget from Ultimate Addons for Elementor as an example:

To register this widget, please see the following example:

<widget name="uael-table">
	<fields-in-item items_of="table_content">
		<field type="The Cell text" editor_type="LINE">cell_text</field>
	</fields-in-item>
	<fields-in-item items_of="table_headings">
		<field type="The Heading text" editor_type="LINE">heading_text</field>
	</fields-in-item>
</widget>

Registering Widgets with Both Simple and Repeater Fields

Note, widgets can have both types: fields and fields-in-item. Check out this example for a widget that uses both:

<widget name="price-table">
	<fields>
		<field type="Price Table: Heading" editor_type="LINE">heading</field>
		<!-- ... -->
	</fields>
	<fields-in-item items_of="features_list">
		<field type="Price table: text" editor_type="LINE">item_text</field>
	</fields-in-item>
</widget>

Registering Other Types of Page Builder Content

See our documentation on registering page builder content in your language configuration file for more on registering strings, shortcodes, and more.

Additional Resources

To learn more about the wpml-config.xml file, visit the Language Configuration Files guide.

For customizing other elements using the wpml-config.xml file, visit our additional guides:

• Set Translation Options for Custom Fields Using WPML Configuration File
• Register Custom Terms, Types & Taxonomies as Translatable
• Make Custom Gutenberg Blocks Translatable
• Translate Texts that Theme and Plugins Save in wp_options
• Customize WPML Language Switcher Using WPML Configuration File