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

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

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

提供: WordPress Codex 日本語版
< プラグイン API
2008年4月2日 (水) 14:16時点におけるNao (トーク)による版 (2008年2月末に作成した翻訳データの流し込み(暫定版。英語最新版との比較が必要))

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

この記事は(おそらくほぼ完全な)アクションフックの一覧です。アクションフックはバージョン2.1 以降から、プラグインおよびテーマ開発時に利用できるようになっています。詳しい情報については下記もご覧下さい。

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

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

データベース読み出し

attachment_icon
フィルター関数引数: アイコンファイルのimg要素情報、添付ファイルID.
get_attachment_icon関数で取得した添付ファイルのアイコンに適用される。
attachment_innerHTML
フィルター関数引数: innerHTML(デフォルトはタイトル)、添付ファイルID.
get_attachment_innerHTML関数内で、添付ファイルにアイコンがない場合タイトルに使われる文字列に適用される。
content_edit_pre(投稿記事本文)
excerpt_edit_pre(記事概要)
title_edit_pre(記事タイトル)
各データが編集画面に表示される前に適用される。
get_attached_file
フィルター関数引数: ファイル情報、添付ファイルID
get_attached_file関数で取得した添付ファイル情報に適用される。
get_enclosed
get_enclosed関数で取得した記事のエンクロージャーリストに適用される。
get_pages
フィルター関数引数: ページリスト(各項目にはページのデータ配列が含まれる)、リクエストされたページを指定するget_pages関数の引数リスト
get_pages関数で取得したページのリストに適用される。
get_pung
get_pung関数で取得したピンバック受信URLのリストに適用される。
get_the_excerpt
get_the_excerpt関数で取得した記事の概要に適用される。
get_the_guid
get_the_guid関数で取得した記事のGUIDに適用される。
get_to_ping
get_to_ping関数で取得したピンバック先のURLリストに適用される。
icon_dir
テンプレートの画像ディレクトリに適用される。MIMEタイプアイコンの置き場所をプラグインを使って変更したいときに使える。
icon_dir_uri
テンプレートの画像ディレクトリURLに適用される。MIMEタイプアイコンの置き場所をプラグインを使って変更したいときに使える。
prepend_attachment
prepend_attachment関数で先頭に追加するHTMLに適用される。
sanitize_title
sanitize_title関数でHTMLタグを除去した記事タイトル名に適用される。
single_post_title
wp_title関数およびsingle_post_title関数で記事タイトルを生成する際に適用される。
the_content(記事本文)
the_excerpt(記事概要)
the_tags(タグ)
the_title(記事タイトル)
データベースから取得したデータを画面に出力する前に適用される。the_tags以外はトラックバックなど他の操作でも使われる。
the_content_rss(記事本文)
the_excerpt_rss(記事概要)
the_title_rss(the_titleでフィルターされた記事タイトル)
各データをRSSフィードに挿入する前に適用される。
the_editor_content
記事本文をリッチテキストエディター内に表示する前に適用される。
wp_dropdown_pages
wp_dropdown_pages関数が生成したページのドロップダウンリストHTMlに適用される。
wp_list_pages
wp_list_pages関数が生成したページのリストHTMLに適用される。
wp_list_pages_excludes
wp_list_pages関数内で、除外ページIDの配列に適用される。
wp_get_attachment_metadata
フィルター関数引数: メタ情報、添付ファイルID
wp_get_attachment_metadata関数で取得した、添付ファイルのメタ情報に適用される。
wp_get_attachment_thumb_file
フィルター関数引数: サムネールファイル、添付ファイルID
wp_get_attachment_thumb_file関数で取得した、添付ファイルのサムネールファイルに適用される。
wp_get_attachment_thumb_url
フィルター関数引数: サムネールURL、添付ファイルID
wp_get_attachment_thumb_URL関数で取得した、添付ファイルのサムネールURLに適用される。
wp_get_attachment_url
フィルター関数引数: URL、添付ファイルID
wp_get_attachment_url関数で取得した、添付ファイルURLに適用される。
wp_mime_type_icon
フィルター関数引数: アイコンのURL、MIMEタイプ情報、投稿記事ID
wp_mime_type_icon関数で算出した、添付ファイルのMIMEタイプアイコンに適用される。
wp_title
wp_title関数が生成したページ名がブラウザに送信される前に適用される。

データベース書き込み

