WPML

https://wpml.org/documentation
Admin
WPML is a WordPress plugin that enables websites to be fully multilingual, allowing content...
Tokens:269,564
Snippets:2,515
Trust Score:9.5
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Load and configure WPML Installer

Source: https://wpml.org/documentation/support/embedded-installer-authors

Loads the WPML Installer Composer library and configures it with optional settings for the plugins install tab, affiliate ID/key, and source name/author for coupons. Must be called before the init hook.

```php
require_once 'vendor/autoload.php';
include 'vendor/otgs/installer/loader.php';

WP_Installer_Setup(
	$wp_installer_instance,
	[
		'plugins_install_tab' => 1, // optional, default value: 0
		'affiliate_id:wpml' => '99999', // optional, default value: empty
		'affiliate_key:wpml' => 'NNNNNNNNNN', // optional, default value: empty
		'src_name' => 'NAME OF THEME', // optional, default value: empty, needed for coupons
		'src_author' => '',// optional, default value: empty, needed for coupons
	]
);
```

--------------------------------

### Example of configuration file with wildcards

Source: https://wpml.org/documentation/support/language-configuration-files/custom-fields-translation-options

Shows how to use wildcards in custom-fields-texts to match subfields. The example matches all subfields under key-name and then the title subfield.

```xml
<wpml-config>
  <custom-fields-texts>
    <key name="key-name">
    <key name="*">
    <key name="title" />
    </key>
    </key>
  </custom-fields-texts>
</wpml-config>
```

--------------------------------

### Add custom WPML Installer tab to theme options

Source: https://wpml.org/documentation/support/embedded-installer-authors

Adds a custom WPML Installer tab to the theme options admin screen by calling WP_Installer_Show_Products with a configuration array. Must be called after the admin_init hook. This example is specific to the GoodDay theme and cannot be copied as-is.

```php
echo '<div class="wrap otgsi_downloads_form">';
$config['template'] = 'compact'; //required
$config['product_name'] = 'WPML';
$config['box_title'] = 'Multilingual GoodDay';
$config['name'] = 'GoodDay'; //name of theme/plugin
$config['box_description'] = 'GoodDay theme is fully compatible with WPML - the WordPress Multilingual plugin. WPML lets you add languages to your existing sites and includes advanced translation management.';
$config['repository'] = 'wpml'; // required
$config['package'] = 'wpml'; // required
$config['product'] = 'multilingual-cms-2'; // required
WP_Installer_Show_Products($config);
echo "</div>";
```

--------------------------------

### Install WooCommerce REST API PHP client library

Source: https://wpml.org/documentation/support/wcml-rest-api

Install the WooCommerce REST API PHP client library using Composer. This is the first step in setting up the library for interacting with the WooCommerce REST API.

```bash
composer require automattic/woocommerce
```

--------------------------------

### Get products in a specific language

Source: https://wpml.org/documentation/support/wcml-rest-api

Retrieve products in a specific language by adding the 'lang' parameter. This example gets Spanish products. Set 'lang' to 'all' to get products in all languages.

```php
$products = $woocommerce->get('products', array( 'per_page' => 25, 'lang' => 'es' ) );
```

--------------------------------

### Run initial sync for English posts with WP-CLI

Source: https://wpml.org/documentation/translating-your-contents/multilingual-search-with-elasticpress

Runs the initial sync for English posts only. The --setup flag clears existing indexes before rebuilding. After this command, English search returns English results; searches from other languages return nothing because their indexes haven't been built yet.

```bash
wp wpml_elasticpress sync --setup --post-type=post --post-lang=en
```

--------------------------------

### Get product taxonomy terms in all languages

Source: https://wpml.org/documentation/support/wcml-rest-api

Retrieve product taxonomy terms (categories, tags, attributes, shipping classes) in a specific language. This example gets categories in all languages by setting 'lang' to 'all'.

```php
$categories= $woocommerce->get('products/categories', array( 'per_page' => 10, 'lang' => 'all' ) );
```

--------------------------------

### View single order in a specific language

Source: https://wpml.org/documentation/support/wcml-rest-api

Retrieve a single order with translations in the specified language. This example gets order #110 in English.

```php
$order = $woocommerce->get('orders/110', array( 'lang' => 'en' ) );
```

--------------------------------

### Initialize WooCommerce REST API client

Source: https://wpml.org/documentation/support/wcml-rest-api

Include the autoload file and instantiate the WooCommerce client with placeholder consumer key and secret. Replace the placeholders with actual credentials generated from WooCommerce settings.

```php
require __DIR__ . '/vendor/autoload.php';

use Automattic\WooCommerce\Client;

$woocommerce = new Client(

   'http://example.com',

   'ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',

   'cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',

   [

       'wp_api' => true,

       'version' => 'wc/v3',

   ]

);
```

