WPML Hooks Reference

Filters the list of the languages enabled (active) for a site. This filter is usually used to create custom language switchers.

This filter can only work when the global $wp_query object has been instantiated. This means that it should be called after the wp action happens.

WPML returns a site’s active (enabled) languages as an array with relative information per language. For example, for a WordPress site running English, French and Italian, the hook will return this:

Array
(
 [en] => Array
  (
   [id] => 1
   [active] => 1
   [default_locale] => en_US
   [native_name] => English
   [missing] => 0
   [translated_name] => English
   [language_code] => en
   [country_flag_url] => http://yourdomain/wpmlpath/res/flags/en.png
   [url] => http://yourdomain/about
  )

 [fr] => Array
  (
   [id] => 4
   [active] => 0
   [default_locale] => fr_FR
   [native_name] => Français
   [missing] => 0
   [translated_name] => French
   [language_code] => fr
   [country_flag_url] => http://yourdomain/wpmlpath/res/flags/fr.png
   [url] => http://yourdomain/fr/a-propos
  )

 [it] => Array
  (
   [id] => 27
   [active] => 0
   [default_locale] => it_IT
   [native_name] => Italiano
   [missing] => 0
   [translated_name] => Italian
   [language_code] => it
   [country_flag_url] => http://yourdomain/wpmlpath/res/flags/it.png
   [url] => http://yourdomain/it/circa
  )
)

The wpml_active_languages filter provides a way to do things like reorder the language array. Or something more complex, like redirecting missing languages to a custom url.

apply_filters( 'wpml_active_languages', mixed $empty_value, array|string $args )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$args

(array|string) (Optional) Arguments to filter the language output

• skip_missing(bool) How to treat languages with no translations. 1 to skip language or 0 to link to home of language for missing translations.
• link_empty_to(string) Works in conjunction with skip_missing = 0 and allows using custom links for the languages that do not have translations for the current element. {%lang} can be used as placeholder for the language code. Empty by default.
• orderby(string) Accepts id|code|name Defaults to custom. The custom order can be defined in the WordPress admin under WPML » Languages » Language Switcher Options
• order(string) Accepts asc|desc

The filter’s arguments can be passed to it as a string as shown in the first example below. They can also be passed as an array as you can see in the second example further down.

In the example below we display a flag only language switcher. However, there is a small difference to the flag-only language switcher you can configure from your “WPML language settings” in the admin backend.

The difference here is that the current language will not be wrapped inside an anchor. Only the page’s alternative languages will have a link. Have a look.

function my_flag_only_language_switcher() {
    $languages = apply_filters( 'wpml_active_languages', NULL, 'orderby=id&order=desc' );

    if ( !empty( $languages ) ) {
        foreach( $languages as $l ) {
            if ( !$l['active'] ) echo ' <a href="' . esc_url( $l['url'] ) . '">';
            echo '<img src="' . esc_url ( $l['country_flag_url'] ) . '" height="12" alt="' . esc_attr( $l['language_code'] ) . '" width="18" />';
            if ( !$l['active'] ) echo '</a> ';
        }
    }
}

In the next example you see below, we redirect missing languages to a custom page where we display a contact form for people to notify the site admin of untranslated content.
We also capitalize the language name of the active language i.e. the language we are currently viewing, using PHP’s strtoupper function.

function my_custom_language_switcher() {
    $languages = apply_filters( 'wpml_active_languages', NULL, array( 'skip_missing' => 0, 'link_empty_to' => 'http://domain.com/missing-translation-contact-form' ) );

    if( !empty( $languages ) ) {
        foreach( $languages as $language ){
			$native_name = $language['active'] ? strtoupper( $language['native_name'] ) : $language['native_name'];

            if( !$language['active'] ) echo '<a href="' . esc_url( $language['url'] ) . '">';
            echo esc_html( $native_name ) . ' ';
            if( !$language['active'] ) echo '</a>';
        }
    }
}

• Run your custom functions right after switching the global current language in WordPress queries.
• To change the current language, use the wpml_switch_language hook.

add_action( 'wpml_language_has_switched', callable $function_to_add );

$function_to_add

(callable) (Required) Your callback to be run when the filter is applied.

• Get trid (the ID of the translation group) of a translated element, which is required for the  wpml_get_element_translations filter and others which expect this argument.
• Learn more about trid on the WPML’s tables documentation page.

apply_filters( 'wpml_element_trid', mixed $empty_value, integer $element_id, string $element_type)

$empty_value

(mixed) (Required) This is usually the value the filter will be modifying. We are not filtering anything here so set this to NULL. This is needed for the filter function to actually receive the full argument list.

$element_id

(integer) (Required) The ID of the item (post_id for post types, term_taxonomy_id for taxonomy terms).

$element_type

(string) (Optional) The type of an element. Can be a post type: post_post, post_page, post_attachment, post_nav_menu_item, post_{custom post key} or taxonomy: tax_category, tax_post_tag, tax_nav_menu, tax_{custom taxonomy key}. Defaults to post_post if not set.

• Get the element translations info using trid (the ID of the translation group).
• trid can be retrieved by the wpml_element_trid filter.
• Learn more about this on the WPML’s tables documentation page.

apply_filters( 'wpml_get_element_translations', mixed $empty_value, integer $trid, string $element_type)

$empty_value

(mixed) (Required) This is usually the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list.

$trid

(integer) (Required) The ID of the translation group.

$element_type

(string) (Optional) The type of an element. Can be a post type: post_post, post_page, post_attachment, post_nav_menu_item, post_{custom post key} or taxonomy: tax_category, tax_post_tag, tax_nav_menu, tax_{custom taxonomy key}. Defaults to post_post if not set.

Displays the language selector as configured on the WPML -> Languages page.

do_action( 'wpml_language_switcher', $args, $twig_template_string );

This action hook has two optional parameters and works as a {{wpml_language_switcher}} shortcode.

$args

(array) (Optional) Arguments to filter the language switcher output

• type – Define the language switcher type – footer, post_translations, widget or custom (default).
• flags (alias for display_flags) – Use 1 to display flags and 0 not to.
• link_current (alias for display_link_for_current_lang ) – Use 1 to display flags and 0 not to.
• native (alias for display_names_in_native_lang ) – Use 1 to display flags and 0 not to.
• translated (alias for display_names_in_current_lang ) – Use 1 to display flags and 0 not to.
• template – The template slug if it needs to be overwritten. Otherwise it will be defined by the type .

$twig_template_string

(string) (Optional)  a Twig template string

Add the code below to your theme template files, where you want the language switcher to be displayed at.

Example

do_action( 'wpml_language_switcher', $args, $twig_template_string );

If you prefer, you can also add the above code line in a PHP widget like PHP Text Widget.

This filter is used when the theme developer wants to use a custom JavaScript for handling the browser redirection.

This filters a boolean set to true by default.
If the filter returns false, the JavaScript which takes care of redirecting the visitor won’t be enqueued.
The filter is applied only if the wpml_browser_redirect_language_params filter returns a valid $param (pageLanguage and languageUrls must be set).

pageLanguage – defines a language for the page

languageUrls – an array that contains pairs of languages and URLs to which browser should be redirected

In order to use this filter Browser language redirect must be enabled on the WPML -> Languages.

The following code can be used to disable the redirect feature on a specific page:

function example( $enqueue ) {
	global $post;
	// Do not enqueue the scripts if the page ID is 123
	if ( $post->ID === 123 ) {
		$enqueue = false;
	}
	return $enqueue;
}
add_filter( 'wpml_enqueue_browser_redirect_language', 'example' );

Returns TRUE is the current language is RTL

apply_filters( 'wpml_is_rtl', mixed $empty_value )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

