如何使用 WordPress rest_api_init 啟用 REST API 端點的多語言支援 - OpenByt

如果您曾經嘗試讓您的 WordPress REST API 端點使用多國語言，卻發現自己被「rest_api_init 無法運作」的問題困住，那您並不孤單。實作多語言支援是一件非常具挑戰性的工作，尤其是當涉及到自訂 REST API 等核心功能時。在本文中，我們將深入探討如何使用 rest_api_init 鉤子有效地建立支援多種語言的 REST API 端點。

瞭解 rest_api_init 與常見陷阱

的 rest_api_init hook 是擴充 WordPress REST API 的重要部分。它允許開發人員註冊自訂路由和端點，以符合其專案的需求。然而，許多開發人員會遇到可怕的「rest_api_init 無法運作」情況，這通常是由於配置錯誤、外掛衝突或掛勾位置不正確所造成。

要成功使用 rest_api_init 為了支援多語言，了解如何正確註冊路由、處理翻譯及調試常見問題是至關重要的。在深入實作之前，請確保您的環境設定正確：確認所有外掛程式都是最新的，而且沒有其他鉤子覆寫您的端點。

實施多語言端點的逐步指南

1.使用 rest_api_init 註冊自訂端點

若要開始，請使用 rest_api_init 動作來為您的 API 註冊自訂路由。將這段程式碼放在主題的 functions.php 檔案或自訂外掛程式中：

add_action('rest_api_init', 'register_multilingual_api_routes')；

function register_multilingual_api_routes() {
    register_rest_route('myplugin/v1', '/content/', array(
        'methods' => 'GET'、
        'callback' => 'get_multilingual_content'、
        'permission_callback' => '__return_true', // 新增權限回呼，以確保安全性
    ));
}

此程式碼會建立一個自訂的 REST API 端點，位於 /wp-json/myplugin/v1/content/.......。 permission_callback 參數對於確保未授權使用者不會存取敏感資料非常重要。現在，我們需要讓它使用多種語言。

2.新增語言參數

為了讓 API 多語言化，我們需要在路由中加入語言參數。您可以像這樣修改 callback 以接受語言參數：

function get_multilingual_content($request) {
    $language = $request->get_param('lang')；
    
    if (!$language) {
        return new WP_Error('no_language', 'Language parameter is required', array('status' => 400))；
    }
    
    // 根據語言參數擷取內容
    $content = get_content_by_language($language)；
    
    if (empty($content)) {
        return new WP_Error('no_content', 'No content found for the specified language', array('status' => 404))；
    }
    
    return rest_ensure_response($content)；
}

此實作可確保語言參數 (長) 是必需的，它會相應地返回特定語言的內容。此方法允許使用者直接指定語言，增強了 API 的靈活性。

3.在 WordPress 中處理多語言內容

要實際提供多語言內容，您需要正確地儲存和擷取資料。您可以使用 WPML 或 Polylang 等外掛程式來管理翻譯。在 依語言取得內容 函數，利用這些外掛程式根據 長 參數。

例如：

function get_content_by_language($language) {
    // 假設正在使用 WPML
    global $sitepress；
    $sitepress->switch_lang($language)；
    
    // 查詢已翻譯的內容
    $args = array(
        'post_type' => 'post'、
        'posts_per_page' => 5
    );
    
    $query = new WP_Query($args)；
    return $query->posts；
}

本範例使用 WPML 的 switch_lang 方法在執行查詢前設定語言上下文，確保傳回的內容符合指定的語言。您可以根據所使用的外掛或翻譯方式調整此方法。

多語言 REST API 的進階技術

1.快取效能

動態處理多語言內容可能會導致效能問題，尤其是當您的網站有大量流量時。強烈建議為您的 REST API 回應實施快取。您可以使用 WP REST Cache 等外掛程式來儲存 API 回應，或利用自訂的快取機制來避免重複查詢已翻譯的內容。

例如，您可以利用 WordPress 中的暫存 API 來快取回應：

function get_multilingual_content($request) {
    $language = $request->get_param('lang')；
    $cache_key = 'multilingual_content_' .$language；
    $cached_content = get_transient($cache_key)；
    
    if ($cached_content) {
        return rest_ensure_response($cached_content)；
    }
    
    // 根據語言參數擷取內容
    $content = get_content_by_language($language)；
    
    if (empty($content)) {
        return new WP_Error('no_content', 'No content found for the specified language', array('status' => 404))；
    }
    
    // 將內容儲存在暫存快取 12 小時
    set_transient($cache_key, $content, 12 * HOUR_IN_SECONDS)；
    
    return rest_ensure_response($content)；
}

這可確保只處理有效的語言，提高安全性和可用性。

3.結構化回應以進行本地化

