wp_add_dashboard_widget() should accept location and priority parameters

[johnbillion]

The wp_add_dashboard_widget() function should accept $location and $priority parameters to bring the function inline with add_meta_box(), which it ultimately calls.

[davidjlaietta]

Attached diff includes $location and $priority arguments, and maintains similar logic for wp_add_dashboard_widget.

If location is not set, it'll be set to normal unless it's a side widget. If priority is not set it will be set to core unless dashboard_browser_nag is set, then it'll be set to high.

New usage:

wp_add_dashboard_widget( 'widget_id', 'Widget Name', callback_function, control_callback, array(), 'side', 'high' );

[DrewAPicture]

Hi @davidjlaietta, thanks for the patch! I've assigned the ticket to you to mark this good-first-bug as "claimed". Sorry for the delay in response.

I did a first pass on the patch, and the big standouts that are still missing are changelog entries for the new parameters in the DocBlock, and we could probably also benefit from unit tests here as well.

For info on changelog entries, check out ​this article in the core handbook.

[davidjlaietta]

The updated patch includes a changelog entry in the docblock

[soulseekah]

Why not set $priority = 'core' and $location = 'normal' to begin with? Why the whole 'default' dance? See 3rd diff version based on 2nd. Also removed tabs from docblock.

[soulseekah]

Enforce default priority and location when null is supplied

[soulseekah]

The unit test

[johnbillion]

42791.5.diff​ is a refreshed patch with improved docs. I think this is ready to go.

[johnbillion]

In 49123:

Administration: Allow context and priority to be specified when adding dashboard widgets.

Props davidjlaietta, soulseekah, johnbillion

Fixes #42791

[SergeyBiryukov]

In 49124:

Docs: Correct comments in test_wp_add_dashboard_widget() per the documentation standards.

See #42791.

[kirasong]

#32922 was marked as a duplicate.