Panduan Lengkap Upload Plugin WordPress ke WordPress.org

Pada kesempatan kali ini kita akan membahas mengenai cara untuk upload plugin wordpress ke direktori wordpress.org

Proses upload plugin ini tidak mudah dan terdapat beberapa langkah yang perlu ditempuh, selain itu terdapat beberapa hal penting yang perlu menjadi perhatian.

Daftar Isi:

I. Hal Penting Yang Perlu Diperhatikan Sebelum Upload Plugin WordPress ke WordPress.org

Beberapa hal penting perlu diperhatikan sebelum mengupload plugin ke direktori wordpress.org:

1. Pastikan semua code telah menggunakan prefix yang unik, baik variabel, constant, fungsi, dll, misal fungsi  aph_get_post(), pada contoh tersebut saya menggunakan prefix aph_

   Hal ini disamping menghindari konflik dengan plugin lain, juga akan mempercepat proses moderasi yang nanti akan dilakukan oleh tim wordpress

2. Hindari penggunaan shorthand  <?= karena tidak semua server mendukung fungsi tersebut, disamping itu, penggunaan fungsi ini juga akan membuat kita mendapat peringatan dari tim wordpress.
3. Pastikan nama file php plugin sudah sesuai standard yang ditetapkan wordpress. Meskipun kita bebas menentukan nama file, untuk keseragaman, sebaiknya ikuti standar yaitu sama dengan nama plugin itu sendiri, misal saya membuat plugin APH Prism Highlighter, maka file php plugin adalah aph-prism-highlighter.php
   
   Penting: sekali nama file ini digunakan, maka tidak akan bisa diubah, sehingga perhatikan baik baik

Persiapan file readme.txt dan nama-plugin.php

Selanjutnya penting untuk memperhatikan struktur file readme.txt  dan file php dari plugin tersebut, pada contoh ini aph-prism-highlighter.php, karena informasi kedua file ini akan ditampilkan pada direktori plugin wordpress.

File readme.txt

Isi dan format file readme.txt  dapat dilihat pada website resmi wordpress: completed readme.txt, contoh untuk file readme.txt yang saya gunakan bisa dilihat disini.

Isi file ini nantinya akan ditampilkan pada halaman plugin kita pada wordpress.org, tampilannya akan seperti ini:

Detail plugin

Hasil pada  https://wordpress.org/plugins/search.php?q=APH+PRISM atau menu Plugins > Add New kemudian search APH PRISM

Deskripsi plugin

Hasil pada alamat:  https://wordpress.org/plugins/aph-prism-highlighter/

Untuk screenshot, kita bahas di bagian bawah

File nama-plugin.php

Blok komentar pada file plugin, pada contoh ini aph-prism-highlighter.php akan ditampilkan pada halaman Admin Plugins (Plugins > Installed Plugins) dan halaman plugin kita pada web wordpress

File aph-prism-highlighter.php

Halaman Admin Plugins (Plugins > Installed Plugins)

Halaman plugin pada web wordpress:  https://wordpress.org/plugins/aph-prism-highlighter/

II. Daftarkan Plugin ke WordPress

Setelah persiapan selesai, selanjutnya kita daftarkan plugin tersebut ke wordpress.org melalui link: Requests – WordPress Plugins  kemudian isikan parameter yang ada, contoh seperti gambar berikut

Beberapa isian parameter:

1. Plugin Name (required). Isikan nama plugin yang ingin didaftarkan, contoh saya mengisikan nama APH Prism Highlighter, nantinya nama file ini akan menjadi url dari plugin kita:  https://wordpress.org/plugins/aph-prism-highlighter/
2. Plugin Description (required). Isikan deskripsi dari plugin, bisa diambilkan dari file readme.txt bagian description dan features
3. Plugin URL. kompres file plugin kita menjadi file zip dan upload ke tempat tertentu sehingga dapat di download oleh tim wordpress untuk direview, pada contoh ini saya upload di jagowebdev.com

Selanjutnya klik Send Post.

Tim wordpress akan mereview code file-file plugin kita, jika ada masalah maka kita akan diberitahu via email untuk memperbaiki file tersebut,  dan jika plugin  telah disetujui, maka kita juga akan diberitahu via email

OLEH KARENA ITU,  perhatikan selalu email yang kita gunakan untuk login ketika mendaftarkan plugin tersebut.

Proses review ini bisa berlangsung antara 1 hingga 3 hari, rata-rata 2 hari, jadi ditunggu saja.

III.  Install Subversion (SVN) Client

Jika plugin kita disetujui, maka tidak serta merta plugin kita bisa muncul pada direktori wordpres.org. File .zip yang kita upload tadi hanya digunakan oleh tim wordpress untuk mereview code kita

Agar dapat muncul di direktori plugin wordpress.org, kita harus mengupload file plugin tersebut ke direktori tertentu pada wordpress.org