This hook is executed at the end of the browser redirection PHP logic, after the wpml_browser_redirect_language_params and wpml_enqueue_browser_redirect_language filters. Despite its name, the action is fired even if wpml_enqueue_browser_redirect_language returns true.

$enqueued

bool If true the script has been enqueued

$params

array Data with values, $pageLanguage, $languageUrls and $cookie.

$pageLanguage string

The language of the current page.

$languageUrls array

Associative array where the key is the language code and the values are the translated URLs of the current page.

cookie

Stores an associative array with the cookie settings. Please refer to Document.cookie for more details. The keys are:

• name: the name of the cookie (defaults to _icl_visitor_lang_js).
• domain: the domain in which the cookie must be used (defaults to the current domain and is not meant to be changed).
• path: the path of the cookie (defaults to /).
• expiration: the expiration in seconds is read from the value set in Remember visitors’ language preference that can be found in Browser language redirect on the WPML -> Languages.

function override_browser_redirect( $enqueued, $params ) {
    if ( ! $enqueued ) {
        // E.g.: A script which uses IP geolocalization
        wp_enqueue_script( 'my-custom-script', 'url/to/custom.script.js' );
        
        // Pass the `$params` array to the script, so it can use it to find the best match
        wp_localize_script( 'my-custom-script', 'params', $params );
    }
}

add_action( 'wpml_enqueued_browser_redirect_language', 'override_browser_redirect', 10, 2 );

Custom fields can be encoded in a format that WPML does not understand. Those fields have to be decoded and encoded before WPML can translate them. To achieve this, the wpml_decode_custom_field and wpml_encode_custom_field filters must be used. These filters can be used if there is additional custom encoding besides the ones already handled by WPML.

apply_filters( $custom_field_val, $custom_field_name )

$custom_field_val

Value contained within field that needs to be encoded

$custom_field_name

Name of the field that needs to be encoded

Custom fields can be encoded in a format that WPML does not understand. Those fields have to be decoded and encoded before WPML can translate them. To achieve this, the wpml_decode_custom_field and wpml_encode_custom_field filters must be used. These filters can be used if there is additional custom encoding besides the ones already handled by WPML.

apply_filters( $custom_field_val, $custom_field_name )

$custom_field_val

Value contained within field that needs to be decoded

$custom_field_name

Name of the field that needs to be decoded

Echoes an HTML hidden input field with name=”lang” and as value the current language.

In order to add a search form to your theme you would normally use the standard WordPress template tag: get_search_form()
If you are making use of the default WordPress search form, you do not need to edit anything. WPML will handle the rest.

However, there may be times when get_search_form() can’t be used. If you are creating a custom search form and you need to make it WPML compatible then this action hook is what you need.

do_action( 'wpml_add_language_form_field' )

This action hook does not have any parameters.

Add the code below inside your search form code.

// Return the HTML code for the current language Spanish
// <input type='hidden' name='lang' value='es' />
do_action( 'wpml_add_language_form_field' );

Displays the horizontal footer language selector as configured from the “WPML->Languages” admin screen

do_action( 'wpml_footer_language_selector' )

This action hook does not have any parameters.

Add the code below to your theme template files, where you want the language switcher to be displayed at.

do_action( 'wpml_footer_language_selector' );

If you like you can also add the above code line in a PHP widget like PHP Text Widget

This filter can be used when the theme developer wants to use a different cookie name or tweak the languageUrls array to use different URLs.

It uses the $params argument which is an associative array containing some information about the current language, the active languages and the cookie settings.

pageLanguage

Stores the current language code.

languageUrls

Stores an associative array containing all the current page’s translation URLs. The keys of the array are the language codes. The same language can have multiple entries to match a different combination of language codes. For instance, in the case of en_US, the same URL is repeated three times with the following keys: en_us, en, and us.

cookie

Stores an associative array with the cookie settings. Please refer to Document.cookie for more details. The keys are:

• name: the name of the cookie (defaults to _icl_visitor_lang_js).
• domain: the domain in which the cookie must be used (defaults to the current domain and is not meant to be changed).
• path: the path of the cookie (defaults to /).
• expiration: the expiration in seconds is read from the value set in Remember visitors’ language preference that can be found in Browser language redirect on the WPML -> Languages.

In order to use this filter Browser language redirect must be enabled on the WPML -> Languages.

Following code can be used to redirect browser to homepage for a post when language is changed to specific one

function example_callback( $params ) {
	global $post;
	// Redirect the French language to the home page if the current page ID is 123
	if ( $post->ID === 123 ) {
		$params['pageLanguage'] = 'en';
		$params['languageUrls'] = [ 'fr' => 'http://example.com/fr/' ];
	}
	return $params;
}
add_filter( 'wpml_browser_redirect_language_params', 'example_callback' );

Displays the drop down language selector as configured from the Custom language switchers section found on WPML → Languages.

do_action( 'wpml_add_language_selector' )

This action hook does not have any parameters.

Add the code below to your theme template files, where you want the language switcher to be displayed at.

do_action( 'wpml_add_language_selector' );

If you like you can also add the above code line in a PHP widget like PHP Code Widget

This filter can block WPML from translating the canonical URL. If the filter returns false WPML will use the WP SEO canonical URL.

$should_translate_canonical_url = apply_filters( 'wpml_must_translate_canonical_url', true, $post_element );
if ( ! $should_translate_canonical_url ) {
	return $canonical_url;
}

This filter receives the list of languages as input.

$languages = $this->sitepress->get_ls_languages( array( 'skip_missing' => true ) );
$languages = apply_filters( 'wpml_head_langs', $languages );

Returns the default language

apply_filters( 'wpml_default_language', mixed $empty_value )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

Returns the current language

apply_filters( 'wpml_current_language', mixed $empty_value )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

A basic example

 $my_current_lang = apply_filters( 'wpml_current_language', NULL ); 

Creating a shortcode to return the current language

function get_language_shortcode() {
    return apply_filters( 'wpml_current_language', null );
}
add_shortcode( 'language', 'get_language_shortcode' );

Returns the translated name of a language in another specified language.

*Note: The languages involved do not need to be active for the site

apply_filters( 'wpml_translated_language_name', mixed $empty_value, string $lang_code, string $display_code )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$lang_code

(string) (Required) The language name will be for this language. Accepts a 2-letter code e.g. en

$display_code

(string|bool) (Optional) The language name will display translated in this language. Accepts a 2-letter code e.g. de. If set to false it will return the translated name in the current language. Default is FALSE.

This filter receives the URL to be filtered, as well as the corresponding language code.

$alternate_hreflang = apply_filters( 'wpml_alternate_hreflang', $lang['url'], $lang['code'] );

To filter the HTML of the produced set of link tags with you can use the following code:

foreach ( $hreflang_items as $hreflang_code => $hreflang_url ) {
	$hreflang .= '<link rel="alternate" hreflang="' . esc_attr( $hreflang_code ) . '" href="' . esc_url( $hreflang_url ) . '" />' . PHP_EOL;
}
echo apply_filters( 'wpml_hreflangs_html', $hreflang );

Returns TRUE or FALSE if a given language has been enabled.

apply_filters( 'wpml_language_is_active', mixed $empty_value, string $language_code )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$language_code

(string) (Required) The language code to check. Accepts a 2-letter code like ‘en’

Some themes load certain menus, such as mobile menus, using AJAX. WPML does not include the language switcher in this case. This filter allows theme authors to add a language switcher to their AJAX-loaded menus.

$isExcluded

bool Exclude the language switcher from the menu.

Run your custom function when a new language is added or deleted.

add_action( 'wpml_update_active_languages', callable $function_to_add );

