9 Kesalahan yang Harus Dihindari Saat Mengembangkan Plugin atau Tema WordPress
Diterbitkan: 2020-09-30Ingin membuat plugin atau tema WordPress? Ingatlah bahwa pengembangan plugin dan tema yang berhasil mencakup beberapa percobaan dan kesalahan. Bahkan pengembang yang paling berpengalaman terkadang mengacaukan kode mereka, dan meskipun tidak mungkin untuk menghindari kesalahan sama sekali, ada beberapa kesalahan umum yang dapat Anda hindari dengan mudah. Untuk membantu Anda, saya telah mengumpulkan sembilan kesalahan umum yang harus dihindari saat mengembangkan plugin atau tema WordPress Anda.
Kesalahan #1: Mengorbankan kualitas demi solusi cepat
Beberapa pengembang mencoba mencari jalan pintas saat mengembangkan plugin atau tema kecil. Mereka membuat kode secara tidak konsisten dan mencoba menemukan solusi termudah dan tercepat.
Namun, kenyataannya adalah tidak ada cara mudah untuk mengembangkan plugin atau tema yang canggih dan berfungsi dengan baik. Beberapa plugin dan tema dapat dikembangkan dengan relatif cepat dan mudah. Misalnya, tidak perlu banyak waktu untuk mengembangkan plugin yang menyembunyikan semua pemberitahuan admin atau plugin yang memasukkan cuplikan JavaScript. Namun, jika menyangkut plugin atau tema yang lebih kompleks, “kecurangan” atau penyalinan dapat mengakibatkan fungsionalitas yang buruk, serta menyebabkan berbagai kesalahan dan kelemahan kinerja.
Sangat penting untuk mengikuti praktik terbaik pengkodean terorganisir bahkan jika Anda hanya membuat prototipe plugin/tema. Ingat, banyak produk paling populer dimulai sebagai prototipe. Jika Anda menggunakan pendekatan "cepat & kotor", Anda akan mulai mengumpulkan utang teknis sejak hari pertama.
Mengembangkan kode yang bersih, ditulis dengan baik, dan dioptimalkan akan meningkatkan waktu pengembangan Anda sebesar 10-30%, tetapi ini pasti sepadan untuk jangka panjang. Pada akhirnya, Anda akan mendapatkan plugin atau tema yang dapat dipelihara, berkinerja baik, dan berfungsi.
Kesalahan #2: Gagal melacak perubahan kode
Gagal melacak perubahan kode adalah kesalahan umum lainnya yang harus dihindari oleh semua pengembang WordPress. Semua tema dan plugin harus dikelola di bawah kontrol versi, terlepas dari apakah Anda satu-satunya pengembang proyek atau bukan.
Semua tema dan plugin harus dikelola di bawah kontrol versi, terlepas dari apakah Anda satu-satunya pengembang proyek atau bukan.Tweet
Sistem kontrol versi membantu Anda dengan merekam dan melacak semua perubahan. Ini memungkinkan Anda dan pengembang lain untuk mengerjakan proyek yang sama saat tema atau plugin berkembang lebih lanjut. Juga, sistem kontrol versi, seperti Git, mendaftarkan semua perubahan yang dilakukan oleh masing-masing pengembang, yang sangat nyaman saat mengerjakan proyek besar. Jika Anda memilih untuk menggunakan Git, saya sarankan menggunakan GitFlow sebagai alur kerja percabangan yang sehat untuk manajemen rilis.
Kesalahan #3: Gagal menggunakan ruang nama
Namespace berguna jika Anda perlu membuat region terpisah untuk grup variabel, kelas, dan fungsi. Ini mencegah konflik plugin yang ada sebelum versi PHP 5.6 dan lebih tinggi yang tidak dapat dikontrol menggunakan ruang nama.
Berikut adalah contoh kode sumber yang menggambarkan namespace yang disebut geometri untuk JavaScript. Definisi paket ini memungkinkan cara untuk membedakan kelas Lingkaran dari kelas lain yang dapat didefinisikan oleh pemrogram lain.
namespace Geometry; class Circle { private $radius; public circle($r) { $radius = $r; } public get_radius() { return $radius; } public get_area() { return pi() * $radius * $radius; } }
Kesalahan #4: Tidak menggunakan nonces WordPress
Mengikuti praktik keamanan modern sama pentingnya dengan memastikan fungsionalitas plugin atau tema Anda. WordPress menggunakan nonces untuk memberikan beberapa tingkat perlindungan untuk memvalidasi keaslian permintaan. Nonces sangat berguna dalam mencegah serangan Cross-Site Request Forgery (CSRF).
Untuk membuat nonce, gunakan fungsi berikut.
$nonce= wp_create_nonce( 'name');
Lihat referensi kode WordPress ini jika Anda tidak terbiasa dengan nonces.
Berlangganan dan dapatkan salinan gratis dari kami
Buku Bisnis Plugin WordPress
Tepatnya bagaimana membuat bisnis plugin WordPress yang makmur dalam ekonomi berlangganan.
Berbagi dengan teman
Masukkan alamat email teman Anda. Kami hanya akan mengirim email kepada mereka buku ini, scout's honor.
Terima kasih sudah berbagi
Luar biasa - salinan 'Buku Bisnis Plugin WordPress' baru saja dikirim ke . Ingin membantu kami menyebarkan berita lebih banyak lagi? Ayo, bagikan buku ini dengan teman dan kolega Anda.
Terima kasih telah berlangganan!
- kami baru saja mengirimkan salinan 'Buku Bisnis Plugin WordPress' Anda ke .
Ada salah ketik di email Anda? klik di sini untuk mengedit alamat email dan mengirim lagi.
Berlangganan dan dapatkan salinan gratis dari kami
Buku Bisnis Plugin WordPress
Tepatnya bagaimana membuat bisnis plugin WordPress yang makmur dalam ekonomi berlangganan.
Berbagi dengan teman
Masukkan alamat email teman Anda. Kami hanya akan mengirim email kepada mereka buku ini, scout's honor.
Terima kasih sudah berbagi
Luar biasa - salinan 'Buku Bisnis Plugin WordPress' baru saja dikirim ke . Ingin membantu kami menyebarkan berita lebih banyak lagi? Ayo, bagikan buku ini dengan teman dan kolega Anda.
Terima kasih telah berlangganan!
- kami baru saja mengirimkan salinan 'Buku Bisnis Plugin WordPress' Anda ke .
Ada salah ketik di email Anda? klik di sini untuk mengedit alamat email dan mengirim lagi.
Kesalahan #5: Tidak menggunakan fungsionalitas inti WordPress
Banyak pengembang gagal memanfaatkan potensi penuh dari fungsionalitas inti WordPress yang ada. Beberapa tema dan plugin memiliki file yang sesuai dengan file inti WordPress, seperti Color Pickers dan jQuery.
Membuat file tambahan akan meningkatkan ukuran akhir dan waktu pemuatan paket. Anda harus memelihara dan memperbarui file-file ini secara teratur, yang juga membutuhkan waktu dan usaha.
Dengan memanfaatkan apa yang ditawarkan WordPress, Anda dapat membuat tema atau plugin yang lebih ringan dan fungsional.
Kesalahan #6: Mengantrekan file JavaScript dan CSS
Mengantrekan file JavaScript dan CSS saat tidak diperlukan adalah kesalahan umum lainnya. Hal ini dapat menyebabkan waktu pemuatan lebih lambat dan penurunan peringkat mesin telusur karena setiap file yang diantrekan menambahkan permintaan HTTP tambahan.
Kesalahan #7: Menempatkan kode JavaScript ke dalam satu file utama untuk tema lanjutan
Jika Anda mengembangkan tema lanjutan yang berat JavaScript, lebih baik jangan menempatkan kode JavaScript ke dalam satu file utama. Banyak pengembang memilih untuk menempatkan kode JavaScript tema WordPress ke dalam satu file utama yang disebut main.js, theme.js, atau custom.js. Ada beberapa alasan mengapa Anda tidak ingin melakukan itu. Pertama, seiring dengan bertambahnya tema Anda, ukuran file juga akan bertambah. Karena file ini akan dimuat di seluruh situs, setiap halaman akan membutuhkan waktu lebih lama untuk dimuat.
Kedua, membuat satu file akan mempersulit pengelolaan kode. Misalnya, Anda tidak akan dapat menempatkan fungsi, seperti wp_dequeue_script() untuk membongkar kode di beberapa halaman guna meningkatkan kecepatan.
Berikut adalah video yang menjelaskan sedikit lebih banyak tentang topik itu:
Perlu diingat bahwa kesalahan ini hanya relevan untuk tema lanjutan dengan struktur JavaScript yang kompleks. Jika tema Anda lebih sederhana dan lebih ringan dalam JavaScript, menempatkan kode JavaScript ke dalam file utama tidak akan merusak fungsionalitas tema Anda.
Kesalahan #8: Gagal membuat opsi tambahan untuk mengubah kode
Ketika pembaruan otomatis dilakukan pada kode secara langsung, semua perubahan kode manual akan hilang kecuali diubah melalui tindakan dan filter. Itulah mengapa sangat penting untuk mengaktifkan tindakan dan filter untuk perubahan.
Dengan cara ini, Anda dan pengembang lain dapat memodifikasi fitur tanpa mengedit plugin itu sendiri atau tema induk. Selain itu, Anda dapat menggunakan filter dan tindakan untuk menambahkan fungsionalitas tambahan seperti ekstensi atau add-on ke plugin atau tema induk.
Kesalahan #9: Gagal menggunakan praktik desain kode modern
Gagal menggunakan praktik desain kode yang benar adalah kesalahan terakhir yang menutup daftar kami. Organisasi kode yang tepat harus dipilih tergantung pada ukuran dan sifat plugin Anda.
Jika Anda berencana untuk membuat plugin tujuan tunggal kecil yang tidak memerlukan ekstensi lebih lanjut, nanti, tidak perlu menggunakan arsitektur yang rumit dengan berbagai kelas.
Jika Anda membuat ekstensi plugin yang berfungsi dengan plugin lain atau plugin yang membutuhkan banyak kode, sebaiknya gunakan pendekatan Pemrograman Berorientasi Objek (OOP). Ide utama di balik OOP adalah mengatur kode menjadi potongan-potongan, seperti kelas untuk organisasi yang lebih baik.
Juga, saya tidak merekomendasikan pencampuran kode PHP dan kode HTML bersama-sama. Lebih baik memisahkannya dengan menggunakan pola Model-View-Controller (MVC), terutama jika plugin Anda dikelola oleh beberapa pengembang.
Bawa pulang
Seperti yang telah Anda pelajari di atas, kesalahan yang paling umum biasanya tidak disengaja, tetapi dapat menyebabkan konsekuensi yang cukup mengecewakan.
Dalam review, kesalahan yang paling umum adalah:
- Mengorbankan kualitas demi solusi cepat
- Gagal melacak perubahan kode
- Gagal menggunakan ruang nama
- Tidak menggunakan nonces WordPress
- Tidak menggunakan fungsionalitas inti WordPress
- Mengantrekan file JavaScript dan CSS
- Menempatkan kode JavaScript ke dalam satu file utama untuk tema lanjutan
- Gagal membuat opsi tambahan untuk mengubah kode
- Gagal menggunakan praktik desain kode modern
Meskipun membuat kesalahan tidak bisa dihindari, sekarang Anda tahu apa itu, akan lebih mudah untuk menghindarinya.
Pernahkah Anda melakukan kesalahan lain saat membuat tema atau plugin? Silakan, bagikan pengalaman Anda di komentar di bawah dan jangan lewatkan 5 kesalahan lain yang harus dihindari ini.
Dengan kontribusi dari Alyse Falk.