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

概要

woocommerce_search_products_post_statuses フィルタは、WooCommerceにおいて商品検索に使用される投稿の公開ステータスをカスタマイズするためのフックです。このフックを使用すると、特定の条件に基づいて検索対象の商品のステータスを変更したり、デフォルトの動作を上書きしたりすることが可能です。

よく使われる機能実装の例

特定のカスタム投稿ステータスの商品を検索結果に含める。
非公開の商品の検索を許可または制限する。
特定のユーザー権限に基づいて検索結果に表示される商品のステータスを変更する。
限定販売の商品を検索結果に表示させる。
商品が特定の条件を満たしているかどうかによって、検索対象を動的に変更する。
商品のステータスが「下書き」の状態でも検索結果に表示する。

構文

apply_filters( 'woocommerce_search_products_post_statuses', $post_statuses );

パラメータ

$post_statuses (array): 検索対象とする投稿のステータスの配列。

戻り値

array: フィルタされた投稿ステータスの配列を返します。

対応するWooCommerceバージョン

WooCommerce 2.1.0 以降

対応するWordPressバージョン

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_search_products_post_statuses', 'add_temp_post_status' );

function add_temp_post_status( $post_statuses ) {
    $post_statuses[] = 'draft'; // 下書きステータスを追加
    return $post_statuses;
}

このコードは、「下書き」ステータスの商品の検索を許可します。

サンプル2: 特定のユーザー向けのステータス設定

add_filter( 'woocommerce_search_products_post_statuses', 'restrict_post_status_based_on_user_role' );

function restrict_post_status_based_on_user_role( $post_statuses ) {
    if ( current_user_can( 'administrator' ) ) {
        $post_statuses[] = 'pending'; // 管理者には保留中のステータスを追加
    }
    return $post_statuses;
}

このコードは、管理者ユーザーのみが「保留中」のステータスの商品を検索結果に加えられるようにします。

サンプル3: 商品の公開日による条件付き検索

add_filter( 'woocommerce_search_products_post_statuses', 'filter_on_publish_date' );

function filter_on_publish_date( $post_statuses ) {
    $date = date('Y-m-d');
    if ( $date < '2023-01-01' ) {
        $post_statuses[] = 'publish'; // 2023年以前の商品を公開ステータスとして追加
    }
    return $post_statuses;
}

このコードは、特定の日付以前の商品を検索対象に加える条件を設定します。

サンプル4: 商品のカスタムステータスを含む

add_filter( 'woocommerce_search_products_post_statuses', 'include_custom_post_statuses' );

function include_custom_post_statuses( $post_statuses ) {
    $post_statuses[] = 'custom_status'; // 'custom_status' というカスタムステータスを追加
    return $post_statuses;
}

このコードは、カスタムステータスの商品を検索結果に含めるためのフィルタを追加します。

サンプル5: 条件に応じた動的ステータス変更

add_filter( 'woocommerce_search_products_post_statuses', 'dynamic_post_status_based_on_condition' );

function dynamic_post_status_based_on_condition( $post_statuses ) {
    if ( is_user_logged_in() ) {
        $post_statuses[] = 'private'; // ログイン中のユーザーには非公開商品の検索を許可
    }
    return $post_statuses;
}

このコードは、ログインしているユーザーに対して非公開商品を検索結果に表示させるフィルタを追加します。

概要