Yard | Digital Agency

Mike van den Hoek

This plugin registers secure API endpoints that allow you to request translations directly from DeepL without exposing your Deepl API-key. These endpoints are only accessible when a valid nonce is provided. When providing translations to website visitors, you can configure which languages are supported for translation.
<h3>Caching Mechanism</h3>
Each object that is translated will store its cached translation in the <code>wp_postmeta</code> table within the database. This caching mechanism ensures that translations are efficiently reused, reducing unnecessary API requests to DeepL and saving costs.
<ul>
<li>Serving Cached Translations: If a cached translation is newer than the <code>post_modified</code> date of the object, the cached version is served.</li>
<li>Fetching New Translations: When the <code>post_modified</code> date of the object is more recent than the cached translation, a new translation is fetched from DeepL. Once retrieved, this translation is immediately cached for future use.</li>
</ul>
This approach minimizes the number of API calls to DeepL, ensuring translations are kept up to date only when necessary.
<h3>External Services</h3>
This plugin connects to the DeepL API to provide translations for content.
<ul>
<li>Service: DeepL API (https://www.deepl.com)</li>
<li>Purpose: To translate text from one language to another based on the provided target language.</li>
<li>Data Sent: Text content for translation, the target language code, and the DeepL API key (handled securely and never exposed to users).</li>
<li>Conditions: Data is sent when a request for translation is initiated.</li>
<li>Privacy Policy: <a href="https://www.deepl.com/privacy" rel="nofollow ugc">DeepL Privacy Policy</a></li>
<li>Terms of Service: <a href="https://www.deepl.com/pro-license" rel="nofollow ugc">DeepL Terms of Service</a></li>
</ul>
<h3>Usage</h3>
<h3>Security</h3>
The API endpoints registered by this plugin are secured using a WordPress nonce. The nonce is passed to the front-end using the <code>wp_localize_script</code> function and is stored in a global JavaScript object <code>ydpl</code> which contains the following properties:
<ul>
<li><code>ydpl_translate_post_id</code>: The ID of the post to be translated.</li>
<li><code>ydpl_rest_translate_url</code>: The URL of the API endpoint for translation requests.</li>
<li><code>ydpl_supported_languages</code>: The list of languages supported for translation.</li>
<li><code>ydpl_api_request_nonce</code>: The nonce used for API validation.</li>
</ul>
When making requests to the API, ensure that the nonce is included in the request headers. The header should be named <code>nonce</code>, and it should contain the value of <code>ydpl_api_request_nonce</code>.
<h3>Example</h3>
<h3>Request</h3>
<pre><code>var xhr = new XMLHttpRequest();
xhr.open('POST', ydpl.ydpl_rest_translate_url, true);

// Set request headers
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('nonce', ydpl.ydpl_api_request_nonce);

// Handle response
xhr.onreadystatechange = function () {
 if (xhr.readyState === 4 && xhr.status === 200) {
 console.log('Translation:', JSON.parse(xhr.responseText));
 } else if (xhr.readyState === 4) {
 console.error('Error:', xhr.statusText);
 }
};

// Prepare and send the request body
var data = JSON.stringify({
 text: ["Look another test"],
 target_lang: "DE"
});

xhr.send(data);
</code></pre>
<h3>Response</h3>
<pre><code>[
 {
 "text": "Look another test!",
 "translation": "Sehen Sie sich einen weiteren Test an!"
 }
]
</code></pre>

Yard DeepL

This plugin registers secure API endpoints that allow you to request translations directly from DeepL without exposing your DeepL API-key.

GeroNikolov

Most of the translation plugins are built in very complicated and messy way… 
That’s why with WP_BASE_TRANSLATE you can create, edit or remove new languages in just a few clicks!
When the plugin is installed it performs the following things:
<ul>
<li>Registers the Language Custom Post Type (CPT)</li>
<li>Creates the _WP_PREFIX_page_language_relations table in your installation Database</li>
<li>Adds page language metabox to Post / Page (it works with all CPTs as well)</li>
<li>Adds avalilable languages metabox on which your page can be translated</li>
</ul>
How to add a new language?
The languages are registered in your database as Posts from Language CPT. 
So to create a new language just go to Languages > Add new > Enter name (as title of the post) > Choose the icon of the language (optional as featured image).
That’s it!
How to translate?
As we mentioned above you can translate every post from a CPT in your WordPress installation.
To achieve that the plugin is registering a meta box called Available Languages, which represents the list of all available languages (as active buttons) on which you can translate the specific page. 
Before you can start translating, you have to choose the current language of the page from the Page Language dropdown box. That will tell the plugin which is the parent language and connect the translated versions with it. 
Once you do that, you just have to select the language on which you want to see your page and start translate the content in it.
That’s all!
How it works on the front?
WP_BASE_TRANSLATE is meant to be easy, so if you currently have a language menu option connected on your website it’ll work with it. 
The only requirement for the plugin to work properly is to add lang parameter in your page URL.
Example: http://geronikolov.com/blog —> http://geronikolov.com/blog?lang=bg (that will call the Blog page translated in Bulgarian)
What happens if I don’t have that language implementation in my site?
WP_BASE_TRANSLATE gives you a simple language dropdown menu, which can be placed everywhere you want it! 
Do add to your Posts, Pages or Code, just use this shortcode – [language_menu]
How to build the Language listing menu?
Since the plugin doesn’t provide a hardcoded menu, it provides a very flexible back-end method for implementing it with your website. 
The core of the plugin gives you a function called get_registered_languages() which returns an Array of Objects which represent the registered Language objects.
Every language object has:
<ul>
<li>Language ID: That’s the ID of the Post in the database</li>
<li>Language Name: That’s the Title of the Post</li>
<li>Language Code: That’s the small version of your language title, for example if you have EN as title, the code will be en. In the navigation menu you should use it as value of the lang parameter.</li>
<li>Language Full Name: That’s the full name of the language. Example: EN = English; ES = Espanol;</li>
<li>Language Slug: That’s the post slug you’ve choosed from the WordPress Dashboard. By default it’s smaller version of the title equal to the Language Code</li>
<li>Language Link: That’s the permalink of the Language Post Object.</li>
<li>Language Author: That’s the ID of the Administrator who created the language in your WordPress installation.</li>
<li>Language Icon: That’s the link to the language icon, which was selected from the WP Dashboard. Usually it’s the flag of the Parent Country of the language.</li>
</ul>
The wpbt_get_registered_languages() function can be found in the functions.php file positioned in the root folder of the plugin.
Functions list: functions.php 
wpbt_get_registered_languages() 
wpbt_get_translation_id()
How to contribute?
You just have to clone the repository and build!
If you want to extend the WP_BASE_TRANSLATE Core make sure to add small comment block above each of your functions.
The code block should look like:
<pre>
/*
* Function name: example_function
* Function arguments: $post_id [ INT ]
* Function purpose: This function is just for an example.
*/
function example_function( $post_id ) { return "John Snow is alive!"; }
</pre>
<a href="https://github.com/Gero0Nikolov/wp-base-translate" rel="nofollow ugc">Join the contributions!</a>

WP Base Translate

This plugin will allow you to create a multilingual website in just a few clicks.

Yard DeepL vs WP Base Translate