$function_to_add

(callable) (Required) Your callback function to run on this action.

• Returns the ID of the original language post or page when given the ID of its translation.

apply_filters( 'wpml_original_element_id', mixed $empty_value, integer $element_id, string $element_type)

$empty_value

(mixed) (Required) This is usually the value the filter will be modifying. We are not filtering anything here so set this to NULL. This is needed for the filter function to actually receive the full argument list.

$element_id

(integer) (Required) The ID of the item (post_id for post types, term_taxonomy_id for taxonomy terms).

$element_type

(string) (Optional) The type of an element. Can be a post type: post_post, post_page, post_attachment, post_nav_menu_item, post_{custom post key} or taxonomy: tax_category, tax_post_tag, tax_nav_menu, tax_{custom taxonomy key}. Defaults to post_post if not set.

Example

// Get the original post ID of a translated page.
$original_id = apply_filters( 'wpml_original_element_id', NULL, 6, 'post_page' );

Checks if the native name of a language and the translated name of the same language are different. If so, it returns them both. Otherwise, it returns only one.
This filter is usually used in custom language switchers.

apply_filters( 'wpml_display_language_names', mixed $empty_value, string $native_name, string|bool $translated_name, bool $lang_native_hidden, bool $lang_translated_hidden )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$native_name

(string) (Required) The language native name

$translated_name

(string|bool) (Required) The language translated name Defaults to FALSE

$lang_native_hidden

(bool) (Optional) Default is FALSE 0|false or 1|true Whether to hide the language native name or not

$lang_translated_hidden

(bool) (Optional) Default is FALSE 0|false or 1|true Whether to hide the language translated name or not

function my_footer_languages_list(){
    $languages = apply_filters( 'wpml_active_languages', NULL, 'skip_missing=0&orderby=code' );
    if( !empty( $languages ) ){
        echo '<div id="footer_language_list"><ul>';
        foreach( $languages as $l ){
            echo '<li>';
            if( $l['country_flag_url'] ){
                if( !$l['active'] ) echo '<a href="'.$l['url'].'">';
                echo '<img src="'.$l['country_flag_url'].'" height="12" alt="'.$l['language_code'].'" width="18" />';
                if( !$l['active'] ) echo '</a>';
            }
            if(!$l['active']) echo '<a href="'.$l['url'].'">';
            echo apply_filters( 'wpml_display_language_names', NULL, $l['native_name'], $l['translated_name'] );
            if( !$l['active'] ) echo '</a>';
            echo '</li>';
        }
        echo '</ul></div>';
    }
}

The example function above does the following:

1. If there are any languages, it creates a DIV and starts an unordered list
2. Then it loops through each of the languages and adds it as a list item.
   If the language is not the active language, it adds a link to the translated page for that language
3. It then adds the language flag
4. Finally, it adds both the native and translated language names if they’re different

Retrieve language information of a post by its ID.

The language information that is returned includes:

• the post language 2-letter code,
• the post locale,
• the language text direction (True for RTL, False for LTR),
• the post language translated name and native name and
• whether the current language is different to the post language (True/False)

apply_filters( 'wpml_post_language_details', mixed $empty_value, int $post_id )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$post_id

(int) (Optional) The post id to retrieve information of (post, page, attachment, custom post) Defaults to current post ID.

In the example below we use the filter to retrieve the language information for the “Hello World” post.
The original language of the post is English and we have translated it to German.

$my_post_language_details = apply_filters( 'wpml_post_language_details', NULL, 1 ) ;

The above will return the following on the English version of the site:

array (
 'language_code' => 'en',
 'locale' => 'en_US',
 'text_direction' => false,
 'display_name' => 'English',
 'native_name' => 'English',
 'different_language' => false,
)

If we switch to the German version of the site we will see the following:

array (
 'language_code' => 'de',
 'locale' => 'de_DE',
 'text_direction' => false,
 'display_name' => 'German',
 'native_name' => 'Deutsch',
 'different_language' => true,
)

This action hook allows controlling the language in WordPress queries. It overrides the WPML language global variable used to filter database query requests.

Note: The action hook must be passed to the pre_get_posts WordPress hook. Use with caution since it affects the WPML language variable globally. To avoid unexpected results, use the hook in combination with WordPress conditional tags to only alter the specific query on the page you want.

do_action( 'wpml_switch_language', string $language_code )

$language_code

(string) (Required) The 2-letter language code to switch to. If set to null it restores the original language. If set to ‘all’ it will query content from all active languages. Defaults to null

In the example below, please note the use of conditional tags to control the specific WordPress query we want. For additional information on the use of conditionals please refer to the pre_get_posts page in the WordPress Codex.

// using the hook on a custom query on the WordPress index front end page
function my_custom_something($query) {
    if ( !is_admin() && is_index() && !$query->is_main_query() ) {
        do_action( 'wpml_switch_language', "de" );
    }
}
add_action('pre_get_posts', 'my_custom_something');

This filter hook will retrieve the language code for a translatable element by querying WPML’s icl_translations database table.

Also look at wpml_element_language_details if you are interested in more information such as the element’s trid

apply_filters( 'wpml_element_language_code', string $language_code, array $args )

$language_code

(string) (Required) A 2-letter language code. Defaults to null.

$args

(array) (Required) An array of arguments to be used.

• element_id(bool) Use term_taxonomy_id for taxonomies, post_id for posts
• element_type(string) The type of element to check. Can be a post type: post, page, attachment, nav_menu_item, {custom post key} or taxonomy: category, post_tag, nav_menu {custom taxonomy key}

This filter hook will retrieve language information for a translatable element. It queries WPML’s icl_translations database table and returns an object with the element’s trid, source language code and language code.

If you are only looking for the element’s language code you might prefer to use wpml_element_language_code

apply_filters( 'wpml_element_language_details', object $element_object, array $args )

$element_object

(object) (Required) A WordPress object. Defaults to null.

$args

(array) (Required) An array of arguments to be used.

• element_id(bool) Use term_taxonomy_id for taxonomies, post_id for posts
• element_type(string) The type of element to check. Can be a post type: post, page, attachment, nav_menu_item, {custom post key} or taxonomy: category, post_tag, nav_menu {custom taxonomy key}

Restore the language that was active before calling wpml_switch_language_for_email.

See wpml_switch_language_for_email

This action hook switches the language of your emails to the user’s preferred language. This is helpful when you need to send emails in different languages. Make sure to reset the language back by using wpml_restore_language_from_email. Also, see the extended documentation: Sending Emails with WPML.

If the given email is not registered, nothing will happen.

$email
(string) The user email.

Returns the home url in the current language. To be used in place of get_option('home')

* Note: Good code will make use of get_home_url() or home_url() which apply filters natively. In this case there is no need to replace anything.

apply_filters( 'wpml_home_url', string $home_url )

$home_url

(string) (Required) The home url from get_option('home')

$my_home_url = apply_filters( 'wpml_home_url', get_option( 'home' ) );
<a href="<?php echo $my_home_url; ?>">Home</a>

The example above will return http://siteurl/ for the default language as we would expect.
Then when we switch to a secondary language, i.e. German, the url will adjust and display as http://siteurl/de

• Gets the post type or taxonomy slug translation in a specific language.
• The translation value is saved in WPML → Settings → Post Types Translation.

$translated_slug = apply_filters( 'wpml_get_translated_slug', string $slug, string $post_type, string $language_code, string $element_type );

$slug

(string) (Required) The value is set in the rewrite argument of the register_post_type function.

$post_type

(string) (Required) The first parameter value of the register_post_type or register_taxonomy function.

$language_code

(string) (Optional) Return the translation in this language. The default is NULL which returns the current language.

$element_type

