• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

プラグイン API/フィルターフック一覧

提供: WordPress Codex 日本語版
移動先: 案内検索

このページには、WordPress 2.1 以降のプラグイン開発で使える広範囲のフィルターフック一覧が含まれています(ただし、100%包括的なものではありません)。さらに詳しい情報については下記をご覧ください。

注: もしこの文書に情報を追加したり、内容をより分かりやすく書き換えたい場合は、現在のスタイルに従って編集を行ってください。

投稿、ページ、添付ファイル(アップロード)関連のフィルタ

以下のカテゴリー・タクソノミー項目関連のフィルター投稿者・ユーザー関連のフィルターリンク関連のフィルター日付・時間関連のフィルター管理画面関連のフィルターもご覧ください。

データベース読み出し

このセクションのフィルターは、データベースから読み出される情報に対してページや編集画面に表示される前に適用されます。

attachment_fields_to_edit /en
フィルター関数引数: フォーム欄の配列、投稿オブジェクト
添付ファイルを編集する際に表示されるフォームに適用される。get_attachment_fields_to_edit 関数で呼び出される。
attachment_icon /en
フィルター関数引数: HTML img タグとしてのアイコンファイル、添付ファイル ID
get_attachment_icon 関数内で添付ファイルのアイコンに対して適用される。
attachment_innerHTML /en
フィルター関数引数: innerHTML(デフォルトはタイトル)、添付ファイル ID
get_attachment_innerHTML 関数内で、添付ファイルにアイコンがない場合タイトルに使われる文字列に適用される。
author_edit_pre /en
投稿者が編集画面に表示される前に適用される。
body_class /en
フィルター関数引数: クラス名の配列、最初の配列に追加されたクラス名の配列
HTML <body> 要素のクラスに適用される。get_body_class /en 関数で呼び出される。
content_edit_pre /en
投稿コンテンツが編集画面に表示される前に適用される。
content_filtered_edit_pre /en
フィルターされた投稿コンテンツが編集画面に表示される前に適用される。
excerpt_edit_pre /en
抜粋が編集画面に表示される前に適用される。
date_edit_pre /en
投稿の日付が編集画面に表示される前に適用される。
date_gmt_edit_pre /en
投稿の日付が編集画面に表示される前に適用される。
get_attached_file /en
フィルター関数引数: ファイル情報、添付ファイル ID
get_attached_file 関数で取得した添付ファイル情報に適用される。
get_enclosed /en
get_enclosed 関数で取得した投稿のエンクロージャーリストに適用される。
get_pages /en
フィルター関数引数: ページのリスト(各項目にはページのデータ配列が含まれる)、リクエストされたページを指定する get_pages 関数の引数リスト
get_pages 関数で取得したページのリストに適用される。
get_pung /en
get_pung 関数で取得したピンバック受信 URL のリストに適用される。
get_the_archive_title /en
get_the_archive_title関数でアーカイブのタイトルに適用される。
get_the_excerpt
get_the_excerpt 関数で取得した投稿の抜粋に適用される。
get_the_guid /en
get_the_guid 関数で取得した投稿の GUID に適用される。
get_to_ping /en
get_to_ping 関数で取得したピンバック先の URL リストに適用される。
icon_dir /en
複数の関数で、テンプレートの画像ディレクトリに適用される。MIME タイプアイコンの置き場所をプラグインを使って変更したいときに使える。
icon_dir_uri /en
複数の関数で、テンプレートの画像ディレクトリ URL に適用される。MIME タイプアイコンの置き場所をプラグインを使って変更したいときに使える。
image_size_names_choose /en
メディアライブラリで選択できる画像サイズのリストに適用される。カスタム画像サイズを選択できるようにしたい時によく使われる。
mime_type_edit_pre /en
編集画面に表示される前に投稿 MIME タイプに適用される。
modified_edit_pre /en
編集画面に表示される前に、投稿が変更された日付に適用される。
modified_gmt_edit_pre /en
編集画面に表示される前に、投稿が変更された日付の GMT 版に適用される。
no_texturize_shortcodes /en
登録されたショートコードに適用される。texturize 関数の自動適用範囲からショートコードを除外するために使える。
parent_edit_pre /en
編集画面に表示される前に、投稿の親 ID に適用される。
password_edit_pre /en
編集画面に表示される前に、投稿パスワードに適用される。
post_class /en
フィルター関数引数: クラス名の配列、最初の配列に追加された追加クラス名の配列、投稿 ID
投稿の一番外側にある HTML 要素に適用される。get_post_class /en 関数内で呼び出される。
prepend_attachment /en
prepend_attachment 関数で先頭に追加する HTML に適用される。
protected_title_format /en
投稿がパスワード保護されている場合の投稿タイトルを編集するために使う。
private_title_format /en
投稿が非公開状態になっている場合の投稿タイトルを編集するために使う。
sanitize_title /en
sanitize_title 関数で HTML タグを除去した投稿タイトル名に適用される。
single_post_title /en
wp_title 関数および single_post_title 関数でブログページタイトルを生成する際に投稿タイトルに適用される。
status_edit_pre /en
編集画面に表示される前に投稿ステータスに対し適用される。
the_content /en
データベースから取得した投稿コンテンツを画面に出力する前に適用される(トラックバックなどの他の操作にも使われる)。
the_content_rss /en
データベースから取得した投稿コンテンツを RSS フィードに含める前に適用される。このフィルターは 2.7 以降機能していない。
the_content_feed /en
データベースから取得した投稿コンテンツを RSS フィードに含める前に適用される。
the_editor_content /en
投稿本文をリッチテキストエディター内に表示する前に適用される。
the_excerpt /en
画面を表示する前にデータベースから取得した記事の抜粋(または投稿、抜粋がない場合)に適用する。(またトラックバックなどの他の操作で使用)
the_excerpt_rss /en
投稿の抜粋を RSS フィードに含める前に適用される。
the_password_form /en
保護された投稿のパスワードフォームに適用される。
the_tags /en
画面を表示する前に、データベースから取得したタグに適用される。
the_title /en
画面を表示する前にデータベースから取得した投稿タイトルに適用される。(トラックバックなどの他の操作でも使用)
the_title_rss / en
the_title でフィルターした後、投稿タイトルをRSS フィードに含める前に適用される。
title_edit_pre /en
投稿タイトルが編集画面に表示される前に適用される。
type_edit_pre /en
投稿タイプが編集画面に表示される前に適用される。
wp_dropdown_pages /en
wp_dropdown_pages 関数が生成したページのドロップダウンリスト HTML に適用される。
wp_list_pages /en
wp_list_pages 関数が生成したページのリスト HTML に適用される。
wp_list_pages_excludes /en
wp_list_pages 関数内で、除外ページ ID の配列に適用される。
wp_get_attachment_metadata /en
フィルター関数引数: メタ情報、添付ファイル ID
wp_get_attachment_metadata 関数で取得した、添付ファイルのメタ情報に適用される。
wp_get_attachment_thumb_file /en
フィルター関数引数: サムネイルファイル、添付ファイル ID
wp_get_attachment_thumb_file 関数で取得した、添付ファイルのサムネイルファイルに適用される。
wp_get_attachment_thumb_url /en
フィルター関数引数: サムネイル URL、添付ファイル ID
wp_get_attachment_thumb_URL関数によってサムネイルに適用するURLを取得する。
wp_get_attachment_url /en
フィルター関数引数: URL、添付ファイル ID
wp_get_attachment_url 関数で取得した、添付ファイル URL に適用される。
wp_mime_type_icon /en
フィルター関数引数: 算出した アイコン URL、MIME タイプ情報、投稿投稿 ID
wp_mime_type_icon 関数で算出した、添付ファイルの MIME タイプアイコンに適用される。
wp_title /en
wp_title 関数が生成したページ名がブラウザに送信される前に適用される。

