WordPressのコンテキストヘルプ画面でアップして実行します

WordPressの組み込みコンテキストヘルプを活用して、プラグイン/テーマの拡張ドキュメント

開発者は、WordPressプラグインとテーマの包括的なドキュメントを見落としていることがよくあります。 この記事では、WordPressの組み込みのコンテキストヘルプスクリーンを効果的に利用して、ユーザーエクスペリエンスを向上させ、すぐに利用できるサポートを提供する方法について説明します。 このアプローチは、スパースプラグインディレクトリの説明または信頼できない外部Webサイトに代わる優れた代替品を提供します。

コンテキストヘルプを使用することの重要な利点：

ユーザーエクスペリエンスの改善：
• WordPress管理インターフェイス内で即時の関連する支援を提供します。 効率的なドキュメント：
重要なテーマ/プラグインの側面を文書化するユーザーフレンドリーな方法。
• ビルトインアクセシビリティ：管理ダッシュボードの「ヘルプ」タブから簡単にアクセスできます。

クラスと

を利用します

コンテキストヘルプの追加には、

関数を介してWP_Screenクラスとの対話が含まれます。この関数は、現在の管理者ページを識別し、ターゲットヘルプコンテンツのコンテキストを提供します。 すべての管理領域にヘルプタブを追加するget_current_screen()

次のコードは、インラインコンテンツとコールバック関数の両方を使用してヘルプタブを追加することを示しています：WP_Screen get_current_screen()

ターゲットヘルプスクリーン：

より多くの焦点を絞った支援については、特定の管理ページにのみヘルプタブを追加します。 この例では、カスタム投稿タイプの「本」の編集画面にのみヘルプタブを追加します：

function add_context_menu_help(){
    $current_screen = get_current_screen();

    $content = '<p>This is a sample help tab.</p>';
    $current_screen->add_help_tab( array(
        'id'      => 'my_plugin_basic_help',
        'title'   => __('Basic Help'),
        'content' => $content
    ));

    $current_screen->add_help_tab( array(
        'id'        => 'my_plugin_advanced_help',
        'title'     => __('Advanced Help'),
        'callback'  => 'my_plugin_advanced_help_callback'
    ));
}
add_action('admin_head', 'add_context_menu_help');

function my_plugin_advanced_help_callback(){
    echo '<p>More detailed help content here.</p>';
}

コンテキストヘルプサイドバーのカスタマイズ：

function add_help_screen_to_books(){
    $current_screen = get_current_screen();
    if($current_screen->post_type == 'book' && $current_screen->base == 'edit'){
        $content = '<p>Help specific to book post type.</p>';
        $current_screen->add_help_tab( array(
            'id'      => 'my_plugin_book_help',
            'title'   => __('Book Help'),
            'content' => $content
        ));
    }
}
add_action('admin_head', 'add_help_screen_to_books');

コンテキストヘルプサイドバーをカスタマイズして、追加情報を表示できます。 [ヘルプ]タブを追加した後、

を呼び出すことを忘れないでください：

set_help_sidebar結論：

WordPressの組み込みコンテキストヘルプを活用することにより、開発者はプラグインとテーマのユーザーエクスペリエンスを大幅に向上させることができます。 この容易にアクセスしやすいコンテキスト固有の情報は、ユーザーに力を与え、外部のドキュメントへの依存を減らします。 最適な結果を得るために、明確で簡潔な、関連するヘルプコンテンツに優先順位を付けることを忘れないでください。

以上がWordPressのコンテキストヘルプ画面でアップして実行しますの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。