wp_check_site_meta_support_prefilter()


WordPressのwp_check_site_meta_support_prefilter()関数は、サイトメタデータのサポートをチェックするためのフィルターフックです。この関数は主にマルチサイト環境で使用され、サイトメタデータが有効かどうかを確認します。

構文

wp_check_site_meta_support_prefilter( $check, $object_id, $meta_key, $single );

引数の説明:

  • $check (mixed) — メタデータの存在をチェックするための初期値
  • $object_id (int) — サイトID
  • $meta_key (string) — チェックするメタデータのキー
  • $single (bool) — 単一の値のみを返すかどうか

例1: サイトメタデータのサポートをチェック

基本的な使用例。サイトメタデータが有効かどうかを確認します。

add_filter( 'site_meta_supported', 'wp_check_site_meta_support_prefilter', 10, 4 );

例2: 特定のサイトIDに対してメタデータをチェック

指定したサイトIDのメタデータサポートを確認します。

wp_check_site_meta_support_prefilter( false, get_current_blog_id(), 'example_key', true );

例3: カスタムメタキーをチェック

特定のメタキーがサポートされているかどうかを確認します。

wp_check_site_meta_support_prefilter( null, 1, 'custom_meta', false );

例4: フィルターを追加してメタサポートを変更

サイトメタデータのサポートをカスタマイズします。

add_filter( 'site_meta_supported', function( $check, $object_id, $meta_key, $single ) { return true; }, 10, 4 );

例5: マルチサイト環境での使用

マルチサイトで全てのサイトのメタサポートを確認します。

foreach ( get_sites() as $site ) { wp_check_site_meta_support_prefilter( false, $site->blog_id, 'site_option', true ); }

例6: メタデータサポートを無効化

特定の条件下でメタデータサポートを無効にします。

add_filter( 'site_meta_supported', '__return_false' );

例7: 条件付きでメタサポートをチェック

特定の条件に基づいてメタサポートを確認します。

if ( wp_check_site_meta_support_prefilter( true, 1, 'special_key', true ) ) { /* 処理 */ }

注意点

  • この関数はマルチサイト環境でのみ意味を持ちます。
  • メタデータのサポートはテーマやプラグインによって変更される可能性があります。
  • パフォーマンスに影響を与える可能性があるため、過度な使用は避けてください。

関連機能：