Dalam tutorial kali akan dijelas tentang dua hal, 1) penamaan plugin dan 2) hal-hal yang harus diperhatikan saat mengembangkan plugin.
Penamaan Plugin
Bagaimana seharusnya plugin wordpress dinamakan itu tergantung dari si pembuat. Namun, ada baiknya mengikuti saran berikut:
- Nama harus jelas, tidak merupakan singkatan/akronim kecuali akronim yang jamak di dunia maya.
- Nama sebisa mungkin mendekati fitur utama yang disuguhkan. Misalnya plugin tentang SEO, jangan dinamakan dengan Plugin HTMLku atau yang lain. Namailah dengan nama berbau SEO.
- Tidak menggunakan kata-kata muluk-muluk seperti, “Terbaik”, “Tercanggih”, “Awesome” dll.
- Tidak menggunakan kata-kata ‘WordPress’ maupun ‘WP’ untuk menghindari akibat hukum dari hak cipta dan merk WordPress dan WP dengan pihak Automattic.
- Tidak mengandung banyak karakter angka atau tanda baca.
- Jangan menonjolkan nama diri atau nama perusahaan jika itu plugin Open Source. Bilapun mencantumkan nama diri atau nama perusahaan, sebaiknya tidak terlalu panjang.
- Tidak menggunakan nama plugin yang telah ada, walaupun dengan kata-kata ‘extended’, ‘reloaded’ dan lain-lain. Anda bisa mengeceknya di repositori plugin ataupun di Google.
- Tidak menggunakan trademark terdaftar apapun, kecuali anda punya ijin.
Hal yang harus Diperhatikan
Berikut hal-hal yang harus anda perhatikan saat mengembangkan plugin, hal-hal ini teknis seputar pengembangan plugin yang besar:
- Gunakan folder, sekalipun plugin anda hanya ditulis dalam satu file.
- Namai file PHP dengan nama yang mendekati nama plugin anda. Misalnya, plugin SMS Gateway, nama filenya smsgateway.php.
- Tambahkan awalan (prefix) disetiap fungsi yang anda tulis.
- Tulis dokumentasi fungsi, nama singkatnya, deskripsinya, parameternya, returnnya, penulisnya dsb.
- Atur file-file plugin dengan baik, yang patut dicatat: harus ada file plugin utama (yang berisi header plugin) dan satu file uninstall. Anda bisa menggunakan pola MCV atau MVC dalam pengaturan file ini.
- Gunakan OOP (object oriented programming) jika plugin anda termasuk plugin yang cukup besar.
- Jika plugin anda termasuk plugin premium (berbayar), cantumkan lisensi plugin anda ditiap file.
- Jika memang dibutuhkan enkripsi file PHP, enkripsilah hanya pada bagian utama plugin anda. (khusus plugin Premium).
- Cantumkan source atau penulis Class/Library yang anda pakai (jika terdapat library dari pihak lain)
- Kembangkan plugin framework, jika anda bekerja dengan banyak situs dengan fungsi-fungsi plugin yang hampir sama. Sehingga anda cukup mengembangkan satu plugin utama milik anda dan plugin lain yang lebih spesifik memperluas kemampuan plugin anda. Hal ini berguna jika anda menjadi pengembang plugin dengan jumlah plugin yang harus diselesaikan banyak.
Contoh struktur folder yang bisa anda tiru:
/unique - plugin - name — (no spaces or special characters) unique - plugin - name.php — Primary plugin PHP fi le uninstall.php — The uninstall fi le for your plugin /js — Folder for JavaScript fi les /css — Folder for stylesheet fi les /includes — Folder for other PHP includes /images — Folder for plugin images
Selamat berjumpa dihalaman ke-3 tentang Header file Plugin WordPress.