Opérationnel avec des écrans de l'aide contextuelle WordPress

Tirez parti de l'aide contextuelle intégrée de WordPress pour une documentation améliorée du plugin / thème

Les développeurs ignorent souvent la documentation complète pour leurs plugins et thèmes WordPress. Cet article explore comment utiliser efficacement les écrans de l'aide contextuelle intégrée de WordPress pour améliorer l'expérience des utilisateurs et fournir un support facilement disponible. Cette approche offre une alternative supérieure aux descriptions de répertoires de plugin clairsemées ou à des sites Web externes peu fiables.

Avantages clés de l'utilisation d'aide contextuelle:

• Expérience utilisateur améliorée: fournit une assistance immédiate et pertinente dans l'interface d'administration WordPress.
• Documentation efficace: Une méthode conviviale pour documenter les aspects cruciaux de thème / plugin.
• Accessibilité intégrée: Facilement accessible à partir de l'onglet "Aide" du tableau de bord Admin.

en utilisant la classe WP_Screen et get_current_screen()

Ajouter une aide contextuelle implique d'interagir avec la classe WP_Screen via la fonction get_current_screen(). Cette fonction identifie la page d'administration actuelle, fournissant un contexte pour un contenu d'aide ciblé.

Ajout d'onglets d'aide à toutes les zones d'administration:

Le code suivant démontre l'ajout d'onglets d'aide en utilisant à la fois le contenu en ligne et une fonction de rappel:

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>';
}

Écrans d'aide ciblés:

Pour une assistance plus ciblée, ajoutez des onglets d'aide uniquement à des pages d'administration spécifiques. Cet exemple ajoute un onglet d'aide uniquement à l'édition d'un type de message personnalisé "Book":

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

Personnalisation de la barre latérale de l'aide contextuelle:

La barre latérale de l'aide contextuelle peut être personnalisée pour afficher des informations supplémentaires. N'oubliez pas d'appeler set_help_sidebar après Ajouter des onglets d'aide:

function add_help_sidebar(){
    $current_screen = get_current_screen();
    if($current_screen->base == 'edit' || $current_screen->base == 'post'){
        $current_screen->set_help_sidebar(
            '<p>Useful links and resources here.</p>'
        );
    }
}
add_action('admin_head', 'add_help_sidebar', 11); // Higher priority to ensure it runs after tab additions.

Conclusion:

En tirant parti de l'aide contextuelle intégrée de WordPress, les développeurs peuvent améliorer considérablement l'expérience utilisateur de leurs plugins et thèmes. Cette information facilement accessible et spécifique au contexte permet aux utilisateurs et réduit la dépendance à la documentation externe. N'oubliez pas de prioriser le contenu d'aide claire, concis et pertinent pour des résultats optimaux.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!