WordPress儀表板小部件API的簡介

WordPress儀表板小部件API允許主題和插件添加，刪除或重新位置WordPress儀表板小部件。 WordPress儀表板是我們登錄WordPress管理屏幕時看到的第一件事。 WordPress儀表板窗口小部件API已從WordPress 2.7開始。 在本教程中，我們將研究API提供的不同動作和功能。並且，如何使用此API添加，刪除和定位儀表板小部件。

鑰匙要點

• > WordPress儀表板窗口小部件API允許主題和插件在WordPress儀表板上添加，或重新位置小部件。自WordPress 2.7以來，此API已可用，並且是WordPress開發人員的關鍵工具。
添加一個小部件涉及使用WP_ADD_DASHBOOD_WIDGET函數，該功能需要三個參數：窗口小部件的唯一ID，窗口小部件的標題和顯示窗口小部件內容的回調。刪除小部件是通過remove_meta_box函數完成的。
> API沒有提供更改小部件位置的方法，但可以通過操縱WordPress Core $ WP_META_BOX變量來實現解決方法。可以將自定義數據添加到小部件中，並且可以使用CSS自定義它們的外觀。
• WordPress儀表板窗口小部件的場景後面 在內部，WordPress儀表板小部件是WordPress Meta框。儀表板窗口小部件API使用WordPress Meta Box API添加，刪除和定位儀表板小部件。
添加儀表板窗口小部件

我們可以使用wp_add_dashboard_widget函數在WordPress儀表板上添加一個小部件。我們需要將此功能包裝在WP_DASHBOOD_SETUP鉤中。 這是一些有關如何使用WP_ADD_DASHBOOD_WIDGET的示例代碼：

在這裡，我們在add_dashboard_widget中調用WP_ADD_DASHBOOD_WIDGET，該WIDGET是由WP_DASHBOOD_SETUP HONK觸發的。 wp_add_dashboard_widget 採取三個論點。這是參數：

$ id：每個儀表板小部件都必須具有唯一的ID。確保您的插件或主題名稱將其前綴以避免覆蓋。

>

<span>function add_dashboard_widget()
</span><span>{
</span><span>wp_add_dashboard_widget("sitepoint", "SitePoint Videos", "display_sitepoint_dashboard_widget");
</span><span>}
</span>
<span>function display_sitepoint_dashboard_widget()
</span><span>{
</span><span>echo "Watch Video Courses at <a href='http://learnable.com'>Learnable</a>";
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "add_dashboard_widget");</span>

$標題：要顯示的小部件的標題。

>
1. $ callback：一個回調，顯示了窗口小部件的內容。
>

小部件的外觀如下：

卸下儀表板小部件

我們可以使用remove_meta_box函數刪除默認或自定義儀表板小部件。我們需要在wp_dashboard_setup函數中包裝此功能。 這是我們將如何使用remove_meta_box：

<span>function add_dashboard_widget()
</span><span>{
</span><span>wp_add_dashboard_widget("sitepoint", "SitePoint Videos", "display_sitepoint_dashboard_widget");
</span><span>}
</span>
<span>function display_sitepoint_dashboard_widget()
</span><span>{
</span><span>echo "Watch Video Courses at <a href='http://learnable.com'>Learnable</a>";
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "add_dashboard_widget");</span>

在這裡，我們在remove_dashboard_widget函數中調用remove_meta_box函數，該功能的確是由WP_DASHBOOD_SETUP操作觸發的。 remove_meta_box進行了三個參數，它們是：

1. $ id：小部件的唯一ID。這是默認小部件的ID列表：dashboard_activity ，dashboard_right_now_now ，dashboard_recent_comments dashboard_quick_press ，dashboard_secondary ， dashboard_primaryand dashboard_incoming_links 。 $ location：刪除儀表板時，這將始終具有“儀表板”的值。 $位置：如果您要刪除由WordPress Core默認創建的窗口小部件，或使用WP_ADD_DASHBOOD_WIDGEG創建的窗口

>在儀表板中定位小部件

默認情況下，新小部件將添加到儀表板頁面的左下方。 WordPress儀表板小部件API無法提供更改小部件位置的方法。但是，我們可以將WordPress Core $ WP_META_BOX變量作為解決方法。 這是我們如何將小部件移至頂部的示例：