(string) (Optional) Specifies if the translated slug applies to a custom post type or custom taxonomy. Accepted values are post or taxonomy. The default is post.

This filter hook can be used to retrieve elements without translations

apply_filters( 'wpml_elements_without_translations', array $element_ids, array $args )

$element_ids

(array) (Required) An array of element ids. Defaults to an empty array.

$args

(array) (Required) An array of arguments to be used.

• target_language(bool) The target language code. A 2-letter code
• source_language(bool) The source language code. A 2-letter code
• element_type(string) The type of element to check. Can be a post type: post, page, attachment, nav_menu_item, {custom post key} or taxonomy: category, post_tag, nav_menu {custom taxonomy key}

In the example below we want to find out which blog posts have not yet been translated into Greek.
Note how as first argument we pass an array of post ids so that if WPML is not active we will get that back.

$get_post_args = array( 'posts_per_page' => -1, );
$posts_array = get_posts( $get_post_args );
$post_ids = array();
foreach ( $posts_array as $post ) {
	$post_ids[] += $post->ID;
}

$wpml_filter_args = array(
'element_type' => 'post',
'source_language' => 'en',
'target_language' => 'el'
);
$posts_without_greek_translations = apply_filters( 'wpml_elements_without_translations', $post_ids, $wpml_filter_args );

Filters a WordPress permalink and converts it to a language-specific permalink based on the language URL format set in the WPML language settings.

This means that when “Language URL format” is set to “Different languages in directories” the permalink will be returned in the http://domain.com/de form. When “A different domain per language” is selected the permalink will be converted to include the correct domain assigned to the requested language.

Example 1

For example, if we have “Different languages in directories” selected, we can use the following code:

// will return http://domain.com/de/contact
$wpml_permalink = apply_filters( 'wpml_permalink', 'http://domain.com/contact', 'de' );	

Example 2

We have a page http://example.org/hello/ and its translation http://example.org/fr/bonjour/. Let’s say we are calling the filter while we are displaying the home page http://example.org.

// displays http://example.org/fr/hello/ (wrong)
echo apply_filters( 'wpml_permalink', 'http://example.org/hello/', 'fr' ); 

// displays http://example.org/fr/bonjour/ (correct)
echo apply_filters( 'wpml_permalink', 'http://example.org/hello/', 'fr', true ); 

Important notes about the second example:

• The full resolution is a heavy process, so WPML has to persist the resolved URLs in the database. The first call to wpml_permalink should significantly increase the database queries and load time. But the subsequent calls should not overload the process.
• The database persistence is partially cleared when post/terms are updated or deleted. And it’s fully cleared when visiting Settings -> Permalinks (this is a good troubleshooting option in case you encounter any issues).
• In case the URL could not be resolved, the filter wpml_permalink will return the original URL.

Returns a post type link or taxonomy term link in the current language.

* Note: There are alternative ways to retrieve an element’s link which gives developers fuller control over the HTML output.
WordPress offers a number of functions to do this such as get_permalink(), get_term_link(), etc.

If you plan on using functions that require a post type or term ID as a parameter then you may be interested in looking into the wpml_object_id filter.

apply_filters( 'wpml_element_link', int $element_id, string $element_type, string $link_text, array $optional_parameters, string $anchor, bool $echo, bool $return_original_if_missing )

$element_id

(int) (Required) The ID of the post type (post, page, attachment, custom post) or taxonomy term (tag, category, custom taxonomy) to link to

$element_type

(string) (Optional) The type of element to link to. Can be ‘post’, ‘page’, ‘attachment’, ‘{custom post}’, ‘tag’, ‘category’, ‘{custom taxonomy}’. Defaults to ‘post’

$link_text

(string) (Optional) The link text. Defaults to the element’s name

$optional_parameters

(array) (Optional) Arguments for the link

$anchor

(string) (Optional) Anchor for the link

$echo

(bool) (Optional) 0|false to return or 1|true to echo the localized link. Defaults to true

$return_original_if_missing

(bool) (Optional) If set to true it will always return a value (the original value, if translation is missing). Default is TRUE

*Retrieves an individual (as opposed to a string that is part of a package**) text string translation. The filter looks for a string with matching $domain and $name. If it finds it, it looks for a translation in the current language or the language you specify. If a translation exists, it will return it. Otherwise, it will return the original string.

*To register a string for translation please see: wpml_register_single_string
**For retrieving a string translation that is part of a package please see: wpml_translate_string

Note: This hook requires the WPML String Translation module

apply_filters( 'wpml_translate_single_string', string $original_value, string $domain, string $name, string $language_code )

$original_value

(string) (Required) The string’s original value

$domain

(string) (Required) The string’s registered domain

$name

(string) (Required) The string’s registered name

$language_code

(string) (Optional) Return the translation in this language. Default is NULL which returns the current language

We pick up the same example of the widget we used for the“wpml_register_single_string” action hook. You may want to go there to refresh your memory. We use the “wpml_translate_single_string” filter in the widget’s output function

