dzachary

<p>This plugin filters the response content of requests made to the WordPress <a href="https://wordpress.org/extend/plugins/json-api" rel="ugc">JSON-API</a> to include data for translations created through the <a href="http://wpml.org" rel="nofollow ugc">WPML Multilingual CMS</a> plugin. One may also request the translation of response objects to a supported target language.</p>
<p><a href="http://www.lettersandlight.org" rel="nofollow ugc">The Office of Letters and Light</a> uses this plugin to integrate WordPress and <a href="http://wpml.org" rel="nofollow ugc">WPML</a> with its Rails-built <a href="http://www.nanowrimo.org" rel="nofollow ugc">National Novel Writing Month</a> event-site application. We use WordPress to manage all back-end site content and our <a href="http://github.com/lettersandlight/kiosk" rel="nofollow ugc">Kiosk Ruby gem</a> for consuming, caching, searching, and serving the content through Rails. This could not have been so easily accomplished without the well-built and extensible <a href="https://wordpress.org/extend/plugins/json-api" rel="ugc">JSON-API</a> for which we are grateful. And without the <a href="http://wpml.org" rel="nofollow ugc">WPML</a> plugin, we would not have such an intuitive and capable CMS i18n interface.</p>
<h3>Usage</h3>
<p>Please be familiar with the<br />
<a href="https://wordpress.org/extend/plugins/json-api" rel="ugc">JSON-API</a>.</p>
<ol>
<li>Augmented response objects
<ul>
<li>1.1. Language</li>
<li>1.2. Translations</li>
</ul>
</li>
<li>Filtering response objects by language
<ul>
<li>2.1. Specifying the language</li>
<li>2.2. Filtered results</li>
</ul>
</li>
<li>Response object translation
<ul>
<li>3.1 Specifying the target language</li>
<li>3.2 Translated results</li>
<li>3.3 Translatable objects and properties</li>
</ul>
</li>
</ol>
<h3>1. Augmented response objects</h3>
<h3>1.1. Language</h3>
<p>After enabling the WPML JSON-API plugin, response objects will contain the<br />
language in which the object content was written.</p>
<p>Let’s take a look at an example response to a request made to <code>http://wordpress.site.example/api/get_page/?dev=1&id=127</code>.</p>
<pre><code>{
  "status": "ok",
  "page": {
    "id": 127,
    "type": "page",
    "slug": "the-best-page",
    "url": "http:\/\/wordpress.site.example\/the-best-page\/",
    "status": "publish",
    "title": "The Best Page",
    "title_plain": "The Best Page",
    "content": "<p>This is the best page ever created.<\/p>\n<blockquote><p>Best damn page ever. – Dan<\/p><\/blockquote>\n",
    "excerpt": "This is the best page ever created. Best damn page ever. – Dan",
    "date": "2011-09-22 18:48:09",
    "modified": "2011-09-22 18:54:55",
    "categories": [],
    "tags": [],
    "author": {
      "id": 4,
      "slug": "dzachary",
      "name": "Daniel Duvall",
      "first_name": "Daniel",
      "last_name": "Duvall",
      "nickname": "Daniel Duvall",
      "url": "",
      "description": ""
    },
    "comments": [],
    "attachments": [],
    "comment_count": 0,
    "comment_status": "open",
    "translations": {
      "en": {
        "post_title": "The Best Page",
        "post_status": "publish",
        "id": 21,
        "language_code": "en",
        "is_original": true,
        "resource_id": 127
      },
      "es": {
        "post_title": "La P\u00e1gina Mejor",
        "post_status": "publish",
        "id": 22,
        "language_code": "es",
        "is_original": false,
        "resource_id": 131
      }
    },
    "language": "en"
  }
}
</code></pre>
<p>The <code>language</code> property specifies the code of the language in which the page<br />
was written—pretty simple.</p>
<h3>1.2. Translations</h3>
<p>The <code>translations</code> objects of the same example response given in Section 1.1.<br />
include data for each <em>published</em> resource that comprises a translation of<br />
its parent object.</p>
<pre><code>"translations": {
  "en": {
    "post_title": "The Best Page",
    "post_status": "publish",
    "id": 21,
    "language_code": "en",
    "is_original": true,
    "resource_id": 127
  },
  "es": {
    "post_title": "La P\u00e1gina Mejor",
    "post_status": "publish",
    "id": 22,
    "language_code": "es",
    "is_original": false,
    "resource_id": 131
  }
</code></pre>
<p>Properties included in each member of the <code>translations</code> object depend on the<br />
type of parent object.</p>
<p>All <code>post</code> and <code>page</code> objects will include the following.</p>
<ul>
<li><code>id</code> – The ID of the translation object.</li>
<li><code>language_code</code> – The code of the language in which the translation is written. Each translation object is also keyed by this value.</li>
<li><code>is_original</code> – Specifies whether the language of this translation is the language in which the original work was written.</li>
<li><code>resource_id</code> – The ID of the translated version of the parent object.</li>
<li><code>post_title</code> – The title of the translated post/page.</li>
<li><code>post_status</code> – The status of the translated post/page. Always ‘publish’.</li>
<li><code>post_id</code> – Redundancy of <code>resource_id</code>.</li>
</ul>
<p>All <code>category</code> objects will include the following.</p>
<ul>
<li><code>id</code> – The ID of the translation object.</li>
<li><code>language_code</code> – The code of the language to which the category was translated.</li>
<li><code>is_original</code> – Specifies whether the language of this translation is the language of the original category.</li>
<li><code>resource_id</code> – The ID of the translated version of the parent object.</li>
<li><code>name</code> – The translated category name.</li>
<li><code>term_id</code> – Redundancy of <code>resource_id</code>.</li>
<li><code>post_count</code> – The number of posts tagged with the translated category.</li>
</ul>
<h3>2. Filtering response objects by language</h3>
<p>You may tell the API to only return objects for a specific language by using<br />
the <code>language</code> parameter.</p>
<h3>2.1. Specifying the language</h3>
<p>The <code>language</code> parameter should be one of the supported language codes.</p>
<p>Example:</p>
<ul>
<li><code>http://wordpress.site.example/api/get_category_index/?language=es&dev=1</code></li>
</ul>
<h3>2.2. Filtered results</h3>
<p>Following is a example response to the example request in Section 2.1.</p>
<pre><code>{
  "status": "ok",
  "count": 2,
  "categories": [
    {
      "id": 13,
      "slug": "noticias-de-ultima-hora-2",
      "title": "Noticias de \u00daltima Hora",
      "description": "",
      "parent": 0,
      "post_count": 1,
      "translations": {
        "en": {
          "name": "Breaking News",
          "term_id": 4,
          "post_count": 2,
          "id": 9,
          "language_code": "en",
          "is_original": true,
          "resource_id": 4
        },
        "es": {
          "name": "Noticias de \u00daltima Hora",
          "term_id": 13,
          "post_count": 1,
          "id": 26,
          "language_code": "es",
          "is_original": false,
          "resource_id": 13
        }
      },
      "language": "es"
    }
  ]
}<h3>3. Response object translation</h3>
</code></pre>
<p>You can request objects to be translated before they are returned. This may<br />
save you some requests if you have the slug or ID and just need the object in<br />
a specific language.</p>
<h3>3.1. Specifying the target language</h3>
<p>The target language can be specified by passing a <code>to_language</code> parameter. The<br />
value should be one of the supported language codes.</p>
<p>Example:</p>
<ul>
<li><code>http://wordpress.site.example/api/get_page/?slug=the-best-page&to_language=es&dev=1</code></li>
</ul>
<h3>3.2. Translated results</h3>
<p>Following is an example response to the example request in Section 3.1.</p>
<pre><code>{
  "status": "ok",
  "page": {
    "id": 127,
    "type": "page",
    "slug": "la-pagina-mejor",
    "url": "http:\/\/wordpress.site.example\/the-best-page\/",
    "status": "publish",
    "title": "La P\u00e1gina Mejor",
    "title_plain": "La P\u00e1gina Mejor",
    "content": "<p>Esta es la p\u00e1gina mejor se haya creado.<\/p>\n<blockquote><p>Best damn page ever. – Dan<\/p><\/blockquote>\n",
    "excerpt": "Esta es la p\u00e1gina mejor se haya creado. Best damn page ever. – Dan",
    "date": "2011-09-22 18:48:09",
    "modified": "2011-09-22 18:54:55",
    "categories": [],
    "tags": [],
    "author": {
      "id": 4,
      "slug": "dzachary",
      "name": "Daniel Duvall",
      "first_name": "Daniel",
      "last_name": "Duvall",
      "nickname": "Daniel Duvall",
      "url": "",
      "description": ""
    },
    "comments": [],
    "attachments": [],
    "comment_count": 0,
    "comment_status": "open",
    "translations": {
      "en": {
        "post_id": 127,
        "post_title": "The Best Page",
        "post_status": "publish",
        "id": 21,
        "language_code": "en",
        "is_original": true,
        "resource_id": 127
      },
      "es": {
        "post_id": 131,
        "post_title": "La P\u00e1gina Mejor",
        "post_status": "publish",
        "id": 22,
        "language_code": "es",
        "is_original": false,
        "resource_id": 131
      }
    },
    "language": "es",
    "translated": true,
    "original_slug": "the-best-page",
    "original_title": "The Best Page",
    "original_title_plain": "The Best Page"
  }
}
</code></pre>
<p>As you can see the <code>slug</code>, <code>title</code>, <code>title_plain</code>, <code>excerpt</code>, and <code>content</code><br />
properties have been rewritten with the Spanish translation. In addition, the<br />
original properties have been prefixed with <code>original_</code>. This is always the<br />
case for all properties except for <code>excerpt</code> and <code>content</code>. In an effort to<br />
save on response size, the latter have been omitted.</p>
<h3>3.3. Translatable objects and properties</h3>
<p>Here are all of the translatable object types and their translatable<br />
properties, those that can be rewritten as described in Section 3.2.</p>
<p>Objects <code>post</code> and <code>page</code>:</p>
<ul>
<li><code>slug</code></li>
<li><code>title</code></li>
<li><code>title_plain</code></li>
<li><code>excerpt</code></li>
<li><code>content</code></li>
</ul>
<p>Objects <code>tag</code> and <code>category</code>:</p>
<ul>
<li><code>slug</code></li>
<li><code>title</code></li>
<li><code>description</code></li>
</ul>


WPML JSON API

An extension to JSON-API for sites using the WPML Multilingual CMS plugin.

Tim W

<p>Loco Translate provides in-browser editing of WordPress translation files and integration with automatic translation services.</p>
<p>It also provides Gettext/localization tools for developers, such as extracting strings and generating templates.</p>
<p>Features include:</p>
<ul>
<li>Built-in translation editor within WordPress admin</li>
<li>Integration with translation APIs including DeepL, Google, Lecto, Microsoft and OpenAI.</li>
<li>Create and update language files directly in your theme or plugin</li>
<li>Extraction of translatable strings from your source code</li>
<li>Native MO file compilation without the need for Gettext on your system</li>
<li>JSON (Jed) file compilation compatible with WordPress script localization</li>
<li>Support for standard PO features including comments, references and plural forms</li>
<li>PO source view with clickable source code references</li>
<li>Protected language directory for saving custom translations</li>
<li>Configurable PO file backups with diff and restore capability</li>
<li>Built-in WordPress locale codes</li>
</ul>
<p>Official <a href="https://localise.biz/" rel="nofollow ugc">Loco</a> WordPress plugin by Tim Whitlock.<br />
For more information please visit our <a href="https://localise.biz/wordpress/plugin" rel="nofollow ugc">plugin page</a>.</p>
<h3>Keyboard shortcuts</h3>
<p>The PO file editor supports the following keyboard shortcuts for faster translating:</p>
<ul>
<li>Done and Next: <code>Ctrl ↵</code></li>
<li>Next string: <code>Ctrl <span aria-hidden="true" class="wp-exclude-emoji">↓</span></code></li>
<li>Previous string: <code>Ctrl <span aria-hidden="true" class="wp-exclude-emoji">↑</span></code></li>
<li>Next untranslated: <code>Shift Ctrl <span aria-hidden="true" class="wp-exclude-emoji">↓</span></code></li>
<li>Previous untranslated: <code>Shift Ctrl <span aria-hidden="true" class="wp-exclude-emoji">↑</span></code></li>
<li>Copy from source text: <code>Ctrl B</code></li>
<li>Clear translation: <code>Ctrl K</code></li>
<li>Toggle Fuzzy: <code>Ctrl U</code></li>
<li>Save PO / compile MO: <code>Ctrl S</code></li>
<li>Toggle invisibles: <code>Shift Ctrl I</code></li>
<li>Suggest translation: <code>Ctrl J</code></li>
</ul>
<p>Mac users can use ⌘ Cmd instead of Ctrl.</p>


Loco Translate

must have


Great plugin. Very useful to be able to translate plugins without an external tool like poedit.


Great tool

I'm using it in all one language projects


We recommend this to all of our clients who ask about translations.



It can even be used to "translate" (alter) default English texts within a plugin/theme too.


Awesome Plugin

Great support!


A must-have plugin for managing the lifecycle of translations in custom plugins and themes. 



There's a steep learning curve to climb when it comes to language and translation management. This plugin helps a lot and works really well.



Also impressed with the speed of response to my help topic. Thanks Tim!


Excellent plugin and support


This is a great tool. I've been using it for years, and it has never let me down.


Simply awesome

Translate WordPress plugins and themes directly in your browser. Versatile PO file editor with integrated AI translation providers.

WPML JSON API vs Loco Translate