Pengenalan kepada API Widgets WordPress Dashboard

Widgets WordPress Widgets API membolehkan tema dan plugin menambah, mengeluarkan atau meletakkan semula widget papan pemuka WordPress. Papan pemuka WordPress adalah perkara pertama yang kita lihat ketika kita log masuk ke skrin pentadbiran WordPress. API widget papan pemuka WordPress telah tersedia dari WordPress 2.7 dan seterusnya. Dalam tutorial ini kita akan melihat tindakan dan fungsi yang berbeza yang disediakan oleh API. Dan, bagaimana untuk menambah, mengeluarkan dan meletakkan widget papan pemuka menggunakan API ini.

Takeaways Key

• API Widgets Dashboard WordPress membolehkan tema dan plugin untuk menambah, membuang atau mengulangi semula widget pada papan pemuka WordPress. API ini telah tersedia sejak WordPress 2.7 dan merupakan alat utama untuk pemaju WordPress.
• Menambah widget melibatkan menggunakan fungsi WP_ADD_DASHBOARD_WIDGET, yang memerlukan tiga argumen: ID unik untuk widget, tajuk widget, dan panggilan balik yang memaparkan kandungan widget. Mengeluarkan widget dilakukan melalui fungsi rove_meta_box.
• Walaupun API tidak menyediakan cara untuk mengubah kedudukan widget, penyelesaian dapat dicapai dengan memanipulasi pembolehubah WordPress Core $ WP_META_BOX. Data tersuai boleh ditambah kepada widget, dan penampilan mereka boleh disesuaikan menggunakan CSS.

di belakang tempat widget papan pemuka WordPress

Secara dalaman, widget papan pemuka WordPress adalah kotak meta WordPress. Widget Dashboard API menggunakan API Kotak Meta WordPress untuk menambah, mengeluarkan dan meletakkan widget papan pemuka.

Menambah widget papan pemuka

Kami boleh menambah widget ke papan pemuka WordPress menggunakan fungsi wp_add_dashboard_widget. Kita perlu membungkus fungsi ini di dalam cangkuk wp_dashboard_setup. Berikut adalah beberapa contoh kod mengenai cara menggunakan wp_add_dashboard_widget:

<span>function add_dashboard_widget()
</span><span>{
</span><span>wp_add_dashboard_widget("sitepoint", "SitePoint Videos", "display_sitepoint_dashboard_widget");
</span><span>}
</span>
<span>function display_sitepoint_dashboard_widget()
</span><span>{
</span><span>echo "Watch Video Courses at <a href='http://learnable.com'>Learnable</a>";
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "add_dashboard_widget");</span>

Di sini, kami memanggil wp_add_dashboard_widget di dalam add_dashboard_widget, yang dicetuskan oleh cangkuk wp_dashboard_setup. wp_add_dashboard_widget mengambil tiga hujah. Berikut adalah hujah:

1. $ id: Setiap widget papan pemuka mesti mempunyai ID yang unik. Pastikan anda awalan dengan plugin atau nama tema anda untuk mengelakkan mengatasi.
2. Tajuk $: Tajuk widget yang akan dipaparkan.
3. $ callback: panggil balik yang memaparkan kandungan widget.

Begini cara widget kelihatan:

mengeluarkan widget papan pemuka

Kami boleh mengeluarkan widget papan pemuka lalai atau adat menggunakan fungsi Rove_meta_box. Kami perlu membungkus fungsi ini dalam fungsi wp_dashboard_setup. Begini cara kami menggunakan REAVE_META_BOX:

<span>function add_dashboard_widget()
</span><span>{
</span><span>wp_add_dashboard_widget("sitepoint", "SitePoint Videos", "display_sitepoint_dashboard_widget");
</span><span>}
</span>
<span>function display_sitepoint_dashboard_widget()
</span><span>{
</span><span>echo "Watch Video Courses at <a href='http://learnable.com'>Learnable</a>";
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "add_dashboard_widget");</span>

Di sini, kami memanggil fungsi Rove_meta_box di dalam fungsi Rove_Dashboard_Widget, yang memang dicetuskan oleh tindakan WP_Dashboard_Setup. membuang_meta_box mengambil tiga argumen, mereka adalah:

1. $ id: ID unik widget. Berikut adalah senarai id widget lalai: Dashboard_Activity , Dashboard_Right_now , Dashboard_Recent_Comments , , , dan . $ lokasi: Ini akan sentiasa mempunyai nilai "papan pemuka" semasa mengeluarkan papan pemuka. kedudukan $: Jika anda mengeluarkan widget yang dicipta oleh WordPress Core secara lalai, atau dibuat menggunakan wp_add_dashboard_widget maka nilainya adalah "normal".

widget kedudukan di papan pemuka

Secara lalai, widget baru ditambah ke kiri bawah halaman papan pemuka. API Widgets Dashboard WordPress tidak menyediakan cara untuk mengubah kedudukan widget. Walau bagaimanapun, kita boleh menggodam pembolehubah WordPress Core $ WP_META_BOX sebagai penyelesaian. Berikut adalah contoh bagaimana kita boleh memindahkan widget kita ke bahagian atas:

