raph-topo/wp-translations

Composer plugin to download translation files from wordpress.org


Keywords
composer, internationalization, roots, wordpress
License
CNRI-Python-GPL-Compatible

Documentation

WP Translations

Packagist Version Packagist Stars Packagist Downloads GitHub last commit PHP Composer GitHub issues GitHub pull requests License

Composer plugin to download translation files for WordPress core, plugins and themes from wordpress.org.

Optimized for the Roots stack, particularly Bedrock, but can be adapted to other setups based on Composer.

Supports Composer v2 (only).

Instructions are given relative to the Bedrock root folder, usually site.

Installation

Add the following settings to composer.json:

{
    "extra": {
        "wordpress-translations": [ "fr_FR" ],
        "wordpress-translations-dir": "web/app/languages"
    }
}

The Translate WordPress page lists available locales (column WP Locale)

Install WP Translations with:

$ composer require raph-topo/wp-translations

Usage

Composer will try to install translations from through the WordPress.org API every time you install or update a package — for this package only.

Commit the translation files (web/app/languages/{.,themes,plugins}/*{.mo,.po}) and deploy them to staging and production.

From time to time, you might want to get rid of old translation files (plugins that were uninstalled, etc.) To do that, you must delete web/app/languages and follow Extant projects hereunder.

Extant projects

To force-update translations for already installed packages, delete the contents of the following folders:

  • web/wp
  • web/app/plugins, except the file web/app/plugins/.gitkeep

Run composer update.

Credits

This package was started by Angry Creative, has been rewritten by Bjørn Johansen, integrates compatibility changes made by Mirai and was updated to support Composer v2.