跳到内容

wp-cli/i18n-命令

wp-cli/i18n-命令

为WordPress项目提供国际化工具。

测试

快速链接:使用|正在安装|贡献|支持

使用

此程序包实现以下命令:

wp-i18n型

为WordPress项目提供国际化工具。

wp-i18n型

示例

#在当前目录中为WordPress插件/主题创建POT文件每磅1800万美元。语言/my-plugin.pot

wp-i18n标记点

为WordPress项目创建POT文件。

wp i18n make-pot<source>[<destination>][--slug=<slug>][--domain=<domain>][--ignore-domain][--merge[=<paths>]][--subtract=<path>][---subtract-and-merge][--include=<pats>][-->exclude=<paths>][--headers=<headers>][--location][--skip-js][--skip-php][--slip-blade][--kipp-block-json][--skip-theme-json][--skip-audit][--文件注释=<文件注释>][--包名称=<名称>]

扫描PHP、Blade-PHP和JavaScript文件中的可翻译字符串,以及主题样式表和插件文件如果源目录被检测为插件或主题。

选项

<来源>要扫描字符串提取的目录。[<目的地>]生成的POT文件的名称。[--段塞=<段塞>]插件或主题slug。默认为源目录的basename。[--域=<域>]要在源代码中查找的文本域,除非使用了“--ignore-domain”选项。默认情况下,使用插件或主题的“文本域”标头。如果没有提供,则返回到项目slug。[--忽略域]完全忽略文本域,并使用任何文本域提取字符串。[--合并[=<路径>]]以逗号分隔的POT文件列表,其内容应与提取的字符串合并。如果保留为空,则默认为目标POT文件。POT文件头将被忽略。[--减法=<路径>]以逗号分隔的POT文件列表,其内容应作为字符串提取的某种拒绝列表。在该拒绝列表中找到的任何字符串都不会被提取。当您想从同一个源目录创建多个POT文件时,这可能很有用不同的内容,它们之间没有重复的字符串。[--减法与合并]是否应将生成的POT文件中的源代码引用和注释添加到POT文件用于减法。警告:这将修改传递给`--subtract`的文件![--包含=<路径>]应用于字符串提取的文件和路径的逗号分隔列表。如果提供了,则只有这些文件和文件夹将被考虑用于字符串提取。例如,`--include=“src,my-file.php`将忽略除`my-file.php`和`src中的文件之外的任何内容`目录。可以使用简单的glob模式,即`--include=foo-*.php`包含带有`foo的任何php文件-`前缀。前导斜杠和尾随斜杠被忽略,即“/my/directory/`与“my/directory”相同。[--排除=<路径>]字符串提取应跳过的文件和路径的逗号分隔列表。例如,`--exclude=.github,myfile.php`将忽略在`myfile.pph`或`.github`中找到的任何字符串`文件夹。可以使用简单的glob模式,即`--exclude=foo-*.php`排除带有`foo的任何php文件-`前缀。前导斜杠和尾随斜杠被忽略,即“/my/directory/`与“my/directory”相同。这个始终排除以下文件和文件夹:node_modules、.git、.svn、。CVS、.hg、供应商、*.min.js。[--标头=<标头>]将添加到POT文件中的自定义头的JSON格式数组。默认为空数组。[--位置]是否写入`#:filename:line`行。默认为true,使用`--no-location`跳过删除。请注意,禁用此选项会使技术熟练的翻译人员更难理解每条消息的上下文。[--skip-js]跳过JavaScript字符串提取。当这在另一个构建步骤中完成时很有用,例如通过Babel。[--skip-php]跳过PHP字符串提取。[--刮刀]跳过Blade-PHP字符串提取。[--skip-block-json]跳过从block.json文件中提取字符串。[--跳过主题-json]跳过从theme.json文件中提取字符串。[--跳过审核]在尝试查找可翻译字符串中可能存在的错误时跳过字符串审核。在运行时很有用自动化环境。[-文件注释=<文件注释>]应作为注释添加到结果POT文件顶部的字符串。默认情况下,会按以下方式为WordPress插件和主题添加版权注释:```版权所有(C)2018示例插件作者此文件与Example Plugin包在同一许可证下分发。```如果插件或主题在其主插件文件或样式表中指定了许可证,则注释如下所示这个:```版权所有(C)2018示例插件作者此文件在GPLv2下分发。```[--包名=<名称>]在生成的POT文件的“Project-Id-Version”头中用于包名称的名称。覆盖插件或主题名称(如果适用)。

示例

#在当前目录中为WordPress插件/主题创建一个POT文件。每磅1800万美元。语言/my-plugin.pot#为WordPress核心中的大洲和城市列表创建一个POT文件。每磅1800万美元。continents-and-cities.pot--include=“wp-admin/includes/continents-cities.php”--ignore-domain#在当前目录中使用自定义标题为WordPress主题创建一个POT文件。每磅1800万美元。languages/my-theme.pot--headers='{“Report-Msgid-Bugs-To”:“https://github.com/theme-author/my-theme/“,”POT创建日期“:”“}”

wp i18n品牌-json