function widget($args, $instance){
        extract($args);
        $title               = apply_filters('widget_title', $instance['title'] );
        $custom_input        = apply_filters('wpml_translate_single_string', $instance['custom_input'], 'Widgets', 'Custom Widget - input field' );
        $custom_textarea     = apply_filters('wpml_translate_single_string', $instance['custom_textarea'], 'Widgets', 'Custom Widget - textarea field' );

        # Before the widget
        echo $before_widget;

        # The title
        if ( $title )
        echo $before_title . $title . $after_title;

        # Output...

WPML String Translation filters theme/plugin setting options in order to return translations of their values in the current language.
This means that on a WordPress installation with WPML languages set for example to English as primary and German as secondary language, you can expect the German translations to be the values retrieved when calling:get_option('{theme_name}_settings'); while the current language is German. Then while the current language is English, the English values will be displayed.

This also means however, that when an option value is updated with: update_option('{theme_name}_settings', $new_value); the option value will be updated in both languages. This may not be always desirable.

This is where the above filter is helpful. The filter allows retrieving an option value by-passing WPML String Translation filters. What is returned is the value in the language it is retrieved in so that further operations taken such as updating it the value in the database will not affect languages other than the one you are working with.

apply_filters( 'wpml_unfiltered_admin_string', mixed $default_value, string $option_name )

$default_value

(mixed) (Required) The value to return in case the string does not exist

$option_name

(string) (Optional) The name of the option to retrieve. A non SQL-escaped name is expected.

For the example that follows below, imagine you are viewing a language other than the default.
The option value you are retrieving is saved as a serialized array. You want to update a single key-value pair in the array and save it to the database. You expect that only the current language will be affected.

// retrieve option value is current language
$a = apply_filters( 'wpml_unfiltered_admin_string', get_option( 'my_option_name' ), 'my_option_name' );

// some operations ...
$a['number']++;

//update the value for the current language only
update_option('my_option_name', $a); 	

Returns an element’s ID in the current language or in another specified language.

By default, WPML automatically adjusts IDs to display all theme elements in the current language. This setting is turned “on” by default under the WPML → Languages page. But, if you’re building your own theme from scratch, use the wpml_object_id function to manually adjust IDs. This approach is more efficient in terms of processing.

apply_filters( 'wpml_object_id', int $element_id, string $element_type, bool $return_original_if_missing, mixed $ulanguage_code )

$element_id

(int) (Required) The ID of the post type (post, page, attachment, custom post) or taxonomy term (tag, category, custom taxonomy) to filter

$element_type

(string) (Required) The type of element the ID belongs to. Can be post, page, {custom post type key}, nav_menu, nav_menu_item, category, post_tag, {custom taxonomy key}

$return_original_if_missing

(bool) (Optional) If set to true it will always return a value (the original value, if translation is missing) Default is FALSE

$ulanguage_code

(mixed) (Optional) If missing or NULL, it will use the current language. If set to a language code, it will return a translation for that language code or the original if the translation is missing and $return_original_if_missing is set to TRUE. Default is NULL

*Retrieves a string translation. The filter looks up a string that is part of a package or a group of strings (as opposed to an individual string**). If it finds it, it looks for a translation in the current language. If a translation exists, it will return it. Otherwise, it will return the original string.

*To register a “package” string translation please see: wpml_register_string
**For retrieving an individual text string that does not belong to a package please see: wpml_translate_single_string

Note: This hook requires the WPML String Translation module

apply_filters( 'wpml_translate_string', string $string_value, string $string_name, (integer|array|object) $package )

$string_value

(string) (Required) The string’s original value

$string_name

(string) (Required) The string’s registered name

$package

(mixed) (Required) The string’s registered package identifier

• If $package is an array it needs to be associative and contain keys kind and name.
• If $package is an object it needs to have kind and name fields.

A complete and detailed example can be found on the “String Package Translation” documentation page.

Returns TRUE or FALSE based on whether a post type or taxonomy term is translated or not.

apply_filters( 'wpml_element_has_translations', mixed $empty_value, int $element_id, string $element_type )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$element_id

(int) (Required) The element id to retrieve the information of. Use term_id for taxonomy terms, post_id for post types

$element_type

(string) (Required) The type of element the ID belongs to. Can be a post type: post, page, attachment, nav_menu_item, {custom post key} or taxonomy: category, post_tag, nav_menu {custom taxonomy key}

Returns a post type or taxonomy term’s translation type (translated or not | duplicated or is a duplicate itself).

apply_filters( 'wpml_element_translation_type', mixed $empty_value, int $element_id, string $element_type )

$empty_value

(mixed) (Required) This is normally the value the filter will be modifying. We are not filtering anything here so set this to NULL. This for the filter function to actually receive the full argument list

$element_id

(int) (Required) The element id to retrieve the information of. Use term_id for taxonomy terms, post_id for post types

$element_type

(string) (Required) The type of element the ID belongs to. Can be a post type: post, page, attachment, nav_menu_item, {custom post key} or taxonomy: category, post_tag, nav_menu {custom taxonomy key}

echo apply_filters( 'wpml_element_translation_type', NULL, 7, 'nav_menu' )

The return value will be one of these:

 *      WPML_ELEMENT_IS_NOT_TRANSLATED  = 0
 *      WPML_ELEMENT_IS_TRANSLATED      = 1
 *      WPML_ELEMENT_IS_DUPLICATED      = 2
 *      WPML_ELEMENT_IS_A_DUPLICATE     = 3

Returns TRUE or FALSE depending on whether a taxonomy has been set to be translatable or not.

apply_filters( 'wpml_is_translated_taxonomy', null, string $taxonomy )

$taxonomy

(string) (Required) The taxonomy you would like to check. This can be a category, post_tag, nav_menu, or other default taxonomy.

For custom taxonomies, please add the slug of the custom taxonomy.

Returns TRUE or FALSE depending on whether a post type has been set to be translatable or not.

apply_filters( 'wpml_is_translated_post_type', null, string $post_type )

$post_type

(string) (Required) The type of post you wish to check. It can be any post type, such as a post, page, attachment, or revision.

For custom post types, please add the slug of the custom post type.

Returns the original post ID from the duplicated post ID

apply_filters( 'wpml_master_post_from_duplicate', int $post_id )

$post_id

(int) (Required) The duplicated post id

// $my_original_post will return the original post ID which was used to create post ID 30
$my_original_post = apply_filters( 'wpml_master_post_from_duplicate', 30 )

If the above variable returns an empty string this would indicate that post ID 30 is not a duplicated post.

Returns the duplicated post IDs from the original post ID.

apply_filters( 'wpml_post_duplicates', int $master_post_id )

$master_post_id

(int) (Required) The original post id from which duplicates exist

// $my_duplications will return an associative array with language codes as indexes and post_ids as values
$my_duplications = apply_filters( 'wpml_post_duplicates', 28 );

The result looks like this:

Array
(
    [de] => 30
    [el] => 73
)

If I attempt to pass a post ID that has not been used as the original post to create duplicates from the filter will return an empty array. To illustrate this more clearly please compare the example below to the one given above.

// note that I use post ID 30 This is the German duplicated post from the first example above
$my_duplications = apply_filters( 'wpml_post_duplicates', 30 );

And the result:

Array
(
)

Deletes a string translation package*. When this action is called, all the data related to the package is deleted: package, strings, strings translations and jobs.

*String translation packages are registered with wpml_register_string and their translations retrieved with wpml_translate_string

Note: This hook requires the WPML String Translation module

do_action( 'wpml_delete_package', string $package_name, string $package_kind )

$package_name

(string) (Required) The unique name of the package as it was registered with wpml_register_string

$package_kind

(string) (Required) The package kind as used when it was registered using wpml_register_string

Builds or updates duplicate posts from a “master” post. This action hook is reserved for admin backend calls.

do_action( 'wpml_admin_make_post_duplicates', int $master_post_id )

$master_post_id

(int) (Required) The ID of the post to duplicate from. It can be that of a post, page or custom post. The “master post” doesn’t need to be in the default language.

// this will create duplicates for the "Hello World!" post
do_action( 'wpml_admin_make_post_duplicates', 1 );

In the example below, we create duplicates for a post or page or custom post when we click on “publish” from the “edit-post” admin screen.

add_action( 'wp_insert_post', 'my_duplicate_on_publish' );
function my_duplicate_on_publish( $post_id ) {
	global $post;

	// don't save for autosave
	if (is_null($post))
		{
       		 return $post_id;
		}

	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
		return $post_id;
	}

	// dont save for revisions
	if ( isset( $post->post_type ) && $post->post_type == 'revision' ) {
		return $post_id;
	}

	// we need this to avoid recursion see add_action at the end
	remove_action( 'wp_insert_post', 'my_duplicate_on_publish' );

	// make duplicates if the post being saved:
	// #1. is not a duplicate of another or
	// #2. does not already have translations

	$is_translated = apply_filters( 'wpml_element_has_translations', '', $post_id, $post->post_type );

	if ( !$is_translated ) {
		do_action( 'wpml_admin_make_post_duplicates', $post_id );
	}

	// must hook again - see remove_action further up
	add_action( 'wp_insert_post', 'my_duplicate_on_publish' );
}

Enables the possibility to save a different value per language for your theme/plugin options using WPML language switcher on directly the settings screen.

do_action( 'wpml_multilingual_options', $wp_option_name );

$wp_option_name

(Required) Exact option name as it is stored in wp_options table database.

Let’s say that you need to assign a different value per language (translate) for a theme option, this usually is easily achievable with the help of WPML String Translation.

However, you may need to act differently with some themes and add a different value directly from the theme options panel. For example, with Avada you can do.

Now, you are working with a theme where you need to translate your options with this later approach, for example your footer option theme_footer. For this, you would need to:

• Add a value for your footer option at Theme Options > Footer,
• Add the following code on your functions.php file and queue it as early as possible:

  add_action( 'init', 'my_theme_bootstrap' );
  
  function my_theme_bootstrap(){
     do_action( 'wpml_multilingual_options', 'theme_footer' );
     $settings = get_option( 'theme_footer');
     // [...]
  }

• Go back to your Theme Options > Footer.
• Click on the language switcher placed on the top bar and switch languages.
• Add a new different value for it.
• You should keep a different value per language.
• If you visit the front-end, it should display a different value for the option.
• If you check the database, there should be a new value stored in wp_options table as theme_footer_fr, where _fr is the language suffix.