データベース書き込み

このセクションのフィルターは、情報をデータベースに保存する前にその情報に対して適用されます。

add_ping /en
ピンバックが追加された際、ピンバック欄に新規追加する値をデータベースに保存する前に適用される。
attachment_fields_to_save /en
フィルタ関数の引数:投稿の配列属性、フォームから送信された変更を含む添付ファイルフィールドの配列。
データベースに保存する前に添付ファイルに関連付けられたフィールドに適用される。media_upload_form_handler関数と呼ぶ。
attachment_max_dims /en
画像を縮小する前に、画像の最大寸法の値に適用される。フィルター関数の入力値と戻り値は、false(最大寸法が指定されていない場合)または2つの数字のリスト(幅、高さ)。
category_save_pre /en
投稿カテゴリーのコンマ区切りリストをデータベースに保存する前に適用される(添付にも使われる)。
comment_status_pre /en
コメントステータスをデータベースに保存する前に適用される(添付にも使われる)。
content_filtered_save_pre /en
フィルターされた投稿コンテンツをデータベースに保存する前に適用される(添付にも使われる)。
content_save_pre /en
投稿コンテンツをデータベースに保存する前に適用される(添付にも使われる)。
excerpt_save_pre /en
投稿の抜粋をデータベースに保存する前に適用される(添付にも使われる)。
image_save_pre /en - 非推奨
代わりに image_editor_save_pre /en を使うこと。
jpeg_quality /en - 非推奨
代わりに wp_editor_set_quality /en または WP_Image_Editor::set_quality() を使うこと。
name_save_pre /en
投稿の名前をデータベースに保存する前に適用される(添付にも使われる)。
phone_content /en
投稿がメールで投稿された際、内容をデータベースに保存する前に実行する。
ping_status_pre /en
投稿のピンバックステータスをデータベースに保存する前に適用される(添付にも使われる)。
post_mime_type_pre /en
添付の MIMEタイプをデータベースに保存する前に適用される。
status_save_pre /en
投稿ステータスをデータベースに保存する前に適用される。
thumbnail_filename /en
画像をアップロードする際、サムネイルのファイル名に適用される。
title_save_pre /en
投稿のタイトルをデータベースに保存する前に適用される(添付にも使われる)。
update_attached_file /en
フィルター関数引数: 添付ファイル情報、添付ファイル ID
添付ファイル情報を update_attached_file 関数で投稿のメタデータとして保存する前に適用される。
wp_create_thumbnail /en - 非推奨
wp_delete_file /en
ファイルを削除する直前、添付ファイル名に適用される。
wp_generate_attachment_metadata /en
添付ファイルのメタ情報配列がデータベースに保存される前に適用される。
wp_save_image_file /en - 非推奨
代わりに wp_save_image_editor_file /en を使うこと。
wp_thumbnail_creation_size_limit /en
フィルター関数引数: ファイルの最大サイズ、添付ファイル ID、添付ファイル名
画像をアップロードする際、サムネイルのファイルサイズに適用される。
wp_thumbnail_max_side_length /en
フィルター関数引数: 画像の最大横幅、添付ファイル ID、添付ファイル名
画像をアップロードする際、サムネイルの寸法に適用される。
wp_update_attachment_metadata /en
フィルター関数引数: メタ情報、添付ファイル ID
wp_update_attachment_metadata 関数で、添付ファイルのメタ情報配列が保存される前に適用される。

コメント・トラックバック・ピンバック関連のフィルター

投稿者・ユーザー関連のフィルターリンク関連のフィルター日付・時間関連のフィルター管理画面関連のフィルターも参照。

データベース読み出し

このセクションのフィルターは、データベースから読み出される情報に対してページや編集画面に表示される前に適用されます。

comment_excerpt /en
comment_excerpt 関数を使ってデータベースから取得したコメント抜粋に適用される。
comment_flood_filter /en
フィルター関数引数: 他のフィルタープラグインがコメントをすでにブロック済みかどうかの判別情報(true/false、プラグインでコメントをブロックする際 true に設定し、値を戻す)、前回のコメント送信日時、今回のコメント送信日時
連続コメントエラーが検出された際に適用される。
comment_post_redirect /en
フィルター関数引数: リダイレクト先情報、コメント情報の配列
コメントを追加した後のリダイレクト先情報に適用される。
comment_text /en
comment_text 関数で取得したコメント本文を画面に出力する前に適用される。
comment_text_rss /en
コメント本文が RSS フィードに挿入される前に適用される。
comments_array /en
フィルター関数引数: コメント情報構造の配列、投稿投稿 ID
comments_template 関数内で、投稿投稿へのコメントの配列に適用される。
comments_number /en
comments_number 関数が生成したコメント数表示用のフォーマット済みテキストに適用される。
get_comment_excerpt /en
get_comment_excerpt 関数を使ってデータベースから取得したコメント抜粋に適用される。
get_comment_ID /en
get_comment_ID 関数を使ってグローバル変数 $comments から読み出したコメント ID に適用される。
get_comment_text /en
get_comment_text 関数内でコメント本文に適用される。
get_comment_type /en
get_comment_type 関数内で取得したコメントの種類(comment/trackback/pingback、= comment_type)に適用される。
get_comments_number /en
get_comments_number 関数を使ってグローバル変数 $comments から読み出したコメント数に適用される。comments_number も参照。
post_comments_feed_link /en
comments_rss 関数が生成したコメントフィード URL に適用される。

データベース書き込み

このセクションのフィルターは、情報がデータベースに保存される前に適用されます。

comment_save_pre /en
フィルター関数引数: comment_post_ID、comment_author、comment_author_email、comment_author_url、comment_content、comment_type、user_ID のインデックスを含むコメントデータ配列
コメントを更新・編集する直前に、コメントデータに適用される。
pre_comment_approved /en
現在のコメント承認ステータス(true/false)をプラグインが上書きできるように適用される。true/false を返し、最初の変数を true/false に設定してコメントを承認または非承認にする。また、このコメントにアクセスできるように $comment_ID のようなグローバル変数を使う。
pre_comment_content /en
コメント本文がデータベースに保存される前に適用される。
preprocess_comment /en
フィルター関数引数: comment_post_ID、comment_author、comment_author_email、comment_author_url、comment_content、comment_type、user_ID のインデックスを含むコメントデータ配列
新しいコメントをデータベースに保存する際、他の処理がまだ施されていないコメントデータに適用される。
wp_insert_post_data /en
フィルター関数引数: 編集され、拡張された投稿の配列とサニタイズ済みの投稿配列
wp_insert_post() 内の修正済みまたは未修正の投稿データに対し、更新前または投稿のデータベースへの挿入前に適用される。

