钩子文档

translations_api

💡 云策文档标注

概述

translations_api 是一个 WordPress 过滤器钩子,允许插件完全覆盖 WordPress.org 翻译安装 API。它用于在请求翻译时修改或替换返回的结果。

关键要点

  • translations_api 是一个过滤器钩子,用于拦截和自定义翻译 API 的响应。
  • 它接受三个参数:$result(初始结果数组,默认为 false)、$type(请求的翻译类型)和 $args(翻译 API 的参数对象)。
  • 插件可以通过此钩子提供自定义翻译数据或完全替代默认的 WordPress.org API 行为。

代码示例

$res = apply_filters( 'translations_api', false, $type, $args );

注意事项

  • 此钩子自 WordPress 4.0.0 版本引入,使用时需确保兼容性。
  • translations_api() 函数在 wp-admin/includes/translation-install.php 中定义,用于从 WordPress 翻译 API 检索翻译。

📄 原文内容

Allows a plugin to override the WordPress.org Translation Installation API entirely.

Parameters

$resultfalse|array
The result array. Default false.
$typestring
The type of translations being requested.
$argsobject
Translation API arguments.

Source

$res = apply_filters( 'translations_api', false, $type, $args );

Changelog

Version Description
4.0.0 Introduced.