内部接口

WP-CLI包括许多被认为是稳定的实用程序，旨在由命令使用。

这也意味着此处未列出的函数和方法被视为私有 API 的一部分。它们可能随时更改或消失。

内部 API 文档在每个版本上从 WP-CLI 代码库生成。要提出改进建议，请提交拉取请求。

注册

• WP_CLI::add_hook() – 安排在某个时间点执行回调。
• WP_CLI：:d o_hook() – 执行注册到给定钩子的回调。
• WP_CLI::add_wp_hook() – 向 WordPress 操作或过滤器添加回调。
• WP_CLI::add_command() – 向 WP-CLI 注册命令。

输出

• WP_CLI\Utils\format_items() – 将项目集合呈现为 ASCII 表、JSON、CSV、YAML、ID 列表或计数。
• WP_CLI\Utils\make_progress_bar() – 创建进度条以显示给定操作的完成百分比。
• WP_CLI::colorize() – 为输出的字符串着色。
• WP_CLI::line() – 显示不带前缀的信息性消息，并忽略“–quiet”。
• WP_CLI::log() – 显示不带前缀的信息性消息。
• WP_CLI::success() – 显示以“成功：”为前缀的成功消息。
• WP_CLI：:debug() – 使用“–debug”时，显示前缀为“Debug：”的调试消息。
• WP_CLI::error() – 显示前缀为“错误：”的错误消息和退出脚本。
• WP_CLI::halt() – 使用特定返回代码停止脚本执行。
• WP_CLI::error_multi_line() – 在红色框中显示多行错误消息。不退出脚本。

输入

• WP_CLI\Utils\launch_editor_for_input() – 启动系统$EDITOR，供用户编辑某些文本。
• WP_CLI\Utils\get_flag_value() – 返回标志值，如果未设置，则返回$default值。
• WP_CLI\Utils\report_batch_operation_results() – 针对多个资源报告同一操作的结果。
• WP_CLI\Utils\parse_str_to_argv() – 将一串命令行参数解析为 $argv-esqe 变量。
• WP_CLI::confirm() – 在运行破坏性操作之前请求确认。
• WP_CLI::read_value() – 从各种格式读取值。
• WP_CLI::has_config() – 确认全局配置参数确实存在。
• WP_CLI::get_config() – 获取全局配置参数的值。

执行

• WP_CLI::launch() – 启动接管 I/O 的任意外部进程。
• WP_CLI::launch_self() – 在新进程中重用当前运行时参数运行 WP-CLI 命令。
• WP_CLI::runcommand() – 运行 WP-CLI 命令。
• WP_CLI::run_command() – 使用相同的全局参数在当前进程中运行给定命令。

系统

• WP_CLI\Utils\get_home_dir() – 获取主目录。
• WP_CLI\Utils\normalize_path() – 规范化文件系统路径。
• WP_CLI\Utils\get_temp_dir() – 获取系统的临时目录。如果不可写，则警告用户。
• WP_CLI\Utils\get_php_binary() – 获取执行 WP-CLI 时使用的 PHP 二进制文件的路径。
• WP_CLI::get_php_binary() – 获取执行 WP-CLI 时使用的 PHP 二进制文件的路径。

杂项

• WP_CLI\Utils\write_csv() – 将数据作为 CSV 写入给定文件。
• WP_CLI\Utils\http_request() – 向远程 URL 发出 HTTP 请求。
• WP_CLI\Utils\get_named_sem_ver() – 比较两个版本字符串以获取命名的语义版本。
• WP_CLI\Utils\parse_ssh_url() – 解析其主机、端口和路径的 SSH URL。
• WP_CLI\Utils\basename() – 与 basename() 的区域设置无关的版本
• WP_CLI\Utils\isPiped() – 检查当前脚本的输出是 TTY 还是管道/重定向
• WP_CLI\Utils\proc_open_compat() – Windows 兼容的 'proc_open()'.解决了PHP中的错误，并且还处理了类似*nix的“ENV_VAR=blah cmd”环境变量前缀。
• WP_CLI\Utils\esc_like() – 在准备 MySQL 之前转义 LIKE 特殊字符 % 和 _ 的前半部分。