Registers an individual text string for translation (as opposed to a string that is part of a package). This action is usually used for user input texts otherwise referred to as “dynamic text strings”.

For retrieving a string translation please see: wpml_translate_single_string
For registering a text string that is part of a package please see: wpml_register_string

Note: This hook requires the WPML String Translation module

do_action( 'wpml_register_single_string', string $context, string $name, string $value )

$context

(string) (Required) This value gives the string you are about to register a context. This will usually be the name of the plugin or theme, in a human readable format

$name

(string) (Required) The name of the string which helps the translator understand what’s being translated

$value

(string) (Required) The string that needs to be translated

$allow_empty_value

(bool: false by default) (Optional) Whether an empty value is allowed or not

$source_lang_code

(string) (Optional) The language code for the registered string

Imagine you have created a custom widget with a title input field and some other options. You can register the widget title for translation using apply_filters but you also want to register the input text you can save in the widget’s other option fields.

Registering input texts for translation is best done when the widget options are saved or updated i.e. inside the ‘update’ method of widgets.

Below is an example of what the code could look like. Our example custom widget has a title, a single line input field and a text area.

function update($new_instance, $old_instance){
	$instance = $old_instance;
	$instance['title'] 		= strip_tags($new_instance['title']);
	$instance['custom_input'] 	= strip_tags($new_instance['custom_input']);
	$instance['custom_textarea'] 	= $new_instance['custom_textarea'];

	//WPML
	/**
	 * register strings for translation
	 */
	do_action( 'wpml_register_single_string', 'Widgets', 'Custom Widget - input field', $instance['custom_input'] );
	do_action( 'wpml_register_single_string', 'Widgets', 'Custom Widget - textarea field', $instance['custom_textarea'] );
	//WPML

	return $instance;
}

The code above tells WPML that the user input text for the input field and textarea needs to be translated. The texts will be registered under the Widgets strings context with the name Custom Widget – input field and Custom Widget – textarea field respectively.

*Registers a text string for translation. The string being registered is part of a package or a group of strings (as opposed to an individual string**).

*For retrieving a “package” string translation please see: wpml_translate_string
**For registering an individual text string that does not belong to a package please see: wpml_register_single_string

Note: This hook requires the WPML String Translation module

do_action( 'wpml_register_string', string $string_value, string $string_name, array $package, string $string_title, string $string_type )

$string_value

(string) (Required) The string to register for translation

$string_name

(string) (Required) A unique name for the string

$package

(array) (Required) The package object. Array keys must match the following WPML_Package fields and will be the same for all texts sent to translation for an object:

• kind A free text to identify the package object. Must be the same for all packages of the same type. i.e. ‘Gravity Form’ or ‘Layout’
• name A name to identify the set of strings with. Must be unique for each package of the same type such as an ID.
• title A humanly readable title for the package. Must be different for each package of the same type.
• edit_link Link to edit this set of strings (it can be an empty string)
• view_link Link to view this set of strings (it can be an empty string)

$string_title

(string) (Required) A title for the string (together with $string_name it will be used to build the name field in icl_strings table)

$string_type

(string) (Required) The string kind. Must be one of the following values:

• AREA Anything that must contain multiple rows
• LINE A single line value
• VISUAL This will be shown as a WYSIWYG editor and will be handled as HTML content

A complete and detailed example can be found on the “String Package Translation” documentation page.

This action is deprecated since String Translation 3.2. Please use wpml_delete_package instead.

Deletes a string translation package*. When this action is called, all the data related to the package is deleted: package, strings, strings translations and jobs.

*String translation packages are registered with wpml_register_string and their translations retrieved with wpml_translate_string

Note: This hook requires the WPML String Translation module

do_action( 'wpml_delete_package_action', string $package_name, string $package_kind )

$package_name

(string) (Required) The unique name of the package as it was registered with wpml_register_string

$package_kind

(string) (Required) The package kind as used when it was registered using wpml_register_string

Outputs the UI to display a language information box in admin screens of content that was registered for translation as a string package*. It also shows the current state of any translations.

*String translation packages are registered with wpml_register_string and their translations retrieved with wpml_translate_string

Note: This hook requires the WPML String Translation module

do_action( 'wpml_show_package_language_ui', array $package, array $args )

$package

(array) (Required) The package object. Array keys must match the following WPML_Package fields and will be the same for all texts sent to translation for an object:

• kind A free text to identify the package object. Must be the same for all packages of the same type. i.e. ‘Gravity Form’ or ‘Layout’
• name A name to identify the set of strings with. Must be unique for each package of the same type such as an ID
• title A humanly readable title for the package. Must be different for each package of the same type.
• edit_link Link to edit this set of strings (it can be an empty string)
• view_link Link to view this set of strings (it can be an empty string)

$args

(array) (Optional) Arguments to control the output

• $show_title(bool) Will hide/show the “WPML Translation” title in the box. Defaults to TRUE
• $show_description(bool) Will hide/show the “Language of this {package_kind} is {language_name}” Defaults to TRUE
• $show_status(bool) Will hide/show the translation status” Defaults to TRUE
• $show_link(bool) Will hide/show the link which leads to the translation dashboard. Defaults to TRUE
• $title_tag(string) The HTML Tag to use for the box title. Defaults to ‘h2’
• $status_container_tag(string) The HTML Tag to use for translation status container. Defaults to ‘p’
• $main_container_attributes(array) Array of keys->values to add to the main container (for CSS and/or js) Defaults to an empty array
• $status_container_attributes(array) Array of keys->values to add to the status container (for CSS and/or js) Defaults to array( 'style' => 'padding-left: 10px' )

Builds duplicate posts from a “master” post. This action hook is reserved for front-end calls.

do_action( 'wpml_make_post_duplicates', int $master_post_id )

$master_post_id

(int) (Required) The ID of the post to duplicate from. It can be that of a post, page or custom post. The “master post” doesn’t need to be in the default language

In the example below, we create duplicates for a post when we insert it from the front-end.
Our function will fire when the footer is loaded on the front-end.

add_action('wp_footer', 'my_duplicate_on_insert');
function my_duplicate_on_insert() {
	// Create post object
	$my_post = array(
	  'post_title'    => 'My post to insert from the front-end',
	  'post_content'  => 'This is my post.',
	  'post_status'   => 'publish',
	  'post_author'   => 1,
	  'post_category' => array(1)
	);

	// Insert the post into the database
	$post_id = wp_insert_post( $my_post );
	if ( $post_id ) {
		do_action( 'wpml_make_post_duplicates', $post_id );
	}
}

This filter hook allows developers to copy a post to a specified language with WPML. It duplicates the post into the target language and provides the option to mark it as a duplicate or as a translation.

apply_filters( 'wpml_copy_post_to_language', int $post_id, string $target_language, bool $mark_as_duplicate )

In the example below, we use the filter to copy a post with the ID of 1 into French and mark it as a duplicate of the original post.

$duplicate_post_id = apply_filters( 'wpml_copy_post_to_language', 1, 'fr', true );

In the advanced example you see below, we demonstrate how to automatically duplicate a given post to all other active languages on your WPML site, excluding the original language of the post.