カテゴリー・タクソノミー項目関連のフィルター

管理画面関連のフィルターも参照。

データベース読み出し

このセクションのフィルターは、データベースから読み出された情報がページまたは編集画面に表示される前に適用されます。

category_description /en
category_description 関数でのフィルター関数引数: カテゴリーの説明、カテゴリー ID
wp_list_categories 関数でのフィルター関数引数: カテゴリーの説明、全カテゴリー情報の配列
category_description 関数および wp_list_categories 関数のカテゴリー情報に適用される。
category_feed_link /en
get_category_rss_link 関数が生成したカテゴリーフィード URL に適用される。
category_link /en
フィルター関数引数: リンク URL、カテゴリー ID
get_category_link 関数が生成したカテゴリーの URL に適用される。
get_ancestors /en
フィルター関数引数: 祖先オブジェクトIDの配列、指定されたオブジェクトID、指定されたオブジェクトタイプ
get_ancestorsから返された祖先オブジェクト ID リストに適用される(そして多くの他の関数によって順に使用される)。
get_categories /en
フィルター関数引数: カテゴリーリスト、get_categories オプションリスト
get_categories 関数が生成したカテゴリーのリストに適用される(そして多くの他の関数によって順に使用される)。
get_category /en
get_category が検索するカテゴリー情報に適用される。基本的にはWordPressのカテゴリーテーブル内で、特定のカテゴリーIDに関するすべてのフィールドの配列。
list_cats /en
フィルター関数引数: カテゴリー名、カテゴリー情報リスト(指定したカテゴリーテーブル内の全フィールド)
このフィルターは2種類の目的で使用される。
1. wp_dropdown_categories 関数では、show_option_all および show_option_none 引数をフィルターするために適用される。この場合、追加のフィルター関数引数はなし。
2. wp_list_categories 関数でカテゴリー名に対して適用する。
list_cats_exclusions /en
フィルター関数引数: SQL 文の WHERE 節で除外されたカテゴリー、get_categories オプションのリスト
get_categories 関数で、除外カテゴリーを決定する SQL 文の WHERE 節に適用される。
single_cat_title /en
wp_title 関数および single_cat_title 関数内でカテゴリーページのタイトルに利用するカテゴリー名に適用される。
the_category /en
フィルター関数引数: 生成 HTML、リスト区切り設定(空の場合はデフォルトの <li>)、get_the_category_list の親変数
get_the_category_list 関数が生成したカテゴリーリスト(リンクを含む HTML リスト)に適用される。
the_category_rss /en
フィルター関数引数: リストテキストおよびフィードの種類(通常 rdf または rss)
get_the_category_rss 関数内で、投稿のカテゴリーリスト(カテゴリー XML 要素のリスト)が RSS フィードに挿入される前に適用される。
wp_dropdown_cats /en
wp_dropdown_categories 関数が生成したカテゴリードロップダウンリスト HTML に適用される。
wp_list_categories /en
wp_list_categories 関数で生成されたカテゴリーリスト(HTML リスト)に適用される。
wp_get_object_terms /en
get_the_termsget_the_category などの複数のカテゴリーまたはタクソノミー関連の関数によって呼び出される、wp_get_object_terms 関数で生成された項目リスト(オブジェクトの配列)に適用される。

データベース書き込み

このセクションのフィルターは、情報がデータベースに保存される前に適用される。

pre_category_description /en
カテゴリーの説明がデータベースに保存される前に適用される。
edited_terms /en
カテゴリー・タクソノミーの変更がデータベースに保存される前に適用される。
pre_category_name /en
カテゴリー名がデータベースに保存される前に適用される。
pre_category_nicename(カテゴリースラッグ) /en
カテゴリーの nicename がデータベースに保存される前に適用される。

リンク関連のフィルター

注: このセクションでは投稿・ページ・アーカイブ・フィードなどのリンクに関するフィルターを紹介しています。リンク集(ブログロールリンク)についてはリンク集関連のフィルターセクションを参照。

attachment_link /en
フィルター関数引数: リンク URL、添付ファイル ID
get_attachment_link 関数が生成した添付ファイルの固定リンクに適用される。
author_feed_link /en
get_author_rss_link 関数が生成した投稿者フィードのURLに適用される。
author_link /en
フィルター関数引数: リンク URL、投稿者名スラッグ、投稿者 ID
get_author_posts_url 関数が生成した投稿者別アーカイブのリンク URL に適用される。
comment_reply_link /en
フィルター関数引数: リンク(文字列)、カスタムオプション(配列)、現在のコメント(オブジェクト)、現在の投稿(オブジェクト)
関数 comments_template 内で呼ばれるget_comment_reply_link によって、特定のコメントへの応答のため生成されたリンクに適用される。
day_link /en
フィルター関数引数: URL、年、月(数字)、日(数字)
get_day_link 関数が生成した日付別アーカイブのリンク URL に適用される。
feed_link /en
フィルター関数引数: URL、フィードの種類(例:rss2、atom など)
get_feed_link 関数が生成したフィードのリンク URL に適用される。
get_comment_author_link /en
フィルター関数引数: ユーザー名
get_comment_author_link 関数が生成したコメント投稿者のリンク HTML に適用される(これは comment_author_link で呼び出されるものと同じ)。
get_comment_author_url_link /en
get_comment_author_url_link 関数が生成したコメント投稿者のリンク HTML に適用される(これは comment_author_link で呼び出されるものと同じ)。
month_link /en
フィルター関数引数: URL、年、月(数字)
get_month_link 関数が生成した月別アーカイブのリンク URL に適用される。
page_link /en
フィルター関数引数: URL、ページ ID
get_page_link 関数が生成したページURLに適用される。
post_link /en
フィルター関数引数: 固定リンク URL、投稿投稿データのリスト
get_permalink 関数が生成した投稿投稿の固定リンクに適用される(これは the_permalink、post_permalink</tt>、previous_post_link</tt>、next_post_link 関数で呼び出されるものと同じ)。
post_type_link /en
get_post_permalink 関数によって算出されたカスタム投稿タイプパーマリンクに適用される。
the_permalink /en
the_permalink 関数が投稿投稿のパーマリンク URL を出力する前に適用される。
year_link /en
フィルター関数引数: URL、年
get_year_link 関数が生成した年別アーカイブのリンク URL に適用される。
tag_link /en
フィルター関数引数: リンク URL、タグ ID
get_tag_link 関数が生成したタグの URL に適用される。
term_link /en
フィルター関数引数: 項目リンク URL、項目オブジェクト、タクソノミースラッグ
get_term_link 関数が生成したタクソノミー項目の URL に適用される。

日付・時間関連のフィルター

リンク関連のフィルターも参照。