<span>function add_dashboard_widget()
</span><span>{
</span><span>wp_add_dashboard_widget("sitepoint", "SitePoint Videos", "display_sitepoint_dashboard_widget");
</span><span>}
</span>
<span>function display_sitepoint_dashboard_widget()
</span><span>{
</span><span>echo "Watch Video Courses at <a href='http://learnable.com'>Learnable</a>";
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "add_dashboard_widget");</span>

Anda boleh mengubah array ini dan menukar kedudukan widget seperti yang diperlukan.

memaparkan suapan RSS dalam widget papan pemuka

Mari buat widget papan pemuka yang mengambil suapan RSS SitePoint, kemudian memaparkannya. Kami akan menggunakan API WordPress untuk mengambil dan menghuraikan suapan RSS. Inilah kod untuk widget kami:

<span>function remove_dashboard_widget()
</span><span>{
</span><span>remove_meta_box("sitepoint", "dashboard", "normal");
</span><span>}
</span>
<span>add_action("wp_dashboard_setup", "remove_dashboard_widget");</span>

Di sini, kami termasuk fail "feed.php", yang mendedahkan semua API yang diperlukan untuk bekerja dengan RSS di WordPress. Kemudian, kami menggunakan fetch_feed untuk memuat turun dan menghuraikan suapan RSS, akhirnya kami memaparkan 10 item RSS. Berikut adalah widget papan pemuka RSS kami seperti:

Kesimpulan

Banyak plugin WordPress seperti Analytics, WooCommerce Addons dan pelbagai sambungan pemantauan menggunakan API Widgets Dashboard. API Widgets Dashboard WordPress adalah salah satu API yang paling penting untuk pemaju WordPress, dalam contoh ini kami telah membawakan anda melalui beberapa contoh asas. Sila berasa bebas untuk memberi komen mengenai pengalaman anda dengan API di bawah.

Soalan Lazim mengenai WordPress Dashboard Widgets API

Bagaimana saya boleh menambah widget baru ke papan pemuka WordPress saya?

Menambah widget baru ke papan pemuka WordPress anda adalah proses mudah. Pertama, anda perlu membuat fungsi yang mengeluarkan kandungan widget anda. Kemudian, anda perlu mendaftarkan fungsi ini dengan WordPress menggunakan fungsi wp_add_dashboard_widget. Fungsi ini mengambil tiga parameter: id widget, namanya, dan fungsi yang mengeluarkan kandungannya. Sebaik sahaja anda telah melakukan ini, widget anda akan muncul di papan pemuka anda.

Bolehkah saya mengeluarkan widget sedia ada dari papan pemuka WordPress saya? Ini boleh dilakukan dengan menggunakan fungsi Rove_meta_box. Fungsi ini mengambil tiga parameter: id widget yang anda ingin keluarkan, skrin di mana widget dipaparkan, dan konteks di mana widget dipaparkan. Widget?

Penampilan widget papan pemuka anda boleh disesuaikan menggunakan CSS. Anda boleh menambah CSS tersuai ke fail gaya.css tema anda atau gunakan plugin CSS tersuai. Anda boleh menargetkan widget khusus dengan menggunakan ID mereka sebagai pemilih CSS.

Bolehkah saya mengawal kedudukan widget papan pemuka saya? Ini boleh dilakukan dengan menggunakan cangkuk tindakan WP_DASHBOARD_SETUP. Cangkuk ini membolehkan anda menentukan kedudukan widget anda di papan pemuka.

Bagaimana saya boleh menambah data tersuai ke widget papan pemuka saya?

Anda boleh menambah data tersuai ke widget papan pemuka anda dengan membuat fungsi yang mengeluarkan data dan mendaftarkan fungsi ini dengan WordPress menggunakan fungsi wp_add_dashboard_widget. Data boleh menjadi apa sahaja yang anda mahukan, seperti statistik, graf, atau bentuk tersuai. . Ini boleh dilakukan dengan memupuk fail JavaScript yang diperlukan dan menggunakan cangkuk tindakan wp_ajax_ untuk mengendalikan permintaan ajax di sisi pelayan.

Widget papan pemuka anda interaktif dengan menggunakan JavaScript. Anda boleh memupuk fail JavaScript anda menggunakan fungsi wp_enqueue_script dan kemudian gunakan javascript untuk menambah interaktiviti ke widget anda. Tambah pelbagai contoh widget yang sama ke papan pemuka anda. Setiap widget mesti mempunyai ID yang unik, jadi jika anda ingin menambah beberapa contoh widget yang sama, anda perlu mendaftarkan setiap contoh sebagai widget berasingan dengan ID yang unik. Skrin di WordPress?

Ya, anda boleh menambah widget papan pemuka ke skrin lain di WordPress. Ini boleh dilakukan menggunakan fungsi add_meta_box. Fungsi ini membolehkan anda menambah widget ke mana -mana skrin di WordPress, bukan hanya papan pemuka. pertanyaan. Anda boleh menambah pertanyaan media ini ke fail gaya.css tema anda atau gunakan plugin CSS tersuai. Anda boleh menyasarkan widget tertentu dengan menggunakan ID mereka sebagai pemilih CSS.

Atas ialah kandungan terperinci Pengenalan kepada API Widgets WordPress Dashboard. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!