Yard DeepL

The uncached call count is only incremented for visitor requests (users without cache-write capability) and is automatically reset per language once a cache entry is stored. Posts with the Disable translation cache option enabled are excluded from the column entirely.

External Services

This plugin connects to the DeepL API to provide translations for content.

• Service: DeepL API (https://www.deepl.com)
• Purpose: To translate text from one language to another based on the provided target language.
• Data Sent: Text content for translation, the target language code, and the DeepL API key (handled securely and never exposed to users).
• Conditions: Data is sent when a request for translation is initiated.
• Privacy Policy: DeepL Privacy Policy
• Terms of Service: DeepL Terms of Service

The API base URL defaults to https://api.deepl.com/v2/translate and can be overridden on the plugin’s settings page, for example to use a DeepL Free API account ( https://api-free.deepl.com/v2/translate ).

Usage

Security

The API endpoints registered by this plugin are secured using a WordPress nonce. The nonce is passed to the front-end using the wp_localize_script function and is stored in a global JavaScript object ydpl which contains the following properties:

• ydpl_translate_post_id : The ID of the post to be translated.
• ydpl_rest_translate_url : The URL of the API endpoint for translation requests.
• ydpl_supported_languages : The list of languages supported for translation.
• ydpl_api_request_nonce : The nonce used for API validation.

When making requests to the API, ensure that the nonce is included in the request headers. The header should be named X-WP-Nonce , and it should contain a nonce created with the wp_rest action (available via ydpl.ydpl_api_request_nonce on the front-end).

Rate limiting: Unauthenticated requests (or requests from users without the cache capability) are limited to 3 requests per 60 seconds per IP address. Authenticated users with the required cache capability (default: edit_posts) are exempt from this rate limit.

Cache capability: Only users with the edit_posts capability can trigger cache creation. This can be customized using the yard::deepl/cache_capability filter.

Example

Request:

var xhr = new XMLHttpRequest(); xhr.open('POST', ydpl.ydpl_rest_translate_url, true); // Set request headers xhr.setRequestHeader('Content-Type', 'application/json'); xhr.setRequestHeader('X-WP-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);

Response:

[ { "text": "Look another test!", "translation": "Sehen Sie sich einen weiteren Test an!" } ]<h3>Filters</h3>

* yard::deepl/cache_capability (default: edit_posts ) — The WordPress capability required to create cache entries. Users without this capability receive translations but results are not cached. * yard::deepl/cache_metabox_post_types (default: ['page'] ) — Post types on which the Yard DeepL cache metabox is displayed. * yard::deepl/disable_cache_metabox_post_types — Deprecated. Use yard::deepl/cache_metabox_post_types instead.