How do I pass arguments to dashboard widget callback functions?

Question

I'm struggling to use the $callback_args parameter of wp_add_dashboard_widget successfully.

The following code keeps displaying string(0)"" when dumping $args:

add_action( 'wp_dashboard_setup', 'sample_widget_setup' );

function sample_widget_setup() {

    wp_add_dashboard_widget(
        'sample_dashboard_widget',
        'Sample Widget',
        'sample_dashboard_widget_callback',
        null,
        'sample_string'
    );
}

function sample_dashboard_widget_callback($args) {
    var_dump($args);
}

How can I pass a variable to sample_dashboard_widget_callback?

Chris_O · Accepted Answer · 2014-01-09 18:22:24Z

6

The args are stored in the 2nd variable passed to your callback function.

add_action( 'wp_dashboard_setup', 'sample_widget_setup' );

function sample_widget_setup() {

    wp_add_dashboard_widget(
      'sample_dashboard_widget',
      'Sample Widget',
      'sample_dashboard_widget_callback',
       null,
        'sample_string'
    );
}

function sample_dashboard_widget_callback( $var, $args ) {
    var_dump( $args );
}

Output from above:

array
  'id' => string 'sample_dashboard_widget' (length=23)
  'title' => string 'Sample Widget' (length=13)
  'callback' => string 'sample_dashboard_widget_callback' (length=32)
  'args' => string 'sample_string' (length=13)

answered Jan 9, 2014 at 18:22

Chris_O

20.6k5 gold badges63 silver badges98 bronze badges

Perfect. Thanks! Do you, by chance, know what the 1st variable is actually for?

MadtownLems
– MadtownLems

2014-01-10 15:27:17 +00:00
Commented Jan 10, 2014 at 15:27
from the codex; wp_add_dashboard_widget($widget_id, $widget_name, $callback, $control_callback, $callback_args );

numediaweb
– numediaweb

2014-09-06 19:13:53 +00:00
Commented Sep 6, 2014 at 19:13
$control_callback (string) (optional) The name of a function you create that will handle submission of widget options (configuration) forms, and will also display the form elements.

numediaweb
– numediaweb

2014-09-06 19:22:35 +00:00
Commented Sep 6, 2014 at 19:22

Add a comment |

Stack Exchange Network

How do I pass arguments to dashboard widget callback functions?

1 Answer 1

Your Answer

Hot Network Questions

How do I pass arguments to dashboard widget callback functions?

1 Answer 1

Your Answer

Sign up or log in

Post as a guest

Related

Hot Network Questions