get_comment_date /en
get_comment_date 関数で呼び出されたフォーマット済みのコメント投稿日に適用される(comment_date でも呼び出される)。
get_comment_time /en
get_comment_time 関数が生成したフォーマット済みのコメント投稿時間に適用される。
get_the_modified_date /en
get_the_modified_date 関数が生成したフォーマット済みの投稿修正年月日に適用される(この関数は the_modified_date 関数内でも呼び出される)。
get_the_modified_time /en
get_the_modified_time 関数または get_post_modified_time 関数が生成したフォーマット済みの投稿修正時間に適用される(これらの関数は the_modified_time 関数内でも呼び出される)。
get_the_time /en
get_the_time 関数または get_post_time 関数が生成したフォーマット済みの投稿年月日に適用される(これらの関数は the_time 関数内でも呼び出される)。
the_date /en
the_date 関数が生成したフォーマット済みの投稿年月日に適用される。
the_modified_date /en
the_modified_time 関数が生成したフォーマット済みの投稿修正年月日に適用される。
the_modified_time /en
the_modified_time 関数が生成したフォーマット済みの投稿修正時間に適用される。
the_time /en
the_time 関数が生成したフォーマット済みの投稿時間に適用される。
the_weekday /en
the_weekday 関数が生成したフォーマット済みの曜日名に適用される。
the_weekday_date /en
フィルター関数引数: 曜日名、曜日名の前に出力する文字列、曜日名の後に出力する文字列
the_weekday_date 関数が生成した投稿の曜日名に適用される。

投稿者・ユーザー関連のフィルター

リンク関連のフィルター管理画面関連のフィルターセクションも参照

login_body_class /en
login_header() /enの出力となるログイン画面のbody要素のclass属性に適用される。
login_redirect /en
ログイン処理の実行中に redirect_to post/get 変数に適用される。
user_contactmethods /en
「あなたのプロフィール」画面の連絡先情報に適用される (古いページは contactmethods 参照)。
update_(meta_type)_metadata /en
(ユーザーの)メタデータが更新される前に適用される。

データベース読み出し

このセクションのフィルターは、データベースから読み出された情報がページまたは編集画面に表示される前に適用されます。

author_email /en
comment_author_email 関数で取得したコメント投稿者のメールアドレスに適用される。
comment_author /en
comment_author 関数で取得したコメント投稿者名に適用される。 get_comment_author も参照。
comment_author_rss /en
コメント投稿者名が RSS フィードに挿入される前に適用される。
comment_email /en
comment_author_email_link 関数で取得したコメント投稿者のメールアドレスに適用される。
comment_url /en
comment_author_url 関数で取得したコメント投稿者のサイトURLに適用される(get_comment_author_url も参照)。
get_comment_author /en
get_comment_author 関数で取得したコメント投稿者名に適用される。これは comment_author で呼び出されるものと同じ。comment_author も参照。
get_comment_author_email /en
get_comment_author_email 関数で取得したコメント投稿者のメールアドレスに適用される。これは comment_author_email で呼び出されるものと同じ。author_email も参照。
get_comment_author_IP /en
get_comment_author_IP 関数で取得したコメント投稿者の IP アドレスに適用される。これは comment_author_IP で呼び出されるものと同じ。
get_comment_author_url /en
get_comment_author_url 関数で取得したコメント投稿者の URL に適用される。これは comment_url で呼び出されるものと同じ。comment_author も参照。
login_errors /en
ログイン画面に表示されるエラーメッセージに適用される。
login_headertitle /en
ログインヘッダー URL の title 属性(デフォルトでは "Powered by WordPress")に適用される。
login_headerurl /en
ログインヘッダー URL のリンク先(デフォルトでは wordpress.org)に適用される。
login_message /en
ログイン画面に表示されるメッセージに適用される。
role_has_cap /en
フィルター関数引数: フィルターする権限のリスト、チェックする権限、ユーザー権限グループ名
WP_Role->has_cap 関数内で、ユーザー権限グループの権限リストに適用される。
sanitize_user /en
フィルター関数引数: サニタイズ済みのユーザー名、サニタイズされていないユーザー名、厳格な ASCII 文字を使うかどうか(true/false)
sanitize_user 関数で返されるユーザー名に適用される。
the_author /en
get_the_author 関数で返されるユーザーの表示名に適用される。これは the_author で呼び出されるものと同じ。
the_author_email /en
the_author_email 関数で返されるユーザーのメールアドレスに適用される。
user_search_columns /en
wp_users テーブル内のカラム一覧に WP_User_Query 内の WHERE 節を含めるために適用される。

データベース書き込み

このセクションのフィルターは、情報がデータベースに保存される前に適用されます。

pre_comment_author_email /en
コメントをデータベースに保存する前に、コメント投稿者のメールアドレスに対して適用される。
pre_comment_author_name /en
コメントをデータベースに保存する前に、コメント投稿者のユーザー名に対して適用される。
pre_comment_author_url /en
コメントをデータベースに保存する前に、コメント投稿者の URL に対して適用される。
pre_comment_user_agent /en
コメントをデータベースに保存する前に、コメント投稿者のユーザーエージェント情報に対して適用される。
pre_comment_user_ip /en
コメントをデータベースに保存する前に、コメント投稿者の IP アドレス情報に対して適用される。
pre_user_id /en
コメントをデータベースに保存する前に、コメント投稿者のユーザー ID に対して適用される。
pre_user_description /en
コメントをデータベースに保存する前に、コメント投稿者の説明文に対して適用される。
pre_user_display_name /en
コメントをデータベースに保存する前に、コメント投稿者のブログ上の表示名に対して適用される。
pre_user_email /en
データベースに保存する前に、ユーザーのメールアドレスに対して適用される。
pre_user_first_name /en
データベースに保存する前に、ユーザーの名前(ファーストネーム)に対して適用される。
pre_user_last_name /en
データベースに保存する前に、ユーザーの苗字に対して適用される。
pre_user_login /en
データベースに保存する前に、ユーザーのログイン名に対して適用される。
pre_user_nicename /en
データベースに保存する前に、ユーザー名のスラッグ("nice name")に対して適用される。
pre_user_nickname /en
データベースに保存する前に、ユーザーのニックネームに対して適用される。
pre_user_url /en
データベースに保存する前に、ユーザーの URL に対して適用される。
registration_errors /en
新規アカウント登録の際に発生した登録エラーのリストに適用される。
user_registration_email /en
新規ユーザーを登録する前に、登録ページから読み取ったユーザーのメールアドレスに適用される。
validate_username /en
フィルター関数引数: ユーザー名が有効かどうかの確認結果(true/false)、確認されたユーザー名
新規ユーザー名が有効かどうかの確認結果に適用される。

リンク集関連のフィルター

注: このセクションではリンク集(ブログロール)関連のフィルターを紹介しています。投稿、ページ、カテゴリーなどに関連するリンクのフィルターについては、リンク関連のフィルターを参照。

get_bookmarks /en
フィルター関数引数: データベースクエリ結果のリスト、get_bookmarks 引数のリスト
get_bookmarks 関数で取得した、リンク集のデータベースクエリ結果に適用される。
link_category /en
get_links_list 関数および wp_list_bookmarks 関数で取得したリンクカテゴリー情報に適用される(WordPress 2.2 以降)。
link_description /en
get_links_list 関数および wp_list_bookmarks 関数で取得したリンク説明文に適用される(WordPress 2.2 以降)。
link_rating /en
get_links_list 関数および wp_list_bookmarks 関数で取得したリンク名に適用される(WordPress 2.2 以降)。
link_title /en
get_linkrating 関数で取得したリンク評価(数字)に適用される。
pre_link_description /en
リンク説明がデータベースに保存される前に適用される。
pre_link_image /en
リンク画像がデータベースに保存される前に適用される。
pre_link_name /en
リンク名がデータベースに保存される前に適用される。
pre_link_notes /en
リンクのメモがデータベースに保存される前に適用される。
pre_link_rel /en
リンク先の関係/間柄(XFN)情報がデータベースに保存される前に適用される。
pre_link_rss /en
リンク先の RSS URL がデータベースに保存される前に適用される。
pre_link_target /en
リンクターゲットがデータベースに保存される前に適用される。
pre_link_url /en
リンク URL がデータベースに保存される前に適用される。

