カスタムタブナビゲーションの登録
開発者は、ユーザーが新しいタブにアクセスできるようにナビゲーション要素を作成する必要があります。これは、タブキーとそのラベルの関連配列であるsite_health_navigation_tabs
フィルターを使用して行います。
<?php
function wporg_example_site_health_navigation_tabs( $tabs ) {
// translators: Tab heading for Site Health navigation.
$tabs['example-site-health-tab'] = esc_html_x( 'My New Tab', 'Site Health', 'text-domain' );
return $tabs;
}
add_filter( 'site_health_navigation_tabs', 'wporg_example_site_health_navigation_tabs' );
上記の例では、example-site-health-tab
という識別子をMy New Tab
というラベルと共に、サイトヘルス画面にあるヘッダーナビゲーションに追加します。
このフィルターを使用して、最初に表示されるタブの順序を変更したり、タブを削除したりすることも可能です。デフォルトでは、コアにはStatus
とInfo
の2つのタブがあります。Status
画面はデフォルトであり、したがってスラッグはありません。
ナビゲーションエリアを過負荷にしないために、4つ以上のアイテムが追加されると、最初の3つのみが直接表示され、残りのアイテムはサブナビゲーション内にラップされます。これは、ヘルスチェックプラグインでの使用テストに基づいており、4つのアイテムがほとんどのユースケースをカバーするのに十分であることが示されていますが、混乱を招くほど多くはありません。
カスタムタブのコンテンツの表示
ユーザーがデフォルト画面以外のサイトヘルスタブを訪れると、site_health_tab_content
アクションがトリガーされます。このアクションには、前のフィルターで定義されたタブナビゲーションによって定義されたスラッグという単一の引数が含まれており、開発者がどのページがリクエストされているかを特定するのに役立ちます。
アクションはヘッダー自体が読み込まれた後に発火しますが、ラッパーは含まれていません。これにより、開発者としては、画面の全幅(管理メニューを除く)を使用できます。
<?php
function wporg_example_site_health_tab_content( $tab ) {
// Do nothing if this is not our tab.
if ( 'example-site-health-tab' !== $tab ) {
return;
}
// Include the interface, kept in a separate file just to differentiate code from views.
include trailingslashit( plugin_dir_path( __FILE__ ) ) . 'views/site-health-tab.php';
}
add_action( 'site_health_tab_content', 'wporg_example_site_health_tab_content' );
上記の例では、プラグインからタブコンテンツを含むファイルを読み込みますが、これはタブが前の例で定義されたタブキー(またはスラッグ)と一致する場合のみです。
この方法で任意のタブに出力を提供することが可能であり、他のタブ(自分のタブではない)に対しても可能です。たとえば、相互にやり取りする場合です。
別の例として、スラッグがdebug
であるデフォルトのInfo
タブを拡張し、特定の情報をコピーするボタンを追加することが考えられます。これは、あなたのプラグインまたはテーマにのみ特有の情報です:
<?php
function wporg_add_button_to_site_health_info_tab( $tab ) {
// Do nothing if this is not the "debug" tab.
if ( 'debug' !== $tab ) {
return;
}
?>
<button class="copy-my-plugin-info">
<?php esc_html_e( 'Click to copy plugin info', 'text-domain' ); ?>
</button>
<?php
}
add_action( 'site_health_tab_content', 'wporg_add_button_to_site_health_info_tab' );