This function is used to add a sidebar to the Contextual Help menu in an admin page. The sidebar appears to the right-side of the main help content.
set_help_sidebar() is a method of the WP_Screen class, and can not be called directly.
Sidebar must be registered AFTER help tabs have been added using the add_help_tab() method.
<?php
$screen = get_current_screen();
$screen->set_help_sidebar( $content );
?>
<?php
add_action('admin_menu', 'my_admin_add_page');
function my_admin_add_page() {
global $my_admin_page;
$my_admin_page = add_options_page(__('My Admin Page', 'map'), __('My Admin Page', 'map'), 'manage_options', 'map', 'my_admin_page');
// Adds my_help_tab when my_admin_page loads
add_action('load-'.$my_admin_page, 'my_admin_add_help_tab');
}
function my_admin_add_help_tab () {
global $my_admin_page;
$screen = get_current_screen();
/*
* Check if current screen is My Admin Page
* Don't add help tab if it's not
*/
if ( $screen->id != $my_admin_page )
return;
// Add my_help_tab if current screen is My Admin Page
$screen->add_help_tab( array(
'id' => 'my_help_tab',
'title' => __('My Help Tab'),
'content' => '<p>' . __( 'Descriptive content that will show in My Help Tab-body goes here.' ) . '</p>',
) );
$screen->set_help_sidebar(
__('This is the content you will be adding to the sidebar for the current page. You must make sure other tabs have already been added using the "add_help_tab" function above. This sidebar will not show up unless there are tabs for the current screen')
);
}
?>
set_help_sidebar() is located in wp-admin/includes/screen.php.