<span>function add_dashboard_widget()
</span><span>{
</span><span>wp_add_dashboard_widget("sitepoint", "SitePoint Videos", "display_sitepoint_dashboard_widget");
</span><span>}
</span>
<span>function display_sitepoint_dashboard_widget()
</span><span>{
</span><span>echo "Watch Video Courses at <a href='http://learnable.com'>Learnable</a>";
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "add_dashboard_widget");</span>

您可以更改此數組並根據需要更改小部件的位置。

>在儀表板窗口小部件中顯示RSS feed

讓我們創建一個儀表板小部件，該小部件可以檢索SitePoint的RSS feed，然後顯示它。我們將使用WordPress的API獲取和解析RSS feed。 這是我們小部件的代碼：

<span>function remove_dashboard_widget()
</span><span>{
</span><span>remove_meta_box("sitepoint", "dashboard", "normal");
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "remove_dashboard_widget");</span>

在這裡，我們包括文件“ feed.php”，該文件揭示了與WordPress中RSS一起使用所需的所有API。然後，我們使用fetch_feed下載和解析RSS feed，最後顯示10個RSS項目。 這是我們的RSS儀表板小部件的外觀：

結論

許多WordPress插件，例如分析，WooCommerce插件和各種監視擴展程序，都使用儀表板小部件API。 WordPress儀表板窗口小部件API是WordPress開發人員最重要的API之一，在此示例中，我們介紹了一些基本示例。請隨時評論您對下面API的經歷。

經常詢問有關WordPress儀表板小部件API

的問題

如何在WordPress儀表板中添加一個新的小部件？

>在WordPress儀表板中添加一個新的小部件是一個簡單的過程。首先，您需要創建一個輸出小部件內容的函數。然後，您需要使用WP_ADD_DASHBOOD_WIDGET函數向WordPress註冊此功能。此功能採用三個參數：小部件的ID，其名稱以及輸出其內容的功能。完成此操作後，您的小部件將出現在您的儀表板上。

我可以從WordPress儀表板上刪除現有的小部件嗎？可以使用remove_meta_box函數完成此操作。此函數採用三個參數：要刪除的小部件的ID，顯示小部件的屏幕以及顯示小部件的上下文。可以使用CSS自定義儀表板小部件的窗口小部件？您可以將自定義CSS添加到主題的樣式.css文件或使用自定義CSS插件。您可以通過將其ID用作CSS選擇器來定位特定的小部件。

我可以控制儀表板小部件的位置嗎？可以使用WP_DASHBOOD_SETUP ACTION HONK完成此操作。此鉤子允許您指定小部件在儀表板上的位置。

>

>如何將自定義數據添加到我的儀表板窗口小部件？

您可以通過創建一個輸出數據並使用wp_add_dashboard_widget函數的WordPress註冊該功能的函數來將自定義數據添加到儀表板窗口小部件中。數據可以是您想要的任何東西，例如統計，圖形甚至自定義表單。

>我可以在儀表板窗口小部件中使用ajax嗎？

是的，您可以在儀表板窗口窗口中使用ajax 。這可以通過啟用必要的JavaScript文件並使用WP_AJAX_ ACTION鉤在服務器端處理AJAX請求來完成。

>如何使我的儀表板窗口互動？您的儀表板小部件通過使用JavaScript進行交互。您可以使用WP_ENQUEUE_SCRIPT函數加入JavaScript文件，然後使用JavaScript將交互性添加到您的小部件中。

我可以在我的儀表板上添加同一小部件​​的多個實例嗎？將同一小部件​​的多個實例添加到儀表板中。每個小部件必須具有唯一的ID，因此，如果要添加同一小部件​​的多個實例，則需要將每個實例註冊為具有唯一ID的單獨的窗口小部件。

我可以將儀表板窗口小部件添加到其他WordPress中的屏幕？可以使用add_meta_box函數完成此操作。此功能使您允許您在WordPress的任何屏幕上添加小部件，而不僅僅是儀表板。

>如何使我的儀表板窗口小部件響應良好？

>您可以通過使用CSS Media通過CSS Media來響應您的儀表板窗口小部件。查詢。您可以將這些媒體查詢添加到主題的樣式.css文件中，或使用自定義CSS插件。您可以通過使用其ID作為CSS選擇器來定位特定的小部件。

以上是WordPress儀表板小部件API的簡介的詳細內容。更多資訊請關注PHP中文網其他相關文章！