Alamat direktori ini akan diberitahu via email setelah plugin kita disetujui, biasanya sesuai dengan nama plugin kita, pada contoh ini, saya mendapatkan alamat svn: https://plugins.svn.wordpress.org/aph-prism-highlighter/

Apache Subversion

WordPress menggunakan version control untuk memanage semua plugin yang ada di dalam direktori wordpress.org, adapun version control yang digunakan adalah subversion  yang dikembangkan oleh apache.

Untuk dapat menggunakan subversion ini, kita perlu untuk menginstall Apache Subversion client. Ada terdapat banyak subversion client, yang paling populer digunakan adalah TortoiseSVN, sobat dapat mendownloadnya disini, selanjutnya install dengan mengikuti wizard yang ada.

IV. Perhatikan Penulisan Pesan Perubahan Ketika Menjalankan SVN Commit

Setelah berhasil menginstall TortoiseSVN, kedepan, dengan aplikasi ini kita akan banyak berinteraksi dengan direktori SVN kita yang ada di WordPress.org.

Salah satunya adalah mensinkronisasi / mengupdate direktori SVN tersebut agar sesuai dengan direktori lokal, adapun perintah yang kita gunakan adalah SVN Commit.

Ketika menjalankan perintah ini, maka kita akan diminta memberikan catatan/message mengenai perubahan yang terjadi misal seperti: adding plugin files for the first time to the trunk directory, add screenshot, dll

V. Upload File Plugin Menggunakan  TortoiseSVN

Selanjutnya kita perlu untuk membuat direktori pada komputer lokal yang nantinya akan SELALU  kita gunakan untuk sinkronisasi dengan direktori svn kita pada wordpress.org

1 Buat direktori plugin

Agar terorganisir, buat folder khusus yang berisi file plugin kita, pada contoh ini saya membuatnya pada direktori E:\Wordpress\Plugin Projects\aph-prism-highlighter

Kenapa kita tidak langsung saja menggunakan direktori plugin kita yang ada di wordpress lokal yang kita gunakan yang ada di direktori plugins (wp-content\plugins\aph-prism-highlighter)?

Kita tidak melakukannya karena nantinya ketika menggunakan svn,  akan banyak direktori yang kita buat,  sehingga akan mengacaukan plugin kita, untuk itu kita harus membuatnya pada direktori tersendiri.

2 Sinkronkan direktori lokal dengan direktori remote

Selanjutnya kita sinkronisasikan direktori yang telah kita buat tadi dengan direktori plugin kita yang ada di SVN WordPress, caranya:

1. Klik kanan pada direktori tersebut kemudian pilih SVN Checkout

   

   Setiap kali kita ingin mengcopy semua isi direktori dari SVN wordpress ke komputer lokal, kita gunakan perintah SVN Checkout
2. Selanjutnya, pada jendela Checkout, bagian URL of repository: isikan alamat sesuai yang telah kita terima dari tim wordpress via email, pada contoh ini alamat yang saya terima:  https:/plugins.svn.wordpress.org/aph-prism-highlighter/

   

   Klik OK untuk melanjutkan.

3. Setelah berhasil, maka akan terbentuk beberapa direktori sama persis dengan yang ada pada server

   Gambar pada SVN Server

   

   Gambar pada direktori komputer

   

Setelah proses ini, maka semua perubahan pada direktori plugin kita (aph-prism-highlighter) akan dicatat oleh TortoiseSVN yang  sehingga memudahkan kita untuk melakukan pengaturan file baik yang akan/telah ditambahkan, diubah maupun dihapus.

3 Copy file plugin ke direktori trunk dan commit

Terakhir, kita tampilkan plugin kita di direktori wordpress.org sehingga siap untuk digunakan oleh pengguna lain.

Untuk melakukannya, kita perlu untuk membuat tag. Tag ini umum digunakan pada version control, gunanya adalah untuk menandai versi release dari suatu program seperti (1.0, 2.2, 4.3, dst…)

Karena merupakan yang pertama, kita buat tag 1.0, yang artinya plugin kita memiliki versi 1.0, caranya:

1. Klik kanan pada direktori plugin, pada contoh ini: aph-prism-highlighter kemudian pilih TortoiseSVN » Branch/Tag…
2. Pada bagian To Path, kita tambahkan tags/1.0 sehingga To Path-nya menjadi aph-prism-highlighter/tags/1.0, perhatikan bahwa pada bagian destination url juga ikut berubah menjadi https://plugins.svn.wordpress.org/aph-prism-highlighter/tags/1.0

   Pada proses ini kita akan mengirim semua file pada direktori trunk  pada server ke direktori tags/1.0 yang artinya plugin kita akan mulai muncul di repository wordpress.org

   Jangan lupa untuk menuliskan comment/message yang jelas tentang perubahan yang terjadi

   PENTING!!! perlu diperhatikan bahwa ketika kita sudah menjalankan proses ini, maka kita tidak bisa lagi (tidak disarankan) melakukan perubahan file pada direktori tags/1.0 tadi.

   jika ada perubahan, maka kita perlu membuat versi baru, misal 1.0.1,  sehingga kita perlu memastikan bahwa plugins ini benar-benar ingin kita publish, kecuali perubahan pada yang bukan signifikan seperti pada file readme.txt

   Jika ini dilanggar, maka di khawatirkan user akan mendownload versi yang sama namun dengan script yang berbeda, sehingga kita tidak bisa memastikan user menggunakan versi terbaru dari plugin kita

