Auf dem Laufenden mit WordPress -Kontext -Hilfebildschirmen in Betrieb

Nutzen Sie die integrierte kontextbezogene Hilfe von WordPress für erweiterte Plugin/Themendokumentation

Entwickler übersehen häufig eine umfassende Dokumentation für ihre WordPress -Plugins und Themen. In diesem Artikel wird untersucht, wie die integrierten Kontextbildschirme von WordPress effektiv verwendet werden, um die Benutzererfahrung zu verbessern und leicht verfügbare Unterstützung zu bieten. Dieser Ansatz bietet eine überlegene Alternative zu Sparse Plugin -Verzeichnisbeschreibungen oder unzuverlässigen externen Websites.

wichtige Vorteile der Verwendung kontextbezogener Hilfe:

• Verbesserte Benutzererfahrung: bietet eine sofortige, relevante Unterstützung in der WordPress -Administratorschnittstelle.
• Effiziente Dokumentation: Eine benutzerfreundliche Methode, um wichtige Themen/Plugin-Aspekte zu dokumentieren.
• integrierte Barrierefreiheit: leicht zugänglich auf der Registerkarte "Help" des Administrator Dashboards.

unter Verwendung der WP_Screen Klasse und get_current_screen()

Hinzufügen von kontextbezogenen Hilfe beinhaltet die Interaktion mit der WP_Screen -Klasse über die get_current_screen() -Funktion. Diese Funktion identifiziert die aktuelle Administratorseite und bietet einen Kontext für gezielte Hilfeinhalt.

Hinzufügen von Registerkarten für Hilfe zu allen Verwaltungsbereichen:

Der folgende Code zeigt, dass das Hinzufügen von Registerkarten von Hilfe sowohl mit Inline -Inhalt als auch eine Rückruffunktion hinzugefügt wird:

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

Ziele Hilfe -Screens:

Für fokussiertere Hilfe fügen Sie die Registerkarte Hilfe nur zu bestimmten Administratorseiten hinzu. Dieses Beispiel fügt dem Bildschirm eines benutzerdefinierten Beitragstyps "Buch" eine Registerkarte "Hilfe" nur hinzu:

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

Anpassen der Kontexthilfe -Seitenleiste:

Die Seitenleiste der Kontexthilfe kann so angepasst werden, dass zusätzliche Informationen angezeigt werden. Denken Sie daran, set_help_sidebar nach Registerkarten zu Hilfe hinzuzufügen:

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.

Schlussfolgerung:

Durch die Nutzung der integrierten kontextuellen Hilfe von WordPress können Entwickler die Benutzererfahrung ihrer Plugins und Themen erheblich verbessern. Diese leicht zugängliche, kontextspezifische Informationen ermöglichen Benutzern und verringern die Abhängigkeit von externen Dokumentationen. Denken Sie daran, klare, präzise und relevante Hilfeinhalte für optimale Ergebnisse zu priorisieren.

Das obige ist der detaillierte Inhalt vonAuf dem Laufenden mit WordPress -Kontext -Hilfebildschirmen in Betrieb. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!