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

Standar Pengkodean WordPress: Konvensi Penamaan & Argumen Fungsi

by
Length:MediumLanguages:
This post is part of a series called The WordPress Coding Standards.
The WordPress Coding Standards: An Introduction
The WordPress Coding Standards: Single Quotes and Double Quotes

Indonesian (Bahasa Indonesia) translation by ⚡ Rova Rindrata (you can also view the original English article)

Dalam seri ini, kita menyelam dalam Standar Pengkodean WordPress - secara khusus, standar pengkodean PHP - dalam rangka mewartakan dan memahami bagaimana kode WordPress berkualitas harus ditulis.

Terlepas dari kenyataan bahwa ini didokumentasikan dalam Buku Pegangan Pengembang WordPress, saya pikir ada sesuatu yang bisa dikatakan untuk memahami alasan di balik mengapa beberapa hal terjadi seperti adanya.

Ingat: Tujuan utama kita adalah memastikan bahwa kita menulis kode yang sesuai dengan standar pengkodean sehingga kita, bersama dengan pengembang lainnya, dapat lebih mudah membaca, memahami, dan memelihara kode untuk tema, plugin, dan aplikasi yang dibangun di atas WordPress.

Dalam posting ini, kita akan melihat bagaimana menangani konvensi penamaan dan argumen fungsi.


Konvensi Penamaan

Sebelum menghabiskan waktu untuk menguraikan poin-poin yang diuraikan dalam standar pengkodean, penting untuk memahami peran konvensi penamaan dalam menulis kode terlepas dari platform yang Anda gunakan.

Pada akhirnya, konvensi penamaan - terlepas dari apakah itu untuk kelas, fungsi, variabel, atribut, atau argumen - harus membantu menjelaskan tujuan yang mereka layani.

Dengan itu, maksud saya, nama kelas biasanya adalah kata benda, fungsi biasanya harus berupa kata kerja, dan variabel, atribut, dan argumen harus menjelaskan tujuan yang mereka layani dalam konteks kelas atau fungsi di mana mereka harus didefinisikan. Ini semua tentang membuat kode itu semudah mungkin dibaca.

Sama seperti Standar Pengkodean menyatakan:

Jangan menyingkat nama variabel jika tidak perlu; biarkan kode menjadi tidak ambigu dan mendokumentasikan ia sendiri.

Ini adalah aturan praktis yang bagus terlepas dari bagian kode mana yang Anda gunakan.

Nama Kelas

Ketika bekerja dengan WordPress, Anda tidak mungkin menghadapi kelas kecuali jika Anda melakukan salah satu dari dua hal berikut:

  • Menulis pustaka khusus untuk bekerja bersama dalam sebuah tema atau aplikasi
  • Menulis sebuah plugin berbasis OOP

Jika Anda hanya mengerjakan tema, Anda lebih mungkin bekerja dengan seperangkat fungsi - kita akan membicarakannya sebentar lagi.

Tetapi bagi mereka yang bekerja dengan plugin atau pustaka mereka sendiri, penting untuk diingat bahwa kelas biasanya adalah kata benda - mereka harus mewakili tujuan yang mereka rancang dan mereka idealnya harus melakukan satu hal dan melakukannya dengan baik.

Misalnya, jika Anda memiliki kelas yang disebut Local_File_Operations maka ia mungkin bertanggung jawab untuk membaca dan menulis file.Ia seharusnya tidak bertanggung jawab untuk membaca dan menulis file dan juga, misalnya, mengambil file jarak jauh.

Menurut Standar Pengkodean WordPress, kelas harus mengikuti konvensi berikut:

  • Nama kelas harus menggunakan kata-kata yang dikapitalisasi yang dipisahkan oleh garis bawah.
  • Akronim mana pun harus semuanya huruf besar.

Sederhana kan?

Secara praktis, ini akan terlihat seperti berikut:

  • class Local_File_Operations {}
  • class Remote_File_Operations {}
  • class HTTP_Request {}
  • class SQL_Manager {}

Untuk mengulangi: kelas juga harus berupa kata benda dan harus menggambarkan tujuan tunggal yang mereka layani.

Nama Fungsi

Seperti disebutkan sebelumnya, jika kelas adalah kata benda yang idealnya mewakili satu gagasan atau tujuan tunggal, maka metode mereka seharusnya merupakan tindakan yang dapat mereka lakukan. Dengan demikian, mereka harus menjadi kata kerja - mereka harus menunjukkan tindakan apa yang akan diambil kapan pun mereka dipanggil.

Selanjutnya, argumen yang mereka terima juga harus merupakan faktor ke nama fungsi. Misalnya, jika sebuah fungsi bertanggung jawab untuk membuka file, maka parameternya harus berupa nama file. Karena tujuan kita seharusnya membuatnya semudah mungkin untuk membaca kode, maka ia seharusnya membaca sesuatu seperti "minta manajer file lokal membaca file yang memiliki nama file berikut."

Dalam kode, ini mungkin terlihat seperti ini:

Tentu saja, ini masih belum mencakup bagaimana fungsi harus ditulis dalam konteks pengembangan WordPress. Standar Pengkodean menyatakan:

Gunakan huruf kecil dalam nama variabel, tindakan, dan fungsi (jangan pernah camelCase). Pisahkan kata melalui garis bawah. Jangan menyingkat nama variabel jika tidak perlu; biarkan kode menjadi jelas dan mendokumentasikan ia sendiri.