考慮結構化您的 API 回應，以包含語言的元資料和任何其他相關資訊，這對使用您 API 的前端應用程式特別有用。

function get_multilingual_content($request) {
    $language = $request->get_param('lang')；
    $content = get_content_by_language($language)；
    
    if (empty($content)) {
        return new WP_Error('no_content', 'No content found for the specified language', array('status' => 404))；
    }
    
    $response = array(
        'language' => $language、
        'content' => $content、
        'timestamp' => current_time('mysql')、
        'status' => 'success
    );
    
    return rest_ensure_response($response)；
}

添加語言、時間戳記和狀態等元資料有助於 API 的消費者（例如 JavaScript 前端框架）了解資料的上下文。

支援多語言的外掛程式整合

WPML 與 Polylang 整合

如果您正在使用 WPML 或 Polylang，將它們與您的 REST API 整合可以簡化處理多語言內容的程序。以下是如何有效地將 WPML 與您的自訂 API 搭配使用：

WPML 整合： 使用 wpml_object_id_filter 來取得自訂文章的翻譯版本。例如

function get_content_by_language($language) {
    global $sitepress；
    $sitepress->switch_lang($language)；
    
    $args = array(
        'post_type' => 'post'、
        'posts_per_page' => 5
    );
    
    $query = new WP_Query($args)；
    $posts = array()；
    
    foreach ($query->posts as $post) {
        $translated_id = apply_filters('wpml_object_id', $post->ID, 'post', true, $language)；
        if ($translated_id) {
            $posts[] = get_post($translated_id)；
        }
    }
    
    return $posts；
}

Polylang 整合： 使用 Polylang 的 API 取得所需語言的內容：

function get_content_by_language($language) {
    pll_set_language($language)；
    
    $args = array(
        'post_type' => 'post'、
        'posts_per_page' => 5
    );
    
    $query = new WP_Query($args)；
    return $query->posts；
}

這些整合可確保您的內容根據要求的語言進行適當的翻譯和提供。

rest_api_init 無法運作的疑難排解

如果您發現 rest_api_init 無法如預期般運作，請考慮以下詳細的解決方案：

檢查是否有衝突的外掛程式： 與 REST API 互動的外掛程式可能會產生衝突。逐一停用外掛程式以找出罪魁禍首。檢閱每個外掛程式的說明文件，看看它們是否修改或限制 REST API，也會很有幫助。
啟用除錯工具： 啟用 WordPress 的除錯功能 (define('WP_DEBUG', true)) 並使用 Postman 或 cURL 等工具來測試您的端點並驗證回應。例如，使用 cURL 傳送 GET 請求：

curl -X GET "http://yourdomain.com/wp-json/myplugin/v1/content?lang=en"

curl -X GET "http://yourdomain.com/wp-json/myplugin/v1/content?lang=en"這些工具有助於確保您的端點如預期般運作，並提供詳細的錯誤回應。
正確的鉤子位置： 確保 rest_api_init 在正確的時間被呼叫，也就是當所有其他的相依性都已經載入。不正確的位置會導致路由無法正常註冊。建議您在插件或 functions.php 但不是在所有外掛程式初始化之前。
Permalinks 設定： 有時候，永久連結結構是路由失敗的根本原因。前往「設定」>「永久連結」並重新儲存設定，以刷新永久連結設定。

安全考量

為了確保 REST API 端點的安全性，您應該實施適當的驗證和授權：

使用 OAuth 或 JWT 進行驗證： 考慮使用 OAuth 或 JSON Web Tokens (JWT) 進行安全存取。相較於僅依賴 permission_callback.舉例來說，使用 JWT Authentication for WP REST API 外掛程式，您就可以使用令牌來驗證請求。

function register_multilingual_api_routes() {
    register_rest_route('myplugin/v1', '/content/', array(
        'methods' => 'GET'、
        'callback' => 'get_multilingual_content'、
        'permission_callback' => 'is_authenticated_user'.
    ));
}

function is_authenticated_user() {
    return is_user_logged_in(); // 範例檢查，必要時以 JWT 驗證取代
}

速率限制： 為了保護您的 API 免遭濫用，請考慮實施速率限制。您可以使用 Limit Login Attempts Reloaded 等外掛程式來防止暴力攻擊，或為 API 請求建立自訂速率限制器。

總結

使用下列工具建立多語言 REST API 端點 rest_api_init 在 WordPress 中使用多語言 REST API 需要深入瞭解路由註冊、參數處理、翻譯外掛程式、快取和安全措施。透過遵循最佳實務，例如適當地加入語言參數、穩健地處理錯誤、為了效能而進行快取，以及確保端點的安全性，您就可以建立功能強大的多語言 REST API，滿足專案的需求。