Internationalize WordPress themes and plugins.
Branch: develop
Clone or download
Latest commit 1111add Feb 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Replace continue statement inside a switch (#21) Jan 17, 2019
docs Add exclude option to `makepot` cli command (#12) Apr 3, 2018
lib Blank out reference headers when normalizing for comparison. Dec 21, 2018
test Add a custom header in the test comparing POT objects for changes. Dec 21, 2018
.editorconfig Initial commit. Dec 10, 2015
.gitignore Update dependencies. Oct 30, 2017
.jshintrc Initial commit. Dec 10, 2015
.travis.yml Add PHP 7.2 to the Travis config. Apr 3, 2018
LICENSE.md Initial commit. Dec 10, 2015
README.md
index.js
package.json Release 1.2.3. Feb 5, 2019

README.md

node-wp-i18n Build Status

Internationalize WordPress plugins and themes.

WordPress has a robust suite of tools to help internationalize plugins and themes. This plugin brings the power of those existing tools to Node.js in order to make it easy for you to automate the i18n process and make your projects more accessible to an international audience.

If you're not familiar with i18n concepts, read the Internationalization entries in the Plugin Developer Handbook or Theme Developer Handbook.

node-wp-i18n started as the core of the grunt-wp-i18n plugin, but has been extracted and rewritten to be more useful as a standalone module and with other tools.

Getting Started

node-wp-i18n includes a basic CLI tool to help generate POT file or add text domains to i18n functions in WordPress plugins or themes. Installing this module globally will allow you to access the wpi18n command:

npm install -g node-wp-i18n

Once installed, run this command from a plugin or theme to see the available options:

wpi18n -h

Running wpi18n info in a plugin or theme directory will show you information about that package.

Requirements

  • PHP CLI must be in your system path.