title: "内部 API" post_status: publish comment_status: open taxonomy: category: - wp-cli-handbook post_tag: - Repos - Data - Docs Translate

内部 API

WP-CLI 包含一系列被视为稳定且供命令使用的实用工具。

这也意味着未在此列出的函数和方法属于私有 API 的范畴。它们可能随时变更或消失。

内部 API 文档随每个版本从 WP-CLI 代码库自动生成。如需改进建议，请提交拉取请求。

注册

WP_CLI::add_hook() - 安排回调函数在特定时间点执行。
WP_CLI::do_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() - 显示以“Success: ”为前缀的成功消息。
WP_CLI::debug() - 当使用 `--debug` 参数时，显示以“Debug: ”为前缀的调试消息。
WP_CLI::warning() - 显示以“Warning: ”为前缀的警告消息。
WP_CLI::error() - 显示以“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 的变量。
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\trailingslashit() - 添加尾部斜杠。
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 中的错误，并处理类 Unix 的 `ENV_VAR=blah cmd` 环境变量前缀。
WP_CLI\Utils\esc_like() - 在为 MySQL 准备之前，转义 LIKE 特殊字符 % 和 _ 的前半部分。

← 返回文档中心