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

概要

woocommerce_placeholder_img_src フィルタとは

woocommerce_placeholder_img_srcフィルタは、WooCommerceのデフォルトのプレースホルダー画像のURLをフィルタリングするために使用されます。このフィルタを使用することで、デフォルトの画像を独自の画像に変更したり、特定の条件に基づいて画像を動的に変更したりすることができます。

よく使われるケース

カスタムプレースホルダー画像の設定
ショップのブランドイメージに合わせた画像の変更
特定の商品カテゴリー用の異なるプレースホルダー画像の指定
多言語サイトにおける条件付き画像の変更
画像のサイズやスタイルを変更するためのフィルタ
テスト環境でのデフォルト画像の管理

構文

apply_filters( 'woocommerce_placeholder_img_src', $src );

パラメータ

$src: デフォルトのプレースホルダー画像のURL（文字列）

戻り値

変更されたプレースホルダー画像のURL（文字列）

発行可能なバージョン

WooCommerce: 3.0以上
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_placeholder_img_src', 'custom_placeholder_img' );

function custom_placeholder_img( $src ) {
    return 'https://example.com/path/to/custom-placeholder.png';
}

このサンプルでは、デフォルトのプレースホルダー画像を指定されたカスタム画像URLに置き換えています。

サンプル 2: 商品カテゴリーに応じたプレースホルダー画像の変更

add_filter( 'woocommerce_placeholder_img_src', 'conditional_placeholder_img' );

function conditional_placeholder_img( $src ) {
    if ( is_product_category('special-category') ) {
        return 'https://example.com/path/to/special-placeholder.png';
    }
    return $src;
}

このサンプルでは、特定の商品のカテゴリーにいる場合に限り、異なるプレースホルダー画像を返しています。

サンプル 3: 多言語対応のプレースホルダー画像

add_filter( 'woocommerce_placeholder_img_src', 'multilingual_placeholder_img' );

function multilingual_placeholder_img( $src ) {
    if ( get_locale() == 'fr_FR' ) {
        return 'https://example.com/path/to/french-placeholder.png';
    }
    return $src;
}

このサンプルでは、フランス語のサイトの場合にのみ異なるプレースホルダー画像を提供しています。

サンプル 4: 設定に基づくプレースホルダー画像の変更

add_filter( 'woocommerce_placeholder_img_src', 'settings_based_placeholder_img' );

function settings_based_placeholder_img( $src ) {
    $custom_img = get_option( 'custom_placeholder_image' );
    if ( $custom_img ) {
        return $custom_img;
    }
    return $src;
}

このサンプルでは、WordPressの設定からカスタム画像URLを取得し、設定が存在する場合はそれを使用しています。

サンプル 5: サイズを指定したプレースホルダー画像

add_filter( 'woocommerce_placeholder_img_src', 'size_based_placeholder_img' );

function size_based_placeholder_img( $src ) {
    return add_query_arg( 'size', '300x300', $src );
}

このサンプルでは、デフォルトのプレースホルダー画像のURLに画像サイズを指定して変更しています。

概要