Edit dashboard’s help tab

by

The documentation in the Codex seems outdated.

Use the following code (see comments):

// Priority 5 allows the removal of default tabs and insertion of other plugin's tabs 
add_filter( 'contextual_help', 'wpse_77308_products_help', 5, 3 );

function wpse_77308_products_help( $old_help, $screen_id, $screen )
{
    // Not our screen, exit earlier
    // Adjust for your correct screen_id, see plugin recommendation bellow
    if( 'edit-magazine' != $screen_id )
        return;

    // Remove default tabs
    $screen->remove_help_tabs();

    // Add one help tab
    // For new ones: duplicate this, change id's and create custom callbacks
    $screen->add_help_tab( array(
        'id'      => 'products-help',
        'title'   => 'Products',
        'content' => '', // left empty on purpose, we use the callback bellow
        'callback' => 'wpse_77308_print_help'
    ));

    // This sets the sidebar, which is common for all tabs of this screen
    get_current_screen()->set_help_sidebar(
        '<p><strong>' . __('For more information:') . '</strong></p>' .
        '<p>' . __('<a href="http://wordpress.stackexchange.com/" title="WordPress StackExchange" target="_blank">WordPress Answers</a>') . '</p>' .
        '<p>' . __('<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
    );

    return $old_help;
}


function wpse_77308_print_help()
{
    echo '
        <p>Products show the details of the items that we sell on the website. 
        You can see a list of them on this page in reverse chronological order 
        - the latest one we added is first.</p> 

        <p>You can view/edit the details of each product
        by clicking on its name, or you can perform bulk actions 
        using the dropdown menu and selecting multiple items.</p>
    ';
}

Result:

cpt help tab

To get the right $screen_id, use the plugin Current Admin Info, born from two great Stack contributors (kaiser and Stephen Harris).

Displays info about the current admin screen and its globals,
contextual hooks, etc.

The info appears in new tabs in the »Contextual Help«-panel in the
upper right corner of an admin screen.

Leave a Comment