本文列出了WordPress 2.1及以上版本中,可用于插件開(kāi)發(fā)的過(guò)濾器鉤子(hook)。
注意:為本文添加詞條或做其它改動(dòng)時(shí),請參照當前格式。添加時(shí)請說(shuō)明過(guò)濾器函數適用的數據類(lèi)型,如果過(guò)濾器函數接收多個(gè)參數,請在參數列表中說(shuō)明。
目錄[隱藏] |
數據庫讀取本部分中的過(guò)濾器函數適用于從數據庫讀出、尚未顯示到頁(yè)面或編輯界面的數據。
accachment_icon
在get_attachment_icon函數中,該過(guò)濾器函數應用于附件圖標。過(guò)濾器函數可接收的參數:圖標文件(作為HTML IMG標簽),附件ID。
attachment_innerHTML
在get_attachment_innerHTML函數中,若附件沒(méi)有圖標,該過(guò)濾器函數應用于附件標題。過(guò)濾器函數可接收的參數:內部HTML (默認為附件標題),附件ID。
content_edit_pre
應用于編輯前的日志正文
excerpt_edit_pre
應用于編輯前的日志摘要
get_attached_file
應用于由get_attached_file 函數檢索出的附件文件信息。過(guò)濾器函數接收的參數:文件信息,附件ID。
get_enclosed
應用于get_enclosed函數中的日志附件列表
get_pages
應用于get_pages函數返回的頁(yè)面列表。過(guò)濾器函數接收的參數:頁(yè)面列表(每個(gè)詞條中都包含一個(gè)頁(yè)面數據組),get_pages 函數頁(yè)面列表(get_pages函數可接收的參數列表,該列表可識別用戶(hù)所請求的頁(yè)面)。
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
在多個(gè)函數中,應用于模板的圖片目錄。其中插件能夠規定,MIME類(lèi)型的圖標可以來(lái)自其它存儲位置。
icon_dir_uri
在多個(gè)函數中,應用于模板圖片目錄URL。其中插件能夠規定,MIME類(lèi)型的圖標可以來(lái)自其它存儲位置。
prepend_attachment
應用于prepend_attachment函數預先存儲的HTML代碼。
sanitize_title
在sanitize_title函數中,刪除HTML標簽后,用于日志標題
single_post_title
在wp_title 和 single_post_title函數中,用于用以創(chuàng )建博客頁(yè)面標題的日志標題
the_content
應用于從數據庫中檢索到、尚未顯示在屏幕上的日志正文(也可用在“引用通告”等其它操作中)。
the_content_rss
在包含RSS訂閱前,用于日志正文
the_editor_content
在將日志內容輸入富編輯器窗口前,用于日志正文
the_excerpt
應用于從數據庫中檢索到、尚未顯示在屏幕上的日志摘要(若沒(méi)有日志摘要,可以應用于日志正文)(也可用在“引用通告”等其它操作中)。
the_excerpt_rss
在包含RSS訂閱前,用于日志摘要
the_tags
應用于從數據庫中檢索到的、尚未顯示在屏幕上的標簽
the_title
應用于從數據庫中檢索到、尚未顯示在屏幕上的日志標題(也可用在“引用通告”等其它操作中)。
the_title_rss
在包含RSS訂閱前,用于日志標題(用the_title進(jìn)行首次過(guò)濾后)。
the_edit_pre
顯示編輯頁(yè)面前,應用于日志標題
wp_dropdown_pages
應用于由wp_dropdown_pages函數生成的WordPress頁(yè)面的HTML下拉列表。
wp_list_pages
應用于由wp_list_pages函數生成的HTML列表。
wp_list_pages_excludes
在wp_list_pages函數中,應用于被排除在外的頁(yè)面列表(頁(yè)面ID數組)
wp_get_attachment_metadata
應用于wp_get_attachment_metadata 函數檢索到的附件元數據。過(guò)濾器函數接收的參數:元數據,附件ID。
wp_get_attachment_thumb_file
應用于wp_get_attachment_thumb_file 函數檢索到的附件縮略圖文件。過(guò)濾器函數接收的參數:縮略圖文件,附件ID。
wp_get_attachment_thumb_url
應用于wp_get_attachment_thumb_URL 函數檢索到的附件縮略圖URL。過(guò)濾器函數接收的參數:縮略圖URL,附件 ID。
wp_get_attachment_url
應用于wp_get_attachment_url 函數檢索到的附件URL。過(guò)濾器函數接收的參數:URL,附件 ID。
wp_mime_type_icon
應用于wp_mime_type_icon 函數為附件計算出的MIME類(lèi)型圖標。過(guò)濾器函數接收的參數:計算出的圖標URI , MIME 類(lèi)型,日志 ID。
wp_title
在wp_title函數中,應用于尚未發(fā)送到瀏覽器的博客頁(yè)面標題
本部分中的過(guò)濾器函數適用于尚未保存到數據庫中的數據。
add_ping
應用于添加ping引用后、保存入數據庫前的日志引用域的新值。
attachment_max_dims
縮小圖片前,應用于最大圖片尺寸。過(guò)濾器函數輸入值(以及返回的值)是false(若未規定最大尺寸)或一個(gè)兩欄列表(寬度、高度)
category_save_pre
應用于尚未保存到數據庫前的、由逗號隔開(kāi)的日志類(lèi)別列表(也可用于附件)。
comment_status_pre
應用于尚未保存到數據庫前的日志評論狀態(tài)(也可用于附件)。
content_filtered_save_pre
應用于尚未保存到數據庫前、經(jīng)過(guò)過(guò)濾的日志正文(也可用于附件)。
content_save_pre
應用于尚未保存到數據庫前的日志正文(也可用于附件)。
excerpt_save_pre
應用于尚未保存到數據庫前的日志摘要(也可用于附件)。
name_save_pre
應用于尚未保存到數據庫前的日志名稱(chēng)(也可用于附件)。
phone_content
應用于尚未保存到數據庫前、由電子郵件提交的日志正文。
ping_status_pre
應用于尚未保存到數據庫前的日志引用狀態(tài)(也可用于附件)。
post_mime_type_pre
應用于尚未保存到數據庫中的插件的MIME類(lèi)型
status_save_pre
應用于尚未保存到數據庫中的日志狀態(tài)。
thumbnail_filename
應用于上傳圖片時(shí)縮略圖的文件名。
wp_thumbnail_creation_size_limit
應用于上傳圖片時(shí)縮略圖的大小。過(guò)濾器函數接收的參數:文件最大尺寸,附件 ID,附件文件名。
wp_thumbnail_max_side_length
應用于上傳圖片時(shí)縮略圖的大小。過(guò)濾器函數接收的參數:圖片側邊最大尺寸, 附件ID,附件文件名。
title_save_pre
應用于尚未存儲到數據庫中的日志標題(也可用于附件)。
update_attached_file
在update_attached_file 函數中,應用于尚未保存到日志元數據中的附件信息。過(guò)濾器函數接收的參數:附件信息,附件ID。
wp_delete_file
應用于被刪除前的附件文件名
wp_generate_attachment_metadata
應用于保存到數據庫前的附件元數據數組。
wp_update_attachment_metadata
應用于尚未保存到wp_update_attachment_metadata 函數的附件元數據。過(guò)濾器函數接收的參數:元數據,附件ID。
數據庫讀取本部分中的過(guò)濾器函數適用于從數據庫讀出的、尚未顯示到頁(yè)面或編輯界面的數據。
commet_excerpt
在comment_excerpt函數中,應用于評論摘要。參見(jiàn)get_comment_excerpt。
comment_flood_filter
若有人試圖評論轟炸某個(gè)博客,博客主人可以使用comment_flood_filter。過(guò)濾器函數接收的參數:已鎖定(true/false,是否已經(jīng)有過(guò)了插件鎖定了此人的評論;可以在插件中將此參數值設為true并返回true以鎖定評論), 之前評論時(shí)間,當前評論時(shí)間。
comment_post_redirect
應用于有人發(fā)表評論后的重定向位置。過(guò)濾器函數接收的參數:重定向位置,評論信息數組。
comment_text
在comment_text函數和管理菜單中,應用于尚未顯示在屏幕上的評論內容。
comment_text_rss
在包含RSS訂閱前,應用于評論內容。
comments_array
在comments_template函數中,應用于日志的評論數組。過(guò)濾器函數可接收的參數:評論信息結構數組,日志 ID。
comments_number
應用于comments_number函數生成評論數量的格式化文本。參見(jiàn)get_comments_number。
get_comment_excerpt
應用于由get_comment_excerpt函數從數據庫讀出的評論摘要(comment_excerpt也會(huì )從數據庫讀出評論摘要)。參見(jiàn)comment_excerpt。
get_comment_ID
應用于get_comment_ID函數從全局變量$comments 中讀出的評論ID。
get_comment_text
在get_comment_text函數中,應用于當前評論的評論內容,comment_text函數也會(huì )調用評論內容。
get_comment_type
在get_comment_type中,應用于評論類(lèi)型("comment", "trackback", 或 "pingback"),comment_type也會(huì )調用評論類(lèi)型。
get_comments_number
應用于get_comments_number函數從全局變量$post中讀出的評論總數(comments_number函數也會(huì )調用評論總數;參見(jiàn)comments_number過(guò)濾器)。
post_comments_feed_link
應用于comments_rss函數為評論feed生成的feed URL。
本部分中的過(guò)濾器函數適用于尚未保存到數據庫中的數據。
comment_save_pre
應用于更新/編輯前的評論信息。函數接收的參數:評論信息數據,包括"comment_post_ID", "comment_author", "comment_author_email", "comment_author_url", "comment_content", "comment_type", 以及 "user_ID"。
pre_comment_approved
應用于當前評論的審核狀態(tài)(true/false),以便于插件進(jìn)行重寫(xiě)。返回true(或false)并將第一個(gè)參數設為true(或false),表示批準(或不批準)該評論,使用$comment_ID等全局變量獲取該評論的信息。
pre_comment_content
當評論尚未寫(xiě)入數據庫時(shí),應用于評論內容。
preprocess_comment
將評論保存到數據庫中,尚未進(jìn)行其它操作時(shí),應用于評論信息。函數可接收的參數:評論信息數組,包括"comment_post_ID", "comment_author", "comment_author_email", "comment_author_url", "comment_content", "comment_type", 以及"user_ID"。
wp_insert_post_data
更新數據庫中的日志前,應用于wp_insert_post()中經(jīng)過(guò)修改以及未經(jīng)修改的日志信息。函數接收的參數:經(jīng)過(guò)修改的日志數組與經(jīng)過(guò)過(guò)濾的日志數組。
類(lèi)別過(guò)濾器
參見(jiàn)下文中的管理界面過(guò)濾器。
本部分中的過(guò)濾器函數適用于從數據庫讀出的、尚未顯示到頁(yè)面或編輯界面的數據。
category_description
應用于category_description 以及wp_list_categories函數中的“description”字段類(lèi)別。過(guò)濾器函數接收的參數:說(shuō)明,(從category_description中調用的)類(lèi)別 ID;說(shuō)明,(從wp_list_categories中調用的)類(lèi)別信息數組(包括該類(lèi)別的類(lèi)別表中所有字段)。
category_feed_link
應用于get_category_rss_link函數為類(lèi)別feed生成的feed URL。
category_link
應該用于get_category_link函數為類(lèi)別生成的URL。過(guò)濾器函數接收的參數:鏈接 URL,類(lèi)別 ID。
get_categories
應用于get_categories函數生成的類(lèi)別列表(很多其它函數會(huì )使用get_categories函數所生成的類(lèi)別列表)。過(guò)濾器函數接收的參數:類(lèi)別列表,,get_categories選項列表。
get_category
應用于get_category函數查找到的類(lèi)別信息。該信息是一個(gè)數組,數組包括WordPress類(lèi)別表中某個(gè)指定類(lèi)別ID的所有字段。
list_cats
應用于兩種不同情況下:
list_cats_exclusions
get_categories函數將排除一些類(lèi)別,list_cats_exclusions應用于可給出這些類(lèi)別的SQL WHERE語(yǔ)句。插件也可以排除類(lèi)別列表中的類(lèi)別或類(lèi)別組。過(guò)濾器函數接收的參數:排除類(lèi)別的WHERE語(yǔ)句,get_categories選項列表。
single_cat_title
生成博客頁(yè)面標題時(shí),wp_title函數 與single_cat_title函數將single_cat_title用于類(lèi)別名稱(chēng)。
the_category
在et_the_category_list函數中,應用于類(lèi)別列表(帶有鏈接的HTML列表)。過(guò)濾器函數接收的參數:生成的HTML文本,當前使用的列表分隔符(空字符串表示默認LI列表),父參數為get_the_category_list。
the_category_rss
包含RSS 訂閱前,在get_the_category_rss函數中應用于日志的類(lèi)別列表(類(lèi)別XML元素列表)。過(guò)濾器函數接收的參數包括列表內容和類(lèi)型(一般是"rdf"或"rss")。
wp_dropdown_cats
應用于wp_dropdown_categories函數生成的下拉類(lèi)別列表(含有HTML選項元素的文本字符串)。
wp_list_categories
應用于wp_list_categories函數生成的類(lèi)別列表(HTML列表)。
本部分中的過(guò)濾器函數適用于尚未保存到數據庫中的數據。
pre_category_description
應用于尚未保存到數據庫中的類(lèi)別說(shuō)明
pre_category_name
應用于尚未保存到數據庫中的類(lèi)別名稱(chēng)。
pre_category_nicename
應用于尚未保存到數據庫中的類(lèi)別別名。
注意:本部分是關(guān)于日志、頁(yè)面、存檔、訂閱等鏈接的過(guò)濾器函數。博客反向鏈接過(guò)濾器函數見(jiàn)下文。
attachment_link
在get_attachment_link函數中,應用于總計出的附件永久鏈接。過(guò)濾器函數接收的參數:鏈接 URL,附件ID。
author_feed_link
應用于get_author_rss_link 函數為作者訂閱生成的訂閱URL。
author_link
應用于get_author_posts_url 函數生成的作者存檔永久鏈接。過(guò)濾器函數接收的參數:鏈接URL,作者別名, 作者 ID。注意,get_author_posts_url在wp_list_authors與the_author_posts_link內被調用。
comment_reply_link
應用于get_comment_reply_link函數為回復某個(gè)特定評論而生成的鏈接。get_comment_reply_link函數在comments_template函數中被調用。過(guò)濾器函數接收的參數:鏈接(字符串),自定義選項(數組),當前評論(對象),當前日志(對象)。
day_link
在get_day_link函數中,應用于日存檔文章的鏈接URL。過(guò)濾器函數接收的參數:URL,年,月,日。
feed_link
在get_feed_link函數中,應用于訂閱的鏈接URL。過(guò)濾器函數接收的參數:URL,訂閱類(lèi)型(如"rss2","atom"等)。
get_comment_author_link
在get_comment_author_link函數中,應用于評論中為作者鏈接而生成的HTML(comment_author_link也會(huì )調用此HTML)。動(dòng)作函數接收的參數:用戶(hù)名。
get_comment_author_url_link
在get_comment_author_url_link函數中,應用于評論中為作者鏈接而生成的HTML(comment_author_link也會(huì )調用此HTML)。
month_link
在get_month_link函數中,應用于月存檔日志的鏈接URL。過(guò)濾器函數接收的參數:URL,年,月。
page_link
在get_page_link函數中,應用于計算出的頁(yè)面URL。過(guò)濾器函數接收的參數:URL,頁(yè)面 ID。注意:有一個(gè)內部過(guò)濾器函數被稱(chēng)為_(kāi)get_page_link,該過(guò)濾器也可過(guò)濾非博客主頁(yè)上的頁(yè)面URL(_get_page_link與page_link參數相同)。
post_link
在get_permalink函數中,應用于計算出的頁(yè)面永久鏈接。the_permalink, post_permalink, previous_post_link以及next_post_link函數也會(huì )調用此類(lèi)頁(yè)面永久鏈接。過(guò)濾器函數接收的參數:永久鏈接,日志信息列表。
the_permalink
在the_permalink函數中,應用于尚未顯示在瀏覽器上的日志永久鏈接。
year_link
在get_year_link函數中,應用于年存檔日志的鏈接。過(guò)濾器函數接收的參數:URL,年。
get_comment_date
應用于get_comment_date函數生成的格式統一的評論日期(comment_date函數也會(huì )調用此類(lèi)評論日期)。
get_comment_time
在get_comment_time函數中應用于格式統一的評論時(shí)間(comment_time函數也會(huì )調用此類(lèi)評論時(shí)間)。
get_the_modified_date
應用于由get_the_modified_date函數生成的、格式統一的日志修改日期(the_modified_date函數也會(huì )調用此類(lèi)日志日期)。
get_the_modified_time
應用于由get_the_modified_time和get_post_modified_time函數生成的、格式統一的日志修改時(shí)間(the_modified_time也會(huì )調用此類(lèi)時(shí)間)。
get_the_time
應用于get_the_time和get_post_time函數生成的、格式統一的日志時(shí)間(the_time函數也會(huì )調用此類(lèi)日志時(shí)間)。
the_date
應用于the_date函數所生成的、格式統一的日志發(fā)表日期。
the_modified_date
應用于由the_modified_date函數生成的、格式統一的日志修改日期。
the_modified_time
應用于由the_modified_time函數生成的、格式統一的日志修改時(shí)間。
the_time
應用于由the_time函數生成的、格式統一的日志發(fā)表時(shí)間。
the_weekday
應用于由the_weekday函數生成的日志發(fā)表日期當天的星期數。
the_weekday_date
應用于由the_weekday_date函數生成的日志發(fā)表日期當天的星期數。函數接收的參數包括:星期數(周一、周二、周三、周四、周五、周六、周日),before text與after text。
login_redirect
在用戶(hù)登錄過(guò)程中,應用于redirect_to post/get變量。
本部分中的過(guò)濾器函數適用于從數據庫讀出的、尚未顯示到頁(yè)面或編輯界面的數據。
author_email
應用于comment_author_email函數從數據庫檢索到的評論者的電子郵件地址。參見(jiàn)get_comment_author_email。
comment_author
應用于comment_author函數從數據庫檢索到的評論者的名稱(chēng)。參見(jiàn)get_comment_authorl。
comment_author_rss
包含RSS訂閱前,應用于評論者的名稱(chēng)。
comment_email
應用于comment_author_email_link函數從數據庫檢索到的評論者的電子郵件地址。
comment_url
應用于comment_author_url函數從數據庫檢索到的評論者的URL地址(參見(jiàn)get_comment_author_url)。
get_comment_author
應用于get_comment_author函數從數據庫檢索到的評論者的名稱(chēng),comment_author函數也會(huì )調用此類(lèi)評論者名稱(chēng)。參見(jiàn)comment_author。
get_comment_author_email
應用于get_comment_author_email函數從數據庫檢索到的評論者的電子郵件地址。comment_author_email也會(huì )調用此類(lèi)電子郵件地址。參見(jiàn)author_email。
get_comment_author_IP
應用于get_comment_author_IP函數從數據庫檢索到的評論者的IP地址。comment_author_IP函數也會(huì )調用此類(lèi)IP地址。
get_comment_author_url
應用于get_comment_author_url函數從數據庫檢索到的評論者的URL。comment_author_url函數也會(huì )調用此類(lèi)URL地址。參見(jiàn)comment_url。
login_errors
應用于顯示在登錄界面上的登錄錯誤信息。
login_headertitle
應用于顯示在登錄界面上的登錄信息頭URL(WordPress默認顯示)標題。
login_headerurl
應用于顯示在登錄界面上的登錄信息頭URL(默認指向WordPress.org)。
login_message
應用于顯示在登錄界面上的登錄信息。
role_has_cap
在WP_Role->has_cap函數中應用于某位用戶(hù)的權限列表。過(guò)濾器函數接收的參數包括:將要被過(guò)濾的權限列表,目前還無(wú)法使用的權限,以及用戶(hù)名稱(chēng)。
sanitize_user
在sanitize_user函數中應用于用戶(hù)名。過(guò)濾器函數接收的參數包括:用戶(hù)名 (整理后),原始用戶(hù)名,strict(true或者false,表示使用/不使用精確的ASCII碼)。
the_author
在get_the_author函數中,應用于日志作者所顯示的名稱(chēng)。the_author函數也會(huì )調用該名稱(chēng)。
the_author_email
在the_author_email函數中,應用于日志作者的點(diǎn)知郵件地址。
本部分中的過(guò)濾器函數適用于尚未保存到數據庫中的數據。
pre_comment_author_email
應用于評論尚未保存到數據庫時(shí)該評論作者的電子郵件地址。
pre_comment_author_name
應用于評論尚未保存到數據庫時(shí)該評論作者的用戶(hù)名。
pre_comment_author_url
應用于評論尚未保存到數據庫時(shí)該評論作者的URL。
pre_comment_user_agent
應用于評論尚未保存到數據庫時(shí)該評論作者的用戶(hù)代理。
pre_comment_user_ip
應用于評論尚未保存到數據庫時(shí)該評論作者的IP地址。
pre_user_id
應用于評論尚未保存到數據庫時(shí)該評論作者的用戶(hù)ID。
pre_user_description
應用于尚未保存到數據庫中的用戶(hù)說(shuō)明。
pre_user_display_name
應用于尚未保存到數據庫中的用戶(hù)顯示名。
pre_user_email
應用于尚未保存到數據庫中的用電子郵箱地址。
pre_user_first_name
應用于尚未保存到數據庫中的用戶(hù)的名字。
pre_user_last_name
應用于尚未保存到數據庫中的用戶(hù)的姓。
pre_user_login
應用于尚未保存到數據庫中的用戶(hù)登錄名。
pre_user_nicename
應用于尚未保存到數據庫中的用戶(hù)別名。
pre_user_display_name
應用于尚未保存到數據庫中的用戶(hù)昵稱(chēng)。
pre_user_url
應用于尚未保存到數據庫中的用戶(hù)URL。
registration_errors
應用于注冊新用戶(hù)所生成的注冊錯誤列表。
user_registration_email
在用戶(hù)首次登錄時(shí),應用于從注冊頁(yè)面讀取到的該用戶(hù)電子郵件地址。
validate_username
應用戶(hù)新用戶(hù)名的驗證結果。過(guò)濾器函數接收的參數:valid (true/false), 被驗證的用戶(hù)名。
注意:本部分是關(guān)于反向鏈接的過(guò)濾器函數。日志、頁(yè)面、類(lèi)別等連接過(guò)濾器函數見(jiàn)上文。
get_bookmarks
在get_bookmarks函數中,應用于反向鏈接數據庫查詢(xún)結果。過(guò)濾器函數接收的參數:數據庫查詢(xún)結果列表,get_bookmarks參數列表。
link_category
在get_links_list 和 wp_list_bookmarks函數中,應用于鏈接說(shuō)明。
link_rating
在get_linkrating函數中,應用于鏈接評價(jià)值。
link_title
在get_links和wp_list_bookmarks函數中,應用于鏈接標題。(自WordPress 2.2起)
pre_link_description
應用于尚未保存到數據庫中的鏈接說(shuō)明。
pre_link_image
應用于尚未保存到數據庫中的鏈接圖片。
pre_link_name
應用于尚未保存到數據庫中的鏈接名稱(chēng)。
pre_link_notes
應用于尚未保存到數據庫中的鏈接注釋。
pre_link_rel
應用于尚未保存到數據庫中的鏈接聯(lián)系信息。
pre_link_rss
應用于尚未保存到數據庫中的鏈接RSS URL地址。
pre_link_target
應用于尚未保存到數據庫中的鏈接目標信息。
pre_link_url
應用于尚未保存到數據庫中的鏈接URL。
all_options
應用于get_alloptions函數從數據庫中檢索到的選項列表。
bloginfo
應用于get_bloginfo函數檢索博客選項信息后,bloginfo函數再次從數據庫中檢索出的博客選項信息。第二個(gè)參數$show給出所請求的bloginfo選項名稱(chēng)。注意:bloginfo("url"),bloginfo("directory") 與bloginfo("home")不使用該過(guò)濾器函數(參見(jiàn)bloginfo_url)。
bloginfo_rss
在get_bloginfo_rss函數中, get_bloginfo函數首次檢索過(guò)博客選項信息、過(guò)濾HTML標簽、轉換相應字符后,應用于博客選項信息(bloginfo_rss函數也調用此類(lèi)信息)。參數$show給出所請求的bloginfo選項名稱(chēng)。
bloginfo_url
應用于bloginfo("url"), bloginfo("directory") 以及bloginfo("home")尚未返回的輸出結果。
loginout
應用于wp_loginout函數為用戶(hù)登錄和退出生成的HTML鏈接。
option_(option name)
應用于反序列化(解碼基于數組的選項)后,get_option函數從數據庫檢索到的選項值。使用該過(guò)濾器函數時(shí)需要為特定選項名稱(chēng)添加過(guò)濾器函數,例如為 "option_foo"添加過(guò)濾器以過(guò)濾get_option("foo")的輸出結果。
pre_option_(option name)
應用于反序列化后get_alloption函數從數據庫檢索到的選項值(解碼基于數組的選項)。使用該過(guò)濾器函數時(shí)需要為特定選項名稱(chēng)添加過(guò)濾器函數,例如為 "pre_option_foo"添加過(guò)濾器以過(guò)濾"foo"選項。
register
應用于wp_register函數為用戶(hù)創(chuàng )建的、用以注冊(在允許注冊的情況下)或訪(fǎng)問(wèn)控制板(已登錄用戶(hù))的側邊欄鏈接。
upload_dir
應用于wp_upload_dir函數用以上傳文件的文件目錄。過(guò)濾器函數接收的參數是一個(gè)帶有"dir"(上傳目錄路徑)、"url"(上傳目錄的URL)、"error"(如果需要生成錯誤信息,可將此項設為true)元素的數組。
upload_mimes
若沒(méi)有MIME列表輸入wp_check_filetype函數,upload_mimes允許過(guò)濾器函數返回MIME類(lèi)型列表以供上傳。
一般性文章過(guò)濾器函數
attribute_escape
在attribute_escape函數中,應用于日志正文和其它內容。WordPress在多處地方調用attribute_escape以在內容發(fā)送到瀏覽器前,將某些字符改為HTML屬性。
js_escape
在js_escape函數中,內容發(fā)送到瀏覽器窗口前,應用于Javascript代碼。
本部分是關(guān)于包括內容編輯界面在內的WordPress管理界面的過(guò)濾器函數。
autosave_interval
應用于自動(dòng)保存日志的時(shí)間間隔中。
cat_rows
在管理菜單中,應用于為管理類(lèi)別而生成的類(lèi)別行HTML。
comment_edit_pre
應用于尚未顯示到編輯界面上的評論內容。
comment_edit_redirect
當有人在管理菜單中編輯評論后,應用于重定向。過(guò)濾器函數接收的參數:重定向地址,評論ID。
comment_moderation_subject
應用于通知網(wǎng)站管理人員審核新評論時(shí)發(fā)送的電子郵件的郵件主題。過(guò)濾器函數接收的參數:郵件主題,評論 ID。注意:該過(guò)程發(fā)生在 wp_notify_moderator 函數中。 wp_notify_moderator 是一個(gè)“可插入式”函數,即插件能夠改寫(xiě)該函數;參見(jiàn)插件API。
comment_moderation_text
應用于通知網(wǎng)站管理人員審核新評論時(shí)發(fā)送的電子郵件的郵件正文。過(guò)濾器函數接收的參數:郵件正文內容,評論 ID。注意:該過(guò)程發(fā)生在 wp_notify_moderator 函數中。 wp_notify_moderator 是一個(gè)“可插入式”函數,即插件能夠改寫(xiě)該函數;參見(jiàn)插件API。
comment_notification_headers
應用于通知日志作者有新評論時(shí)所發(fā)送的電子郵件的郵件標頭。過(guò)濾器函數接收的參數:郵件標頭,評論 ID。注意:該過(guò)程發(fā)生在 wp_notify_postauthor函數中。 wp_notify_postauthor是一個(gè)“可插入式”函數,即插件能夠改寫(xiě)該函數;參見(jiàn)插件API。
comment_notification_subject
應用于通知日志作者有新評論時(shí)所發(fā)送的電子郵件的郵件主題。過(guò)濾器函數接收的參數:郵件主題,評論ID。注意:該過(guò)程發(fā)生在 wp_notify_postauthor函數中。 wp_notify_postauthor是一個(gè)“可插入式”函數,即插件能夠改寫(xiě)該函數;參見(jiàn)插件API。
comment_notification_text
應用于通知日志作者有新評論時(shí)發(fā)送的電子郵件的郵件正文。過(guò)濾器函數接收的參數:郵件正文,評論 ID。注意:該過(guò)程發(fā)生在 wp_notify_postauthor函數中。 wp_notify_postauthor是一個(gè)“可插入式”函數,即插件能夠改寫(xiě)該函數;參見(jiàn)插件API。
cron_schedules
在wp_get_schedules函數中,應用于一個(gè)空數組,讓插件能夠生成計劃任務(wù)。
default_content
應用于尚未打開(kāi)新日志的編輯框時(shí)默認的日志內容。
default_excerpt
應用于尚未打開(kāi)新日志的編輯框時(shí)默認的日志摘要。
default_title
應用于尚未打開(kāi)新日志的編輯框時(shí)默認的日志標題。
editable_slug
在get_sample_permalink函數中,應用于日志、頁(yè)面、標簽以及類(lèi)別的別名。
explain_nonce_(verb)-(noun)
允許過(guò)濾器函數定義文本,用文本來(lái)解釋W(xué)ordPress核心代碼沒(méi)有解釋的隨機數。使用此參數前用戶(hù)需要定義特別的動(dòng)詞/名詞過(guò)濾器。例如,如果我們開(kāi)發(fā)的插件為升級標簽定義了一個(gè)隨機數,我們就需要為“explain_nonce_update-tag”定義一個(gè)過(guò)濾器。過(guò)濾器函數接收的參數: 將要顯示的文本(默認為常見(jiàn)的 "Are you sure you want to do this?")以及動(dòng)作URL末尾部分的信息。
format_to_edit
在format_to_edit函數中,應用于正文、摘要、標題和密碼,管理菜單會(huì )調用format_to_edit函數來(lái)設定需要編輯的日志。在管理菜單中編輯評論時(shí)也可用到該參數。
format_to_post
在format_to_post函數中,應用于日志內容。默認情況下WordPress不使用這個(gè)參數。
manage_link-manager_columns
在WordPress 2.7以前,這個(gè)參數被稱(chēng)為manage_link_columns。應用于欄列表,以在反向鏈接管理界面上輸入內容。過(guò)濾器函數的參數值/返回的值是一個(gè)關(guān)聯(lián)列表,其中的元素關(guān)鍵字是欄名稱(chēng),元素值是該欄頁(yè)眉處的文本。參見(jiàn)動(dòng)作函數manage_link_custom_column,這個(gè)函數將欄信息放在編輯界面中。
manage_posts_columns
應用于欄列表,以在日志管理界面上輸入內容。過(guò)濾器函數的參數值/返回的值是一個(gè)關(guān)聯(lián)數組,其中的元素關(guān)鍵字是欄名稱(chēng),元素值是該欄頁(yè)眉處的文本。參見(jiàn)動(dòng)作函數manage_posts_custom_column,這個(gè)函數將欄信息放入編輯界面。
manage_pages_columns
應用于欄列表,以在頁(yè)面管理界面上輸入內容。過(guò)濾器函數的參數值/返回的值是一個(gè)關(guān)聯(lián)數組,其中的元素關(guān)鍵字是欄名稱(chēng),元素值是該欄頁(yè)眉處的文本。參見(jiàn)動(dòng)作函數manage_pages_custom_column,這個(gè)函數將欄信息放入編輯界面。
postmeta_form_limit
應用于日志編輯界面上的日志meta信息項的個(gè)數。
pre_upload_error
上傳文件時(shí),允許插件生成XMLRPC錯誤。
preview_page_link
應用于頁(yè)面編輯界面上的鏈接,頁(yè)面預覽效果顯示在界面下方。
preview_post_link
應用于日志編輯界面上的鏈接,日志預覽效果顯示在界面下方。
richedit_pre
在wp_richedit_pre函數中,應用于尚未顯示到富文本編輯器的日志內容。
show_password_fields
應用于true/false變量,該變量決定用戶(hù)是否選擇在用戶(hù)資料界面上更改密碼(若變量值為true,顯示密碼修改項;變量值為false,表示用戶(hù)無(wú)需修改密碼)。
the_editor
應用于尚未顯示在屏幕上的HTML DIV,該DIV用以存放富文本編輯器。過(guò)濾器函數的參數/返回的值是一個(gè)字符串。
user_can_richedit
在user_can_richedit函數中,用于統計用戶(hù)的瀏覽器是否具有富編輯功能,以及用戶(hù)是否希望使用富文本編輯器。若當前用戶(hù)能夠/不能夠使用富文本編輯器時(shí),過(guò)濾器函數的參數(返回值)為true/false。
user_has_cap
在WP_User->has_cap函數中,應用于用戶(hù)的權限列表(current_user_can 函數調用WP_User->has_cap函數)。該過(guò)濾器函數的參數是將要被過(guò)濾的權限列表,以及參數列表(若用戶(hù)能夠編輯日志,參數列表中將包括日志ID等內容)。
wp_handle_upload
應用于上傳文件時(shí)的相關(guān)上傳信息。該過(guò)濾器函數的參數:帶有"file"(文件名)、"url"、"type"元素的數組。
wp_upload_tabs
應用于自定義表的列表,以顯示在上傳管理界面上。該參數用動(dòng)作函數upload_files_(tab)顯示自定義表的頁(yè)面。
本部分中的過(guò)濾器函數修改了富文本編輯器的配置。
mce_spellchecker_languages
應用于拼寫(xiě)檢查器中有效的語(yǔ)言選擇。
mce_buttons, mce_buttons_2, mce_buttons_3, mce_buttons_4
應用于富文本編輯器中的按鈕行(每一行都是按鈕名稱(chēng)的數組)。
mce_css
應用于富文本編輯器的CSS文件URL。
mce_external_plugins
應用于富文本編輯器加載的外部插件列表。
mce_external_languages
應用于外部插件加載的語(yǔ)言文件列表(參見(jiàn) tinymce/langs/wp-langs.php)。
tiny_mce_before_init
應用于編輯器的完整初始化數組。
本部分是關(guān)于主題、模板和樣式文件的鏈接過(guò)濾器函數。
kubrick_header_color
應用于默認主題頁(yè)眉處的顏色。
kubrick_header_display
應用于默認主題頁(yè)眉處的顯示設置。
kubrick_header_image
應用于默認主題的頁(yè)眉圖片文件。
locale_stylesheet_uri
應用于get_locale_stylesheet_uri函數返回的、指定位置的樣式表單URI。過(guò)濾器函數的參數:URI,樣式表單目錄URI。
stylesheet
應用于get_stylesheet函數返回的樣式表單。
stylesheet_directory
應用于get_stylesheet_directory函數返回的樣式表單目錄。過(guò)濾器函數的參數:樣式表單目錄,樣式表單。
stylesheet_directory_uri
應用于get_stylesheet_directory_uri函數返回的樣式表單目錄URI。過(guò)濾器函數的參數:樣式表單目錄URI,樣式表單。
stylesheet_uri
應用于get_stylesheet_uri函數返回的樣式表單URI。過(guò)濾器函數的參數:樣式表單URI,樣式表單。
template
應用于get_template函數返回的模板。
template_directory
應用于get_template_directory函數返回的模板目錄。過(guò)濾器函數的參數:模板目錄,模板。
template_directory_uri
應用于get_template_directory_uri函數返回的模板目錄URI。過(guò)濾器函數的參數:模板目錄URI,模板。
theme_root
應用于get_theme_root函數返回的主題根目錄(正常情況下即wp-content/themes).
theme_root_uri
應用于get_theme_root_uri函數返回的主題根目錄URI。過(guò)濾器函數的參數:URI,網(wǎng)站URL。
我們也可以用以下過(guò)濾器鉤子來(lái)代替主題中的單個(gè)模板文件。每個(gè)過(guò)濾器函數都將當前主題中相應的模板文件路徑作為輸入內容。插件可以為模板文件返回新的路徑,以此修改將要使用的文件。
本部分是與WordPress查詢(xún)語(yǔ)句、重寫(xiě)規則、國際化以及其它WordPress核心功能相關(guān)的高等過(guò)濾器函數。
author_rewrite_rules
應用于已生成的、與作者相關(guān)的重寫(xiě)過(guò)則。
category_rewrite_rules
應用于已生成的、與類(lèi)別相關(guān)的重寫(xiě)規則。
comments_rewrite_rules
應用于已生成的、與評論相關(guān)的重寫(xiě)規則。
creat_user_query
應用于尚未執行的、用以將新用戶(hù)信息存入數據庫的查詢(xún)語(yǔ)句。
date_rewrite_rules
應用于已生成的、與日期相關(guān)的重寫(xiě)規則。
found_posts
應用于執行數據庫查詢(xún)后的日志列表。
found_posts_query
數據庫查詢(xún)過(guò)即將顯示在頁(yè)面上的日志列表后,WordPress會(huì )在查詢(xún)結果中選擇日志行。此時(shí)用戶(hù)可用該過(guò)濾器函數來(lái)進(jìn)行其它操作,而不是執行SELECT FOUND_ROWS()。
get_editable_authors
在get_editable_authors函數中,應用于當前用戶(hù)有權管理的日志作者列表。
gettext
應用于 __ and _e國際化函數翻譯的文本。過(guò)濾器函數的參數:翻譯文本和未翻譯文本。該過(guò)濾器函數只在國際化有效且已加載文本域后有效。
get_next_post_join
在get_next_post函數(該函數查找當前日志之后需要顯示的日志)中,應用于SQL JOIN語(yǔ)句(當用戶(hù)查看類(lèi)別存檔時(shí),該語(yǔ)句通常與類(lèi)別表相連接)。過(guò)濾器函數的參數:JOIN語(yǔ)句,stay in same category (true/false),被排除的類(lèi)別列表。
get_next_post_sort
在get_next_post函數(該函數查找當前日志之后需要顯示的日志)中,應用于SQL ORDER BY語(yǔ)句(該語(yǔ)句通常按日志發(fā)表時(shí)間升序排列日志;至少需要有一篇日志)。過(guò)濾器函數的參數:ORDER BY語(yǔ)句。
get_next_post_where
在get_next_post函數(該函數查找當前日志之后需要顯示的日志)中,應用于SQL WHERE語(yǔ)句(該語(yǔ)句通常按時(shí)間順序查找下一篇已發(fā)表日志)。過(guò)濾器函數的參數:WHERE語(yǔ)句,stay in same category (true/false),被排除的類(lèi)別類(lèi)表。
get_others_drafts
應用于查詢(xún)語(yǔ)句,該查詢(xún)語(yǔ)句能夠選擇其他用戶(hù)的日志草稿并顯示在管理菜單中。
get_previous_post_join
在get_previous_post函數(該函數查找當前日志之前所顯示的日志)中,應用于SQL JOIN語(yǔ)句(當用戶(hù)查看類(lèi)別存檔時(shí),該語(yǔ)句通常與類(lèi)別表相連接)。過(guò)濾器函數的參數:JOIN語(yǔ)句,stay in same category (true/false),被排除的類(lèi)別列表。
get_previous_post_sort
在get_previous_post函數(該函數查找當前日志之前所顯示的日志)中,應用于SQL ORDER BY語(yǔ)句(該語(yǔ)句通常按日志發(fā)表時(shí)間降序排列日志;至少需要有一篇日志)。過(guò)濾器函數的參數:ORDER BY語(yǔ)句。
get_previous_post_where
在get_previous_post函數(該函數查找當前日志之前所顯示的日志)中,應用于SQL WHERE語(yǔ)句(該語(yǔ)句通常按時(shí)間順序查找上一篇已發(fā)表日志)。過(guò)濾器函數的參數:WHERE語(yǔ)句,stay in same category (true/false),被排除的類(lèi)別類(lèi)表。
get_user_drafts
應用于查詢(xún)語(yǔ)句,該查詢(xún)語(yǔ)句能夠選擇其他用戶(hù)的日志草稿并顯示在管理菜單中。
locale
應用于get_locale函數的存儲位置。
mod_rewrite_rules
應用于重寫(xiě)規則列表,用戶(hù)更改永久鏈接結構時(shí)將該重寫(xiě)規則列表存入.htaccess文件。
post_limits
應用于查詢(xún)的LIMIT語(yǔ)句,該查詢(xún)可返回日志數組。
posts_distinct
允許插件將DISTINCTROW語(yǔ)句加入查詢(xún),該查詢(xún)可返回日志數組。
posts_fields
應用于查詢(xún)的字段列表,該查詢(xún)可返回日志數組。
posts_groupby
應用于查詢(xún)的GROUP BY語(yǔ)句,該查詢(xún)返回日志數組(通常情況下該數組為空)。
posts_join_paged
應用于查詢(xún)語(yǔ)句的JOIN語(yǔ)句。在計算出分頁(yè)后,該查詢(xún)返回日志列表(分頁(yè)并不影響JOIN語(yǔ)句,因此該函數相當于posts_join)。
posts_orderby
應用于查詢(xún)語(yǔ)句的ORDER BY語(yǔ)句。該查詢(xún)返回日志數組。
posts_request
應用于尚未執行的、將返回日志數組的SQL查詢(xún)語(yǔ)句整體。
post_rewrite_rules
應用于已生成的、與日志相關(guān)的重寫(xiě)規則。
root_rewrite_rules
應用于生成后的根目錄級重寫(xiě)規則。
page_rewrite_rules
應用于已生成的、與頁(yè)面相關(guān)的重寫(xiě)規則。
posts_where_paged
應用于查詢(xún)的WHERE語(yǔ)句。在計算出分頁(yè)后,該查詢(xún)返回日志數組(分頁(yè)并不影響WHERE語(yǔ)句,因此該函數相當于posts_where)。
posts_join
應用于查詢(xún)的JOIN語(yǔ)句。該查詢(xún)返回日志數組。這個(gè)過(guò)濾器函數與posts_where過(guò)濾器函數一并為JOIN語(yǔ)句添加了一個(gè)數據庫表。
posts_where
應用于查詢(xún)的WHERE語(yǔ)句。該查詢(xún)返回日志數組。
query
應用于所有查詢(xún)語(yǔ)句(至少加載插件后運行的所有查詢(xún)語(yǔ)句)。
query_string
已停用——可用query_vars或request來(lái)代替該函數。
query_vars
在生成SQL查詢(xún)語(yǔ)句前,應用于WordPress公共查詢(xún)變量列表。適用于刪除插件進(jìn)行其它操作時(shí)多余的永久鏈接信息。
request
類(lèi)似query_vars,但request用在添加了“額外”的私有查詢(xún)變量后。
rewrite_rules_array
應用于已生成的所有重寫(xiě)規則。
search_rewrite_rules
應用于已生成的、與查找相關(guān)的重寫(xiě)規則。
the_posts
WordPress對只有一篇日志的網(wǎng)頁(yè)進(jìn)行許可權限和草稿狀態(tài)的最簡(jiǎn)單處理后,將the_posts用在從數據庫查詢(xún)出的日志列表上。
excerpt_length
定義某一篇日志摘要的長(cháng)度。
update_user_query
應用于更新查詢(xún)語(yǔ)句。該查詢(xún)語(yǔ)句可在執行查詢(xún)前更新用戶(hù)信息。
uploading_iframe_src(自WordPress 2.5后被刪除)
為日志和頁(yè)面編輯界面中所上傳的內嵌框架使用HTML src標簽。
wp_redirect
在wp_redirect函數中,應用于重定向的URL。過(guò)濾器函數的參數:URL,HTTP狀態(tài)碼。注意:wp_redirect是一個(gè)“可插入式”函數,插件能夠改寫(xiě)該函數;參見(jiàn)插件API。
xmlrpc_methods
應用于已經(jīng)為XMLRPC服務(wù)器定義的XMLRPC方法列表。
wp_mail_from
在wp_mail函數中,用于發(fā)出郵件前。該函數的輸入值是郵件地址的計算結果,這里的郵件地址即當前主機名稱(chēng)下的WordPress(該值由$_SERVER['SERVER_NAME']規定)。過(guò)濾器函數wp_mail_from返回一個(gè)郵件地址,如“user@example.com”,或姓名和郵件地址的組合,如“Name <user@example.com>”(均無(wú)引號)。
wp_mail_from_name
在wp_mail函數中,用于發(fā)出郵件前。過(guò)濾器函數wp_mail_from_name返回一個(gè)名稱(chēng)字符串,該字符串將用作郵件發(fā)送人的名稱(chēng)。
聯(lián)系客服