WordPress 透過多個元鍵查詢 WP REST API v2

問題描述

使用 v2 的 REST API，我想透過多個元鍵查詢一些帖子。使用 v1，我能夠格式化像&filter[meta_value][month]=12&[meta_value][year]=2015 這樣的 URL，它的工作 (將元值暴露給 API 之後) 。

現在使用 v2，我只能透過使用這個 GitHub 執行緒上列出的方法來使其工作：https://github.com/WP-API/WP-API/issues/1599#issuecomment-161166805

基本上，使用 rest_query_vars 過濾器新增元欄位，如：

add_filter( 'rest_query_vars', 'flux_allow_meta_query' ); function flux_allow_meta_query( $valid_vars ) { $valid_vars = array_merge( $valid_vars, array( 'meta_key', 'meta_value', 'meta_compare' ) ); return $valid_vars; }

因此，我可以使用像 wp-json/wp/v2/posts?filter[meta_key]=test&filter[meta_value]=on 這樣的網址過濾一個元鍵。

然而，這聽起來像是在多個元鍵上過濾的唯一方法是編寫一個自定義過濾器。有人可以指出我正確的做法嗎？

最佳解決思路

新增 custom endpoint 是非常簡單的。

我也修改了 url 看起來更像

http://example.com/wp-json/namespace/v2/posts?filter[meta_value][month]=12&filter[meta_value][year]=2015

function wp_json_namespace_v2__init()
{

    // create json-api endpoint

    add_action('rest_api_init', function () {

        // http://example.com/wp-json/namespace/v2/posts?filter[meta_value][month]=12&filter[meta_value][year]=2015

        register_rest_route('namespace/v2', '/posts', array (
            'methods'             => 'GET',
            'callback'            => 'wp_json_namespace_v2__posts',
            'permission_callback' => function (WP_REST_Request $request) {
                return true;
            }
        ));
    });

    // handle the request

    function wp_json_namespace_v2__posts($request)
    {
        // json-api params

        $parameters = $request->get_query_params();

        // default search args

        $args = array(
            'post_type'      => 'post',
            'post_status'    => 'publish',
            'numberposts'    => -1,
            // limit to only ids
            // 'fields'      => 'ids',
        );

        // check the query and add valid items

        if (isset($parameters['filter']['meta_value'])) {
            foreach ($parameters['filter']['meta_value'] as $key => $value) {
                switch ($key) {

                    case 'month':
                        if (is_numeric($value))
                            $args['monthnum'] = $value;
                        break;

                    case 'year':
                        if (is_numeric($value))
                            $args['year'] = $value;
                        break;
                }
            }
        }

        // run query

        $posts = get_posts($args);

        // return results

        $data = array(
            'success' => true,
            'request' => $parameters,
            'count' => count($posts),
            'posts' => $posts,
        );

        return new WP_REST_Response($data, 200);
    }

    flush_rewrite_rules(true); // FIXME: <------- DONT LEAVE ME HERE
}

add_action('init', 'wp_json_namespace_v2__init');

參考文獻

Query WP REST API v2 by multiple meta keys

注：本文內容整合自 Google/Baidu/Bing 輔助翻譯的英文資料結果。如果您對結果不滿意，可以加入我們改善翻譯效果：薇曉朵技術論壇。

WordPress 透過多個元鍵查詢 WP REST API v2