从PO文件中提取JavaScript字符串并将其添加到单个JSON文件中。

wp i18n生成json<source>〔<destination>〕〔-清除〕〔-更新mo文件〕〔-漂亮打印〕〔-使用map=<paths_or_maps>〕

为了实现JavaScript国际化,WordPress要求将翻译拆分为每个JavaScript源文件一个Jed-formatted JSON文件。

请参见https://make.wordpress.org/core/2018/11/09/new-javascript-i18n-support-in-wordpress/了解更多信息关于WordPress JavaScript国际化。

选项

<来源>现有PO文件或包含多个PO文件的目录的路径。[<目的地>]结果JSON文件的目标目录的路径。默认为源目录。[--清除]是否清除从原始源文件提取的字符串。默认为true,使用`--no-plurge`跳过删除。[-更新mo文件]更新采购订单文件后是否也应更新生产订单文件。只有与`--purge`结合使用时才有效。[--精美打印]预打印生成的JSON文件。[--使用映射=<路径_or_maps>]是否将字符串的映射文件用作JSON值数组以指定多个。每个元素可以是字符串(文件路径)或对象(映射)。

示例

#为languages目录中的所有PO文件创建JSON文件$wp i18n make-json语言#为my-plugin-de_de.po创建JSON文件,并保持po文件不变。$wp i18n make-json my-plugin-de_de.po/tmp--无清除#使用映射创建JSON文件$wp-i18n make-json语言--use-map=build/map.json#使用多个映射创建JSON文件$wp-i18n make-json语言'--use-map=[“build/map.json”,“build-map2.json”]'#使用对象映射创建JSON文件$wp-i18n make-json语言'--use-map={“source/index.js”:“build/indexjs”}'

wp-i18n-make-mo

从PO文件创建MO文件。

wp i18n make-mo<源>[<目的地>]

选项

<来源>现有采购订单文件或包含多个采购订单文件的目录的路径。[<目的地>]结果MO文件的目标文件或目录的路径。默认为源目录。

示例

#为当前目录中的所有PO文件创建MO文件。每磅1800万美元。#从特定目录中的单个PO文件创建MO文件。$wp-i18n make-mo示例-plugin-de_de.po语言#从单个PO文件创建MO文件到特定文件目标$wp i18n make-mo示例-plugin-de_de.po语言/bar.mo

wp-i18n品牌-php

从PO文件创建PHP文件。

wp i18n make-php<源>[<目标>]

选项

<来源>现有PO文件或包含多个PO文件的目录的路径。[<目的地>]生成的PHP文件的目标目录的路径。默认为源目录。

示例

#为当前目录中的所有PO文件创建PHP文件。每加仑1800万美元。成功:创建了3个文件。#从特定目录中的单个PO文件创建PHP文件。$wp-i18n make-php示例-plugin-de_de.po语言成功:创建了1个文件。

wp-i18n更新-po

从POT文件更新PO文件。

wp i18n更新-po<源>[<目标>]

其行为类似于消息合并命令。

选项

<来源>要用于更新的现有POT文件的路径。[<目的地>]要更新的PO文件或包含多个PO文件的目录。默认为源目录中的所有PO文件。

示例

#从当前目录中的POT文件更新所有PO文件。$wp i18n更新-po示例-plugin.pot成功:更新了3个文件。#从POT文件更新PO文件。$wp i18n更新po example-plugin.pot example-plugin-de_de.po成功:更新了1个文件。#从POT文件更新给定目录中的所有PO文件。$wp i18n更新po-example-plugin.pot语言成功:更新了2个文件。

正在安装

此软件包包含在WP-CLI本身中,无需额外安装。

要在WP-CLI中包含的内容上安装此软件包的最新版本,请运行:

wp包安装git@github.com:wp-cli/i18n-command.git

贡献

我们感谢你主动为这个项目做出贡献。

贡献不仅仅限于代码。我们鼓励您以最适合自己能力的方式作出贡献,包括编写教程、在本地会议上演示、帮助其他用户解答支持问题或修改我们的文档。

为了更全面的介绍,查看WP-CLI的贡献指南。此套餐遵循这些政策和指南。

报告错误

你觉得你发现了一个bug吗?我们希望您能帮助我们修复它。

在创建新问题之前,您应该搜索现有问题看看是否有现有的解决方案,或者是否已经在新版本中修复。

一旦你做了一点搜索,发现你的bug没有一个开放或修复的问题,请创建新问题。尽可能多地包含细节,并尽可能清晰地再现步骤。有关更多指导,查看我们的错误报告文档.

创建拉取请求

想贡献一个新功能吗?请你先打开新一期讨论该功能是否适合该项目。

一旦你决定花时间查看拉入请求,请遵循我们创建拉取请求的指导原则确保这是一次愉快的经历。请参阅“设置“了解本地处理此软件包的详细信息。

支持

GitHub问题不适用于一般支持问题,但您可以尝试其他解决方案:https://wp-cli.org/#支持

此README.md是使用从项目的代码库动态生成的wp脚手架包自述(文件). 要建议更改,请针对代码库的相应部分提交一个拉取请求。