add_ping
ピンバックが追加された際、ピンバック欄に新規追加する値をデータベースに保存する前に適用される。
attachment_max_dims
画像を縮小する前に、画像の最大寸法の値に適用される。フィルター関数の入力値と戻り値は、false(最大寸法が指定されていない場合)または2つの数字のリスト(幅、高さ)。
category_save_pre(記事のカテゴリーリスト・コンマ区切り)
comment_status_pre(コメントのステータス)
content_filtered_save_pre(フィルタ済みの記事本文)
content_save_pre(記事本文)
excerpt_save_pre(記事概要)
excerpt_save_pre(記事名)
ping_status_pre(ピンバックステータス)
title_save_pre(記事タイトル)
post_mime_type_pre(添付ファイルのMIMEタイプ)
status_save_pre (記事のステータス)
各情報がデータベースに保存される前に適用する(添付ファイルの情報に対しても適用される)。
phone_content
記事がメールで投稿された際、内容をデータベースに保存する前に実行する。
thumbnail_filename
画像をアップロードする際、サムネイルのファイル名に適用される。
wp_thumbnail_creation_size_limit
フィルター関数引数: ファイルの最大ファイルサイズ、添付ファイルID、添付ファイル名
画像をアップロードする際、サムネイルのファイルサイズに適用される。
wp_thumbnail_max_side_length
フィルター関数引数: 画像の最大横幅、添付ファイルID、添付ファイル名
画像をアップロードする際、サムネイルの寸法に適用される。
update_attached_file
フィルター関数引数: 添付ファイル情報、添付ファイルID
添付ファイル情報をupdate_attached_file関数で記事のメタデータとして保存する前に適用される。
wp_delete_file
ファイルを削除する直前、添付ファイル名に適用される。
wp_generate_attachment_metadata
添付ファイルのメタ情報配列がデータベースに保存される前に適用される。
wp_update_attachment_metadata
フィルター関数引数: メタ情報、添付ファイルID
wp_update_attachment_metadata関数で、添付ファイルのメタ情報配列が保存される前に適用される。

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

データベース書き込み

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

データベース書き込み

comment_save_pre
フィルター関数引数: comment_post_ID、comment_author、comment_author_email、comment_author_url、comment_content、comment_type、user_IDのインデックスを含むコメントデータ配列
コメントを更新・編集する直前に、コメントデータに適用される。
pre_comment_approved
コメントの承認ステータス(true/false)に適用される。
pre_comment_content(コメント本文)
コメント本文がデータベースに保存される前に適用される。
preprocess_comment
フィルター関数引数: comment_post_ID、comment_author、comment_author_email、comment_author_url、comment_content、comment_type、user_IDのインデックスを含むコメントデータ配列
新しいコメントをデータベースに保存する際、他の処理がまだ施されていないコメントデータに適用される。

カテゴリー関連のフィルター

データベース書き込み

category_description
category_description関数でのフィルター関数引数: カテゴリーの説明、カテゴリーID
wp_list_categories関数でのフィルター関数引数: カテゴリーの説明、全カテゴリー情報の配列
category_description関数およびwp_list_categories関数のカテゴリー情報に適用される。
category_feed_link
get_category_rss_link関数が生成したカテゴリーフィードURLに適用される。
category_link
フィルター関数引数: リンクURL、カテゴリーID
get_category_link関数が生成したカテゴリーのURLに適用される。
get_categories
フィルター関数引数: カテゴリーリスト、get_categoriesオプションリスト
get_categories関数が生成したカテゴリーのリストに適用される。
get_category
get_category関数で取得した、特定のカテゴリーIDに関する全情報の配列に適用される。
list_cats
フィルター関数引数: カテゴリー名、カテゴリー情報リスト(指定したカテゴリーテーブル内の全フィールド)
このフィルターは2種類の目的で使用される。
1. wp_dropdown_categories関数では、show_option_allおよびshow_option_none引数をフィルターするために適用される。この場合、追加のフィルター関数引数はなし。
2. wp_list_categories関数でカテゴリー名に対して適用する。
list_cats_exclusions
フィルター関数引数: SQL文の WHERE 節で除外されたカテゴリー、get_categoriesオプションのリスト
get_categories関数で、除外カテゴリーを決定するSQL文の WHERE 節に適用される。
single_cat_title
wp_title関数およびsingle_cat_title関数内でカテゴリーページのタイトルに利用するカテゴリー名に適用される。
the_category
フィルター関数引数: 生成HTML、リスト区切り設定(空の場合はデフォルトの<li>)、get_the_category_listの親変数
get_the_category_list関数が生成したリンク付きのカテゴリーリストHTMLに適用される。
the_category_rss
フィルター関数引数: リストテキストおよびフィードの種類(通常rdfまたはrss)
get_the_category_rss関数内で、記事のカテゴリーリスト(カテゴリーXML要素のリスト)がRSSフィードに挿入される前に適用される。
wp_dropdown_cats
wp_dropdown_categories関数が生成したカテゴリードロップダウンリストHTMLに適用される。
wp_list_categories
wp_list_categories関数が生成したカテゴリーリストHTMLに適用される。

