apply_filters()


WordPressのapply_filters()関数は、フィルターフックを適用して、値を変更または処理するために使用されます。この関数は、プラグインやテーマが値を変更する機会を提供します。

構文

apply_filters( string $tag, mixed $value, mixed ...$args );

引数の説明:

  • $tag (string) — フィルターフックの名前。
  • $value (mixed) — フィルタリング対象の値。
  • $args (mixed) — （オプション）追加の引数。

例 1. フィルターを使用して投稿タイトルを変更する

以下のコードは、投稿タイトルをカスタマイズします。

add_filter( 'the_title', function( $title ) { return 'カスタム: ' . $title; } );

例 2. カスタムHTMLタグを値に追加する

値にHTMLタグを追加するコードです。

add_filter( 'my_custom_filter', function( $value ) { return '<strong>' . $value . '</strong>'; } );

例 3. URLを加工する

URLにパラメータを追加する例です。

add_filter( 'the_permalink', function( $url ) { return $url . '?source=custom'; } );

例 4. ユーザー入力をサニタイズする

ユーザー入力データを安全に加工します。

add_filter( 'sanitize_text_field', function( $value ) { return htmlspecialchars( $value, ENT_QUOTES ); } );

例 5. カスタムデータをフィルターで処理する

カスタムデータをフィルタリングして処理するコードです。

add_filter( 'my_data_filter', function( $data ) { return array_map( 'strtoupper', $data ); } );

注意事項

  • フィルターフックの名前は一意である必要があります。
  • 値を加工する場合は、元のデータ型を保持するよう注意してください。
  • 必要に応じて、フィルターを削除することも可能です。

関連機能：