Cara mempublikasikan plugin WordPress pertama Anda

Diterbitkan: 2016-02-04

Melepaskan plugin WordPress selalu tampak bagi saya sebagai tugas yang menakutkan yang hanya mampu dilakukan oleh pengembang PHP yang sangat berbakat. Sebagian besar pengalaman WordPress saya terletak pada pengembangan tema khusus, jadi menjelajah ke pengembangan plugin tampak tidak masuk akal dan menakutkan. Tapi aku membawa kabar baik! Saya baru saja merilis dua plugin yang tersedia di direktori plugin WordPress dan, coba tebak? Itu tidak menakutkan seperti yang Anda percaya! Sebenarnya itu adalah pengalaman yang cukup menyenangkan untuk mempublikasikannya ke WordPress.org setelah pengembangan selesai.

Artikel ini tidak akan membahas detail pembuatan plugin, melainkan akan membahas langkah-langkah yang diperlukan agar plugin Anda benar-benar diluncurkan dan tersedia di direktori WordPress.org dan setiap situs WordPress di dunia. Sebagai referensi, saya menggunakan WordPress Plugin Boilerplate sebagai titik awal untuk plugin saya dan open source semuanya di GitHub (sangat disarankan).

Catatan: Artikel ini adalah cuplikan dari ebook gratis, Pemrograman, penerbitan, dan promosi plugin WordPress Anda. Dapatkan cerita lengkapnya dengan mengunduh panduan hari ini!

Readme.txt

Hal pertama yang harus Anda miliki agar WordPress menerima plugin Anda adalah file Readme.txt. Ini berisi semua informasi yang terkait dengan plugin Anda dan yang digunakan WordPress untuk menghasilkan halaman untuk plugin Anda di direktori WordPress.org (seperti tab Deskripsi, Instalasi, dan Tangkapan Layar).

Format untuk Readme terlihat seperti ini:

=== Plugin Name ===

Contributors: yourname

Donate link: http://yoursite.com

Tags: business, directory

Requires at least: 4.3

Tested up to: 4.3

Stable tag: 4.3

License: GPLv2 or later

License URI: http://www.gnu.org/licenses/gpl-2.0.html
A simple description
== Description ==
A longer description with a
- list

- of

- features
== Installation ==
This section describes how to install the plugin and get it working.
1. Upload [`plugin-name`](link-to-github.zip) to the `/wp-content/plugins/` directory

2. Activate the plugin through the 'Plugins' menu in WordPress
== Frequently Asked Questions ==
= Is this a cool plugin? =
Yes
== Screenshots ==
1. Desktop view
2. Mobile view
== Changelog ==
= v1.0.0 =

* Initial release

Contoh lengkap dapat ditemukan di sini. Validator yang berguna juga tersedia untuk memeriksa apakah Readme Anda sudah normal.

Changelog dan pembuatan versi

Sangat penting untuk selalu memperbarui nomor versi plugin Anda sehingga, jika tidak ada yang lain, pengguna dapat diberi tahu ketika ada pembaruan untuk itu. Memperbarui changelog semudah menambahkan entri baru ke bagian changelog di Readme. Ada beberapa pandangan berbeda tentang pembuatan versi dan apa yang seharusnya merupakan rilis mayor atau minor; Saya suka berkonsultasi dengan situs Semantic Versioning 2.0.0 untuk referensi tentang itu.

Sebagai contoh, katakanlah Anda mengirimkan plugin Anda pada versi 1.0.0. Kemudian keesokan harinya Anda memperbaiki sedikit bug atau menambahkan sedikit fungsionalitas yang Anda lupa saat pertama kali memublikasikan plugin. Sebelum Anda menerapkan plugin ke direktori WordPress (lebih lanjut tentang cara melakukannya nanti), Anda harus memperbarui bagian changelog di Readme menjadi seperti ini:

== Changelog ==
= v1.0.1 =

* Fix a thing that allows users to do a thing
= v1.0.0 =

* Initial release

Kemudian (ini penting), Anda perlu memperbarui nomor versi di file bootstrap plugin. Anda seharusnya sudah familiar dengan file bootstrap jika Anda sedang menulis sebuah plugin, tetapi untuk referensi itu adalah file yang memberikan informasi WordPress tentang keseluruhan plugin melalui blok komentar di bagian atas.

terbitkan-wordpress-plugin-versi Blok komentar dari file bootstrap plugin.

Kirim ke WordPress.org

Dengan Readme di tempat dan pengujian ekstensif selesai, Anda siap mengirimkan plugin ke WordPress! Ini adalah bagian termudah dari keseluruhan proses. Cukup buka https://wordpress.org/plugins/add/, masuk dengan akun WordPress Anda (atau buat akun), dan isi formulir singkatnya.

terbitkan-wordpress-plugin-kirim Formulir pengiriman plugin WordPress.

Berhati-hatilah agar Anda tidak menggunakan nama “WordPress” pada nama plugin. Mereka akan menolak plugin jika Anda melakukannya. Mereka juga akan menolak plugin jika Anda menyertakan nama produk bermerek dagang atau jika plugin Anda dimulai dengan nama plugin lain. Saya menemukan itu dengan cara yang sulit dengan sebuah plugin yang saya coba kirimkan yang memperluas Formulir Ninja dan mendapat tanggapan ini dalam email:

