wp-includes/widgets.php

WP檔案 41
Core Widgets API
函式/鉤子名 描述
wp_widgets_init (函式) wp_widgets_init – 這個函式用來初始化WordPress小工具系統。它負責註冊內建的WordPress小工具,並設定必要的動作和過濾器,以允許第三方外掛和主題新增自定義小工具。
wp_widget_rss_process (函式) wp_widget_rss_process – 這個函式用來處理WordPress小工具管理介面中RSS小工具的小工具控制表格的輸入。它負責根據使用者的輸入來更新RSS小工具的設定。
wp_widget_rss_output (函式) wp_widget_rss_output – 這個函式用來在WordPress網站的前端顯示一個RSS小工具的輸出。它負責渲染HTML輸出,在一個小工具中顯示RSS提要的內容。
wp_widget_rss_form (函式) wp_widget_rss_form – 這個函式用來在WordPress小工具管理螢幕中顯示RSS小工具的小工具控制表格。它負責渲染HTML表格,讓使用者配置RSS小工具的設定。
wp_widget_description (函式) wp_widget_description – 這個函式用來在WordPress小工具管理介面顯示小工具的描述文字。描述文字提供了一個關於該小工具的目的和用途的簡要概述。
wp_use_widgets_block_editor (函式) wp_use_widgets_block_editor: 這個函式用來檢查是否正在使用區塊編輯器(Gutenberg)來管理WordPress管理員中的小工具。如果正在使用區塊編輯器,它返回true,
wp_unregister_widget_control (函式) wp_unregister_widget_control: 這個函式刪除了一個先前註冊的widget的控制函式。控制函式負責在WordPress管理區呈現小工具控制,允許網站管理員修改小工具的設定。
wp_unregister_sidebar_widget (函式) wp_unregister_sidebar_widget: 這個函式刪除了一個先前註冊的側邊欄小工具。widget是一個可以被新增到WordPress網站側邊欄的小塊。wp_unregister_si
wp_sidebar_description (函式) wp_sidebar_description 是一個函式,用來顯示WordPress中一個小工具區域的描述。
wp_setup_widgets_block_editor (函式) wp_setup_widgets_block_editor: 這個函式在WordPress的區塊編輯器(Gutenberg)中使用,用於設定區塊編輯器中使用的小工具和小工具區域。
wp_set_sidebars_widgets (函式) wp_set_sidebars_widgets: 這個函式設定與一個側邊欄相關的小工具。它接受一個widgets陣列,每個側邊欄由一個widget ID陣列表示。
wp_render_widget_control (函式) wp_render_widget_control: 這個函式用來渲染WordPress管理面板中一個小工具的控制表單。它把小工具的ID和一個例項資料的陣列作為引數,並返回控制表單的HTML。
wp_render_widget (函式) wp_render_widget: 這個函式用來在WordPress網站的前端渲染一個小工具。它把小工具的ID作為引數,並返回小工具的內容。
wp_register_widget_control (函式) wp_register_widget_control: 這個函式用於註冊一個小工具的控制形式。它接受幾個引數,包括小工具的ID、名稱和回撥函式。
wp_register_sidebar_widget (函式) wp_register_sidebar_widget: 這個函式用來註冊一個小工具,以便在側邊欄顯示。它接受幾個引數,包括小工具的名稱、ID、描述和回撥函式。
wp_parse_widget_id (函式) wp_parse_widget_id: 這個函式解析一個widget ID,並返回一個包含widget型別和編號的陣列。
wp_map_sidebars_widgets (函式) wp_map_sidebars_widgets: 這是一個函式,用於將註冊的小工具區域對映到實際的小工具。它返回一個註冊的小工具區域的陣列,以及相應的小工具。
wp_get_widget_defaults (函式) wp_get_widget_defaults: 這個函式是用來獲取一個小工具的預設設定。它把小工具的ID作為引數,並返回該小工具的預設設定陣列。
wp_get_sidebars_widgets (函式) wp_get_sidebars_widgets: 這個函式檢索當前分配給WordPress站點中每個側邊欄的小工具的列表。它返回一個陣列,其中側邊欄的名字是鍵,小工具的ID列表是值。
wp_get_sidebar (函式) wp_get_sidebar: 這個函式為一個特定的WordPress主題檢索側邊欄的內容。它接受一個單一的引數–要檢索的側邊欄的名稱。如果該側邊欄在主題中不存在,它將返回一個空字串。
wp_find_widgets_sidebar (函式) wp_find_widgets_sidebar: 這個函式用來檢索當前在指定的側邊欄中活動的小工具的列表。它接受側邊欄的ID作為引數,並返回一個widget物件的陣列。
_wp_block_theme_register_classic_sidebars (函式) _wp_block_theme_register_classic_sidebars(): 這個函式為WordPress中的塊主題註冊經典側邊欄。
wp_convert_widget_settings (函式) wp_convert_widget_settings: 這是一個將小工具設定從陣列格式轉換為字串格式的函式。它可以用來在資料庫中儲存小工具的設定,並在以後檢索它們。
wp_check_widget_editor_deps (函式) wp_check_widget_editor_deps: 這是一個檢查WordPress小工具編輯器所需依賴性的函式。它可以用來確保在使用小工具編輯器時,所有必要的指令碼和樣式都被載入。
wp_assign_widget_to_sidebar (函式) wp_assign_widget_to_sidebar: 這個函式用來把一個widget分配到WordPress的一個特定的側邊欄。它需要兩個引數–小工具例項和小工具將被分配的側邊欄的ID: 這個函
unregister_widget (函式) unregister_widget: 在WordPress中取消一個先前註冊的小工具: 這個函式將該小工具從註冊的小工具列表中移除。
unregister_sidebar (函式) unregister_sidebar: 在WordPress中取消註冊一個先前註冊的側邊欄: 這個函式將側邊欄從註冊的側邊欄列表中移除,並使其無法在Widgets管理螢幕中選擇。
the_widget (函式) the_widget: 這個函式在一個特定的小工具區域顯示一個註冊的小工具。它需要兩個引數:widget類例項和控制widget的顯示和行為的引數陣列。
retrieve_widgets (函式) retrieve_widgets: 這是一個WordPress的函式,用來檢索特定側邊欄的小工具。小工具是一些小的內容塊,可以新增到網站的不同區域,如側邊欄。 retrieve_widgets檢索已經
register_widget (函式) register_widget: 這個函式允許你註冊一個新的小工具。小工具是小的內容塊,可以放置在WordPress的側邊欄或任何其他小工具區域。你可以使用這個函式來註冊一個新的小工具,並定義它的功能
register_sidebars (函式) register_sidebars: 這個函式用於在WordPress中註冊多個側邊欄: 當建立一個有多個小工具區域的主題或建立一個在網站上新增多個側邊欄的外掛時,這很有用。
register_sidebar (函式) register_sidebar: 這個函式用來在WordPress中註冊一個新的側邊欄。側邊欄是用來在WordPress網站上顯示小工具的,比如最近的文章列表或搜尋欄。
is_registered_sidebar (函式) is_registered_sidebar – 這個函式檢查一個給定的側邊欄是否被註冊。如果該側邊欄已經註冊,則返回真,否則返回假。
is_dynamic_sidebar (函式) is_dynamic_sidebar: 如果當前頁面有一個動態側邊欄,該函式返回 true。動態側邊欄是網站中的一個區域,網站所有者可以在其中新增或刪除小工具: 這個函式經常被用來根據動態邊欄是否存在
is_active_widget (函式) is_active_widget: 這個函式用來檢查一個小工具是否當前在網站上是活躍的。它以小工具的ID為引數,如果該小工具是活動的,則返回true,否則返回false。
is_active_sidebar (函式) is_active_sidebar: 這個函式用來檢查一個側邊欄是否有任何小工具被新增到它。它把側邊欄的ID作為一個引數,如果側邊欄有任何小工具,則返回true,否則返回false。
dynamic_sidebar (函式) dynamic_sidebar: 這個函式在WordPress中顯示一個小工具區域(sidebar)的內容。它通常用於sidebar.php模板檔案,顯示在WordPress管理面板中新增的小工具。
_wp_sidebars_changed (函式) _wp_sidebars_changed: 這個函式檢查WordPress安裝中的側邊欄是否被改變: 當一個主題被改變時,它被用來更新側邊欄。
_wp_remove_unregistered_widgets (函式) _wp_remove_unregistered_widgets: 這個函式刪除任何不再在WordPress安裝中註冊的小工具。它在widgets_init動作中被呼叫。
_register_widget_update_callback (函式) _register_widget_update_callback: 這個函式用來註冊一個回撥函式,用來為一個widget儲存表單資料。

常見問題

FAQs
檢視更多 >