WordPress.org

Ready to get started?Download WordPress

Codex

Adding Contextual Help to Administration Menus

Contents

Introduction

Ever since WordPress Version 3.0, every built-in Administration Panel has contained a contextual help section providing additional information to the user on how to navigate the various settings displayed in that admin panel. This helps WordPress keep the main part of the admin panel clear and concise by eliminating unnecessary text that regular users don't need to see on a regular basis.

If your plugin adds additional Administration Panels to WordPress, you can improve support by providing contextual help for your menus.

For information, see Adding Administration Menus and the Plugin API functions for a basic overview of how to add Administration Menus to WordPress with a Plugin.

Every Plot Needs a Hook

To register a function with WordPress to add a new administration menu, the code is:

<?php
add_action('admin_menu', 'my_plugin_menu');

function my_plugin_menu() {

 	add_options_page('My Plugin Options', 'My Plugin', 'manage_options', 'my-unique-identifier', 'my_plugin_options');

}
?>

In order for your contextual help menu to know which admin screen it should go to, it needs a way of knowing which panel you want. Fortunately, when we add our admin panel, WordPress is able to return a hook -- a unique identifier for your panel. To use this, just modify the previous function:

<?php
add_action('admin_menu', 'my_plugin_menu');

function my_plugin_menu() {

 	global $my_plugin_hook;
 	$my_plugin_hook = add_options_page('My Plugin Options', 'My Plugin', 'manage_options', 'my-unique-identifier', 'my_plugin_options');

}
?>

Notice that we have globalized the hook, because you'll need to use it later on outside of this function.

Adding The Contextual Help Function

As of WordPress 3.0, contextual help menus require three parameters to be passed to it. The first parameter, $contextual_help, will be replaced by our function with the contents of our contextual help to be outputted to the browser. The other two parameters, $screen_id and $screen are used to identify the page that we're on.

<?php
function my_plugin_help($contextual_help, $screen_id, $screen) {

	global $my_plugin_hook;
	if ($screen_id == $my_plugin_hook) {

		$contextual_help = 'This is where I would provide help to the user on how everything in my admin panel works. Formatted HTML works fine in here too.';
	}
	return $contextual_help;
}

add_filter('contextual_help', 'my_plugin_help', 10, 3);
?>

By globalizing $my_plugin_hook from earlier, you can check if it matches $screen_id. If these don't match, then the user is not viewing this admin panel, so it simply passes along the $contextual_help value to the next hooked function.

Also notice that the function has three parameters passed to it, so add 10, 3 to our add_action() call so that WordPress is aware of the extra parameters.

Other Usages

If your Administration Panel features a number of different screens during its operation (for example, you have one screen for viewing items, another for adding them, editing them, deleting them, etc.), use additional logic within this function (such as testing for values of $_POST or $_GET) to provide different versions of help for your panel. If you do this, you may want to offload your help content to a separate PHP file within your Plugin, which you can include within your help function and refer to.

It has also been noted that if you were to use object-oriented programming (OOP) in your Plugin and all of your hook functions were part of a class, you could simply make your admin panel hook be a property of your class, thus eliminating the need to globalize it twice.