function myplugin_duplicate_copy_post_to_secondary_languages( $post_id, $mark_as_duplicate = false ) {
    // Retrieve the post's element type, trid, and existing translations
    $element_type = apply_filters( 'wpml_element_type', get_post_type( $post_id ) );
    $trid         = apply_filters( 'wpml_element_trid', null, $post_id, $element_type );
    $translations = (array) apply_filters( 'wpml_get_element_translations', [], $trid, $element_type );

    if ( ! $translations ) {
        // Handle error or invalid values accordingly
        return;
    }

    // Retrieve the active languages
    $wpml_languages = (array) apply_filters('wpml_active_languages', [], 'orderby=id&order=desc');

    foreach ( $wpml_languages as $language ) {
        // Duplicate the post if no translation exists for the given language
        if ( ! isset( $translations[ $language['language_code'] ] ) ) {
            apply_filters(
                    'wpml_copy_post_to_language',
                    $post_id,
                    $language['language_code'],
                    $mark_as_duplicate
            );
        }
    }
}

The action hook makes it possible to set or update an element’s language information. Apart from its straightforward implied usage, the hook can prove to be useful when one needs to connect two elements with one as the “Translation of” the other. Refer to the “Hook Example Usage” section below for an example of this.

do_action( 'wpml_set_element_language_details', array $args )

$args

(array) (Required) An array of arguments to be used.

• element_id(bool) Use term_taxonomy_id for taxonomies, post_id for posts
• element_type(string) The type of an element. Can be a post type: post_post, post_page, post_attachment, post_nav_menu_item, post_{custom post key} or taxonomy: tax_category, tax_post_tag, tax_nav_menu, tax_{custom taxonomy key}. Defaults to post_post if not set.
• trid(int) The trid to which the element is to be assigned to. If set to FALSE it will create a new trid for the element causing any potential translation relations to/from it to disappear.
• language_code(string) The language code for the element
• source_language_code(string) The source language code for the element. NULL is reserved for original elements i.e. elements that are not a translation of another. Defaults to NULL when not set.
• check_duplicates(bool) Defaults to TRUE. What this does is, it checks whether another element of a different type with the same ID already exists and outputs a user-level notice (E_USER_NOTICE) with the message “Element ID already exists with a different type”

WPML automatically tries to redirect visitors to the canonical URL when it does find a match. This hook allows to disable this WPML functionality.