ブログ情報・設定関連のフィルター

all_options /en
get_alloptions 関数で取得した、ブログ設定情報のリストに適用される。
bloginfo /en
get_bloginfo 関数で情報を取得した後、bloginfo 関数で取得したブログ設定情報に適用される。2つ目の引数 $show は、要求された bloginfo の設定名。bloginfo("url")bloginfo("directory")bloginfo("home") はこのフィルターに影響されないことに注意する(bloginfo_url フィルターの項を参照)。
bloginfo_rss /en
get_bloginfo_rss 関数内で get_bloginfo 関数を使ってブログ設定情報を取得し、 HTML タグを除去して特殊文字を変換した後に適用される。2つ目の引数 $show は、要求された bloginfo の設定名。
bloginfo_url /en
bloginfo("url")bloginfo("directory")bloginfo("home") の出力値を返す前に適用される。
loginout /en
wp_loginout 関数で(通常サイドバーに配置される)ログイン・ログアウト用の HTML リンクを生成する際に適用される。
option_(option name) /en
get_option 関数で取得した設定値に対し、配列ベースの設定を解読した後に適用される。例えば foo という設定について get_option("foo") の出力値をフィルターする場合、"option_foo" という名前のフィルターを追加して使用する。
pre_option_(option name) /en
get_alloptions 関数で取得した設定値に対し、配列ベースの設定を解読した後に適用される。例えば foo という設定をフィルターする場合、pre_option_foo という名前のフィルターを追加して使用する。
pre_get_space_used /en
get_space_used() 関数に適用され、使用中のディスク領域を表示する代替方法を提供する。このフィルターで false を返すと、デフォルトの表示方法に戻る (wp_upload_dir() が返すディレクトリの空き領域をメガバイト単位で)。
pre_option_(option name) /en
get_alloptions関数によりデータベースから取得されるオプション値に適用される。配列のオプション値であればシリアライズ化される。このフィルターを使用するには、特定のオプション名を付けてフィルターを追加する必要がある。たとえば、オプション “foo” をフィルターするには “pre_option_foo”。
pre_update_option_(option name) /en
オプション値がデータベースに保存される前に適用される。つまり、保存する値を上書きできる。このフィルターを使用するには、特定のオプション名を付けてフィルターを追加する必要がある。たとえば、オプション “foo” をフィルターするには “pre_update_option_foo”。
register /en
wp_register 関数で、ユーザー登録が許可されている場合に表示する登録リンク、またはログインしている場合に表示する管理画面へのリンクに適用される。
upload_dir /en
フィルター関数引数: dir(アップロードディレクトリへのパス)、url(アップロードディレクトリの URL)、error(エラーを出力する場合 true に設定)の値を含む配列
wp_upload_dir 関数で算出した、ファイルアップロードディレクトリに適用される。
upload_mimes /en
フィルター関数引数: "|" 記号区切りのファイル拡張子と対応する MIME タイプ情報を含むリスト
wp_check_filetype 関数で MIME タイプリストの入力がない場合、アップロードファイル用の MIME タイプリストを返すためのフィルター。

テキスト関連のフィルター

attribute_escape /en
特殊文字を HTML 文字実体参照に変換するための関数、attribute_escape 関数内でテキストデータ(投稿投稿本文など)に適用される。
js_escape /en
js_escape 関数で、JavaScript コードをブラウザに送信する前に適用される。

管理画面関連のフィルター

このセクションのフィルターは WordPress の管理画面に関連するものです。コンテンツ編集画面もこれに含まれます。

