Home » Hooks » wp_dashboard_setup

The wp_dashboard_setup hook is a WordPress action hook that is used to add or remove widgets from the WordPress dashboard. This hook is triggered when the WordPress dashboard page is loaded and allows developers to customize the dashboard by adding or removing widgets.

Developers can use this hook to add custom widgets to the dashboard or remove existing ones. This can be useful for clients who want to see specific information on the dashboard or for developers who want to provide custom functionality for their plugins or themes.

Here’s an example usage code for the wp_dashboard_setup hook:

function my_custom_dashboard_widget() {
    // Code for custom widget

function my_custom_dashboard_setup() {
    wp_add_dashboard_widget( 'custom_dashboard_widget', 'Custom Widget Title', 'my_custom_dashboard_widget' );

add_action( 'wp_dashboard_setup', 'my_custom_dashboard_setup' );

In this example, we’re creating a custom widget for the WordPress dashboard. We first define the my_custom_dashboard_widget function that contains the code for the widget. Then we define the my_custom_dashboard_setup function that adds the widget to the dashboard using the wp_add_dashboard_widget function. Finally, we hook into the wp_dashboard_setup action using the add_action function to ensure that our custom widget is added to the dashboard.

Learn More on WordPress.org

Register an account to save your snippets or go Pro to get more features.