Kami tidak lagi menerima plugin yang menyertakan nama atau istilah produk bermerek dagang sebagai nama atau slug plugin. Kami juga tidak menerima plugin yang menyertakan nama plugin lain di awal nama/slug.

Pastikan Anda meluangkan waktu untuk menulis deskripsi yang bagus dan kemudian letakkan tautan ke plugin Anda dalam file ZIP di bidang terakhir. Menggunakan GitHub untuk pengembangan plugin membuatnya sangat mudah untuk memiliki ZIP yang tersedia untuk umum.

publish-wordpress-plugin-github Salin URL plugin “Unduh ZIP” dari repo GitHub Anda.

Setelah Anda mengirimkan plugin, duduk dan tunggu! Kedua plugin saya diterima dalam waktu sekitar dua hari. Anda akan mendapatkan email berisi informasi tentang repositori SVN baru jika diterima. Yang membawa kita ke langkah berikutnya – menerapkan!

Terapkan dengan SVN

Setelah plugin diterima, itu masih belum aktif. Anda harus benar-benar mengunggah file ke repositori SVN yang disediakan WordPress untuk Anda. Saya belum pernah menggunakan SVN sebelumnya, tetapi artikel mereka memandu Anda masuk melalui terminal dengan cukup cepat. Pada dasarnya, Anda membuat folder di komputer Anda, memeriksa repo SVN, menyalin file plugin Anda ke folder /trunk yang baru dibuat, dan mendorongnya kembali.

Anda dapat melakukan ini melalui terminal setiap kali Anda perlu menerapkan perubahan, atau Anda dapat menggunakan alat praktis yang disebut Kapal. Saya telah menggunakan Ship untuk setiap penerapan yang telah saya lakukan dan itu berfungsi seperti pesona, secara otomatis menyebarkan ke repo SVN setiap kali Anda menandai rilis baru di GitHub. Jika Anda menggunakan GitHub (yang, sekali lagi, Anda seharusnya) saya sangat merekomendasikan layanan gratis ini.

Untuk proses penerapan dan pemeliharaan terbaik, penting untuk menggunakan rilis atau tag setiap kali Anda menerapkan. Sama seperti Anda memperbarui nomor versi di file plugin dan changelog Anda, Anda juga harus mengeluarkan rilis baru di GitHub. Ini sebenarnya diperlukan untuk melakukan ini untuk menggunakan Kapal.

Terakhir, setelah Anda mendaftar dengan Ship dan memilih repo Anda untuk dihubungkan, Anda dapat menggunakan rilis pertama Anda (pastikan namanya cocok dengan nama rilis di GitHub). Setelah itu, selama Anda mengisi formulir di bawah judul Detail WordPress, Ship hanya akan di-deploy setiap kali rilis baru diterbitkan di GitHub.

terbitkan-wordpress-plugin-kapal UI pengaturan repositori kapal.

Tangkapan layar dan gambar spanduk

Menampilkan tangkapan layar plugin Anda sangat penting untuk membantu orang melihat secara visual seperti apa tampilannya dan memberi mereka gambaran tentang cara kerjanya. Tangkapan layar ini akan muncul di halaman direktori plugin WordPress.org (inilah halaman tangkapan layar plugin kalender saya, misalnya) dan ketika pengguna menambahkan plugin di situs mereka melalui halaman Plugin.

Gambar spanduk tidak sepenting tangkapan layar, tetapi membuat plugin Anda terlihat sedikit lebih mudah dipengaruhi. Gambar spanduk adalah gambar besar yang ditampilkan di bagian atas halaman direktori plugin WordPress.org.

terbitkan-wordpress-plugin-spanduk Gradien biru tua di sini adalah spanduk.

Untuk menampilkan gambar-gambar ini, Anda harus menempatkannya di direktori /assets repo SVN Anda. Sayangnya, Anda tidak dapat menggunakan Ship untuk ini karena hanya menyebarkan folder /trunk , jadi Anda harus membaca artikel ini lagi untuk masuk ke repo SVN Anda.

Untuk mempermudah, tetap beri nama screenshot Anda screenshot-#.png (di mana `#` adalah nomornya). Melakukannya dengan cara ini memungkinkan Anda untuk dengan mudah mereferensikan gambar di Readme untuk memberi mereka deskripsi.

== Screenshots ==
1. Desktop view
2. Mobile view

Misalnya, deskripsi "Tampilan desktop" dari bagian Tangkapan Layar di Readme akan cocok dengan screenshot-1.png di folder /assets .
Untuk spanduk, Anda sebenarnya membutuhkan dua versi dari gambar yang sama – satu untuk layar normal dan satu lagi untuk layar retina. Nama gambar spanduk harus banner-1544x500.png dan banner-772x250.png .

Tamat

Itu dia! Jika Anda mengikutinya, saya harap plugin Anda diterima dan Anda siap untuk mulai menyebarkan berita tentang plugin baru Anda yang mengagumkan. Ingatlah untuk selalu memperbarui Readme, changelog, dan rilis masalah setiap kali Anda memperbarui plugin.

Sekarang plugin Anda sudah aktif, saatnya memberi tahu orang-orang tentangnya! Ikuti panduan sederhana ini untuk pengembang WordPress untuk memasarkan produk Anda dan mendapatkan nama plugin Anda di luar sana.