gem-hunter

wp-cli/i18n-command

Using

wp i18n

wp i18n

# Create a POT file for the WordPress plugin/theme in the current directory
$ wp i18n make-pot . languages/my-plugin.pot

wp i18n audit

wp i18n audit <source> [--slug=<slug>] [--domain=<domain>] [--ignore-domain] [--include=<paths>] [--exclude=<paths>] [--skip-js] [--skip-php] [--skip-blade] [--skip-block-json] [--skip-theme-json] [--format=<format>]

<source>
	Directory to scan for string extraction.

[--slug=<slug>]
	Plugin or theme slug. Defaults to the source directory's basename.

[--domain=<domain>]
	Text domain to look for in the source code, unless the `--ignore-domain` option is used.
	By default, the "Text Domain" header of the plugin or theme is used.
	If none is provided, it falls back to the project slug.

[--ignore-domain]
	Ignore the text domain completely and extract strings with any text domain.

[--include=<paths>]
	Comma-separated list of files and paths that should be used for string extraction.
	If provided, only these files and folders will be taken into account.

[--exclude=<paths>]
	Comma-separated list of files and paths that should be ignored for string extraction.
	For example, `--exclude=.github,myfile.php` would ignore any strings found within `myfile.php` or the `.github`
	folder. Simple glob patterns can be used, i.e. `--exclude="foo-*.php"` excludes any PHP file with the `foo-`
	prefix. Leading and trailing slashes are ignored, i.e. `/my/directory/` is the same as `my/directory`. The
	following files and folders are always excluded: node_modules, .git, .svn, .CVS, .hg, vendor, *.min.js, test, tests.

[--skip-js]
	Skips JavaScript string extraction.

[--skip-php]
	Skips PHP string extraction.

[--skip-blade]
	Skips Blade-PHP string extraction.

[--skip-block-json]
	Skips string extraction from block.json files.

[--skip-theme-json]
	Skips string extraction from theme.json files.

[--format=<format>]
	Output format for the audit results.
	---
	default: plaintext
	options:
	  - plaintext
	  - json
	  - github-actions
	---

# Audit a plugin for possible translation issues.
$ wp i18n audit wp-content/plugins/hello-world

# Audit a plugin and output results as JSON.
$ wp i18n audit wp-content/plugins/hello-world --format=json

# Audit a plugin with GitHub Actions annotations format.
$ wp i18n audit wp-content/plugins/hello-world --format=github-actions

wp i18n make-pot

wp i18n make-pot <source> [<destination>] [--slug=<slug>] [--domain=<domain>] [--ignore-domain] [--merge[=<paths>]] [--subtract=<paths>] [--subtract-and-merge] [--include=<paths>] [--exclude=<paths>] [--headers=<headers>] [--location] [--skip-js] [--skip-php] [--skip-blade] [--skip-block-json] [--skip-theme-json] [--skip-audit] [--file-comment=<file-comment>] [--package-name=<name>]

<source>
	Directory to scan for string extraction.

[<destination>]
	Name of the resulting POT file.

[--slug=<slug>]
	Plugin or theme slug. Defaults to the source directory's basename.

[--domain=<domain>]
	Text domain to look for in the source code, unless the `--ignore-domain` option is used.
	By default, the "Text Domain" header of the plugin or theme is used.
	If none is provided, it falls back to the project slug.

[--ignore-domain]
	Ignore the text domain completely and extract strings with any text domain.

[--merge[=<paths>]]
	Comma-separated list of POT files whose contents should be merged with the extracted strings.
	If left empty, defaults to the destination POT file. POT file headers will be ignored.

[--subtract=<paths>]
	Comma-separated list of POT files whose contents should act as some sort of denylist for string extraction.
	Any string which is found on that denylist will not be extracted.
	This can be useful when you want to create multiple POT files from the same source directory with slightly
	different content and no duplicate strings between them.

[--subtract-and-merge]
	Whether source code references and comments from the generated POT file should be instead added to the POT file
	used for subtraction. Warning: this modifies the files passed to `--subtract`!

[--include=<paths>]
	Comma-separated list of files and paths that should be used for string extraction.
	If provided, only these files and folders will be taken into account for string extraction.
	For example, `--include="src,my-file.php"` will ignore anything besides `my-file.php` and files in the `src`
	directory. Simple glob patterns can be used, i.e. `--include="foo-*.php"` includes any PHP file with the `foo-`
	prefix. Leading and trailing slashes are ignored, i.e. `/my/directory/` is the same as `my/directory`.

[--exclude=<paths>]
	Comma-separated list of files and paths that should be skipped for string extraction.
	For example, `--exclude=.github,myfile.php` would ignore any strings found within `myfile.php` or the `.github`
	folder. Simple glob patterns can be used, i.e. `--exclude="foo-*.php"` excludes any PHP file with the `foo-`
	prefix. Leading and trailing slashes are ignored, i.e. `/my/directory/` is the same as `my/directory`. The
	following files and folders are always excluded: node_modules, .git, .svn, .CVS, .hg, vendor, *.min.js.

[--headers=<headers>]
	Array in JSON format of custom headers which will be added to the POT file. Defaults to empty array.

[--location]
	Whether to write `#: filename:line` lines.
	Defaults to true, use `--no-location` to skip the removal.
	Note that disabling this option makes it harder for technically skilled translators to understand each message’s context.

[--skip-js]
	Skips JavaScript string extraction. Useful when this is done in another build step, e.g. through Babel.