admin_user_info_links /en
WordPress 管理画面クイックメニュー内のユーザープロフィール・情報リンクに適用される。
autosave_interval /en
投稿を自動保存する間隔の時間に適用される。
bulk_actions /en
管理画面の一括操作ドロップダウンの操作対象項目配列に適用される。
bulk_post_updated_messages /en
一括操作更新メッセージに適用される。
cat_rows /en
カテゴリー管理画面で生成される、カテゴリー行の HTML に適用される。
comment_edit_pre /en
コメント本文が編集画面に表示される前に適用される。
comment_edit_redirect /en
フィルター関数引数: リダイレクト先情報、コメント ID
管理画面でコメントを編集した後のリダイレクト先情報に適用される。
comment_moderation_subject /en
フィルター関数引数: メール件名、コメント ID
管理者に承認が必要な新しいコメントがつけられたことを知らせるメールを送信する前に、メール件名に適用される。
注:この操作はデフォルトの wp_notify_moderator 関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照)。
comment_moderation_text /en
フィルター関数引数: メール本文、コメント ID
管理者に承認が必要な新しいコメントがつけられたことを知らせるメールを送信する前に、メール本文に適用される。
注:この操作はデフォルトの wp_notify_moderator 関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照)。
comment_notification_headers /en
フィルター関数引数: メールヘッダーのテキスト、コメント ID
投稿者に新しいコメントがつけられたことを知らせるメールを送信する前に、メールヘッダーに適用される。
注:この操作はデフォルトの wp_notify_moderator 関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照)。
comment_notification_subject /en
フィルター関数引数: メール件名、コメント ID
投稿者に新しいコメントがつけられたことを知らせるメールを送信する前に、メール件名に適用される。
注:この操作はデフォルトの wp_notify_moderator 関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照)。
comment_notification_text /en
フィルター関数引数: メール本文、コメント ID
投稿者に新しいコメントがつけられたことを知らせるメールを送信する前に、メール本文に適用される。
注:この操作はデフォルトの wp_notify_moderator 関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照)。
comment_row_actions /en
コメント行の下の操作リンク(返信、クイック編集、編集)に適用される。
cron_request /en
spawn_cron()wp_remote_post() に渡す URL、キー、引数をフィルターできるようにする。
cron_schedules /en
wp_get_schedules 関数で cron スケジュールを生成できるよう、空の配列に適用される。
custom_menu_order /en
'menu_order' フィルターを有効化するために使われる。
default_content /en
新規投稿の際、編集画面を開く前にデフォルトの投稿本文に対して適用される。
default_excerpt /en
新規投稿の際、編集画面を開く前にデフォルトの投稿抜粋に対して適用される。
default_title /en
新規投稿の際、編集画面を開く前にデフォルトの投稿タイトルに対して適用される。
editable_slug /en
get_sample_permalink 関数によって投稿、ページ、タグ、カテゴリースラッグに対して適用される。
explain_nonce_(verb)-(noun) /en
フィルター関数引数: 表示するテキスト(デフォルトは "Are you sure you want to do this?" メッセージ)およびアクション URL の最後にくる追加情報
フィルター関数が WordPress コアのコードにはないナンスを説明するメッセージを定義できるようにする。使うには、特定の動詞・名刺フィルターを定義する必要がある。例えばプラグインでタグを更新するナンスを定義している場合、explain_nonce_update-tag というフィルターを定義すると、"Are you sure you want to update this tag?" というメッセージが表示されるようにする。
format_to_edit /en
管理画面で編集するために投稿を設定する管理メニューによって呼び出される format_to_edit 関数で、投稿本文・抜粋・タイトル・パスワードに適用される。また、管理画面でコメントを編集する際にも適用される。
format_to_edit /en
(デフォルトでは WordPress には使用されない)format_to_post 関数内の投稿本文に適用される。
manage_edit-${post_type}_columns /en
フィルター関数引数および戻り値: キーがカラム名、値がそのカラムのヘッダーテキストになっている連想配列
カスタム投稿タイプに対して、投稿管理画面に出力されるカラムのリストに適用される。編集画面にカラム情報を挿入するアクションmanage_${post_type}_posts_custom_column /en も参照。
manage_link-manager_columns /en
フィルター関数引数および戻り値: キーがカラム名、値がそのカラムのヘッダーテキストになっている連想リスト
WordPress 2.7 まではmanage_link_columns。ブログロール管理画面に出力されるカラムのリストに適用される。編集画面にカラム情報を挿入するアクションmanage_posts_custom_column /en も参照。
manage_posts_columns /en
フィルター関数引数および戻り値: キーがカラム名、値がそのカラムのヘッダーテキストになっている連想配列
投稿管理画面に出力されるカラムのリストに適用される。編集画面にカラム情報を挿入するアクションmanage_posts_custom_column /enも参照 (サンプルや使い方については Scompt's tutorial 参照(現在、リンク切れ))。
manage_pages_columns /en
フィルター関数引数および戻り値: キーがカラム名、値がそのカラムのヘッダーテキストになっている連想配列
固定ページ管理画面に出力されるカラムのリストに適用される。編集画面にカラム情報を挿入するアクションmanage_pages_custom_column /enも参照
manage_users_columns /en
manage_users_custom_column /en
manage_users_sortable_columns /en
media_row_actions /en
メディアライブラリーの各ファイルの下に表示されるアクションリンクのリスト(表示や編集など)に適用される。
menu_order /en
管理画面のメニューの順番の配列に適用される。事前に custom_menu_order フィルターで有効化される必要がある。
nonce_life /en
nonce の生成や検証などのライフスパンに適用される。通常より早く期限切れする nonce を生成できる。フィルターからの戻り値は秒単位。
nonce_user_logged_out /en
ユーザーがログアウトした際の nonce の生成や検証に利用される現行ユーザーID に適用される。
plugin_row_meta /en
プラグインページの各プラグインの下にリンクを追加する。
postmeta_form_limit /en
投稿管理画面に表示する投稿のメタ情報項目数に適用される。
post_row_actions /en
管理画面の「投稿」 > 「投稿一覧」で表示される各投稿の下のアクションのリンク(クイック編集、編集、表示、プレビューなど)のリストに適用される。
post_updated_messages /en
投稿、固定ページ、カスタム投稿タイプの操作中にユーザーに表示される管理メッセージをもつ配列に適用される。このフィルターは出力メッセージを変更するだけで、メッセージの出力そのものは行わない。register_post_type 文書内の "customizing the messages" 参照。
pre_upload_error /en
プラグインがファイルアップロード時に XMLRPC エラーを生成できるようするために適用される。
preview_page_link /en
ページ編集画面の「プレビュー」リンクに適用される。
preview_post_link /en
投稿編集画面の「プレビュー」リンクに適用される。
richedit_pre /en
wp_richedit_pre 関数内でリッチテキストエディターに投稿本文を表示する前に適用される。
schedule_event /en
cron スケジュールに追加される、単一の繰り返される各イベントに適用される。
show_password_fields /en
ユーザーがプロフィール画面からパスワードを変更できるかどうかの変数に適用される。自分で変更が可能な場合は true、変更できない場合は false。
terms_to_edit /en
各タクソノミーにおけるキーワードの CSV に適用される。CSV は、投稿にどのキーワードが付けられているかの表示に使用される、
the_editor /en
フィルター関数引数および戻り値: 文字列
リッチテキストエディターを囲む HTML の div 要素を生成し、画面に出力する前に適用される。
user_can_richedit /en

ユーザーのブラウザーがリッチテキストエディターに対応しているかどうかの評価、または user_can_richedit 関数で設定されたリッチテキストエディターを使うかどうかの設定に適用される。

user_has_cap /en
フィルター関数引数: フィルターする権限のリスト、チェックする権限、引数リスト(例えば投稿編集の権限の場合、投稿 ID など)
current_user_can 関数で呼び出される WP_User->has_cap 関数内で、ユーザーの権限リストに適用される。
wp_handle_upload_prefilter /en
フィルター関数引数: $_FILES の単一要素を表す配列
ファイルをアップロードする際のアップロード情報に適用される。
wp_handle_upload /en
フィルター関数引数: file(ファイル名)/url/type 情報の配列
ファイルをアップロードする際、アップロード情報に適用される。
wp_revisions_to_keep /en
フィルター関数引数: 保持するリビジョンの数(デフォルトは無限)、投稿オブジェクト
ある投稿に対して保持するリビジョン数を変更する。
wp_terms_checklist_args /en
フィルター関数引数: チェックボックスのリストの引数の配列、投稿ID
wp_terms_checklist() 関数の引数に適用される。
wp_upload_tabs /en
アップロードファイル管理画面でカスタムタブのリストを出力する際に実行する。カスタムタブ用のページを表示するには、upload_files_タブ名 アクションフィルターを使用する(プラグイン_API/アクションフック一覧を参照)。
media_upload_tabs /en
アップロードファイル管理画面でカスタムタブのリストを出力する際に実行する。カスタムタブ用のページを表示するには、upload_files_タブ名 アクションフィルターを使用する(プラグイン_API/アクションフック一覧を参照)。
plugin_action_links_(plugin file name) /en
プラグイン画面に表示されるリンクのリストに適用される (有効化、無効化リンクのとなり)。
views_edit-post / en
投稿一覧に適用される。例: すべて (30) | 公開済み (22) | 下書き (5) | 保留中 (2) | ゴミ箱 (1)

リッチエディター関連のフィルター

これらのフィルターはリッチテキストエディタ(TinyMCE)の設定を変更する。

mce_spellchecker_languages /en
スペルチェッカーで利用できる言語の選択肢に適用される。
mce_buttons, mce_buttons_2, mce_buttons_3, mce_buttons_4 /en
それぞれのフィルターにはボタン名の配列が含まれる。リッチテキストエディターツールバーのボタン行に適用される。
mce_css /en
リッチテキストエディター用の CSS ファイル URL に適用される。
mce_external_plugins /en
リッチテキストエディターが読み込む外部プラグインの配列に適用される。
mce_external_languages /en
外部プラグインによって読み込まれた言語ファイルの配列に適用され、標準の翻訳メソッドが利用できるようにする(詳しくは wp-includes/js/tinymce/langs/wp-langs.php ファイルを参照)。
tiny_mce_before_init /en
リッチテキストエディターの init 配列全体に適用される。

テンプレート関連のフィルター

このセクションではテーマ・テンプレート・スタイルファイル関連のリンクを紹介しています。

locale_stylesheet_uri /en
フィルター関数引数: URL、スタイルシートディレクトリ URL
get_locale_stylesheet_uri 関数で返されるロケール特有のスタイルシート情報に適用される。
stylesheet /en
get_stylesheet 関数で返されるスタイルシート情報に適用される。
stylesheet_directory /en
フィルター関数引数: スタイルシートディレクトリ情報、スタイルシート情報
get_stylesheet_directory 関数で返されるスタイルシートディレクトリ情報に適用される。
stylesheet_directory_uri /en
フィルター関数引数: スタイルシートディレクトリ URL、スタイルシート情報
get_stylesheet_directory_uri 関数で返されるスタイルシートディレクトリ URL に適用される。
stylesheet_uri /en
フィルター関数引数: スタイルシート URL、スタイルシート情報
get_stylesheet_uri 関数で返されるスタイルシート URL に適用される。
template /en
get_template 関数で返されるテンプレート情報に適用される。
template_directory /en
フィルター関数引数: テンプレートディレクトリ情報、テンプレート情報
get_template_directory 関数で返されるテンプレートディレクトリ情報に適用される。
template_directory_uri /en
フィルター関数引数: テンプレートディレクトリ URL、テンプレート情報
get_template_directory_uri 関数で返されるテンプレートディレクトリ URL に適用される。
theme_root /en
get_theme_root 関数で返されるテーマのルートディレクトリ情報(通常は wp-content/themes)に適用される。
theme_root_uri /en
フィルター関数引数: URL、サイトURL
get_theme_root_uri 関数で返されるテーマのルートディレクトリ URLに適用される。
また、以下のフィルターフックを使用すれば、テーマ内の各テンプレートファイルの位置指定を変更することもできる(template_redirect アクションフックも参照)。
404_template /en
archive_template /en
このフィルターを使って例えば、カスタム投稿タイプのアーカイブに特定のテンプレートを強制できる。つまりすべてのコードをプラグイン内に保持できる。
attachment_template /en
author_template /en
category_template /en
comments_popup_template /en
comments_template /en
"comments_template"フィルターを使用すると、プラグインからカスタムテンプレートをロードし、デフォルトのコメントテンプレートを置換できる。
date_template /en
home_template /en
page_template /en
paged_template /en
search_template /en
single_template /en
このフィルターを使って例えば、カスタム投稿タイプに特定のテンプレートを強制できる。つまりすべてのコードをプラグイン内に保持できる。
shortcut_link / en
「Press This」ブックマークレットに適用される。
template_include /en
wp_nav_menu_args /en
wp_nav_menu 関数の引数に適用される。

Kubrick フィルター

バージョン 3.0 以前のデフォルトテーマ kubric に存在したフィルター。

kubrick_header_color
kubrick テーマのヘッダーカラーに適用される。
kubrick_header_display
kubrick テーマのヘッダー表示オプションに適用される。
kubrick_header_image
kubrick テーマのヘッダー画像ファイルに適用される。

登録・ログイン関連のフィルター

authenticate /en
ユーザー名とパスワードを使用したログインに対して、BASIC認証を実行できる。
registration_errors /en
新規アカウントとしてユーザーを登録する際に生成された登録エラーに適用される。
user_registration_email /en
新規ユーザーとして登録する前に、登録ページから取得されたユーザーの電子メールアドレスに適用される。
validate_username /en
フィルター関数引数: 検証結果が正しいかどうか (true または false)、検証されるユーザー名
新規ユーザー名の検証結果に適用される。
wp_authenticate_user /en
ユーザーがログインし WordPress がユーザー名とパスワードを検証した後、かつ、検証エラーをチェックする前に適用される。

リダイレクト・リライト関連のフィルター

これらの高度なフィルターは、WordPress のリライトルール処理に関連したものです。

allowed_redirect_hosts /en
リダイレクトしても安全と思われるホスト名のリストに適用される。危険な 'redirect_to' リクエストパラメータを防ぐため wp-login.php が使用する。
author_rewrite_rules /en
投稿者に関連する URL リライトルールが生成された後に適用される。
category_rewrite_rules /en
カテゴリーに関連する URL リライトルールが生成された後に適用される。
comments_rewrite_rules /en
コメントに関連する URL リライトルールが生成された後に適用される。
date_rewrite_rules /en
日付に関連する URL リライトルールが生成された後に適用される。
mod_rewrite_rules /en
パーマリンク構造を変更した際、.htaccess ファイルに挿入する URL リライトルールのリストに適用される。現バージョンでは廃止済みの rewrite_rules を置き換えるフィルターでもある。
page_rewrite_rules /en
ページに関連する URL リライトルールが生成された後に適用される。
post_rewrite_rules /en
投稿に関連する URL リライトルールが生成された後に適用される。
redirect_canonical /en
フィルター関数引数: $redirect_url$requested_url
“canonical” URL リダイレクトのキャンセルに使用する。キャンセルには FALSEを返し、リダイレクトを許可するには $redirect_url を返す。
rewrite_rules_array /en
URL リライトルールが生成された後、その配列全体に適用される。
root_rewrite_rules /en
ルートレベル URL リライトルールが生成された後に適用される。
search_rewrite_rules /en
検索に関連する URL リライトルールが生成された後に適用される。
wp_redirect /en
フィルター関数引数: URL、HTTP ステータスコード
wp_redirect 関数内のリダイレクト URL に適用される(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。


wp_redirect_status /en
フィルター関数引数: URL、HTTP ステータスコード
デフォルトの wp_redirect 関数で転送が行われる際の HTTP ステータスコードに適用される(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。

WP_Query フィルター

以下は投稿を取得するためのクエリを構築・実行する間に WP_Query object によって実行されるフィルターです。ユーザー、メタ情報、その他のより一般的なクエリについては高度な WordPress フィルターも参照。

found_posts
投稿のリストをデータベースから取得した直後に、このリストに対して適用される。
found_posts_query /en
表示する投稿のリストが取得された後、WordPress はクエリ結果内の行を選択する。このフィルターを使い、その際に SELECT FOUND_ROWS() 以外の操作を加えることができる。
post_limits /en
post 配列を返すクエリの LIMIT 節に適用される。
posts_clauses /en
post配列を返す、節ごとにキー付きの配列に分割された SQLクエリ全体に適用される。posts_request よりも容易に処理できる。
posts_distinct /en
post 配列を返すクエリに、プラグインが DISTINCTROW 節を追加できるようにする。
posts_fields /en
post 配列を返すクエリのフィールドリストに適用される。
posts_groupby /en
post 配列を返すクエリの GROUP BY 節に適用される(通常は空データ)。
posts_join /en
post 配列を返すクエリの JOIN 節に適用される。通常、JOIN にテーブルを追加する際に posts_where フィルターと一緒に使う。
posts_join_paged /en
post 配列を返すクエリの JOIN 節に対し、ページングが計算された後適用される(ページング自体は JOIN に影響しないので、このフィルターは posts_join と実質的には同一)。
posts_orderby /en
post 配列を返すクエリの ORDER BY 節に適用される。
posts_request /en
post 配列を返す SQL クエリを実行する直前に、クエリ全体に対して適用される。
posts_results / en
クエリから返された結果の配列を操作できる。
posts_search /en
WP_Query の WHERE 節で使用される検索 SQL に適用される。
posts_where /en
post 配列を返すクエリの WHERE 節に適用される。
posts_where_paged /en
post 配列を返すクエリの WHERE 節に対し、ページングが計算された後適用される(ページング自体は WHERE に影響しないので、このフィルターは posts_where と実質的には同一)。
the_posts /en
投稿の固定ページで、閲覧権限および投稿ステータスのチェックが行われた後、投稿のリストのクエリに適用される。

メディア関連のフィルター

このセクションではさまざまな種類のメディアと連携して使われるメディアフィルターを紹介しています。

editor_max_image_size /en
image_downsize /en
get_image_tag_class /en
get_image_tag /en
image_resize_dimensions /en
intermediate_image_sizes /en
icon_dir /en
wp_get_attachment_image_attributes /en
img_caption_shortcode /en
post_gallery /en
use_default_gallery_style /en
gallery_style /en
(adjacent)_image_link /en
embed_defaults /en
load_default_embeds /en
embed_googlevideo /en
upload_size_limit /en
wp_image_editors /en
plupload_default_settings /en
plupload_default_params /en
image_size_names_choose /en
wp_prepare_attachment_for_js /en
media_upload_tabs /en
disable_captions /en
media_view_settings /en
media_view_strings /en
wp_handle_upload_prefilter /en

高度な WordPress フィルター

このセクションでは、国際化やさまざまなクエリ、その他 WordPress 基本関数に関連する高度なフィルターを紹介しています。

create_user_query /en
新規登録ユーザーの情報をデータベースに保存するクエリが実行される直前に、このクエリに対して適用される。
get_editable_authors /en
get_editable_authors 関数で、ユーザーが編集可能な投稿者のリストに適用される。
get_next_post_join /en
フィルター関数引数: JOIN 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリーのリスト
get_next_post 関数内で、SQL 文の JOIN 節に適用される。
get_next_post_sort /en
フィルター関数引数: ORDER BY
get_next_post 関数内で、SQL 文の ORDER BY 節に適用される。
get_next_post_where /en
フィルター関数引数: WHERE 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリーのリスト
get_next_post 関数内で、SQL 文の WHERE 節に適用される。
get_previous_post_join /en
フィルター関数引数: JOIN 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリーのリスト
get_previous_post 関数内で、SQL 文の JOIN 節に適用される。
get_previous_post_sort /en
フィルター関数引数: SQL文の ORDER BY
get_previous_post 関数内で、SQL 文の ORDER BY 節に適用される。
get_previous_post_where /en
フィルター関数引数: SQL文の WHERE 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリのリスト
get_previous_post 関数内で、SQL 文の WHERE 節に適用される。
gettext /en
フィルター関数引数: 翻訳済みおよび未翻訳のテキスト、テキストドメイン
translation() 関数で翻訳されたテキスト(__() および _e() などの国際化関数で呼び出される)に適用される。国際化の設定が有効になっていなかったり、テキストドメインが読み込まれていない場合にも適用。
override_load_textdomain /en
get_meta_sql /en
フィルター関数引数: array( compact( 'join', 'where' ), $this->queries, $type, $primary_table, $primary_id_column, $context )
関数 WP_Meta_Query::get_sql (高度なメタクエリ用にメインのクエリに追加される SQL 節を生成する) 内で、高度なメタクエリにより生成された SQL JOIN 節および WHERE 節に適用される。
get_others_drafts /en
管理画面で他のユーザーの下書き投稿を選択するクエリに適用される。
get_users_drafts /en
管理画面で表示する自分の下書き投稿を選択するクエリに適用される。
locale /en
get_locale 関数で取得したロケール情報に適用される。
query /en
プラグインが読み込まれた後に実行されるすべてのクエリに適用される。
query_string /en
非推奨。代わりに query_vars または request を使うこと。
query_vars /en
SQL が生成される前に、WordPress のパブリッククエリ変数のリストに対して適用される。プラグインが他の方法で扱った余分な固定リンク情報を削除するのに使える。現バージョンではすでに廃止されている、query_string を置き換えるフィルターでもある。
request /en
動作は query_vars と同じ。追加クエリ変数・プライベートクエリ変数が追加された後に適用される。
excerpt_length /en
個別投稿の抜粋の長さを定義する。
excerpt_more /en
抜粋の後に来る "more(続きを読む)" 文字列の長さを定義する。
post_edit_form_tag /en
デフォルト投稿・ページエディターのフォームタグの後にコードを付加できるようにする。
update_user_query /en
ユーザー情報を更新するクエリを実行する前に、このクエリに対して適用される。

;uploading_iframe_src /en

(バージョン 2.5 で削除)投稿・ページ編集画面のファイルアップロード iframe の src 属性に適用される。
xmlrpc_methods /en
XMLRPC サーバー用に定義された XMLRPC メソッドに適用される。
wp_mail_from /en
wp_mail 関数でメールが送信される前に、$_SERVER['SERVER_NAME'] で設定されたホスト名の値に適用される。フィルターを使ってメールアドレス(例:user@example.com)または氏名とメールアドレスの組み合わせ(例:Name <user@example.com>)を返すことができる。
wp_mail_from_name /en
wp_mail 関数によりメールが送信される前に適用される。このフィルターはメールの From 欄の名前に使用される文字列を返す必要がある。
update_(meta_type)_metadata /en
メタデータが更新される前に適用される。'user'メタデータが更新されるならフックは 'update_user_metadata'。

ウィジェット

このセクションでは WordPress コア内のウィジェットによって追加されたフィルターを紹介しています。

dynamic_sidebar_params /en
WordPress ウィジェット内の widgets_init 関数の引数に適用される。
widget_archives_dropdown_args /en
WordPress アーカイブウィジェット内の wp_get_archives() /en 関数の引数に適用される。
widget_categories_args /en
WordPress カテゴリーウィジェット内の wp_list_categories() 関数の引数に適用される。
widget_links_args /en
WordPress リンクウィジェット内の wp_list_bookmarks() 関数の引数に適用される。
widget_pages_args /en
WordPress 固定ページウィジェット内の wp_list_pages() 関数の引数に適用される。
widget_tag_cloud_args /en
WordPress 固定ページウィジェット内の wp_tag_cloud() 関数の引数に適用される。
widget_text /en
WordPress テキストウィジェットのウィジェットテキストに適用される。サードパーティ製ウィジェットに適用してもよい。
widget_title /en
ユーザーが編集可能な WordPress ウィジェットのウィジェットタイトルに適用される。サードパーティ製ウィジェットに適用してもよい。

管理バー

このセクションでは WordPress 3.0 で追加された管理バー関連のフィルターを紹介しています。

wp_admin_bar_class / en
wp-includes/admin-bar.php 内の _wp_admin_bar_init() 関数のデフォルト 'WP_Admin_Bar' クラスを変更できる。

これも読んでみよう

最新英語版: WordPress Codex » Plugin API/Filter Reference最新版との差分