--------------------------------

### Complete config.json with all fields

Source: https://wpml.org/documentation/support/custom-currency-switcher-templates

Complete config.json example including all fields: name, css, and js. Note the trailing comma after the js array, which is invalid JSON but shown as-is in the source.

```json
{
"name":           "My custom Vertical List",
"css":            ["style.css"],
"js":             ["script.js"],
}
```

--------------------------------

### View orders in a specific language

Source: https://wpml.org/documentation/support/wcml-rest-api

Retrieve orders in a specific language by adding the 'lang' parameter. This example gets orders placed in French. Products must be translated into the respective language.

```php
$orders = $woocommerce->get('orders', array( 'per_page' => 25, 'lang' => 'fr' ) );
```

--------------------------------

### Create a package and register strings with wpml_register_string

Source: https://wpml.org/documentation/support/string-package-translation

Creates a string package for a user and registers each user field as a translatable string using the 'wpml_register_string' action. The package array requires 'kind', 'kind_slug', 'name', and 'title'; 'kind' and 'kind_slug' should match the declared kind. The action arguments are the string value, a sanitized key, the package, the field name, and the string type 'LINE'.

```php
$userId = 123;

$user   = get_user_by( 'id', $userId );

$package = [

    'kind'      => FOO_USER_FIELD_PACKAGE_KIND_TITLE, // The "namespace".

    'kind_slug' => FOO_USER_FIELD_PACKAGE_KIND_SLUG, // The "namespace" slug.

    'name'      => $userId, // Can be a string or an integer, but should be unique inside the "kind" namespace.

    'title'     => $user->display_name, // The title for the package entity inside the "kind" namespace.

];

$fooUserFields = get_option( 'otgs_foo_user_fields' );

foreach ( $fooUserFields as $fooUserField ) {

$fieldValue = get_user_meta( $userId, $fooUserField, true );

do_action( 'wpml_register_string', $fieldValue, sanitize_key( $fooUserField ), $package, $fooUserField, 'LINE' );

}
```

--------------------------------

### Memcached server configuration example

Source: https://wpml.org/documentation/support/using-wpml-with-memcached-caching

Example final configuration for Memcached servers in object-cache.php, using 'memcached:11211' as the server address.

```php
$memcached_servers = array(
				'default' => array(
				'memcached:11211'
		)
);
```

--------------------------------

### Text-based shortcode example

Source: https://wpml.org/documentation/support/language-configuration-files/translate-custom-shortcodes-with-wpml

Example of a text-based shortcode that outputs text. Used to illustrate how WPML translates shortcodes that output text.

```text
[goodmorning name="Dear client"]
```

--------------------------------

### Specify list of URLs to allow linking to

Source: https://wpml.org/documentation/getting-started-guide/sticky-links

Example of specifying the list of URLs to allow linking to. Add these lines inside the wpml_sl_blacklist_requests function to include the slugs 'documentation' and 'page-builders'.

```php
$blacklist[] = 'documentation';

$blacklist[] = 'page-builders';

```

--------------------------------

### Urlencoded shortcode example

Source: https://wpml.org/documentation/support/translating-urlencoded-shortcodes

Example of a urlencoded shortcode as seen in WordPress Text mode, with the values attribute containing a URL-encoded JSON array.

```markup
[vc_progress_bar values="%5B%7B%22label%22%3A%22Development%20Test%22%2C%22value%22%3A%2290%22%7D%2C%7B%22label%22%3A%22Design%20Test%22%2C%22value%22%3A%2280%22%7D%2C%7B%22label%22%3A%22Marketing%22%2C%22value%22%3A%2270%22%2C%22color%22%3A%22bar_blue%22%7D%5D" title="Progress Bar Title Test" units="%"]
```

--------------------------------

### Equivalent explicit sub-key configuration

Source: https://wpml.org/documentation/support/language-configuration-files/translate-strings-in-wp-options-table

Shows the equivalent explicit configuration for using the wildcard * in a sub-key, listing each sub-key and its nested sub-keys individually.

```XML
<wpml-config>
  <admin-texts>
    <key name="testing_option">
      <key name="sub_key_1"/>
      <key name="sub_key_2">
        <key name="sub_sub_21">
          <key name="sub_sub_211"/> 
        </key> 
        <key name="sub_sub_21"/>
        </key>
      <key name="more_sub_keys"/>
    </key>
  </admin-texts>
</wpml-config>
```

--------------------------------

### Currency Switcher Shortcode with format Attribute

Source: https://wpml.org/documentation/translating-your-contents/multi-currency-and-payment-gateways-for-woocommerce

Example using the format attribute to render the full currency name and symbol, e.g., Euro (€).

```text
[currency_switcher format="%name (%symbol)"]
```
Tokens:
Raw