Unlimited WordPress themes, graphics, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. WordPress
Code

Object-oriented Programming di WordPress: dokumen Plugin II

by
Difficulty:BeginnerLength:LongLanguages:
This post is part of a series called Object-Oriented Programming in WordPress.
Object-Oriented Programming in WordPress: Document the Plugin I
Object-Oriented Programming in WordPress: Inheritance I

Indonesian (Bahasa Indonesia) translation by Arief Syahrir (you can also view the original English article)

Pada titik ini dalam seri ini, kita sudah siap untuk bergerak maju dengan Pembulatan keluar plugin kami mendokumentasikan file kita, class, fungsi, variabel, dan banyak lagi.

Meskipun ini adalah langkah terakhir yang kita untuk menyelesaikan plugin, hal ini bukan post terakhir dalam seri seperti yang kita akan terus melihat beberapa topik-topik lanjutan dalam object-oriented programming

Tetapi sebelum kita melakukan itu, mari kita membawa kami plugin versi 1.0 dengan mempraktekkan segala sesuatu yang kita pelajari di artikel sebelumnya.

Tentu saja, seperti dengan semua artikel sebelumnya, saya merekomendasikan penangkapan pada segala sesuatu yang kita telah dibahas sejauh ini sehingga Anda benar-benar sampai dengan kecepatan tidak hanya dengan pekerjaan yang kita lakukan di artikel terakhir, tetapi dengan bagaimana kita benar-benar sampai ke poin final kita membahas dalam artikel ini.

  1. Sebuah Pengantar
  2. Class
  3. Type
  4. Struktur kontrol: Pernyataan bersyarat
  5. Control Structure: loop
  6. Fungsi dan atribut
  7. Scope
  8. Membuat Plugin I
  9. Membuat Plugin II
  10. Dokumen Plugin I

Dengan semua dari sudah dicover dan ditinjau, mari kita mulai dengan mendokumentasikan masing-masing file kami.

Mendokumentasikan Plugin

Ada sejumlah cara yang berbeda bahwa kita bisa pergi tentang mendokumentasikan plugin ini:

  • Kita bisa mendokumentasikan semua ke header file, maka kita bisa kembali dan dokumentasi sebuah class, maka kita bisa mengembalikan dan dokumen variabel, maka kita bisa dokumen fungsi.
  • Kami bisa mendokumenkan setiap file pada satu waktu dan memiliki diskusi singkat atas segala sesuatu yang disertakan pada basis per file.

Jelas, pilihan akan menghasilkan lebih banyak dokumentasi per bagian, tapi harus mengakibatkan sebuah artikel yang jauh lebih sedikit membosankan dan yang jauh lebih mudah memahami aliran kontrol untuk seluruh plugin.

Untuk itu, kita akan bekerja melalui plugin, file-by-file, memperkenalkan dokumentasi untuk masing-masing potongan kode bahwa kita memiliki dan kemudian kita akan membahas poin yang menarik yang mengikuti kode.

Akhirnya, kami akan memastikan kami merujuk ke versi final dari plugin di akhir artikel. Karena sudah dikatakan, mari kita mulai.

Single Post Meta Manajer

Ingat bahwa file utama untuk memulai plugin adalah file single-post-meta-manager.php terletak di root direktori plugin.

Berikut adalah apa yang tampak seperti versi file yang sepenuhnya didokumentasikan. Baca setiap komentarnya perhatikan tidak hanya untuk format yang mengikuti, tapi konten yang disediakan.

Dalam kode di atas, perhatikan bahwa kita sudah mendefinisikan header file sesuai konvensi bahwa kita dijelaskan bahwa di artikel sebelumnya. Kami juga maintain header tag plugin yang diperlukan dalam rangka untuk WordPress dengan tepat membacanya.

Perhatikan bahwa, dalam kasus ini, kami telah memasukkan mereka di bawah tag kustom @wordpress-plugin. Ini tidak diperlukan, tetapi membantu untuk memisahkan file header komentar dari yang diperlukan komentar plugin.

