README

🌐 Kirby Google Translate

Google Translate integration for Kirby.

This plugin provides Google Cloud Translation V2 API integration for Kirby pages. It makes instant translation and updates the contents of the relevant language.

Installation

Download the latest release
Unzip downloaded file
Copy/paste unzipped folder in your /site/plugins folder

Requirements

Kirby 4 or 5 (for Kirby 3, use 1.1.0)
PHP 8.1+
Google Cloud Translation API KEY

Usage

After you get the Google API KEY and set it from the config file, enable the translation from the blueprint file of the page you want to use as follows

# /site/blueprints/pages/post.yml
title: Post

options:
  translate: true

Google Cloud Translation

Google Cloud Translation is free for up to 500,000 characters per month. For detailed pricing, you can check the official page: https://cloud.google.com/translate/pricing

Fields & Blocks

Only the following fields and blocks are supported. This is because some fields do not need translation. such as email, url or date, etc.

Also custom fields are not supported because their data structure is unknown. Therefore this plugin also allows you to define a class that reads and saves the custom data structure of custom fields.

Supports nested data/form structure, but has not been tested beyond 2 levels.

Fields

blocks
layout
list
structure
textarea
text
writer

Blocks

heading
list
markdown
quote
text

Options

Option	Type	Default	Description
apiKey	string	null	Google Cloud Translate Api Key (required)
fieldTypes	array	[]	Determines the field types you want to be translated.
blockTypes	array	[]	Additional block types to translate, next to the core block types.
overwrite	boolean	false	If disabled, already translated fields, title and slug are kept.
translateTitle	boolean	true	When enabled, the title is translated along with the page.
translateSlug	boolean	true	When enabled, the slug is translated along with the page.

All options optional and the values can be updated in the config.php file and prefixed with owebstudio.google-translate..

Sample options

<?php

// /site/config/config.php
return [
    'owebstudio.google-translate' => [
        'apiKey' => 'MY_GOOGLE_API_KEY',
        'blockTypes' => ['my-custom-block-type'],
        'translateTitle' => true,
        'translateSlug' => true
    ]
];

Defining custom field types

Field should extends \Oweb\GoogleTranslate\Fields\Field
Field have to value and save methods

<?php

class CustomField extends \Oweb\GoogleTranslate\Fields\Field
{
    public string $format = 'html'; // text or html

    public function value(): string|array
    {
        $value = $this->field()->value();
        $result = $this->translate($value);

        return $this->save($result);
    }

    public function save($value)
    {
        return $value;
    }
}

// /site/config/config.php
return [
    'owebstudio.google-translate' => [
        'apiKey' => 'MY_GOOGLE_API_KEY',
        'fieldTypes' => [
            'custom' => CustomField::class
        ]
    ]
];

Field definition can only be done with classes. Field definition with Closure is not possible at the moment, but it can be considered in the future.

License

Google Translate is a commercial plugin. It is free to use on your local computer and on staging sites. A live site needs a license key: buy a license (€29.99) and activate it in the Panel with the button in the translate dialog, or in the System view (Kirby 5 and newer) by clicking the license status of the plugin.

Without a license key, the translate dialog shows a notice on a live site and no page is sent to Google. Your website keeps working.

oweb studio Commercial License. Versions released under the MIT license stay MIT. The current license is available at https://github.com/owebstudio/.github/blob/main/LICENSE.md.

owebstudio / kirby-google-translate

Package info

Security

Statistics