プラグインWooCommerceのwoocommerce_order_query_argsフィルタの使用方法・解説

概要

woocommerce_order_query_argsは、WooCommerceの注文クエリの引数をフィルタリングするためのフックです。このフィルタは、WooCommerceの注文リストや管理画面での表示内容にカスタマイズを加える際に非常に役立ちます。例えば、新しい注文の表示、特定のステータスの注文のみを表示する、または特定のユーザーの注文をフィルタリングするなどの用途でよく使用されます。

主な使用例

特定の注文ステータスを持つ注文のフィルタリング
ユーザーに基づく注文の表示
特定の日付範囲内の注文の取得
注文メタデータによるフィルタリング
カスタムフィールドを持つ注文の取得
特定の製品を含む注文のフィルタリング

構文

add_filter('woocommerce_order_query_args', 'custom_function_name', 10, 2);

パラメータ

$query_args: 現在のクエリ引数の配列。
$query: 現在のWP_Queryオブジェクト。

戻り値

フィルタリングされた引数の配列。

使用可能なバージョン

WooCommerce: バージョン 2.6 以上
WordPress: バージョン 4.0 以上

この関数のアクションでの使用可能性

アクション名	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

サンプルコード 1

add_filter('woocommerce_order_query_args', 'filter_orders_by_status', 10, 2);
function filter_orders_by_status($query_args, $query) {
    $query_args['post_status'] = 'wc-completed';
    return $query_args;
}

説明: このコードは、管理画面に表示される注文の中から「完了（completed）」ステータスの注文のみをフィルタリングします。

サンプルコード 2

add_filter('woocommerce_order_query_args', 'filter_user_orders', 10, 2);
function filter_user_orders($query_args, $query) {
    if (is_admin()) {
        $query_args['meta_query'] = array(
            array(
                'key' => '_customer_user',
                'value' => get_current_user_id(),
                'compare' => '='
            )
        );
    }
    return $query_args;
}

説明: このコードは、管理画面でログイン中のユーザーの注文のみにフィルタリングします。

サンプルコード 3

add_filter('woocommerce_order_query_args', 'filter_orders_by_date', 10, 2);
function filter_orders_by_date($query_args, $query) {
    $query_args['date_query'] = array(
        array(
            'after'     => '1 month ago',
        ),
    );
    return $query_args;
}

説明: このサンプルは、過去1ヶ月以内に行われた注文をフィルタリングします。

サンプルコード 4

add_filter('woocommerce_order_query_args', 'filter_orders_by_product', 10, 2);
function filter_orders_by_product($query_args, $query) {
    $query_args['meta_query'] = array(
        array(
            'key' => '_product_id',
            'value' => 123, // 特定の製品IDを指定
            'compare' => '='
        )
    );
    return $query_args;
}

説明: 指定した製品IDを含む注文のみを表示するためのフィルタリングコードです。

サンプルコード 5

add_filter('woocommerce_order_query_args', 'custom_order_sort', 10, 2);
function custom_order_sort($query_args, $query) {
    $query_args['orderby'] = 'date';
    $query_args['order'] = 'DESC';
    return $query_args;
}

説明: 注文の表示順を新しいものから古いものへの降順に設定します。

これらのサンプルコードを使用することで、woocommerce_order_query_argsフィルタの活用方法や応用の幅が広がります。

概要