- As is usual -

[WordPress]管理画面のヘルプをカスタマイズ

Creation date: 2012-08-15 23:24:45 +0900 JST
Updated: 2012-08-15 23:24:45 +0900 JST

Category: WordPress


管理画面をカスタマイズした際に簡単なヘルプを追加したいことがある。
ヘルプをカスタマイズする簡単なメモ。

/**
 * 管理画面のヘルプ周りのカスタマイズ
 * @param WP_Screen $screen
 */
function custom_current_screen(WP_Screen $screen) {
  switch ($screen->id) {
    case 'post': // 投稿編集画面
      // ヘルプタブのオプション
      // title : ヘルプタブに表示する文字列
      // id : タブを識別するキー
      // content: ヘルプに表示する文字列
      // callback : contentが出力されたあとに実行されたあとに実行されるコールバック関数
      // 引数は2つ
      // 1つ目が WP_Screen クラスのインスタンス
      // 2つ目が 連想配列 $help\_args で指定したもの
      // コールバック関数を指定する場合は、
      // add\_action の 第2引数 で指定する方法と同様
      $help_args = array(
        'title' => __('Custom Help'),
        'id' => 'custom-help-id',
        'content' => '<p>Custom Help</p>',
        'callback' => false,
      );
      // ヘルプタブへ追加
      $screen->add_help_tab($help_args);
      break;
    default:
      break;
  }
}
// current_screen アクションにフックする
add_action('current_screen', 'custom_current_screen');

上記のフックで処理を実行すると、下図のようにヘルプへ追加できる。