Sebagai pengembang WordPress, kami memiliki tanggung jawab untuk membuat plugin yang bermanfaat bagi pengguna kami tidak hanya dengan fungsionalitas yang ditambahkan plugin kami. Plugin kami juga harus menghindari memuat sumber daya yang tidak perlu, tidak memperlambat backend dan harus mudah digunakan, seperti plugin boilerplate WPPB.
Ingat, ekosistem WordPress berkembang biak pada kode sumber terbuka dan pengembang membangun plugin satu sama lain. Ini adalah semangat open source untuk berkolaborasi dan membuat kode yang lebih baik bersama-sama. Tetapi kami juga membutuhkan kerangka kerja untuk bekerja sama secara efektif. Karenanya, Automattic menggunakan pedoman ketat saat menerima plugin ke dalam repositori mereka (hal yang sama berlaku untuk tema).
Untungnya, ada developer seperti Tom McFarlin dan Devin Vinson. Mereka membuat plugin boilerplate WPPB, yang dimaksudkan untuk membuat pembuatan plugin WordPress lebih mudah.
Mengapa menggunakan Plugin Boilerplate seperti WPPB Boilerplate?
Pertama-tama, mari kita bahas tentang mengapa Anda harus mempertimbangkan menggunakan boilerplate dalam alur kerja pengembangan Anda.
Ada beberapa situasi di mana penggunaan boilerplate WPPB masuk akal:
- Anda membuat plugin dari awal dengan tim pengembang
- Plugin ini dimaksudkan untuk dipublikasikan di repositori plugin WP
- Plugin Anda akan menjadi wajib dalam bisnis klien Anda dan harus dapat diandalkan serta stabil
- Anda ingin belajar tentang standar pengkodean dan praktik terbaik WordPress
Mari kita uraikan alasan tersebut satu per satu :
Pertama : Anda membuat plugin dari awal, dengan tim pengembangan.
Setiap kali ada beberapa pengembang yang mengerjakan basis kode yang sama, tantangan muncul yang jarang dihadapi oleh satu pengembang. Anda perlu memastikan bahwa :
- Semua orang memahami struktur file.
- Tujuan setiap file dan kelas jelas.
- Fungsi didokumentasikan dengan baik
- Pengembang memahami di mana menempatkan action, callback, dll.
- Proses mendorong perubahan ke sistem live dan sistem langsung Anda jelas.
Sebagai pengembang tunggal, Anda biasanya tidak terlalu khawatir tentang hal-hal ini. Anda adalah satu-satunya yang mengerjakan plugin, jadi strukturnya tetap milik Anda. Tetapi dengan banyak pengembang, Anda perlu memastikan bahwa pengembang A memahami mengapa pengembang B menulis kode sebagaimana adanya.
Boilerplate WPPB membantu menghindari kebingungan, karena menempatkan semua orang di halaman yang sama.
Kedua : Plugin Ditujukan untuk Diterbitkan di Repositori Plugin WP
Seperti yang dikatakan sebelumnya, Automattic memberlakukan pedoman ketat untuk plugin yang diterima di repositori WP. Menggunakan boilerplate WPPB membuatnya lebih mudah untuk mengikuti pedoman tersebut, karena kode sudah ditulis mengikuti standar pengkodean dan standar dokumentasi. Jadi, Anda menghemat waktu menjelajahi kodeks WordPress dan dapat langsung bekerja, sambil mengikuti struktur yang diberikan dalam boilerplate.
Selain itu, file sudah diatur seperti yang diperlukan oleh repositori plugin. Struktur file menunjukkan dengan jelas, file mana yang pergi ke mana dan menghilangkan semua tebakan.
Ketiga : Bisnis Klien Anda Akan Mengandalkan Plugin Anda
Meskipun mengembangkan plugin yang stabil dan andal harus selalu menjadi tujuan, ada situasi di mana Anda ingin plugin Anda menjadi kokoh. Jika plugin Anda melakukan tindakan yang tidak merugikan bisnis klien Anda, basis kode Anda harus stabil, efisien, dan mudah dipelihara.
Dengan menggunakan plugin boilerplate sebagai fondasinya, Anda akan menemukan bahwa mengerjakan kode Anda semakin mudah semakin Anda terbiasa dengan struktur boilerplate. Tanpa struktur tetap itu, mudah untuk – secara tidak sadar – membuat struktur plugin baru untuk setiap proyek yang Anda kerjakan. Itu akan sangat menyulitkan untuk mengerjakan kode yang belum Anda sentuh dalam 6-12 bulan.
Keempat : Anda Ingin Mempelajari Standar Pengkodean dan Praktik Terbaik WordPress
Untuk menjadi pengembang yang lebih baik, Anda harus terus mempelajari hal-hal baru dan beradaptasi dengan praktik terbaik. Salah satu cara tercepat untuk membiasakan diri dengan standar pengkodean WordPress adalah dengan memperluas plugin yang sudah menerapkannya. WPPB membuat ini sangat nyaman. Anda dapat mengkloning salah satu plugin contoh dan mulai belajar.
Anda akan segera memahami mengapa mereka dibuat sebagaimana adanya dan bagaimana Anda dapat menambahkan fungsi khusus Anda padanya.
Siapkan instalasi lokal dan telusuri kode plugin contoh.
Memulai dengan Plugin Baru Anda menggunakan WPPB Boilerplate untuk WordPress
Cukup teorinya, mari selami penggunaan WPPB.
Untuk posting ini, saya anggap Anda telah menginstal situs lokal sebagai lingkungan pengembangan. Menginstal Git di komputer Anda akan sangat membantu, tetapi itu tidak wajib.
Langkah pertama adalah menuju ke WPPB.me.
Generator ini memungkinkan Anda untuk mengisi detail plugin sejak awal. Penghemat waktu yang bagus.
Karena boilerplate WPPB hadir dengan banyak tempat yang mereferensikan nama plugin, slug, nama penulis, dll., Sebaiknya gunakan generator WPPB.me saat mengunduh file. Anda dapat mengkloning repositori WPPB Github, tapi itu akan membuat semua pencarian + ganti bekerja untuk Anda.
Untuk contoh ini, kami akan menggunakan detail berikut :
Setelah Anda mengklik “Build Plugin”, browser Anda akan mendownload arsip zip yang kemudian dapat Anda instal di situs lokal Anda. Untuk itu, Anda dapat menggunakan penginstal plugin biasa atau unzip arsip dan menempatkannya di wp-content / plugins. Setelah mengaktifkan plugin, Anda akan melihatnya muncul di daftar Plugin Anda.
Memahami Struktur Boilerplate Plugin WordPress
Oke, proses pembuatan dan penginstalan plugin tidak terlalu menarik, tetapi diperlukan sebagai permulaan. Untuk benar-benar mulai mengembangkan plugin, mari kita lihat struktur filenya.
Seperti yang Anda harapkan, file diatur dengan sangat baik.
Folder “admin” berisi logika dan UI yang dimuat di area WP-Admin situs web. Setiap pengembang yang melihat plugin ini segera mengerti itu.
Folder “includes” berisi inti dari plugin, di sini Anda akan menempatkan sebagian besar fungsinya. Sebagai contoh, Anda dapat memperluas class-my-plugin-activator.php untuk menyiapkan tabel database kustom, tugas wp-cron kustom, atau untuk memeriksa plugin dan dependensi lain. Di dalam class-my-plugin-deactivator.php, Anda dapat membersihkan situs web saat plugin Anda dinonaktifkan.
Mengikuti Standar Internasionalisasi, class-my-plugin-i18n.php memuat domain teks plugin.
Apa pun file plugin yang Anda lihat, Anda akan menemukan bahwa kode tersebut didokumentasikan dengan sangat baik.
Di tangkapan layar, Anda dapat melihat file inti untuk plugin baru Anda, yang bagi saya merupakan titik awal yang ideal untuk memahami cara kerja logika plugin. Setiap kali Anda menemukan string “my-plugin” atau “My_Plugin”, ingatlah bahwa saya menyetelnya di generator. Itulah mengapa saya lebih suka membuat boilerplate daripada hanya mengkloning repo Github. Tanpa generator, Anda harus memeriksa semua file plugin dan menyesuaikan string tersebut agar cocok dengan nama plugin Anda.
Mari kita bahas secara singkat struktur file untuk aset seperti file JS atau CSS.
Untuk menghilangkan semua dugaan dari pengembangan, WPPB diatur dalam folder terpisah untuk CSS, JS, dan parsial. Seperti yang Anda harapkan, class-my-plugin-public.php bertanggung jawab untuk mengantrekan CSS dan JS dengan benar dan memuat parsial sesuai kebutuhan. Saat Anda membuka file, Anda akan melihat bahwa file tersebut menggunakan wp_enqueue_script, wp_enqueue_style, dan wp.
Jika Anda tidak terbiasa bekerja dengan parsial, saya sarankan Anda membaca dokumentasi File Template. “Sebagian template adalah bagian dari template yang disertakan sebagai bagian dari template lain, seperti header situs. Parsial template dapat disematkan di beberapa template, menyederhanakan pembuatan tema. ” – Dokumentasi WordPress
Sementara dokumentasi berbicara tentang pembuatan tema, Anda jelas dapat menyertakan sebagian di plugin juga, baik di backend dan frontend. Untuk frontend, cara yang layak untuk menggunakan sebagian mungkin dengan menyematkannya dalam kode pendek. Di backend, Anda mungkin ingin menggunakan sebagian di halaman admin plugin Anda (yang akan kita bahas di artikel ini).
Jelas, file sekarang hampir kosong dan hanya logika paling mendasar yang ada. Ini bagus untuk memulai plugin baru dari awal, tetapi mungkin tidak ideal untuk mempelajari cara kerja kode boilerplate. Untuk belajar, saya sarankan Anda menginstal Plugin Demo WPPB dan membiasakan diri dengannya.
Contoh : Menyiapkan Halaman Opsi di Backend
Seperti yang Anda lihat setelah mengaktifkan Plugin Demo WPPB, ada halaman opsi baru di menu “Plugin”.
Untuk memeriksa bagaimana halaman ini ditambahkan, mari kita lihat kode pluginnya.
Mencari tempat di mana halaman “Opsi Demo WPPB” ditambahkan. Sederhana, kita harus melihat folder “admin”. Berdasarkan struktur folder, tidak ada tempat lain untuk meletakkan kode yang dimuat di area WP-Admin.
File baru ini menangani konten yang ditampilkan di halaman admin. Anda dapat memeriksa logikanya dan Anda akan melihat bahwa ia mampu:
- Menampilkan header, konten, atau footer
- Menyimpan tautan ke profil sosial
- Ada juga contoh untuk menangani input
Silakan lihat fungsi-fungsi ini sebagaimana adanya contohnya, jangan berharap mereka terintegrasi secara mendalam ke dalam tema apa pun yang Anda gunakan. Ini dimaksudkan untuk menjelaskan bagaimana Anda dapat membangun fungsi serupa dengan plugin baru Anda. Memuat konten berlangsung di class-wppb-demo-plugin-admin.php, di fungsi load_dependencies () di baris 70.
Tentu saja, sepenuhnya terserah Anda jika Anda menambahkan setelan plugin sebagai item di menu “Plugin”, sebagai item menu utama, atau halaman Opsi. Anda bisa mengubah implementasinya kapan saja, dengan memodifikasi fungsi setup_plugin_options_menu () di baris 55 class-wppb-demo-plugin-settings.php.
Namun, saya sarankan Anda fokus pada UX backend. Tidak selalu merupakan ide yang baik untuk mengacaukan menu WP-Admin dengan halaman menu, hanya karena menurut Anda plugin Anda lebih penting daripada plugin lain.
Kesimpulan tentang Plugin Boilerplate WPPB untuk WordPress
Bagi saya, plugin boilerplate WPPB adalah fondasi yang fantastis untuk membuat plugin WordPress dari awal.
Saya pikir itu sesuai dengan proyek yang :
- Mewajibkan beberapa pengembang mengerjakan plugin baru
- Rencanakan untuk mengirimkan plugin ke repositori plugin WordPress
- Ingin membangun basis kode yang andal dan dapat dipelihara
- Dimaksudkan untuk membiasakan pengembang dengan standar pengkodean WordPress
Plugin boilerplate WPPB juga bisa berlebihan, terutama jika Anda :
- Ingin membuat plugin MVP untuk memvalidasi ide
- Butuh perbaikan sementara untuk masalah sederhana
Perlu diingat, bahwa developer yang bekerja dengan kode untuk pertama kali harus membiasakan diri dengan boilerplate. Setelah mereka mengetahui boilerplate WPPB, mereka akan berada dalam posisi yang baik untuk membuat plugin yang mengikuti standar pengkodean dan dokumentasi WordPress.
Semoga bermanfaat…