Bagian pertama konvensi cukup mudah dipahami; namun, saya pikir pengembang memiliki kecenderungan untuk mengambil jalan pintas saat mereka mampu. "Ah," kita berpikir, "$str masuk akal di sini, dan $number masuk akal di sini."

Tentu saja, selalu ada yang lebih buruk - beberapa pengembang menggunakan karakter tunggal untuk nama variabel mereka (yang umumnya hanya dapat diterima dalam loop.)

Sama seperti Standar Pengkodean menyatakan: Jangan menyingkat nama variabel jika tidak perlu. Biarkan kode menjadi jelas dan mendokumentasikan ia sendiri.

Sekarang, yang sebenarnya adalah, kode hanya bisa menjadi jelas ke suatu titik. Lagi pula, itu sebabnya disebut kode, bukan? Inilah sebabnya mengapa menurut saya komentar kode harus digunakan secara bebas.

Bagaimanapun, intinya adalah menggunakan huruf kecil pada nama metode Anda, hindari semua camel case, pisahkan dengan spasi, dan sespesifik mungkin saat memberi nama variabel Anda.

Nama variabel

Nama variabel sebenarnya tidak jauh berbeda dengan nama fungsi selain yang mewakili satu nilai atau referensi ke objek tertentu. Konvensi penamaan masih mengikuti apa yang Anda harapkan:

  • Huruf kecil (versus camelCase)
  • Pisahkan spasi dengan garis bawah

Salah satu konvensi lain yang digunakan beberapa pengembang adalah apa yang dikenal sebagai Hungarian Notation yang dimana jenis nilai penyimpan variabel diawali di depan variabel.

Sebagai contoh:

  • String akan sering diwakili sebagai $str_firstname
  • Angka akan ditulis sebagai $i_tax atau $num_tax
  • Array dapat ditulis sebagai $arr_range
  • ...dan seterusnya

Jujur saja, standar pengkodean tidak mengatakan apa-apa tentang hal ini.Di satu sisi, saya berpikir bahwa ini membuat kode lebih bersih dalam keseluruhan cakupan kode, namun ada banyak pengembang yang tidak menyukai Hungarian Notation.

Karena konvensi pengkodean tidak mengatakan apa-apa tentang mereka, saya ragu untuk merekomendasikan mereka karena saya ingin tetap sedekat mungkin dengan standarnya. Dengan demikian, saya harus merekomendasikan yang terbaik adalah agar mengikuti standar pengkodean.

Nama File

Dengan tetap konsisten dengan tema pembuatan kode kita sebagai yang mudah dibaca dan mendokumentasikan ia sendiri, masuk akal jika kita menarik ini melalui kode sumber sampai semua file yang akan kita buat untuk tema, plugin, atau aplikasi.

Menurut Standar Pengkodean:

File harus diberi nama secara deskriptif dengan menggunakan huruf kecil. Tanda hubung harus memisahkan kata-kata.

Agar konsisten dengan contoh sebelumnya, katakanlah kita bekerja dengan Local_File_Operations maka file tersebut akan diberi nama class-local-file-operations.php.

Cukup mudah.

Selanjutnya, jika Anda mengerjakan plugin bernama Instagram_Foo maka file tersebut harus diberi nama instagram-foo.php; namun, perlu dicatat bahwa jika Anda menggunakan beberapa jenis metode lanjutan untuk mengembangkan plugin Anda seperti menyimpan file kelas plugin di filenya sendiri dan kemudian memuatnya menggunakan file lain, maka struktur file Anda mungkin:

  • class-instagram-foo.php
  • instagram-foo.php

Dimana instagram-foo.php bertanggung jawab untuk memuat class-instagram-foo.php. Tentu saja, ini hanya masuk akal jika Anda menggunakan OOP saat menulis plugin WordPress Anda.


Argumen Fungsi

Ketika sampai pada menyampaikan argumen fungsi, penting untuk diingat bahwa jika nama fungsi menggambarkan tindakan yang sedang dilakukan oleh kelas, maka argumen tersebut harus mewakili pada apa fungsi sebenarnya beroperasi.

Dari Standar Pengkodean:

Pilih nilai string menjadi true dan false saat memanggil fungsi.

Karena nilai boolean dapat menjadi tidak jelas saat melewatkan nilai ke fungsi, itu membuat sulit untuk memastikan dengan tepat apa yang sedang dilakukan oleh fungsinya.

Sebagai contoh, mari kita gunakan contoh di atas dengan cara yang sedikit berbeda:

Lebih sulit untuk dimengerti daripada, katakanlah, sesuatu seperti ini:

Selain itu, ingatlah bahwa argumen yang dimasukkan ke dalam fungsi masih merupakan variabel dalam dan dari diri mereka sendiri sehingga mereka tunduk pada konvensi penamaan variabel yang telah kami jelaskan di atas.


Kesimpulan

Kita telah melihat lebih jauh tentang Konvensi Penamaan dan argumen Fungsi dalam Standar Pengkodean. Mudah-mudahan ini membantu memberikan tidak hanya panduan untuk memperbaiki aspek-aspek tertentu dari kode WordPress Anda, namun juga untuk menjelaskan alasan di balik beberapa praktik.

Pada artikel berikutnya, kita akan melihat pentingnya tanda petik tunggal dan tanda petik ganda dalam konteks bekerja dengan string dalam pengembangan WordPress.

Ada perbedaan bagaimana mereka ditafsirkan oleh PHP dan ada kondisi di mana Anda harus menggunakan satu dari yang lain dan kami akan mengulasnya di artikel berikutnya.

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.