Dan berlari dengan skrin bantuan kontekstual WordPress

memanfaatkan bantuan kontekstual terbina dalam WordPress untuk dokumentasi plugin/tema yang dipertingkatkan

Pemaju sering mengabaikan dokumentasi komprehensif untuk plugin dan tema WordPress mereka. Artikel ini meneroka cara menggunakan skrin bantuan kontekstual terbina dalam WordPress untuk meningkatkan pengalaman pengguna dan memberikan sokongan yang sedia ada. Pendekatan ini menawarkan alternatif yang unggul untuk penerangan direktori plugin jarang atau laman web luaran yang tidak boleh dipercayai.

Kelebihan Utama Menggunakan Bantuan Kontekstual:

• Pengalaman pengguna yang lebih baik: menyediakan bantuan segera dan relevan dalam antara muka admin WordPress.
• Dokumentasi yang cekap: Kaedah mesra pengguna untuk mendokumentasikan aspek tema/plugin penting.
• kebolehcapaian terbina dalam: mudah diakses dari tab "bantuan" papan pemuka admin.

menggunakan kelas

dan

WP_Screen get_current_screen() Menambah bantuan kontekstual melibatkan berinteraksi dengan kelas

melalui fungsi

. Fungsi ini mengenal pasti halaman admin semasa, menyediakan konteks untuk kandungan bantuan yang disasarkan. WP_Screen get_current_screen()

Menambah tab Bantuan ke semua kawasan admin:

Kod berikut menunjukkan menambah tab bantuan menggunakan kedua -dua kandungan sebaris dan fungsi panggil balik:

Skrin Bantuan Sasaran:

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

Untuk bantuan yang lebih fokus, tambahkan tab bantuan hanya untuk halaman admin tertentu. Contoh ini menambah tab Bantuan hanya ke skrin edit jenis post "Buku":

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

Menyesuaikan sidebar bantuan kontekstual:

Sidebar Bantuan Kontekstual boleh disesuaikan untuk memaparkan maklumat tambahan. Ingatlah untuk memanggil selepas

menambahkan tab bantuan:

set_help_sidebar

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.

Kesimpulan:

Dengan memanfaatkan bantuan kontekstual terbina dalam WordPress, pemaju dapat meningkatkan pengalaman pengguna plugin dan tema mereka. Maklumat khusus yang mudah diakses dan konteks ini memberi kuasa kepada pengguna dan mengurangkan pergantungan pada dokumentasi luaran. Ingatlah untuk mengutamakan kandungan bantuan yang jelas, ringkas, dan relevan untuk hasil yang optimum.

Atas ialah kandungan terperinci Dan berlari dengan skrin bantuan kontekstual WordPress. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!