投稿、ページ、および添付ファイル(アップロード)フィルター
以下の #カテゴリおよびタームフィルター、#著者およびユーザーフィルター、#リンクフィルター、#日付および時間フィルター、および#管理フィルター も参照してください。
データベースの読み取り
このセクションのフィルターは、ページや編集画面に表示する前にデータベースから読み取った情報に適用されます。
attachment_fields_to_edit : 添付ファイルを編集する際に表示されるフォームフィールドに適用されます。get_attachment_fields_to_edit
関数で呼び出されます。フィルター関数の引数:フォームフィールドの配列、投稿オブジェクト。
attachment_icon : get_attachment_icon
関数で添付ファイルのアイコンに適用されます。フィルター関数の引数:HTML IMG タグとしてのアイコンファイル、添付ファイル ID。
attachment_innerHTML : get_attachment_innerHTML
関数でアイコンがない場合に使用される添付ファイルのタイトルに適用されます。フィルター関数の引数:内部 HTML(デフォルトはタイトル)、添付ファイル ID。
author_edit_pre : 編集のために表示する前の投稿著者に適用されます。
body_class : HTML のクラスに適用されます。
content_edit_pre : 編集のために表示する前の投稿コンテンツに適用されます。
content_filtered_edit_pre : 編集のために表示する前にフィルタリングされた投稿コンテンツに適用されます。
excerpt_edit_pre : 編集のために表示する前の投稿抜粋に適用されます。
date_edit_pre : 編集のために表示する前の投稿日付に適用されます。
date_gmt_edit_pre : 編集のために表示する前の投稿の GMT 日付に適用されます。
get_attached_file : get_attached_file
関数によって取得された添付ファイル情報に適用されます。フィルター関数の引数:ファイル情報、添付ファイル ID。
get_enclosed : get_enclosed
関数によって投稿のエンクロージャリストに適用されます。
get_pages : get_pages
関数 によって返されるページのリストに適用されます。フィルター関数の引数:ページのリスト(各アイテムにはページデータの配列が含まれます)、get_pages
関数引数リスト(要求されたページを示します)。
get_pung : get_pung
関数によって投稿のピンされた URL のリストに適用されます。
get_the_archive_title : get_the_archive_title
関数でアーカイブのタイトルに適用されます。
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 : いくつかの関数でテンプレートの画像ディレクトリ URI に適用されます。基本的に、プラグインが MIME タイプのアイコンを別の場所から取得することを指定できるようにします。
image_size_names_choose : メディアライブラリで選択可能な画像サイズのリストに適用されます。一般的に、カスタム画像サイズ を選択可能にするために使用されます。
mime_type_edit_pre : 編集のために表示する前の投稿の MIME タイプに適用されます。
modified_edit_pre : 編集のために表示する前の投稿の修正日付に適用されます。
modified_gmt_edit_pre : 編集のために表示する前の投稿の修正 GMT 日付に適用されます。
no_texturize_shortcodes : 登録されたショートコードに適用されます。ショートコードを自動テクスチャ機能から除外するために使用できます。
parent_edit_pre : 編集のために表示する前の投稿親 ID に適用されます。
password_edit_pre : 編集のために表示する前の投稿パスワードに適用されます。
post_class : 投稿の最外部 HTML 要素のクラスに適用されます。get_post_class
関数で呼び出されます。フィルター関数の引数:クラス名の配列、最初の配列に追加された追加クラス名の配列、および投稿 ID。
pre_kses : KSES によって処理/サニタイズされる前のさまざまなコンテンツに適用されます。このフックにより、開発者はコンテンツ内で許可されるスクリプト/タグの種類をカスタマイズしたり、削除したりできます。
prepend_attachment : prepend_attachment
関数によって前置される HTML に適用されます。
protected_title_format : 投稿がパスワードで保護されている場合に、投稿タイトルを変更または操作するために使用されます。
private_title_format : 投稿のステータスがプライベートである場合に、投稿タイトルを変更または操作するために使用されます。
sanitize_title : HTML タグを削除した後、sanitize_title
関数によって投稿タイトルに適用されます。
single_post_title : wp_title
および single_post_title
関数によってブログページタイトルを作成する際に投稿タイトルに適用されます。
status_edit_pre : 編集のために表示する前の投稿ステータスに適用されます。
the_content : データベースから取得した投稿コンテンツに適用され、画面に印刷する前に適用されます(トラックバックなどの他の操作でも使用されます)。
the_content_rss : RSS フィードに含める前の投稿コンテンツに適用されます。(非推奨)
the_content_feed : RSS フィードに含める前の投稿コンテンツに適用されます。
the_editor_content : リッチエディタウィンドウに入れる前の投稿コンテンツに適用されます。
the_excerpt : データベースから取得した投稿の抜粋(または抜粋がない場合は投稿コンテンツ)に適用され、画面に印刷する前に適用されます(トラックバックなどの他の操作でも使用されます)。
the_excerpt_rss : RSS フィードに含める前の投稿抜粋に適用されます。
the_password_form : 保護された投稿のパスワードフォームに適用されます。
the_tags : データベースから取得したタグに適用され、画面に印刷する前に適用されます。
the_title : データベースから取得した投稿タイトルに適用され、画面に印刷する前に適用されます(トラックバックなどの他の操作でも使用されます)。
the_title_rss : RSS フィードに含める前の投稿タイトルに適用されます(最初に the_title
でフィルタリングされた後)。
title_edit_pre : 編集のために表示する前の投稿タイトルに適用されます。
type_edit_pre : 編集のために表示する前の投稿タイプに適用されます。
wp_dropdown_pages : wp_dropdown_pages
関数によって生成された WordPress ページの HTML ドロップダウンリストに適用されます。
wp_list_pages : wp_list_pages
関数によって生成された HTML リストに適用されます。
wp_list_pages_excludes : wp_list_pages
関数で除外されたページのリスト(ページ ID の配列)に適用されます。
wp_get_attachment_metadata : wp_get_attachment_metadata
関数によって取得された添付ファイルのメタデータに適用されます。フィルター関数の引数:メタデータ、添付ファイル ID。
wp_get_attachment_thumb_file : wp_get_attachment_thumb_file
関数によって取得された添付ファイルのサムネイルファイルに適用されます。フィルター関数の引数:サムネイルファイル、添付ファイル ID。
wp_get_attachment_thumb_url : wp_get_attachment_thumb_URL
関数によって取得された添付ファイルのサムネイル URL に適用されます。フィルター関数の引数:サムネイル URL、添付ファイル ID。
wp_get_attachment_url : wp_get_attachment_url
関数によって取得された添付ファイルの URL に適用されます。フィルター関数の引数:URL、添付ファイル ID。
wp_mime_type_icon : wp_mime_type_icon
関数によって計算された添付ファイルの MIME タイプアイコンに適用されます。フィルター関数の引数:計算されたアイコン URI、MIME タイプ、投稿 ID。
wp_title : wp_title
関数でブラウザに送信する前のブログページタイトルに適用されます。
データベースの書き込み
このセクションのフィルターは、データベースに保存する前の情報に適用されます。
add_ping : ピンが追加されるときに投稿のピンされたフィールドの新しい値に適用され、新しい情報をデータベースに保存する前に適用されます。
attachment_fields_to_save : 添付ファイルに関連するフィールドに適用され、データベースに保存する前に適用されます。media_upload_form_handler
関数で呼び出されます。フィルター関数の引数:投稿属性の配列、フォームから送信された変更を含む添付ファイルフィールドの配列。
attachment_max_dims : 画像サイズを縮小する前の最大画像寸法に適用されます。フィルター関数の入力(および戻り値)は、最大寸法が指定されていない場合は false であるか、2 要素のリスト(幅、高さ)です。
category_save_pre : データベースに保存する前の投稿カテゴリのカンマ区切りリストに適用されます(添付ファイルにも使用されます)。
comment_status_pre : データベースに保存する前の投稿コメントステータスに適用されます(添付ファイルにも使用されます)。
content_filtered_save_pre : データベースに保存する前にフィルタリングされた投稿コンテンツに適用されます(添付ファイルにも使用されます)。
content_save_pre : データベースに保存する前の投稿コンテンツに適用されます(添付ファイルにも使用されます)。
excerpt_save_pre : データベースに保存する前の投稿抜粋に適用されます(添付ファイルにも使用されます)。
image_save_pre (非推奨) : 代わりに image_editor_save_pre
を使用してください。
jpeg_quality (非推奨) : 代わりに wp_editor_set_quality
または WP_Image_Editor::set_quality()
を使用してください。
name_save_pre (非推奨): データベースに保存する前の投稿名に適用されます(添付ファイルにも使用されます)。
phone_content : メールで送信された投稿の内容に適用され、保存する前に適用されます。
ping_status_pre : データベースに保存する前の投稿ピンステータスに適用されます(添付ファイルにも使用されます)。
post_mime_type_pre : データベースに保存する前の添付ファイルの MIME タイプに適用されます。
status_save_pre : データベースに保存する前の投稿ステータスに適用されます。
thumbnail_filename : 画像をアップロードする際のサムネイルのファイル名に適用されます。
title_save_pre : データベースに保存する前の投稿タイトルに適用されます(添付ファイルにも使用されます)。
update_attached_file : update_attached_file
関数で投稿メタデータに保存する前の添付ファイル情報に適用されます。フィルター関数の引数:添付ファイル情報、添付ファイル ID。
wp_create_thumbnail (非推奨)
wp_delete_file : 削除する直前の添付ファイル名に適用されます。
wp_generate_attachment_metadata : データベースに保存する前の添付ファイルメタデータ配列に適用されます。
wp_save_image_file (非推奨) : 代わりに wp_save_image_editor_file
を使用してください。
wp_thumbnail_creation_size_limit : 画像をアップロードする際のサムネイルのサイズに適用されます。フィルター関数の引数:最大ファイルサイズ、添付ファイル ID、添付ファイル名。
wp_thumbnail_max_side_length : 画像をアップロードする際のサムネイルのサイズに適用されます。フィルター関数の引数:画像の最大サイズ、添付ファイル ID、添付ファイル名。
wp_update_attachment_metadata : wp_update_attachment_metadata
関数で保存する直前の添付ファイルメタデータに適用されます。フィルター関数の引数:メタデータ、添付ファイル ID。
コメント、トラックバック、およびピンフィルター
以下の #著者およびユーザーフィルター、#リンクフィルター、#日付および時間フィルター、および#管理フィルター も参照してください。
データベースの読み取り
このセクションのフィルターは、ページや編集画面に表示する前にデータベースから読み取った情報に適用されます。
comment_excerpt : comment_excerpt
関数によってコメント抜粋に適用されます。get_comment_excerpt
も参照してください。
comment_flood_filter : 誰かがあなたのブログにコメントを大量に投稿しているように見えるときに適用されます。フィルター関数の引数:すでにブロックされているかどうか(true/false、以前のフィルタリングプラグインがすでにブロックしているかどうか;このコメントをブロックするために true に設定し、true を返します)、前のコメントの時間、現在のコメントの時間。
comment_post_redirect : 誰かがコメントを追加した後のリダイレクト先に適用されます。フィルター関数の引数:リダイレクト先、コメント情報配列。
comment_text : comment_text
関数によって画面に表示する前のコメントテキストに適用されます。また、管理メニューでも使用されます。
comment_text_rss : RSS フィードに含める前のコメントテキストに適用されます。
comments_array : comments_template
関数で投稿のコメント配列に適用されます。フィルター関数の引数:コメント情報構造体の配列、投稿 ID。
comments_number : comments_number
関数によって生成されたコメント数を示すフォーマットされたテキストに適用されます。get_comments_number
も参照してください。
get_comment_excerpt : get_comment_excerpt
関数によってデータベースから読み取られたコメント抜粋に適用されます(comment_excerpt
にも呼び出されます)。comment_excerpt
も参照してください。
get_comment_ID : $comments
変数から読み取られたコメント ID に適用されます。get_comment_ID
関数によって呼び出されます。
get_comment_text : get_comment_text
関数で現在のコメントのコメントテキストに適用され、comment_text
関数でも呼び出されます。
get_comment_type : get_comment_type
関数によってコメントタイプ(「コメント」、「トラックバック」、または「ピンバック」)に適用されます(comment_type
関数でも呼び出されます)。
get_comments_number : $post
グローバル変数から読み取られたコメント数に適用され、get_comments_number
関数でも呼び出されます(comments_number
関数でも使用されます;comments_number
フィルターも参照)。
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)に適用され、プラグインがオーバーライドできるようにします。true/false を返し、最初の引数を true/false に設定してコメントを承認/却下し、$comment_ID
などのグローバル変数を使用してこのコメントに関する情報にアクセスします。
pre_comment_content : コメントをデータベースに保存する前のコメントの内容に適用されます。
preprocess_comment : 新しいコメントをデータベースに保存する際に、他の処理の前にコメントデータに適用されます。関数の引数:コメントデータ配列、「comment_post_ID」、「comment_author」、「comment_author_email」、「comment_author_url」、「comment_content」、「comment_type」、および「user_ID」のインデックスを持つ配列。
wp_insert_post_data : 投稿をデータベースに更新または挿入する前に、wp_insert_post() で修正されたおよび未修正の投稿データに適用されます。関数の引数:修正されたおよび拡張された投稿配列とサニタイズされた投稿配列。
カテゴリおよびタームフィルター
以下の #管理フィルター も参照してください。
データベースの読み取り
このセクションのフィルターは、ページや編集画面に表示する前にデータベースから読み取った情報に適用されます。
category_description : category_description
および wp_list_categories
関数によってカテゴリの「説明」フィールドに適用されます。フィルター関数の引数:説明、category_description
から呼び出されたときのカテゴリ ID;説明、wp_list_categories
から呼び出されたときのカテゴリ情報配列(その特定のカテゴリのカテゴリテーブルからのすべてのフィールド)。
category_feed_link : get_category_feed_link
関数によって生成されたカテゴリフィードのフィード URL に適用されます。
category_link : get_category_link
関数によって生成されたカテゴリの URL に適用されます。フィルター関数の引数:リンク URL、カテゴリ ID。
get_ancestors : get_ancestors
関数によって返される祖先 ID のリストに適用されます(これは他の多くの関数で使用されます)。フィルター関数の引数:祖先 ID 配列、指定されたオブジェクト ID、指定されたオブジェクトタイプ。
get_categories : get_categories
関数によって生成されたカテゴリリストに適用されます(これは他の多くの関数で使用されます)。フィルター関数の引数:カテゴリリスト、get_categories
オプションリスト。
get_category : get_category
関数が検索するカテゴリ情報に適用されます。これは基本的に特定のカテゴリ ID の WordPress のカテゴリテーブルのすべてのフィールドの配列です。
list_cats : 2 つの異なる目的で呼び出されます:
- 1.
wp_dropdown_categories
関数は、show_option_all
およびshow_option_none
引数をフィルタリングするために使用します(これらは「すべて」と「なし」のオプションをカテゴリのドロップダウンリストに入れるために使用されます)。追加のフィルター関数の引数はありません。 - 2.
wp_list_categories
関数は、カテゴリ名に適用されます。フィルター関数の引数:カテゴリ名、カテゴリ情報リスト(その特定のカテゴリのカテゴリテーブルからのすべてのフィールド)。
list_cats_exclusions : get_categories
関数によって除外されるカテゴリを指定する SQL WHERE ステートメントに適用されます。通常、プラグインはこのリストに追加して、特定のカテゴリまたはカテゴリグループをカテゴリリストから除外します。フィルター関数の引数:除外されたカテゴリ WHERE 句、get_categories
オプションリスト。
single_cat_title : wp_title
および single_cat_title
関数によってブログページタイトルを作成する際にカテゴリ名に適用されます。
the_category : get_the_category_list
関数によって生成されたカテゴリのリスト(リンク付きの HTML リスト)に適用されます。フィルター関数の引数:生成された HTML テキスト、使用されているリスト区切り(空の文字列はデフォルトの LI リストを意味します)、parents
引数に get_the_category_list
。
the_category_rss : 投稿のカテゴリリスト(カテゴリ XML 要素のリスト)に、get_the_category_rss
関数によって適用され、RSS フィードに含める前に適用されます。フィルター関数の引数はリストテキストとタイプ(一般的に「rdf」または「rss」)です。
wp_dropdown_cats : wp_dropdown_categories
関数によって生成されたドロップダウンカテゴリリスト(HTML オプション要素を含むテキスト文字列)に適用されます。
wp_list_categories : wp_list_categories
関数によって生成されたカテゴリリスト(HTML リスト)に適用されます。
wp_get_object_terms : wp_get_object_terms
関数によって生成されたタームのリスト(オブジェクトの配列)に適用されます。これは、get_the_terms
や get_the_category
などの多くのカテゴリ/ターム関連関数によって呼び出されます。
データベースの書き込み
このセクションのフィルターは、データベースに保存する前の情報に適用されます。
pre_category_description : データベースに保存する前のカテゴリ説明に適用されます。
wp_update_term_parent : タームの更新が適用される前にターム親をフィルタリングします。このフィルターにフックして、階層ループを引き起こすかどうかを確認します。
edit_terms : (実際にはアクションですが、フィルターのように使用されることが多い)データベースに分類/カテゴリの変更を保存する前にフックされます。
pre_category_name : データベースに保存する前のカテゴリ名に適用されます。
pre_category_nicename : データベースに保存する前のカテゴリのニックネームに適用されます。
リンクフィルター
注意: このセクションには、投稿、ページ、アーカイブ、フィードなどへのリンクに関連するフィルターが含まれています。ブログロールリンクについては、以下の #Blogroll Filters セクションを参照してください。
attachment_link : get_attachment_link
関数によって計算された添付パーマリンクに適用されます。フィルタ関数の引数: リンクURL、添付ID。
author_feed_link : get_author_rss_link
関数によって生成された著者フィードのフィードURLに適用されます。
author_link : get_author_posts_url
関数によって作成された著者のアーカイブパーマリンクに適用されます。フィルタ関数の引数: リンクURL、著者ID、著者の「ニックネーム」。get_author_posts_url
は wp_list_authors
および the_author_posts_link
関数内で呼び出されることに注意してください。
comment_reply_link : get_comment_reply_link
関数によって生成された特定のコメントに返信するためのリンクに適用され、comments_template
関数内で呼び出されます。フィルタ関数の引数: リンク(文字列)、カスタムオプション(配列)、現在のコメント(オブジェクト)、現在の投稿(オブジェクト)。
day_link : get_day_link
関数によって日次アーカイブのリンクURLに適用されます。フィルタ関数の引数: URL、年、月番号、日番号。
feed_link : get_feed_link
関数によってフィードのリンクURLに適用されます。フィルタ関数の引数: URL、フィードの種類(例: “rss2”、”atom”など)。
get_comment_author_link : get_comment_author_link
関数内で生成されたコメントの著者リンクのHTMLに適用されます(comment_author_link
にも呼び出されます)。アクション関数の引数: ユーザー名
get_comment_author_url_link : get_comment_author_url_link
関数内で生成されたコメントの著者リンクのHTMLに適用されます(comment_author_link
にも呼び出されます)。
month_link : get_month_link
関数によって月次アーカイブのリンクURLに適用されます。フィルタ関数の引数: URL、年、月番号。
page_link : get_page_link
関数によって計算されたページURLに適用されます。フィルタ関数の引数: URL、ページID。ブログのホームページとして指定されていないページのURLをフィルタリングするために使用できる内部フィルタ _get_page_link
もあることに注意してください(同じ引数)。これはWordPressのページにのみ適用され、投稿、カスタム投稿タイプ、または添付ファイルには適用されません。
post_link : get_permalink
関数によって計算された投稿のパーマリンクに適用され、the_permalink
、post_permalink
、previous_post_link
、および next_post_link
関数によっても呼び出されます。フィルタ関数の引数: パーマリンクURL、投稿データリスト。これはWordPressのデフォルトの投稿にのみ適用され、カスタム投稿タイプ(ページや添付ファイルを含まない)には適用されません。
post_type_link : get_post_permalink
関数によって計算されたカスタム投稿タイプのパーマリンクに適用されます。
the_permalink : the_permalink
関数によって印刷前の投稿のパーマリンクURLに適用されます。
year_link : get_year_link
関数によって年次アーカイブのリンクURLに適用されます。フィルタ関数の引数: URL、年。
tag_link : get_tag_link 関数によって作成されたタグのURLに適用されます。フィルタ関数の引数: リンクURL、タグID。
term_link : get_term_link 関数によって作成された用語のURLに適用されます。フィルタ関数の引数: 用語リンクURL、用語オブジェクトおよびタクソノミースラッグ。
日付と時間のフィルター
上記の #Link Filters も参照してください。
get_comment_date : get_comment_date
関数によって生成されたフォーマットされたコメント日付に適用されます(comment_date
にも呼び出されます)。
get_comment_time : get_comment_time
関数内のフォーマットされたコメント時間に適用されます(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_date
関数によって生成されたフォーマットされた投稿の修正日付に適用されます。
the_modified_time : the_modified_time
関数によって生成されたフォーマットされた投稿の修正時間に適用されます。
the_time : the_time
関数によって生成されたフォーマットされた投稿時間に適用されます。
the_weekday : the_weekday
関数によって生成された投稿日付の曜日名に適用されます。
the_weekday_date : the_weekday_date
関数によって生成された投稿日付の曜日名に適用されます。関数の引数は曜日名、前のテキスト、後のテキストです(現在の投稿の曜日が前の投稿の曜日と異なる場合、前のテキストと後のテキストが曜日名に追加されます)。
著者およびユーザーフィルター
上記の #Link Filters および #Administrative Filters セクションも参照してください。
login_body_class : login_header()
のログイン画面に適用されるボディクラスのフィルタリングを許可します。
login_redirect : ユーザーログインプロセス中の redirect_to
投稿/取得変数に適用されます。
user_contactmethods : ユーザープロフィールページの連絡方法フィールドに適用されます。(古いページはこちら: contactmethods)
update_(meta_type)_metadata_metadata/) : (ユーザー)メタデータが更新される前に適用されます。
データベースの読み取り
このセクションのフィルターは、ページまたは編集画面に表示する前にデータベースから読み取った情報に適用されます。
author_email : comment_author_email
関数によってデータベースから取得されたコメント著者のメールアドレスに適用されます。get_comment_author_email
も参照してください。
comment_author : comment_author
関数によってデータベースから取得されたコメント著者の名前に適用されます。get_comment_author
も参照してください。
comment_author_rss : RSSフィードに含める前のコメント著者の名前に適用されます。
comment_email : comment_author_email_link
関数によってデータベースから取得されたコメント著者のメールアドレスに適用されます。
comment_url : comment_author_url
関数によってデータベースから取得されたコメント著者のURLに適用されます(get_comment_author_url
も参照)。
get_comment_author : get_comment_author
によってデータベースから取得されたコメント著者の名前に適用され、comment_author
にも呼び出されます。comment_author
も参照してください。
get_comment_author_email : get_comment_author_email
によってデータベースから取得されたコメント著者のメールアドレスに適用され、comment_author_email
にも呼び出されます。author_email
も参照してください。
get_comment_author_IP : get_comment_author_IP
関数によってデータベースから取得されたコメント著者のIPアドレスに適用され、comment_author_IP
にも呼び出されます。
get_comment_author_url : get_comment_author_url
関数によってデータベースから取得されたコメント著者のURLに適用され、comment_author_url
にも呼び出されます。comment_url
も参照してください。
login_errors : ログイン画面に表示されるログインエラーメッセージに適用されます。
login_headertitle : ログイン画面に表示されるログインヘッダーURLのタイトル(デフォルトでは「Powered by WordPress」)に適用されます。
login_headerurl : ログイン画面に表示されるログインヘッダーURL(デフォルトではwordpress.orgを指す)に適用されます。
login_message : ログイン画面に表示されるログインメッセージに適用されます。
role_has_cap : WP_Role->has_cap
関数内の役割の能力リストに適用されます。フィルタ関数の引数は、フィルタリングされる能力リスト、質問される能力、および役割の名前です。
sanitize_user : sanitize_user
関数によってユーザー名に適用されます。フィルタ関数の引数: ユーザー名(いくつかのクリーンアップ後)、生のユーザー名、厳密(厳密なASCIIを使用するかどうかの真偽値)。
the_author : get_the_author
関数によって投稿著者の表示名に適用され、the_author
関数にも呼び出されます。
the_author_email : the_author_email
関数によって投稿著者のメールアドレスに適用されます。
user_search_columns : WP_User_Query 内の WHERE
句に含めるための wp_users テーブルの列のリストに適用されます。
データベースの書き込み
このセクションのフィルターは、データベースに保存する前の情報に適用されます。
pre_comment_author_email : コメントをデータベースに保存する前のコメント著者のメールアドレスに適用されます。
pre_comment_author_name : コメントをデータベースに保存する前のコメント著者のユーザー名に適用されます。
pre_comment_author_url : コメントをデータベースに保存する前のコメント著者のURLに適用されます。
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_nicename : データベースに保存する前のユーザーの「ニックネーム」に適用されます。
pre_user_nickname : データベースに保存する前のユーザーのニックネームに適用されます。
pre_user_url : データベースに保存する前のユーザーのURLに適用されます。
registration_errors : ユーザーが新しいアカウントに登録する際に生成される登録エラーのリストに適用されます。
user_registration_email : 新しいユーザーとして登録しようとする前に、登録ページから読み取ったユーザーのメールアドレスに適用されます。
validate_username : 新しいユーザー名の検証結果に適用されます。フィルタ関数の引数: 有効(真/偽)、検証されるユーザー名。
ブログロールフィルター
注意: このセクションには、ブログロールリンクに関連するフィルターが含まれています。投稿、ページ、カテゴリなどへのリンクに関連するフィルターについては、上記の #Link Filters セクションを参照してください。
get_bookmarks : get_bookmarks
関数によってリンク/ブログロールデータベースクエリ結果に適用されます。フィルタ関数の引数: データベースクエリ結果リスト、get_bookmarks
引数リスト。
link_category : get_links_list
および wp_list_bookmarks
関数によってリンクカテゴリに適用されます(WordPress 2.2以降)。
link_description : get_links
および wp_list_bookmarks
関数によってリンク説明に適用されます(WordPress 2.2以降)。
link_rating : get_linkrating
関数によってリンク評価数に適用されます。
link_title : get_links
および wp_list_bookmarks
関数によってリンクタイトルに適用されます(WordPress 2.2以降)
pre_link_description : データベースに保存する前のリンク説明に適用されます。
pre_link_image : データベースに保存する前のリンク画像に適用されます。
pre_link_name : データベースに保存する前のリンク名に適用されます。
pre_link_notes : データベースに保存する前のリンクノートに適用されます。
pre_link_rel : データベースに保存する前のリンク関係情報に適用されます。
pre_link_rss : データベースに保存する前のリンクRSS URLに適用されます。
pre_link_target : データベースに保存する前のリンクターゲット情報に適用されます。
pre_link_url : データベースに保存する前のリンクURLに適用されます。
ブログ情報およびオプションフィルター
all_options : get_alloptions
関数によってデータベースから取得されたオプションリストに適用されます。
all_plugins : プラグインリストの表示のために取得されたプラグインのリストに適用されます。
bloginfo : bloginfo
関数によってデータベースから取得されたブログオプション情報に適用され、最初に get_bloginfo
関数で情報を取得した後に適用されます。第二引数 $show
は要求された bloginfo オプションの名前を示します。bloginfo("url")
、bloginfo("directory")
および bloginfo("home")
はこのフィルタリング関数を使用しないことに注意してください(bloginfo_url
を参照)。
bloginfo_rss : get_bloginfo_rss
関数によってブログオプション情報に適用されます(bloginfo_rss
からも呼び出されます)、最初に get_bloginfo
関数で情報を取得し、HTMLタグを取り除き、適切に文字を変換します。第二引数 $show
は要求された bloginfo オプションの名前を示します。
bloginfo_url : bloginfo("url")
、bloginfo("directory")
および bloginfo("home")
の出力に適用され、情報を返す前に処理されます。
loginout : wp_loginout
関数によって生成されたログインおよびログアウトのためのHTMLリンクに適用されます(一般的にはサイドバーに配置されます)。
lostpassword_url : ユーザーがパスワードをリセットできるURLに適用されます。
option_(option name)/) : get_option
関数によってデータベースから取得されたオプション値に適用され、アンシリアライズされた後(配列ベースのオプションをデコードします)。このフィルタを使用するには、特定のオプション名のフィルタを追加する必要があります。たとえば、「option_foo」を使用して get_option("foo")
の出力をフィルタリングします。
pre_get_space_used: get_space_used()
関数に適用され、使用されているストレージスペースを表示するための代替方法を提供します。このフィルタから false を返すと、デフォルトの表示動作に戻ります(wp_upload_dir() ディレクトリのスペースをメガバイト単位で使用します)。
preoption(option name)/) : get_alloptions
関数によってデータベースから取得されたオプション値に適用され、アンシリアライズされた後(配列ベースのオプションをデコードします)。このフィルタを使用するには、特定のオプション名のフィルタを追加する必要があります。たとえば、「pre_option_foo」を使用してオプション「foo」をフィルタリングします。
preupdate_option(option name)/) : データベースに保存される前のオプション値に適用され、保存される値を上書きすることを許可します。このフィルタを使用するには、特定のオプション名のフィルタを追加する必要があります。たとえば、「pre_update_option_foo」を使用してオプション「foo」をフィルタリングします。
register : ユーザーが登録するために作成されたサイドバーリンクに適用されます(許可されている場合)または管理パネルに訪問するために(すでにログインしている場合)wp_register
関数によって生成されます。
upload_dir : wp_upload_dir
関数によって計算されたアップロードに使用されるディレクトリに適用されます。フィルタ関数の引数は、「dir」(アップロードディレクトリパス)、「url」(アップロードディレクトリのURL)、および「error」(エラーを生成したい場合はtrueに設定できます)を含む配列です。
upload_mimes : アップロードのためのMIMEタイプのリストを返すフィルタ関数を許可します。wp_check_filetype
関数にMIMEリストの入力がない場合。フィルタ関数の引数は、コンポーネント名がファイル拡張子(縦線で区切られた)で、値が対応するMIMEタイプの関連リストです。
一般的なテキストフィルター
attribute_escape : 投稿テキストやその他のコンテンツに attribute_escape
関数によって適用され、特定の文字をHTML属性に変換してブラウザに送信するためにWordPressの多くの場所で呼び出されます。
js_escape : js_escape
関数内でブラウザに送信する前のJavaScriptコードに適用されます。
sanitize_key : 設定、フィールド、またはその他のニーズに使用する前にキーに適用され、sanitize_key
関数によって生成されます。
管理フィルター
このセクションのフィルターは、WordPressの管理画面、特にコンテンツ編集画面に関連しています。
admin_user_info_links : WordPress管理クイックメニューのユーザープロフィールおよび情報リンクに適用されます。
autosave_interval : 投稿の自動保存間隔に適用されます。
bulk_actions : 管理のバルクアクションドロップダウン内のバルクアイテムの配列に適用されます。
bulk_post_updated_messages : バルクアクションの更新メッセージの配列に適用されます。
cat_rows : 管理メニューでカテゴリを管理するために生成されたカテゴリ行のHTMLに適用されます。
comment_edit_pre : 編集画面に表示される前のコメントコンテンツに適用されます。
comment_edit_redirect : 誰かが管理メニューでコメントを編集した後のリダイレクト先に適用されます。フィルタ関数の引数:リダイレクト先、コメントID。
comment_moderation_subject : 新しいコメントのモデレーションが必要であることを管理者に通知するメールを送信する前のメールの件名に適用されます。フィルタ関数の引数:メールの件名、コメントID。
comment_moderation_text : 新しいコメントのモデレーションが必要であることを管理者に通知するメールを送信する前のメールメッセージの本文に適用されます。フィルタ関数の引数:メール本文テキスト、コメントID。
comment_notification_headers : 新しいコメントについて投稿者に通知するメールを送信する前のメールヘッダーに適用されます。フィルタ関数の引数:メールヘッダーテキスト、コメントID。
comment_notification_subject : 新しいコメントについて投稿者に通知するメールを送信する前のメールの件名に適用されます。フィルタ関数の引数:メールの件名、コメントID。
comment_notification_text : 新しいコメントについて投稿者に通知するメールを送信する前のメールメッセージの本文に適用されます。フィルタ関数の引数:メール本文テキスト、コメントID。
comment_row_actions : 各コメント行の下にあるアクションリンクのリスト(返信、クイック編集、編集など)に適用されます。
cron_request : spawn_cron()内のwp_remote_post()に渡されるURL、キー、および引数をフィルタリングすることを許可します。
cron_schedules : wp_get_schedules
関数内でプラグインがcronスケジュールを生成できるようにするために空の配列に適用されます。
custom_menu_order : ‘menu_order’フィルターを有効にするために使用されます。
default_content : 新しい投稿のためにエディタを開く前のデフォルトの投稿コンテンツに適用されます。
default_excerpt : 新しい投稿のためにエディタを開く前のデフォルトの投稿抜粋に適用されます。
default_title : 新しい投稿のためにエディタを開く前のデフォルトの投稿タイトルに適用されます。
editable_slug : get_sample_permalink
関数によって投稿、ページ、タグ、またはカテゴリのスラッグに適用されます。
format_to_edit : 投稿コンテンツ、抜粋、タイトル、およびパスワードにformat_to_edit
関数によって適用され、管理メニューによって投稿を編集のために設定するために呼び出されます。また、管理メニューでコメントを編集する際にも適用されます。
format_to_post : 投稿コンテンツにformat_to_post
関数によって適用され、WordPressではデフォルトで使用されません。
manage_edit-${post_type}_columns : カスタム投稿タイプの管理投稿画面に印刷する列のリストに適用されます。フィルタ関数の引数/戻り値は、要素キーが列の名前で、値がその列のヘッダーテキストである連想配列です。列情報を編集画面に配置するアクションmanage_${post_type}_posts_custom_column
も参照してください。
manage_link-manager_columns : WordPress 2.7までmanage_link_columns
でした。ブログロール管理画面に印刷する列のリストに適用されます。フィルタ関数の引数/戻り値は、要素キーが列の名前で、値がその列のヘッダーテキストである連想リストです。列情報を編集画面に配置するアクションmanage_link_custom_column
も参照してください。
manage_posts_columns : 管理投稿画面に印刷する列のリストに適用されます。フィルタ関数の引数/戻り値は、要素キーが列の名前で、値がその列のヘッダーテキストである連想配列です。列情報を編集画面に配置するアクションmanage_posts_custom_column
も参照してください。(例と使用についてはhttp://scompt.com/archives/2007/10/20/adding-custom-columns-to-the-wordpress-manage-posts-screenの[Scomptのチュートリアル]を参照してください。)
manage_pages_columns : 管理ページ画面に印刷する列のリストに適用されます。フィルタ関数の引数/戻り値は、要素キーが列の名前で、値がその列のヘッダーテキストである連想配列です。列情報を編集画面に配置するアクションmanage_pages_custom_column
も参照してください。
media_row_actions : メディアライブラリ内の各ファイルの下にあるアクションリンクのリスト(表示、編集など)に適用されます。
menu_order : 管理メニューの順序の配列に適用されます。事前に‘custom_menu_order’フィルターで有効にする必要があります。
nonce_life : nonceを生成または検証するための寿命に適用されます。早く期限切れになるnonceを生成するために使用できます。フィルタによって返される値は秒単位である必要があります。
nonce_user_logged_out : ユーザーがログアウトしているときにnonceを生成または検証するために使用される現在のユーザーIDに適用されます。
plugin_row_meta : プラグインページの各プラグインの下に追加のリンクを追加します。
postmeta_form_limit : 投稿編集画面に表示される投稿メタ情報アイテムの数に適用されます。
post_row_actions : 投稿 > すべての投稿セクション内の各投稿の下にあるアクションリンクのリスト(クイック編集、編集、表示、プレビューなど)に適用されます。
post_updated_messages : 投稿、ページ、およびカスタム投稿タイプを操作する際に表示される管理メッセージを格納する配列に適用されます。このフィルターは、メッセージのテキストを変更するために使用され、トリガーするためには使用されません。register_post_typeのドキュメントの「メッセージのカスタマイズ」を参照してください。
pre_upload_error : プラグインがファイルをアップロードするためのXMLRPCエラーを作成できるようにするために適用されます。
preview_page_link : ページ編集画面の下部にページプレビューを表示するリンクに適用されます。
preview_post_link : 投稿編集画面の下部に投稿プレビューを表示するリンクに適用されます。
richedit_pre : リッチテキストエディタに表示される前に投稿コンテンツにwp_richedit_pre
関数によって適用されます。
schedule_event : cronスケジュールに追加される各繰り返しおよび単一イベントに適用されます。
set-screen-option : 設定される前に画面オプションの値をフィルタリングします。
show_password_fields : ユーザープロフィール画面でユーザーがパスワードを変更する機会を提示されるかどうかを制御する真偽値変数に適用されます(trueはパスワード変更フィールドを表示することを意味し、falseは表示しないことを意味します)。
terms_to_edit : 投稿に添付されている用語を表示するために使用される各タクソノミーの用語のCSVに適用されます。
the_editor : リッチテキストエディタを表示するために作成されたHTML DIVに適用され、画面に印刷される前にフィルタリングされます。フィルタ関数の引数/戻り値は文字列です。
user_can_richedit : ユーザーのブラウザがリッチ編集機能を持っているかどうか、ユーザーがリッチエディタを使用したいかどうかの計算にuser_can_richedit
関数によって適用されます。フィルタ関数の引数と戻り値は、現在のユーザーがリッチエディタを使用できるかどうかの真偽値です。
user_has_cap : WP_User->has_cap
関数(current_user_can
関数によって呼び出される)内のユーザーの権限リストに適用されます。フィルタ関数の引数は、フィルタリングされる権限リスト、質問される権限、および引数リスト(権限が投稿を編集するものであれば投稿IDなどが含まれます)です。
wp_handle_upload_prefilter : ファイルをアップロードする際のアップロード情報に適用されます。フィルタ関数の引数:$_FILESの単一要素を表す配列。
wp_handle_upload : ファイルをアップロードする際のアップロード情報に適用されます。フィルタ関数の引数:要素「file」(ファイル名)、「url」、「type」を含む配列。
wp_revisions_to_keep : 特定の投稿のために保持されるリビジョンの数を変更します。フィルタ関数の引数:保存されるリビジョンの数(デフォルトは無制限のリビジョン)、投稿オブジェクト。
wp_terms_checklist_args : wp_terms_checklist()関数の引数に適用されます。フィルタ関数の引数:チェックリスト引数の配列、投稿ID。
wp_upload_tabs : アップロード管理管理画面に表示するカスタムタブのリストに適用されます。アクションupload_files_(tab)
を使用してカスタムタブのページを表示します。
media_upload_tabs : アップロード管理管理画面に表示するカスタムタブのリストに適用されます。アクションupload_files_(tab)
を使用してカスタムタブのページを表示します。
pluginaction_links(plugin file name)/) : プラグインページに表示するリンクのリストに適用されます(有効化/無効化リンクの横)。
views_edit-post : 投稿リストに適用されます。例:すべて (30) | 公開 (22) | 下書き (5) | 保留 (2) | ゴミ箱 (1)
リッチテキストエディタフィルター
これらのフィルターは、リッチテキストエディタTinyMCEの設定を変更します。
mce_spellchecker_languages : スペルチェッカーで利用可能な言語選択に適用されます。
mce_buttons, mce_buttons_2, mce_buttons_3, mce_buttons_4 : リッチエディタツールバーのボタン行に適用されます(各ボタン名の配列です)。
mce_css : リッチテキストエディタのCSSファイルURLに適用されます。
mce_external_plugins : リッチテキストエディタによって読み込まれる外部プラグインの配列に適用されます。
mce_external_languages : 外部プラグインによって読み込まれる言語ファイルの配列に適用され、標準の翻訳方法を使用できるようにします(参照:tinymce/langs/wp-langs.php)。
tiny_mce_before_init : エディタの全体の初期化配列に適用されます。
テンプレートフィルター
このセクションには、テーマ、テンプレート、およびスタイルファイルに関連するリンクが含まれています。
locale_stylesheet_uri : get_locale_stylesheet_uri
関数によって返されるロケール特有のスタイルシートURIに適用されます。フィルタ関数の引数:URI、スタイルシートディレクトリURI。
stylesheet : get_stylesheet
関数によって返されるスタイルシートに適用されます。
stylesheet_directory : get_stylesheet_directory
関数によって返されるスタイルシートディレクトリに適用されます。フィルタ関数の引数:スタイルシートディレクトリ、スタイルシート。
stylesheet_directory_uri : get_stylesheet_directory_uri
関数によって返されるスタイルシートディレクトリURIに適用されます。フィルタ関数の引数:スタイルシートディレクトリURI、スタイルシート。
stylesheet_uri : get_stylesheet_uri
関数によって返されるスタイルシートURIに適用されます。フィルタ関数の引数:スタイルシートURI、スタイルシート。
template : get_template
関数によって返されるテンプレートに適用されます。
template_directory : get_template_directory
関数によって返されるテンプレートディレクトリに適用されます。フィルタ関数の引数:テンプレートディレクトリ、テンプレート。
template_directory_uri : get_template_directory_uri
関数によって返されるテンプレートディレクトリURIに適用されます。フィルタ関数の引数:テンプレートディレクトリURI、テンプレート。
theme_root : get_theme_root
関数によって返されるテーマルートディレクトリ(通常はwp-content/themes)に適用されます。
theme_root_uri : get_theme_root_uri
関数によって返されるテーマルートディレクトリURIに適用されます。フィルタ関数の引数:URI、サイトURL。
テーマから個々のテンプレートファイルを置き換えることもできます。
次のフィルターフックを使用します。template_redirect
アクションフックも参照してください。これらのフィルターの各々は、現在のテーマ内の対応するテンプレートファイルへのパスを入力として受け取ります。プラグインは、新しいテンプレートファイルへのパスを返すことで、使用されるファイルを変更できます。
archive_template : たとえば、カスタム投稿タイプアーカイブの特定のテンプレートを強制するために使用できます。この方法で、すべてのコードをプラグインに保持できます。
comments_template : “comments_template”フィルターは、テーマのデフォルトのコメントテンプレートを置き換えるプラグインからカスタムテンプレートを読み込むために使用できます。
single_template : カスタム投稿タイプの特定のテンプレートを強制するために使用できます。この方法で、すべてのコードをプラグインに保持できます。
shortcut_link : “Press This”ブックマークレットリンクに適用されます。
wp_nav_menu_args : wp_nav_menu
関数の引数に適用されます。
wp_nav_menu_items : ナビゲーションメニューのHTMLリストコンテンツをフィルタリングします。
クブリックフィルター
これらのフィルターは、3.0以前のデフォルトテーマクブリックに存在していました。
kubrick_header_color : クブリックテーマのヘッダーの色に適用されます。
kubrick_header_display : クブリックテーマのヘッダーの表示オプションに適用されます。
kubrick_header_image : クブリックテーマのヘッダー画像ファイルに適用されます。
登録およびログインフィルター
authenticate : ユーザー名とパスワードに基づいてログイン時に基本的な認証を実行できるようにします。
registration_errors : 新しいアカウントのためにユーザーを登録する際に生成される登録エラーのリストに適用されます。
user_registration_email : 新しいユーザーとして登録しようとする前に、登録ページから読み取られたユーザーのメールアドレスに適用されます。
validate_username : 新しいユーザー名の検証結果に適用されます。フィルタ関数の引数:有効(true/false)、検証されるユーザー名。
wp_authenticate_user : ユーザーがログインを試みたときに、WordPressがユーザー名とパスワードを検証した後、しかし検証エラーがチェックされる前に適用されます。
リダイレクト/リライトフィルター
これらの高度なフィルターは、WordPressのリライトルールの処理に関連しています。
allowed_redirect_hosts : リダイレクトに安全と見なされるホスト名のリストに適用されます。wp-login.phpは、危険な‘redirect_to’リクエストパラメータに対してこれを使用します。
author_rewrite_rules : 生成された後の著者関連のリライトルールに適用されます。
category_rewrite_rules : 生成された後のカテゴリ関連のリライトルールに適用されます。
comments_rewrite_rules : 生成された後のコメント関連のリライトルールに適用されます。
date_rewrite_rules : 生成された後の日付関連のリライトルールに適用されます。
mod_rewrite_rules : パーマリンク構造を変更するときにユーザーに提供されるリライトルールのリストに適用されます。(注意:非推奨のフィルターrewrite_rules
を置き換えます。)
page_rewrite_rules : 生成された後のページ関連のリライトルールに適用されます。
post_rewrite_rules : 生成された後の投稿関連のリライトルールに適用されます。
redirect_canonical : “canonical” URLリダイレクトをキャンセルするために使用できます。2つのパラメータを受け入れます:$redirect_url
、$requested_url
。リダイレクトをキャンセルするにはFALSE
を返し、リダイレクトを許可するには$redirect_url
を返します。
rewrite_rules_array : 生成された後の全リライトルール配列に適用されます。
root_rewrite_rules : 生成された後のルートレベルのリライトルールに適用されます。
search_rewrite_rules : 生成された後の検索関連のリライトルールに適用されます。
wp_redirect : デフォルトのwp_redirect
関数によってリダイレクトURLに適用されます。フィルタ関数の引数:URL、HTTPステータスコード。
wp_redirect_status : デフォルトのwp_redirect
関数によってリダイレクトする際のHTTPステータスコードに適用されます。フィルタ関数の引数:HTTPステータスコード、URL。
WP_Queryフィルター
これらは、投稿を取得するためのクエリを構築および実行する過程でWP_Queryオブジェクトによって実行されるフィルターです。ユーザー、メタ値、およびより一般的なクエリに関連するクエリについては、#Advanced WordPress Filtersも参照してください。
found_posts : データベースからクエリした後の投稿のリストに適用されます。
found_posts_query : 表示する投稿のリストがデータベースからクエリされた後、WordPressはクエリ結果の行を選択します。このフィルターは、そのステップでSELECT FOUND_ROWS()
以外のことを行うことを許可します。
post_limits : 投稿配列を返すクエリのLIMIT
句に適用されます。
posts_clauses : 投稿配列を返すクエリの全SQLクエリに適用され、各句タイプのためにキー付き配列に分割されます。posts_request
よりも扱いやすい場合があります。
posts_distinct : プラグインが投稿配列を返すクエリにDISTINCTROW
句を追加できるようにします。
posts_fields : 投稿配列を返すクエリのフィールドリストに適用されます。
posts_groupby : 投稿配列を返すクエリのGROUP BY
句に適用されます(通常は空です)。
posts_join : 投稿配列を返すクエリのJOIN
句に適用されます。通常、JOIN
にテーブルを追加するために使用され、posts_where
フィルターと組み合わせて使用されます。
posts_join_paged : ページングが計算された後、投稿配列を返すクエリのJOIN
句に適用されます(ただし、ページングはJOINに影響しないため、実際にはposts_join
と同等です)。
posts_orderby : 投稿配列を返すクエリのORDER BY
句に適用されます。
posts_request : クエリを実行する直前に投稿配列を返す全SQLクエリに適用されます。
posts_results : クエリから返された結果の配列を操作できるようにします。
posts_search : WP_QueryのWHERE
句で使用される検索SQLに適用されます。
posts_where : 投稿配列を返すクエリのWHERE
句に適用されます。
posts_where_paged : ページングが計算された後、投稿配列を返すクエリのWHERE
句に適用されます(ただし、ページングはWHEREに影響しないため、実際にはposts_where
と同等です)。
the_posts : 単一投稿ページでの権限と下書きステータスの最小限の処理の後にデータベースからクエリされた投稿のリストに適用されます。
メディアフィルター
このセクションには、さまざまなタイプのメディアを統合するために使用されるメディアフィルターが含まれています。
icon_dir :
wp_get_attachment_image_attributes :
(adjacent)_image_link_image_link/) :
wp_prepare_attachment_for_js :
高度なWordPressフィルター
このセクションには、国際化、
雑多なクエリ、およびその他の基本的なWordPress機能に関連する高度なフィルターが含まれています。
create_user_query : 新しいユーザーの情報をデータベースに保存するために使用されるクエリに適用され、クエリを実行する直前に適用されます。
get_editable_authors : 現在のユーザーがget_editable_authors
関数で編集を許可されている投稿の著者のリストに適用されます。
get_next_post_join : get_next_post
関数(現在表示されている投稿の後の投稿を見つける)で、SQL JOIN句に適用されます(通常、ユーザーがカテゴリアーカイブを表示している場合はカテゴリテーブルに結合します)。フィルタ関数の引数:JOIN句、同じカテゴリに留まる(true/false)、除外されたカテゴリのリスト。
get_next_post_sort : get_next_post
関数(現在表示されている投稿の後の投稿を見つける)で、SQL ORDER BY句に適用されます(通常、投稿日で昇順に並べ替え、1件の投稿に制限されます)。フィルタ関数の引数:ORDER BY句。
get_next_post_where : get_next_post
関数(現在表示されている投稿の後の投稿を見つける)で、SQL WHERE句に適用されます(通常、次の日付の公開投稿を探します)。フィルタ関数の引数:WHERE句、同じカテゴリに留まる(true/false)、除外されたカテゴリのリスト。
get_previous_post_join : get_previous_post
関数(現在表示されている投稿の前の投稿を見つける)で、SQL JOIN句に適用されます(通常、ユーザーがカテゴリアーカイブを表示している場合はカテゴリテーブルに結合します)。フィルタ関数の引数:JOIN句、同じカテゴリに留まる(true/false)、除外されたカテゴリのリスト。
get_previous_post_sort : get_previous_post
関数(現在表示されている投稿の前の投稿を見つける)で、SQL ORDER BY句に適用されます(通常、投稿日で降順に並べ替え、1件の投稿に制限されます)。フィルタ関数の引数:ORDER BY句。
get_previous_post_where : get_previous_post
関数(現在表示されている投稿の前の投稿を見つける)で、SQL WHERE句に適用されます(通常、前の日付の公開投稿を探します)。フィルタ関数の引数:WHERE句、同じカテゴリに留まる(true/false)、除外されたカテゴリのリスト。
gettext : translation()
関数によって翻訳されたテキストに適用されます(()
や_e()
のような国際化関数によって呼び出されます)。フィルタ関数の引数:翻訳されたテキスト、未翻訳のテキスト、およびテキストドメイン。国際化が有効でない場合やテキストドメインが読み込まれていない場合でも適用されます。
get_meta_sql : WP_Meta_Query::get_sql
関数(高度なメタクエリのためにメインクエリに追加されるSQL句を生成します)で、高度なメタクエリによって生成されたSQL JOINおよびWHERE句に適用されます。フィルタ関数の引数:array( compact( ‘join’, ‘where’ ), $this-
>queries, $type, $primary_table, $primary_id_column, $context )
get_others_drafts : 管理メニューに表示する他のユーザーのドラフトを選択するクエリに適用されます。
get_users_drafts : 管理メニューに表示するユーザーのドラフトを選択するクエリに適用されます。
locale : get_locale
関数によってロケールに適用されます。
query : すべてのクエリに適用されます(少なくともプラグインが読み込まれた後のすべてのクエリ)。
query_string : 非推奨 – 代わりにquery_vars
またはrequest
を使用してください。
query_vars : SQLクエリが形成される前の公開WordPressクエリ変数のリストに適用されます。プラグインが他の方法で処理した余分なパーマリンク情報を削除するのに便利です。
request : query_vars
のように、ただし「余分」およびプライベートクエリ変数が追加された後に適用されます。
excerpt_length : 単一投稿の抜粋の長さを定義します。
excerpt_more : 抜粋の最後にある「もっと」文字列を定義します。
post_edit_form_tag : デフォルトの投稿/ページエディタのフォームタグにコードを追加できるようにします。
update_user_query : ユーザー情報を更新するために使用される更新クエリに適用され、クエリを実行する前に適用されます。
uploading_iframe_src (WP 2.5以降削除): 投稿およびページ編集画面のアップロードiframeのHTML srcタグに適用されます。
xmlrpc_methods : XMLRPCサーバーの定義されたXMLRPCメソッドのリストに適用されます。
wp_mail_from : wp_mail関数によってメールが送信される前に適用されます。提供された値は、現在のホスト名($_SERVER[‘SERVER_NAME’]によって設定)から計算された送信元アドレスです。フィルタは「[email protected]」または「Name \u0026lt;[email protected]\u0026gt;」(引用符なし)形式のメールアドレスまたは名前/メールの組み合わせを返す必要があります。
wp_mail_from_name : wp_mail関数によってメールが送信される前に適用されます。フィルタは、メールの送信者名として使用される名前文字列を返す必要があります。
update_(meta_type)_metadata_metadata/) : メタデータが更新される前に適用されます。たとえば、ユーザーメタデータが更新される場合、フックは「update_user_metadata」となります。
ウィジェット
このセクションには、WordPressコアに存在するウィジェットによって追加されたフィルターが含まれています。
dynamic_sidebar_params : WordPressウィジェットのwidgets_init関数に渡される引数に適用されます。
widget_archives_dropdown_args : WordPressアーカイブウィジェットのwp_get_archives()
関数に渡される引数に適用されます。
widget_categories_args : WordPressカテゴリウィジェットのwp_list_categories()
関数に渡される引数に適用されます。
widget_links_args : WordPressリンクウィジェットのwp_list_bookmarks()
関数に渡される引数に適用されます。
widget_nav_menu_args : WordPressカスタムメニューウィジェットのwp_nav_menu()
関数に渡される引数に適用されます。
widget_pages_args : WordPressページウィジェットのwp_list_pages()
関数に渡される引数に適用されます。
widget_tag_cloud_args : WordPressページウィジェットのwp_tag_cloud()
関数に渡される引数に適用されます。
widget_text : WordPressテキストウィジェットのウィジェットテキストに適用されます。いくつかのサードパーティウィジェットにも適用される場合があります。
widget_title : ユーザーが編集可能な任意のWordPressウィジェットのウィジェットタイトルに適用されます。いくつかのサードパーティウィジェットにも適用される場合があります。
管理バー
このセクションには、WordPress 3.1.0で追加された管理バーによって追加されたフィルターが含まれています。
wp_admin_bar_class : _wp_admin_bar_init()
関数内のデフォルトの‘WP_Admin_Bar’クラスを変更することを許可します。
さらなる読み物
- フックデータベース – 公式WordPressコードリファレンスのすべてのフックに関するドキュメント。