WordPress 插件安装过程中的扩展点与自定义实践

/**
 * 修改 plugins_api 请求参数的过滤器示例
 *
 * @param object $args   API 请求参数对象。
 * @param string $action 当前的 API 动作（例如 'plugin_information'）。
 * @return object 修改后的 API 请求参数对象。
 */
add_filter( 'plugins_api_args', 'my_custom_plugin_api_args', 10, 2 );
function my_custom_plugin_api_args( $args, $action ) {
    // 仅当动作是获取插件信息时进行修改
    if ( 'plugin_information' === $action ) {
        // 假设我们想为某个特定的插件slug添加一个自定义参数
        if ( isset( $args->slug ) && 'my-target-plugin' === $args->slug ) {
            $args->my_custom_param = 'some_value'; // 添加自定义参数
            // 也可以修改现有参数，例如 $args->locale = 'en_US';
        }
    }
    return $args;
}

/**
 * 接管 plugins_api 请求的过滤器示例
 *
 * @param false|object $res    API 响应结果，如果为 false 表示未处理。
 * @param string       $action 当前的 API 动作。
 * @param object       $args   API 请求参数对象。
 * @return object|false 自定义的 API 响应结果，或 false 继续默认处理。
 */
add_filter( 'plugins_api', 'my_custom_plugin_api_handler', 10, 3 );
function my_custom_plugin_api_handler( $res, $action, $args ) {
    // 如果 $res 已经不是 false，说明已被其他过滤器处理，直接返回
    if ( false !== $res ) {
        return $res;
    }

    // 假设我们想为名为 'my-private-plugin' 的插件提供自定义信息
    if ( 'plugin_information' === $action && isset( $args->slug ) && 'my-private-plugin' === $args->slug ) {
        // 构建一个模拟的插件信息对象
        return (object) array(
            'slug'          => 'my-private-plugin',
            'name'          => '我的私有插件',
            'version'       => '1.2.3',
            'author'        => '<a href="https://example.com">自定义作者</a>',
            'author_profile'=> 'https://example.com',
            'requires'      => '5.0',
            'tested'        => '6.0',
            'requires_php'  => '7.4',
            'download_link' => 'https://example.com/my-private-plugin-1.2.3.zip', // 必须提供下载链接
            'last_updated'  => gmdate( 'Y-m-d H:i:s' ),
            'sections'      => array(
                'description' => '这是一个通过自定义API提供的私有插件。',
                'installation'=> '请通过后台安装此插件。',
            ),
            // ... 其他必要的插件信息字段
        );
    }
    return $res; // 继续默认处理
}

/**
 * 修改 plugins_api 结果的过滤器示例
 *
 * @param object $res    API 响应结果对象。
 * @param string $action 当前的 API 动作。
 * @param object $args   API 请求参数对象。
 * @return object 修改后的 API 响应结果对象。
 */
add_filter( 'plugins_api_result', 'my_custom_plugin_api_result', 10, 3 );
function my_custom_plugin_api_result( $res, $action, $args ) {
    // 仅当动作是获取插件信息且结果有效时进行修改
    if ( 'plugin_information' === $action && is_object( $res ) && isset( $res->slug ) ) {
        // 假设我们想为某个插件的描述添加一个免责声明
        if ( 'my-target-plugin' === $res->slug ) {
            $res->description .= '<br/><p><strong>重要提示：</strong>此插件正在测试中，请谨慎使用。</p>';
            // 也可以修改其他字段，例如 $res->version = '1.0.0-beta';
        }
    }
    return $res;
}