wp_dashboard_setup()

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to wp_dashboard_setup() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Reaches an outbound HTTP request via wp_remote_post().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

74–185

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 291.

Plugin surface

7 hooks

Third-party callbacks on 'wp_network_dashboard_setup', 'wp_network_dashboard_widgets', 'wp_user_dashboard_setup' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• transienttransientget_site_transient()one call below wp_dashboard_setup()
• httpoutbound HTTP requestwp_remote_post()one call below wp_dashboard_setup()

Further down the call graph this can also reach cache, option, query and serialize. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 538 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_dashboard_setup() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 8

8 hooks fire while wp_dashboard_setup() runs, in this order:

1. 1
   do_action( wp_network_dashboard_setup )actionline 101 (+81 into the body)

   Fires after core widgets for the Network Admin dashboard have been registered.

2. 2
   apply_filters( wp_network_dashboard_widgets )filterline 110 (+90 into the body)

   Filters the list of widgets to load for the Network Admin dashboard.

3. 3
   do_action( wp_user_dashboard_setup )actionline 118 (+98 into the body)

   Fires after core widgets for the User Admin dashboard have been registered.

4. 4
   apply_filters( wp_user_dashboard_widgets )filterline 127 (+107 into the body)

   Filters the list of widgets to load for the User Admin dashboard.

5. 5
   do_action( wp_dashboard_setup )actionline 135 (+115 into the body)

   Fires after core widgets for the admin dashboard have been registered.

6. 6
   apply_filters( wp_dashboard_widgets )filterline 144 (+124 into the body)

   Filters the list of widgets to load for the admin dashboard.

7. 7
   do_action( do_meta_boxes )actionline 162 (+142 into the body)

   Fires after meta boxes have been added.

8. 8
   do_action( do_meta_boxes )actionline 165 (+145 into the body)

   Fires after meta boxes have been added.

Uses · 20

• get_current_screen()Get the current screen object
• wp_check_browser_version()Checks if the user needs a browser update.
• add_filter()Adds a callback function to a filter hook.
• wp_add_dashboard_widget()Adds a new dashboard widget.
• __()Retrieves the translation of $text.
• wp_check_php_version()Checks if the user needs to update PHP.
• current_user_can()Returns whether the current user has the specified capability.
• is_network_admin()Determines whether the current request is for the network administrative interface.
• wp_enqueue_style()Enqueues a CSS stylesheet.
• wp_enqueue_script()Enqueues a script.
• is_blog_admin()Determines whether the current request is for a site's administrative interface.
• get_post_type_object()Retrieves a post type object by name.

Source code

View on Trac ↗View on GitHub ↗

20function wp_dashboard_setup() {21	global $wp_registered_widgets, $wp_registered_widget_controls, $wp_dashboard_control_callbacks;22 23	$screen = get_current_screen();24 25	/* Register Widgets and Controls */26	$wp_dashboard_control_callbacks = array();27 28	// Browser version29	$check_browser = wp_check_browser_version();30 31	if ( $check_browser && $check_browser['upgrade'] ) {32		add_filter( 'postbox_classes_dashboard_dashboard_browser_nag', 'dashboard_browser_nag_class' );33 34		if ( $check_browser['insecure'] ) {35			wp_add_dashboard_widget( 'dashboard_browser_nag', __( 'You are using an insecure browser!' ), 'wp_dashboard_browser_nag' );36		} else {37			wp_add_dashboard_widget( 'dashboard_browser_nag', __( 'Your browser is out of date!' ), 'wp_dashboard_browser_nag' );38		}39	}40 41	// PHP Version.42	$check_php = wp_check_php_version();43 44	if ( $check_php && current_user_can( 'update_php' ) ) {45		// If "not acceptable" the widget will be shown.46		if ( isset( $check_php['is_acceptable'] ) && ! $check_php['is_acceptable'] ) {47			add_filter( 'postbox_classes_dashboard_dashboard_php_nag', 'dashboard_php_nag_class' );48 49			if ( $check_php['is_lower_than_future_minimum'] ) {50				wp_add_dashboard_widget( 'dashboard_php_nag', __( 'PHP Update Required' ), 'wp_dashboard_php_nag' );51			} else {52				wp_add_dashboard_widget( 'dashboard_php_nag', __( 'PHP Update Recommended' ), 'wp_dashboard_php_nag' );53			}54		}55	}56 57	// Site Health.58	if ( current_user_can( 'view_site_health_checks' ) && ! is_network_admin() ) {59		if ( ! class_exists( 'WP_Site_Health' ) ) {60			require_once ABSPATH . 'wp-admin/includes/class-wp-site-health.php';61		}62 63		WP_Site_Health::get_instance();64 65		wp_enqueue_style( 'site-health' );66		wp_enqueue_script( 'site-health' );67 68		wp_add_dashboard_widget( 'dashboard_site_health', __( 'Site Health Status' ), 'wp_dashboard_site_health' );69	}70 71	// Right Now.72	if ( is_blog_admin() && current_user_can( 'edit_posts' ) ) {73		wp_add_dashboard_widget( 'dashboard_right_now', __( 'At a Glance' ), 'wp_dashboard_right_now' );74	}75 76	if ( is_network_admin() ) {77		wp_add_dashboard_widget( 'network_dashboard_right_now', __( 'Right Now' ), 'wp_network_dashboard_right_now' );78	}79 80	// Activity Widget.81	if ( is_blog_admin() ) {82		wp_add_dashboard_widget( 'dashboard_activity', __( 'Activity' ), 'wp_dashboard_site_activity' );83	}84 85	// QuickPress Widget.86	if ( is_blog_admin() && current_user_can( get_post_type_object( 'post' )->cap->create_posts ) ) {87		$quick_draft_title = sprintf( '<span class="hide-if-no-js">%1$s</span> <span class="hide-if-js">%2$s</span>', __( 'Quick Draft' ), __( 'Your Recent Drafts' ) );88		wp_add_dashboard_widget( 'dashboard_quick_press', $quick_draft_title, 'wp_dashboard_quick_press' );89	}90 91	// WordPress Events and News.92	wp_add_dashboard_widget( 'dashboard_primary', __( 'WordPress Events and News' ), 'wp_dashboard_events_news' );93 94	if ( is_network_admin() ) {95 96		/**97		 * Fires after core widgets for the Network Admin dashboard have been registered.98		 *99		 * @since 3.1.0

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/dashboard.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.