データベース書き込み

pre_category_description(カテゴリーの説明)
pre_category_name(カテゴリー名)
pre_category_nicename(カテゴリースラッグ)
各情報がデータベースに保存される前に適用される。

リンク関連のフィルター

attachment_link
フィルター関数引数: リンクURL、添付ファイルID
get_attachment_link関数が生成した添付ファイルの固定リンクに適用される。
author_feed_link
get_author_rss_link関数が生成した投稿者フィードのURLに適用される。
author_link
フィルター関数引数: リンクURL、投稿者名スラッグ、投稿者ID
get_author_posts_url関数が生成した投稿者別アーカイブのリンクURLに適用される。
day_link
フィルター関数引数: URL、年、月(数字)、日(数字)
get_day_link関数が生成した日付別アーカイブのリンクURLに適用される。
feed_link
フィルター関数引数: URL、フィードの種類(例:rss2、atomなど)
get_feed_link関数が生成したフィードのリンクURLに適用される。
get_comment_author_link
get_comment_author_link関数が生成したコメント投稿者のリンクHTMLに適用される。
get_comment_author_url_link
get_comment_author_url_link関数が生成したコメント投稿者のリンクHTMLに適用される。
month_link
フィルター関数引数: URL、年、月(数字)
get_month_link関数が生成した月別アーカイブのリンクURLに適用される。
page_link
フィルター関数引数: URL、ページID
get_page_link関数が生成したページURLに適用される。
post_link
フィルター関数引数: 固定リンクURL、投稿記事データのリスト
get_permalink関数が生成した投稿記事の固定リンクに適用される。
the_permalink
the_permalink関数が投稿記事の固定リンクを出力する前に適用される。
year_link
フィルター関数引数: URL、年
get_year_link関数が生成した年別アーカイブのリンクURLに適用される。

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

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

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

データベース読み出し

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

データベース書き込み

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

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

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

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

all_options
get_alloptions関数で取得した、ブログ設定情報のリストに適用される。
bloginfo
bloginfo関数で取得した、ブログ設定情報に適用される。
※注:bloginfo("url")、bloginfo("directory")、bloginfo("home")はこのフィルターに影響されない(bloginfo_urlフィルターの項を参照)。
bloginfo_rss
get_bloginfo_rss関数内でget_bloginfo関数を使ってブログ設定情報を取得し、HTMLタグを除去して特殊文字を変換した後に適用される。2つ目の引数$showは、要求されたbloginfoの設定名。
bloginfo_url
bloginfo("url")、bloginfo("directory")、bloginfo("home")の出力値を返す前に適用される。
loginout
wp_loginout関数でログイン・ログアウト用のリンクを生成する際に適用される。
option_設定名
get_option関数で取得した設定値に対し、配列ベースの設定を解読した後に適用される。例えばfooという設定についてget_option("foo")の出力値をフィルターする場合、option_fooという名前のフィルターを追加して使用する。
pre_option_設定名
get_alloptions関数で取得した設定値に対し、配列ベースの設定を解読した後に適用される。例えばfooという設定をフィルターする場合、pre_option_fooという名前のフィルターを追加して使用する。
register
wp_register関数で、ユーザー登録が許可されている場合に表示する登録リンク、またはログインしている場合に表示する管理画面へのリンクに適用される。
upload_dir
フィルター関数引数: dir(アップロードディレクトリへのパス)、url(アップロードディレクトリのURL)、error(エラーを出力する場合trueに設定)の値を含む配列
wp_upload_dir関数で算出した、ファイルアップロードディレクトリに適用される。
upload_mimes
フィルター関数引数: "|"記号区切りのファイル拡張子と対応するMIMEタイプ情報を含むリスト
wp_check_filetype関数でMIMEタイプリストの入力がない場合、アップロードファイル用のMIMEタイプリストを返すためのフィルター。

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

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

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