3.  Selanjutnya klik OK untuk melanjutkan, tunggu beberapa saat hingga muncul pesan konfirmasi bahwa proses copy telah berhasil.

   Biasanya terdapat peringatan bahwa working copy kita masih di path sebelumnya (trunk), dan kita diminta untuk memindahnya ke tags/1.0, kita tidak memerlukan hal ini, sehingga abaikan saja peringatan tersebut.

4. Selanjutnya kita update direktori lokal kita agar sama dengan direktori server (ada tambahan tags/1.0). Untuk melakukannya,  klik kanan pada direktori plugin (aph-prism-highlighter) kemudian pilih SVN Update.
5. Isikan penanda/pesan perubahan ini misal “Initial Plublic Release 1.0”, kemudian klik OK

Selesai.

VI. Upload Screenshot Plugin

Pada file readme.txt  terdapat bagian bernama == Screenshots ==, bagian ini akan menampilkan screenshot plugin kita yang ada di wordpress.org, contoh:

Tampilan pada: https://wordpress.org/plugins/aph-prism-highlighter/screenshots/

Seperti contoh diatas, dalam memberi nama file untuk screenshot, WordPress meggunakan pola screenshot-[nourut].[tipefile] contoh: screenshot-1.png  dan deskripsi dari screenshot tersebut ditulis sesuai angka pada screenshot.

Cara upload screenshot plugin wordpress

Terdapat dua cara untuk mengupload file screenshot ini, yaitu:

• Menggabungkannya dengan file plugin, sehingga strukturnya seperti ini:

  

  Dengan cara ini, maka kita harus menyertakan file screenshot pada setiap versi plugin kita, sehingga tidak efisien.

• Cara kedua adalah mengupload file tersebut ke direktori assets  yang ada pada direktori svn plugin kita yang ada di wordpress.org, dengan lokasi terpisah maka ukuran file plugin menjadi lebih efisien.
  
  Gunakan cara ini, karena cara inilah yang direkomendasikan oleh wordpress

Untuk menjalankan kedua cara diatas, maka kita cukup meng copy-paste file screenshot ke direktori yang kita inginkan (plugin/assets)

Contoh kita tempatkan file screenshot pada direktori asset:

1. Copy file screenshot ke direktori assets yang berada di direktori plugin kita, contoh: E:\Wordpress\Plugin Projects\aph-prism-highlighter\assets
2. Kembali ke folder aph-prism-highlighter, klik kanan pada folder assets, dan pilih SVN Commit…

   

3. Isikan Message dan klik OK untuk melanjutkan

Selesai. Demikian cara mengupload screenshot plugin wordpress ke wordpress.org

VII. Update Versi Plugin

Suatu ketika kita  menambahkan beberapa fitur pada plugin yang telah kita publish tadi, dan kita memberi versi baru misal versi 1.1, agar user memperoleh versi yang terbaru, caranya yang diperlukan adalah:

1. Copy semua file plugin versi yang baru ke direktori trunk (timpa file yang lama)
2. Ubah “Stable tag”  pada file readme.txt yang ada menjadi 1.1. perbedaan versi pada file readme.txt dengan versi yang digunakan user akan memunculkan notifikasi pada user bahwa telah tersedia versi terbaru dari plugin.

   PENTING  jangan lupa untuk mengubah versi pada blok komentar yang ada di file php dari plugin (aph-prism-highlighter.php) menjadi 1.1, jika tidak, maka akan terjadi ketidak sinkronan yang muncul pada user (jika tidak diubah maka meskipun user telah melakukan update, versi yang muncul tetap versi 1.0)

3. Upload data trunk ke server SVN dengan meng klik kanan folder trunk kemudian pilih SVN Commit. Pada saat commit, centang file file yang miss agar terupdate
   

   Update Plugin Pada WordPress

4. Buat tag baru seperti contoh sebelumnya, misal kita buat 1.1,  caranya klik kanan pada direktori trunk kemudian pilih TortoiseSVN » Branch/Tags..

   Tambahkan bagian To Path  dengan tags/1.1 sehingga bagian To Path menjadi aph-prism-highlighter/tags/1.1

5. Klik OK untuk menjalankan proses update
   
   setelah diupdate, user tidak akan langsung memperoleh notifikasi adanya versi baru, WordPress akan mengecek versi baru setiap 7 jam, jadi jangan kaget setelah update versi plugin, notifikasi adanya versi baru tidak muncul.

Demikian pembahasan mengenai cara upload plugin wordpress pada wordpress.org plugin direktori