WordPressの管理画面を見ていると、上部に「ヘルプ」というタブが出てくることがあります。

別件の調べ物をしていた時にこれの出し方についてのドキュメントを見つけたので、覚書としてまとめました。

add_help_tab()関数

add_help_tab()を利用します。

これはWP_Screenクラス内のメソッドなので、以下のように使用します。

get_current_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>',
) );

追加した管理画面に表示させる

そしてこれを追加したいwp-admin内のページで実行する必要がありますので、以下のようにします。

add_action('admin_menu', 'my_admin_add_page');

// オプションページの追加と、ヘルプタブを追加するアクションフックの登録を実行します。
function my_admin_add_page() {
    $my_admin_page = add_options_page(__('My Admin Page', 'map'), __('My Admin Page', 'map'), 'manage_options', 'map', 'my_admin_page');
    add_action('load-'.$my_admin_page, 'my_admin_add_help_tab');
}

// オプションページに表示するコンテンツをここに書きます。
function my_admin_page() {
    echo esc_html( 'hoge' );
}

// ヘルプタブのコンテンツを追加します。
function my_admin_add_help_tab () {
    get_current_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>',
    ) );
}

その他

Codexの方にクラスで使用する方法なども載っています。

コアの方でよく使われている様子なので、細かい設定とかはその辺を参考にすると良さそうです。