add_filter( 'wpml_is_redirected', 'callable $function_to_add, 10, 3 );

There are three parameters being passed to this filter:

$redirect

(bool) Boolean value to define whether or not to disable WPML canonical URL redirection actions.

$post_id

(integer) post ID

$query

(array) The WordPress query array.

The following example prevents WPML canonical URL redirection for a Custom Post Type with a slug of “city”

function mytheme_do_not_redirect_city_post_type( $redirect, $post_id, $query ) {
    if ( 'city' === $query->get( 'post_type' ) ) {
       return false;
     }
    return $redirect;
    };
add_filter( 'wpml_is_redirected', mytheme_do_not_redirect_city_post_type, 10, 3 );

This filter allows you to update the language switcher when a visitor navigates on the front-end and the theme or plugin is refreshing the page with AJAX (the language switcher links will follow the navigation).

Note: This feature will work only if the AJAX response receives the full page content, so that WPML can extract and replace the language switchers.

$isEnabled

(boolean) Enable or disable AJAX navigation. Default: false.

// The AJAX navigation will always be enabled
add_filter( 'wpml_ls_enable_ajax_navigation', '__return_true' );

Returns a WPML setting value

apply_filters( 'wpml_setting', mixed|bool $default, string $key )

$default

(mixed|bool) (Required) The value to return if the settings key does not exist. Set to false if not using

$key

(string) (Required) The settings name key to return the value of

Filters a WordPress element type (post type, taxonomy term, comment) by adding the WPML prefix ‘post_’, ‘tax_’ (for default tags use ‘post_tag’), or nothing for ‘comment’ as used in the icl_translations db table.

apply_filters( 'wpml_element_type', string $element_type )

$element_type

(string) (Required) Accepts comment, post, page, attachment, nav_menu_item, {custom post key}, nav_menu, category, post_tag, {custom taxonomy key}

Filters the post meta values before they are copied to the translation. In other words, it filters the $copied_value of a $meta_key that will be copied from one post (specified using $post_id_from) to another (specified using $post_id_to).

$copied_value

(mixed) (Required) The unserialized and slashed value.

$post_id_from

(int) (Optional)The ID of the source post.

$post_id_to

(int) (Optional) The ID of the destination post.

$meta_key

(string) (Optional) The key of the post meta being copied.

$args

(array) (Optional) The internal parameters.

$copied_value = apply_filters( 'wpml_sync_custom_field_copied_value', $copied_value, $post_id_from, $post_id_to, $meta_key, $args );

This filter defines where to place the WPML post edit meta box.

side

This will display the WPML language box in the sidebar.

normal

This will display the WPML language box beneath the main editor.

advanced

The same as “normal” but with lower priority. So, if you have two meta boxes, one with context set to normal and the other set to advanced, the box with the normal context will be displayed first/before.

add_filter('wpml_post_edit_meta_box_context', function (){
    return 'normal';
});

Allows you to filter the displayed languages of the language switcher. You can use this filter when you need to add additional URLs or flags to an existing language switcher.

• $languages (array) Collection of active languages to display in the language switcher. Each language is an array of:
  • default_locale: The language locale. i.e. fr_FR
  • language_code: The language code. i.e. fr
  • native_name: Name of the language in its own language. i.e. Français
  • translated_name: Name of the language in the current active language. i.e. French when English is the current active language.
  • url: The URL to the language of the current page. This is used for the link in the language switcher.
  • active: 1 if the language is currently active and 0 otherwise.

Returns a WPML sub setting value.

apply_filters( 'wpml_sub_setting', mixed|bool $default, string $key, string $sub_key )

$default

(mixed|bool) (Required) The value to return if the settings key does not exist. Set to false if not using

$key

(string) (Required) The settings name key the sub key belongs to

$sub_key

(string) (Required) The sub key to return the value of

Filter CSS classes for each item in a language switcher.

add_filter( 'wpml_ls_model_language_css_classes', 'the_callback_function' );

There is only one parameter passed to this filter: css_classes.

$css_classes

(array) The array including CSS classes for each item of language switchers.

WPML applies this hook filter on custom field values, post content, post title and post excerpt when a WordPress post type is being duplicated and before the data is saved into the database. The data are in this way made available to external themes and plugins for filtering.

apply_filters( 'wpml_duplicate_generic_string', string $value_to_filter, string $target_language, array $meta_data )

$value_to_filter

(string) (Required) The data string to filter

$target_language

(string) (Optional) The target language code

$meta_data

(array) (Optional) See details below:

• context(string) The data context. Set to “custom_field” if the value belongs to a custom field and “post” for all other cases (post title, content or excerpt)
• attribute(string) Set to: “value” for custom fields, “content” for post content, “title” for post title, “excerpt” for post excerpt
• key(string) The $post_meta->meta_key if the filter is being applied to custom field values. Otherwise the id of the original post that acts as master for duplication
• $is_serialized(bool) Passed only for custom field data. true|false Whether the data is serialized. This allows to unserialize the value if needed.
• post_id(int) Passed only for custom field data. The id of the post being duplicated
• master_post_id(int) Passed only for custom field data. The id of the original post that acts as master for duplication

Filters an array of user meta keys which will be translated when calling the function get_the_author(). The translatable user meta fields will be registered as strings in WPML String Translation.

add_filter( 'wpml_translatable_user_meta_fields', array $user_meta_fields );

$user_meta_fields

(array) (Required) Containing the user meta fields to translate.

• Retrieve the data passed by the filter wpml_cross_domain_language_data.You can find more details in our document Passing session data between languages in domains.
• This is specific for displaying the language URL format as A different domain per language.

apply_filters( 'wpml_get_cross_domain_language_data', array $array );

$array

(array) (Required) This is just an empty array, you should always use this value array().

• Pass the necessary information among language domains. You can find more details in our document Passing session data between languages in domains.
• This is specific for displaying the language URL format as A different domain per language.
• To get back the data, use the filter wpml_get_cross_domain_language_data.

add_filter( 'wpml_cross_domain_language_data', callable $function_to_add);

$function_to_add

(callable) (Required) Your callback to be run when the filter is applied.

• To make sure a WPML dependent code is executed at the right time, this code should be hooked into the wpml_loaded action. This action is called after WPML is fully configured and loaded.
• If we do not hook into this wpml_loaded, sometimes the WPML dependent code might be called too early. Then even if WPML is active and configured, we may not get expected results.
• wpml_loaded is executed during the plugins_loaded action.
• There are similar hooks for WPML String Translation wpml_st_loaded and WPML Translation Management wpml_tm_loaded. They are both hooked to wpml_loaded.

add_action( 'wpml_loaded', callable $function_to_add );

$function_to_add

(callable) (Required) Your callback to be run when the filter is applied.

• To make sure a WPML String Translation dependent code is executed at the right time, this code should be hooked into the wpml_st_loaded action. This action is called after WPML String Translation is fully configured and loaded.
• If we do not hook into this wpml_st_loaded, sometimes the WPML String Translation dependent code might be called too early. Then even if WPML String Translation is active and configured, we may not get expected results.
• wpml_st_loaded is executed during the plugins_loaded and wpml_loaded actions.
• There is a similar hook for WPML Translation Management wpml_tm_loaded.

add_action( 'wpml_st_loaded', callable $function_to_add );

$function_to_add

(callable) (Required) Your callback to be run when the filter is applied.

• To make sure a WPML Translation Management dependent code is executed at the right time, this code should be hooked into the wpml_tm_loaded action. This action is called after WPML Translation Management is fully configured and loaded.
• If we do not hook into this wpml_tm_loaded, sometimes the WPML Translation Management dependent code might be called too early. Then even if WPML Translation Management is active and configured, we may not get expected results.
• wpml_tm_loaded is executed during the plugins_loaded and wpml_loaded actions.
• There is a similar hook for WPML Translation Management wpml_st_loaded.

add_action( 'wpml_tm_loaded', callable $function_to_add );

$function_to_add

(callable) (Required) Your callback to be run when the filter is applied.

• Allows hiding the translation management column based on the post type.
• This filter is working in sync with Screen Options. Therefore, hiding column from Screen Options will have the same effect.

add_action( 'wpml_hide_management_column', 'the_callback_function', 10, 2 );

There are two parameters being passed to this action:

$is_visible

(bool) Whether or not the translation management column displays.

$post_type

(string) The post type.

This filter must return a bool value of $is_visible.

• Add directories containing language switcher templates.
• This hook is useful when developers want to add their own directories instead of the default directory {your-theme-folder}/wpml/templates/language-switchers/.
• See more at the Designing Custom Language Switchers Using Template Files document.

add_filter( 'wpml_ls_directories_to_scan', 'the_callback_function' );

There is only one parameter passed to this filter: dirs.

$dirs

(array) The array including directories.

WPML applies this hook filter on custom field values when a post is displayed in translation editor. The custom field value is in this way made available to external themes and plugins for filtering.

apply_filters( 'wpml_editor_cf_to_display', object $element, object $job )

$element

(object) (Optional) The element object available for filtering

$job

(object) (Optional) The job object the $element belongs to

Filter CSS classes for language switcher wrappers. These wrappers are not available for language switchers in menus.

add_filter( 'wpml_ls_model_css_classes', 'the_callback_function' );

There is only one parameter passed to this filter: css_classes.

$css_classes

(array) The array including CSS classes for language switcher wrappers.

WPML applies this hook filter to the translated custom field values when a document is exported to an XLIFF file. The custom field value is in this way made available to external themes and plugins for further manipulation before saving e.g. substitution.

apply_filters( 'wpml_tm_xliff_export_translated_cf', string $field_data_translated, object $element )

$field_data_translated

(string) (Optional) The encoded translated custom field value. Empty if not translated yet

$element

(object) (Optional) The current custom field

WPML applies this hook filter on custom field values when a translation is saved either via the translation editor screen or via an XLIFF import. The custom field value is in this way made available to external themes and plugins for further manipulation before saving e.g. encoding or substitution.

apply_filters( 'wpml_tm_save_translation_cf', array $field, string $fieldname, array $data )

$field

(array) (Optional) The current custom field array

$fieldname

(string) (Optional) The custom field name

$data

(array) (Optional) The data array being processed through the filter

WPML applies this hook filter to the original custom field values when a document is exported to an XLIFF file. The custom field value is in this way made available to external themes and plugins for further manipulation before saving e.g. substitution.

apply_filters( 'wpml_tm_xliff_export_original_cf', string $field_data, object $element )

$field_data

(string) (Optional) The encoded original custom field value.

$element

(object) (Optional) The current custom field

Display the front-end link to the WPML Translation Feedback feature. Clicking this link displays the dialog box for users to leave their feedback about the current page’s translation.

do_action( 'wpml_tf_feedback_open_link', $args );

$args

(array) (Optional) Arguments to filter the translation feedback link output:

• title – Link text to display on the front-end.
• classes – classes to add to the <a> tag.

Add the code below to your theme’s footer.php template file or where you want the translation feedback link to be displayed at. The link in this example would be underlined and red.

<style>
    .my-custom-rate-link {
        text-decoration: underline;
        color: red;
    }
</style>

<?php $args = array( 'title' => __( 'Please rate the page', 'my-text-domain' ),
    'classes' => 'my-custom-rate-link',
);
do_action( 'wpml_tf_feedback_open_link', $args );
?>

Synchronizes the value of a specified custom field across all translations of a given post. It only does it if the translation option for this custom field is set to Copy.

do_action( 'wpml_sync_custom_field', $post_id, $custom_field );

For this action hook, you only need to provide a post ID and the slug of the custom field you want to synchronize.

do_action( 'wpml_sync_custom_field', 1234, $event-date );

Synchronizes the values of all custom fields across all translations of a given post. It only does it if the translation option for these custom fields are set to Copy.

do_action( 'wpml_sync_all_custom_fields', $post_id );

For this action hook, you only need to provide an ID of a post for which you want to synchronize custom fields.

do_action( 'wpml_sync_all_custom_fields', 1234)

When returning true, WPML will synchronize the attachment with its translations (status, terms, custom fields).

A boolean to enable or not the synchronization (default: false)

$post_id

(integer) The attachment ID being processed.

/**
* @param bool $isEnabled
* @param int $postId
*/
function myplugin_apply_save_attachment_actions( $isEnabled, $postId ) {
    return true;
}
add_filter( 'wpml_apply_save_attachment_actions', 'myplugin_apply_save_attachment_actions', 10, 2 );

WPML allows you to translate entries from the wp_options table. We call these Admin Texts.

To avoid confusion, when the user is editing these settings in the dashboard, these options aren’t translated in admin.

But we sometimes require translating them, even in admin. For example, when sending an email from the dashboard.

The only required argument is an array of strings where each string is the name of an admin text.

Allows setting a translation mode for a given post type.

do_action( 'wpml_set_translation_mode_for_post_type', $post_type, $translation_mode );

$post_type

(string) (Required) The slug of the post type you want to set translation mode for.

$translation_mode

(string) (Required) Translation mode to set, can be one of the following values:

• “do_not_translate”
• “translate”
• “display_as_translated”

Let’s say you have a custom post type “Books” (its slug is “book”) and you want to set it to use translation if available or fallback to default language.

do_action( 'wpml_set_translation_mode_for_post_type', "book", "display_as_translated" );