[--skip-php]
	Skips PHP string extraction.

[--skip-blade]
	Skips Blade-PHP string extraction.

[--skip-block-json]
	Skips string extraction from block.json files.

[--skip-theme-json]
	Skips string extraction from theme.json files.

[--skip-audit]
	Skips string audit where it tries to find possible mistakes in translatable strings. Useful when running in an
	automated environment.

[--file-comment=<file-comment>]
	String that should be added as a comment to the top of the resulting POT file.
	By default, a copyright comment is added for WordPress plugins and themes in the following manner:

	```
	Copyright (C) 2018 Example Plugin Author
	This file is distributed under the same license as the Example Plugin package.
	```

	If a plugin or theme specifies a license in their main plugin file or stylesheet, the comment looks like
	this:

	```
	Copyright (C) 2018 Example Plugin Author
	This file is distributed under the GPLv2.
	```

[--package-name=<name>]
	Name to use for package name in the resulting POT file's `Project-Id-Version` header.
	Overrides plugin or theme name, if applicable.

# Create a POT file for the WordPress plugin/theme in the current directory.
$ wp i18n make-pot . languages/my-plugin.pot

# Create a POT file for the continents and cities list in WordPress core.
$ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php" --ignore-domain

# Create a POT file for the WordPress theme in the current directory with custom headers.
$ wp i18n make-pot . languages/my-theme.pot --headers='{"Report-Msgid-Bugs-To":"https://github.com/theme-author/my-theme/","POT-Creation-Date":""}'

wp i18n make-json

wp i18n make-json <source> [<destination>] [--domain=<domain>] [--extensions=<extensions>] [--pretty-print] [--use-map=<paths_or_maps>]

<source>
	Path to an existing PO file or a directory containing multiple PO files.

[<destination>]
	Path to the destination directory for the resulting JSON files. Defaults to the source directory.

[--domain=<domain>]
	Text domain to use for the JSON file name. Overrides the default one extracted from the PO file.

[--extensions=<extensions>]
	Additional custom JS extensions, comma separated list. By default searches for .min.js and .js extensions.

[--pretty-print]
	Pretty-print resulting JSON files.

[--use-map=<paths_or_maps>]
	Whether to use a mapping file for the strings, as a JSON value, array to specify multiple.
	Each element can either be a string (file path) or object (map).

# Create JSON files for all PO files in the languages directory
$ wp i18n make-json languages

# Create JSON files for my-plugin-de_DE.po
$ wp i18n make-json my-plugin-de_DE.po /tmp

# Create JSON files with mapping
$ wp i18n make-json languages --use-map=build/map.json

# Create JSON files with multiple mappings
$ wp i18n make-json languages '--use-map=["build/map.json","build/map2.json"]'

# Create JSON files with object mapping
$ wp i18n make-json languages '--use-map={"source/index.js":"build/index.js"}'

wp i18n make-mo

wp i18n make-mo <source> [<destination>]

<source>
	Path to an existing PO file or a directory containing multiple PO files.

[<destination>]
	Path to the destination file or directory for the resulting MO files. Defaults to the source directory.

# Create MO files for all PO files in the current directory.
$ wp i18n make-mo .

# Create a MO file from a single PO file in a specific directory.
$ wp i18n make-mo example-plugin-de_DE.po languages

# Create a MO file from a single PO file to a specific file destination
$ wp i18n make-mo example-plugin-de_DE.po languages/bar.mo

wp i18n make-php

wp i18n make-php <source> [<destination>] [--pretty-print]

<source>
	Path to an existing PO file or a directory containing multiple PO files.

[<destination>]
	Path to the destination directory for the resulting PHP files. Defaults to the source directory.

[--pretty-print]
	Pretty-print resulting PHP files.

# Create PHP files for all PO files in the current directory.
$ wp i18n make-php .
Success: Created 3 files.

# Create a PHP file from a single PO file in a specific directory.
$ wp i18n make-php example-plugin-de_DE.po languages
Success: Created 1 file.

# Create a pretty-printed PHP file.
$ wp i18n make-php example-plugin-de_DE.po languages --pretty-print
Success: Created 1 file.

wp i18n update-po

wp i18n update-po <source> [<destination>] [--purge]

<source>
	Path to an existing POT file to use for updating.

[<destination>]
	PO file to update or a directory containing multiple PO files.
	  Defaults to all PO files in the source directory.

[--purge]
	Remove obsolete strings and replace translator comments. Defaults to true.
	  By default, strings not found in the POT file are removed, and translator comments are replaced with those from the POT file.
	  Use `--no-purge` to preserve obsolete translations (marked with #~) and existing translator comments like copyright notices.

# Update all PO files from a POT file in the current directory.
$ wp i18n update-po example-plugin.pot
Success: Updated 3 files.

# Update a PO file from a POT file.
$ wp i18n update-po example-plugin.pot example-plugin-de_DE.po
Success: Updated 1 file.

# Update all PO files in a given directory from a POT file.
$ wp i18n update-po example-plugin.pot languages
Success: Updated 2 files.

# Update PO files while keeping obsolete strings and translator comments.
$ wp i18n update-po example-plugin.pot --no-purge
Success: Updated 3 files.

# Shows message when some files don't need updating.
$ wp i18n update-po example-plugin.pot languages
Success: Updated 2 files. 1 file unchanged.

Installing

wp package install git@github.com:wp-cli/i18n-command.git

Contributing

Reporting a bug

Creating a pull request

License

Support