autosave_interval
記事を自動保存する間隔の時間に適用される。
cat_rows
カテゴリー管理画面で生成される、カテゴリー行のHTMLに適用される。
comment_edit_pre
コメント本文が編集画面に表示される前に適用される。
comment_edit_redirect
フィルター関数引数: リダイレクト先情報、コメントID
管理画面でコメントを編集した後のリダイレクト先情報に適用される。
comment_moderation_subject
フィルター関数引数: メール件名、コメントID
管理者に承認が必要な新しいコメントがつけられたことを知らせるメールを送信する前に、メール件名に適用される。
注:この操作はデフォルトのwp_notify_moderator関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。
comment_moderation_text
フィルター関数引数: メール本文、コメントID
管理者に承認が必要な新しいコメントがつけられたことを知らせるメールを送信する前に、メール本文に適用される。
注:この操作はデフォルトのwp_notify_moderator関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。
comment_notification_headers
フィルター関数引数: メールヘッダーのテキスト、コメントID
投稿者に新しいコメントがつけられたことを知らせるメールを送信する前に、メールヘッダーに適用される。
注:この操作はデフォルトのwp_notify_postauthor関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。
comment_notification_subject
フィルター関数引数: メール件名、コメントID
投稿者に新しいコメントがつけられたことを知らせるメールを送信する前に、メール件名に適用される。
注:この操作はデフォルトのwp_notify_postauthor関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。
comment_notification_text
フィルター関数引数: メール本文、コメントID
投稿者に新しいコメントがつけられたことを知らせるメールを送信する前に、メール本文に適用される。
注:この操作はデフォルトのwp_notify_postauthor関数内で発生する(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。
cron_schedules
wp_get_schedules関数でcronスケジュールを生成することができるよう、空の配列に適用される。
default_content(記事本文)
default_excerpt(デフォルトの記事概要)
default_title(記事タイトル)
新規投稿の際、編集画面を開く前にそれぞれのデフォルト情報に対して適用される。
format_to_edit
管理画面でコメント編集ページを生成する際に呼び出されるformat_to_edit関数で、コメント本文、投稿者名、投稿者メールアドレス、投稿者URLに適用される。また、管理画面で記事を編集する際にも適用される。
explain_nonce_動詞-名詞
フィルター関数引数: 表示するテキスト(デフォルトは "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
format_to_edit関数内で記事本文、概要、タイトル、パスワードに適用される。また、管理画面でコメントを編集する際にも適用される。
format_to_post
format_to_post関数(デフォルトでは使用されない)内の投稿記事本文に適用される。
manage_link_columns
フィルター関数引数および戻り値: キーがカラム名、値がそのカラムのヘッダーテキストになっている結合リスト
リンク管理画面に出力するカラムのリストに適用される。
manage_posts_columns
フィルター関数引数および戻り値: キーがカラム名、値がそのカラムのヘッダーテキストになっている結合リスト
記事管理画面に出力されるカラムのリストに適用される。
postmeta_form_limit
記事管理画面に表示する記事のメタ情報項目数に適用される。
pre_upload_error
プラグインがファイルアップロード時にXMLRPCエラーを生成できるようするために適用される。
preview_page_link(ページ)
preview_post_link(投稿記事)
各編集画面の「プレビュー」リンクに適用される。
richedit_pre
wp_richedit_pre関数内でリッチテキストエディターに記事本文を表示する前に適用される。
show_password_fields
ユーザーがパスワードを変更できるかどうかの引数に適用される。自分で変更が可能な場合はtrue、変更できない場合はfalse。
the_editor
リッチテキストエディターを囲むHTMLのdiv要素を生成し、画面に出力する前に適用される。
user_can_richedit
フィルター関数引数および戻り値: 現在のユーザーがリッチテキストエディターを使用できるかどうかの判断(true/false)
ユーザーのブラウザーがリッチテキストエディターに対応しているかどうかの評価、またはuser_can_richedit関数で設定された、リッチテキストエディターを使うかどうかの設定に適用される。
user_has_cap
フィルター関数引数: フィルターする権限のリスト、チェックする権限、引数リスト(例えば記事編集の権限の場合、記事IDなど)
current_user_can関数で呼び出されるWP_User->has_cap関数内で、ユーザーの権限リストに適用される。
wp_handle_upload
フィルター関数引数: file(ファイル名)/url/type情報の配列
ファイルをアップロードする際、アップロード情報に適用される。
wp_upload_tabs
アップロードファイル管理画面でカスタムタブのリストを出力する際に実行する。カスタムタブ用のページを表示するには、action upload_files_タブ名フィルターを使用する。

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

mce_browsers
リッチテキストエディターに対応しているブラウザ名の配列に適用される。
mce_buttons、mce_buttons_2、mce_buttons_3
それぞれのフィルターにはボタン名の配列が含まれる。リッチテキストエディターツールバーのボタン行に適用される。
mce_css
リッチテキストエディター用のCSSファイルURLに適用される。
mce_plugins
リッチテキストエディターが読み込むプラグインの配列に適用される。
mce_valid_elements
リッチテキストエディターで有効なHTML要素のコンマ区切りリストに適用される。このリストに含まれない要素は、記事が投稿される前に自動的に除去される。
tiny_mce_config_url
TinyMCEの設定ファイルURLに適用される。

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

デフォルトテーマ

kubrick_header_color(ヘッダー色)
kubrick_header_display(ヘッダー表示設定)
kubrick_header_image(ヘッダー画像情報)
デフォルトテーマに関するそれぞれの情報に適用される。

スタイルシート

locale_stylesheet_uri
フィルター関数引数: URL、スタイルシートディレクトリURL
get_locale_stylesheet_uri関数で返されるロケール特有のスタイルシート情報に適用される。
stylesheet
get_stylesheet関数で返されるスタイルシート情報に適用される。
stylesheet_directory
フィルター関数引数: スタイルシートディレクトリ情報、スタイルシート情報
get_stylesheet_directory関数で返されるスタイルシートディレクトリ情報に適用される。
stylesheet_directory_uri
フィルター関数引数: スタイルシートディレクトリURL、スタイルシート情報
get_stylesheet_directory_uri関数で返されるスタイルシートディレクトリURLに適用される。
stylesheet_uri
フィルター関数引数: スタイルシートディレクトリURL、スタイルシート情報
get_stylesheet_uri関数で返されるスタイルシートURLに適用される。

テンプレート

template
get_template関数で返されるテンプレート情報に適用される。
template_directory
フィルター関数引数: テンプレートディレクトリ情報、テンプレート情報
get_template_directory関数で返されるテンプレートディレクトリ情報に適用される。
template_directory_uri
フィルター関数引数: テンプレートディレクトリURL、テンプレート情報
get_template_directory_uri関数で返されるテンプレートディレクトリURLに適用される。
theme_root
get_theme_root関数で返されるテーマのルートディレクトリ情報(通常はwp-content/themes)に適用される。
theme_root_uri
フィルター関数引数: URL、サイトURL
get_theme_root_uri関数で返されるテーマのルートディレクトリURL(通常はwp-content/themes)に適用される。
また、以下のフィルターフックを使用すれば、テーマ内の各テンプレートファイルの位置指定を変更することもできる(template_redirectアクションフックも参照)。
404_template、archive_template、attachment_template、author_template、category_template、comments_popup_template、comments_template、date_template、home_template、page_template、paged_template、search_template、single_template

その他の高度なフィルター

このセクションでは、表示する記事を判断するクエリ、URLリライトルール、国際化など、WordPressの基本的なコードに関連する高度なフィルターを紹介しています。

URLリライトルール

author_rewrite_rules(投稿者)
category_rewrite_rules(カテゴリー)
comments_rewrite_rules(コメント)
date_rewrite_rules(日付)
post_rewrite_rules(投稿)
page_rewrite_rules(ページ)
search_rewrite_rules(検索)
root_rewrite_rules(ルートレベル)
それぞれのデータに関連するURLリライトルールが生成された後に適用される。
mod_rewrite_rules
パーマリンク構造を変更した際、.htaccessファイルに挿入するURLリライトルールのリストに適用される。現バージョンでは廃止済みのrewrite_rulesを置き換えるフィルターでもある。
rewrite_rules_array
URLリライトルールのが生成された後、その配列全体に適用される。

クエリ

create_user_query
新規登録ユーザーの情報をデータベースに保存するクエリが実行される直前に、このクエリに対して適用される。
found_posts_query
表示する記事のリストが取得された後、WordPressはクエリ結果内の行を選択する。このフィルターを使い、その際にSELECT FOUND_ROWS()以外の操作を加えることができる。
query
プラグインが読み込まれた後に実行されるすべてのクエリに適用される。
query_vars
SQLが生成される前に、WordPressのパブリッククエリ変数のリストに対して適用される。プラグインが他の方法で扱った余分な固定リンク情報を削除するのに使える。現バージョンではすでに廃止されている、query_stringを置き換えるフィルターでもある。
request
動作はquery_varsと同じ。追加クエリ変数・プライベートクエリ変数が追加された後に適用される。
update_user_query
ユーザー情報を更新するクエリを実行する前に、このクエリに対して適用される。

投稿

found_posts
投稿記事のリストをデータベースから取得した直後に、このリストに対して適用される。
get_next_post_join
フィルター関数引数: JOIN 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリーのリスト
get_next_post関数内で、SQL文の JOIN 節に適用される。
get_next_post_sort
フィルター関数引数: ORDER BY 節
get_next_post関数内で、SQL文の ORDER BY 節に適用される。
get_next_post_where
フィルター関数引数: WHERE 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリーのリスト
get_next_post関数内で、SQL文の WHERE 節に適用される。
get_others_drafts
管理画面で他のユーザーの下書き投稿を選択するクエリに適用される。
get_previous_post_join
フィルター関数引数: JOIN 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリーのリスト
get_previous_post関数内で、SQL文の JOIN 節に適用される。
get_previous_post_sort
フィルター関数引数: SQL文の ORDER BY 節
get_previous_post関数内で、SQL文の ORDER BY 節に適用される。
get_previous_post_where
フィルター関数引数: SQL文の WHERE 節、同じカテゴリ内かどうかの判断(true/false)、除外するカテゴリのリスト
get_previous_post関数内で、SQL文の WHERE 節に適用される。
get_users_drafts
管理画面で表示する公開前の記事を選択するクエリに適用される。
post_limits
post配列を返すクエリの LIMIT 節に適用される。
posts_distinct
post配列を返すクエリに、プラグインが DISTINCTROW 節を追加できるようにする。
posts_fields
post配列を返すクエリのフィールドリストに適用される。
posts_groupby
post配列を返すクエリの GROUP BY 節に適用される(通常は空データ)。
posts_join_paged
post配列を返すクエリの JOIN 節に対し、ページングが計算された後適用される(ページング自体は JOIN に影響しないので、このフィルターはposts_joinと実際的には同一)。
posts_orderby
post配列を返すクエリの ORDER BY 節に適用される。
posts_request
post配列を返すSQLクエリを実行する直前に、クエリ全体に対して適用される。
posts_where_paged
post配列を返すクエリの WHERE 節に対し、ページングが計算された後適用される(ページング自体は WHERE に影響しないので、このフィルターはposts_whereと実際的には同一)。
posts_join
post配列を返すクエリの JOIN 節に適用される。通常、JOINにテーブルを追加する際にposts_whereフィルターと一緒に使う。
posts_where
post配列を返すクエリの WHERE 節に適用される。
the_posts
記事の固定ページで、閲覧権限および記事ステータスのチェックが行われた後、記事のリストのクエリに適用される。

国際化

gettext
フィルター関数引数: 翻訳済みおよび未翻訳のテキスト。国際化の設定が有効になっており、テキストドメインが読み込まれている場合のみに国際化関数(「__」および「_e」 )で取得した翻訳済みテキストに適用される。
locale
get_locale関数で取得したロケール情報に適用される。

その他

get_editable_authors
get_editable_authors関数で、ユーザーが編集可能な投稿者のリストに適用される。
uploading_iframe_src
記事・ページ編集画面のファイルアップロードiframeのsrc属性に適用される。
wp_redirect
フィルター関数引数: URL、HTTPステータスコード
wp_redirect関数内のリダイレクトURLに適用される(この関数はプラグインによる上書きが可能。詳しくはプラグイン APIを参照)。
xmlrpc_methods
xMLRPCサーバー用に定義されたXMLRPCメソッドに適用される。
wp_mail_from
wp_mail関数でメールが送信される前に、$_SERVER['SERVER_NAME']で設定されたホスト名の値に適用される。フィルターを使ってメールアドレス(例:user@example.com)または氏名とメールアドレスの組み合わせ(例:Name <user@example.com>)を返すことができる。