Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 2.59 KB

README.md

File metadata and controls

78 lines (49 loc) · 2.59 KB
Raw

Composer Auto Language Updates

This package will automatically update translations for WordPress core, themes & plugins when you install or update them via composer.*

Made with ❤️ by Angry Creative in Sweden.

* This only works if the translations are available via the WordPress API.

Installation instructions

1. Add this repository as a composer dependency

First, add this .git repo to the repositories array in your sites main composer.json file.

{
  "type": "git",
  "url": "https://github.com/Angrycreative/composer-plugin-language-update.git"
}

2. Require the package.

Run composer require Angrycreative/composer-plugin-language-update:"*".

3. Define the languages used on your site and the path to your wp-content directory.

This can be done by adding the following parameters to the extras object in your sites' main composer.json file.

"extra": {
  "wordpress-languages": [ "sv_SE", "en_GB", "da_DK" ],
  "wordpress-path-to-content-dir": "public/wp-content"
 }

(We need to add a list of locales manually as this operation cannot rely on having a connection to the database available).

4. Add the required composer install hooks.

Add the following lines to the scripts section of your composer.json.

"scripts": {
  "post-package-install": [
    "AngryCreative\\PostUpdateLanguageUpdate::install_t10ns"
  ],
  "post-package-update": [
    "AngryCreative\\PostUpdateLanguageUpdate::update_t10ns"
  ]
}

That's it. Next time you run a composer update|install the translations for the relevant packages will be installed automatically.

Tests

If you're testing, this package must be installed as a part of WordPress installation. You should ideally remove the entire wp-content/languages directory, so as to make sure the package behaves as expected.

Obviously you should probably do this on seperate branch, so you don't remove t10ns accidentaly when you run the tests.

cd into the packagage directory and run composer test.

You may need to run the tests as root to avoid permissions errors when creating the directories.

WTF?

I can haz missing translation plz?

This only works if the t10ns are found on the WordPress API, eg. https://api.wordpress.org/translations/plugins/1.0/?slug=redirection&version=2.7.3

I can haz clean up after you?

At the moment the translations are not removed on composer uninstall. Pull requests welcome!

I can haz missing feature plz?

Sure thing! This is GitHub so just make us a pull request and we'll work together on making that happen.