Akhirnya, perhatikan bahwa kita naikan versi plugin ini sampai 1.0, dan kami juga telah memberikan plugin ini nilai @package SPMM yang adalah singkatan dari Single Post Meta Manager Kita akan menggunakan ini seluruh plugin.

Direktori includes

Selanjutnya, mari kita perhatikan untuk semua file yang terletak di direktori includes.

Karena file-file yang diperlukan sebelum sesuatu dalam direktori admin, itu membuat akal untuk memandang masing-masing file secara individual, dan kemudian putar keluar diskusi kami dengan sisa file dalam direktori admin.

Single Post Meta Manajer

Jelas, ada banyak komentar baru yang telah diperkenalkan ke dalam file ini tertentu; Namun, ini harus menjadi sangat jelas tentang apa yang masing-masing class properti, konstruktor dan fungsi internal yang di lakukan.

Hal penting untuk diperhatikan - selain bagaimana informasi dikoordinasikan melalui keluar plugin - adalah bagaimana kami telah mematuhi standar yang ditetapkan dalam artikel sebelumnya.

Lihat, bagaimanapun, bahwa kita telah mengambil kebebasan jika tidak menggunakan tag tertentu dan/atau fitur dokumentasi ketika mereka tidak relevan. Ini adalah sesuatu yang kita akan terus melakukan sepanjang sisa artikel.

Single Post Meta manajer Loader

Perhatikan bahwa class ini adalah lebih kurang komponen inti plugin di bahwa koordinat semua action dan filter yang digunakan di seluruh plugin. Plugin ini centralizes semua pendaftaran dan koordinasi hook yang digunakan di seluruh plugin.

Akhirnya, ketika run dipanggil, semua hook yang terdaftar dengan WordPress jadi sebagai plugin dijalankan, hal itu akan memangil setiap action yang terdaftar dan filter.

admin direktori

Pada titik ini, kami siap untuk mengalihkan perhatian kita ke file-file yang terletak di direktori admin plugin.

Meskipun file terdiri dari beberapa file PHP, ini juga terdiri dari CSS file. Untuk artikel ini, kita tidak akan mendokumentasikan CSS file; Namun, WordPress Codex melakukan definisi dokumentasi untuk ini.

Untuk sekarang, meskipun, mari kita lanjutkan mendokumentasikan class dan file yang ada di direktori admin.

Single Post Meta manajer Admin

Class Single Post Meta manajer Admin memiliki single jawab tunggal: mendefinisikan fungsi untuk merender meta box dan style untuk dashboard.

Perhatikan bahwa class atas memiliki sangat sedikit fungsional rincian. Terutama, class maintain referensi ke versi plugin, style sheet digunakan untuk style meta box dan fungsi yang diperlukan untuk benar-benar membuat meta box.

Ingat bahwa semua ini adalah setup dalam berkas utama plugin dan loader. Ini membantu untuk mengkalo logika yang ada dalam plugin sehingga setiap class dapat fokus pada apa tujuan utamanya.

Tentu saja, potongan terakhir plugin mengandalkan sebagian sebenarnya file yang berisi markup diperlukan untuk menampilkan meta box.

Single Post Meta manajer parsial

Ini harusnya cukup jelas ; Namun, untuk menjadi lengkap, perhatikan bahwa file ini mengambil ID post saat ini (melalui penggunaan fungsi get_the_ID()), membaca post meta data, dan kemudian iterates melalui itu membangun sebuah tabel yang menampilkan key dan nilai-nilai.

Menyelesaikan Plugin

Pada titik ini, kami telah menyelesaikan pelaksanaan plugin kami. Menempatkan object-oriented programming praktek ke tempatnya, untuk mendokumentasikan kode.

Anda dapat mengambil versi final dari plugin di GitHub; Namun, kami akan berlanjut diskusi object-oriented atas beberapa post yang lebih sehingga kita dapat menjelajahi beberapa topik yang lebih maju seperti inheritance, abstraksi dan topik lainnya.

Sementara itu, jika Anda memiliki pertanyaan atau komentar tentang plugin, jangan ragu untuk meninggalkan komentar!

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.