WordPress, açık kaynaklı bir yazılım olduğundan, kod kalitesini ve tutarlılığı sağlamak için belirli kodlama standartları belirlemiştir. Bu standartlar, geliştiricilerin WordPress ekosisteminde daha verimli ve uyumlu bir şekilde çalışmasını sağlar. İşte WordPress kodlama standartları:
PHP Standartları
WordPress, PHP kodlama standardı olarak PHP-FIG tarafından oluşturulan PSR-2 ve PSR-12 standartlarını temel alır:
– Girintileme: Girintileme için 4 boşluk kullanılır. Tab karakteri kullanılmaz.
– PHP Etiketleri: `` etiketleri tercih edilir. Kısa etiketler (`
– Adlandırma Kuralları: Sınıf isimleri PascalCase, fonksiyon isimleri snake_case ve değişken isimleri ise snake_case olarak adlandırılmalıdır.
– PHP Satır Sonları: Her PHP etiketinin sonunda boşluk bırakılmalıdır (`` yerine ``).
– Yorum Satırları: Yorum satırları `//` veya `/ /` şeklinde olmalıdır ve kodun ne yaptığını açıklamalıdır.
– Kontrol Yapıları: Kontrol yapıları (`if`, `for`, `while`, `switch` vb.) her zaman parantez içinde yazılmalıdır.
– Atamalar: Atamalar (`=`, `+=`, `-=` vb.) etrafında boşluk bırakılmalıdır.
– Mantıksal Operatörler: `&&`, `||` ve `!` operatörleri etrafında boşluk bırakılmalıdır.
JavaScript Standartları
JavaScript için WordPress, JSHint kullanarak kodun doğrulanmasını teşvik eder:
– Girintileme: Girintileme için 4 boşluk kullanılır.
– Semicolon: JavaScript satırları noktalı virgül ile bitirilmelidir.
– Değişkenler: Değişken isimleri camelCase kullanılarak adlandırılmalıdır.
– Fonksiyonlar: Fonksiyonlar `function` anahtar kelimesi ile tanımlanmalıdır. Ok işlevleri (`=>`) kullanılabilir ancak karmaşıklık arttıkça tercih edilmemelidir.
– Konsol Logları: Üretim ortamında konsol logları kullanılmamalıdır.
– Yorum Satırları: Yorum satırları `//` veya `/ /` şeklinde olmalı ve kodun ne yaptığını açıklamalıdır.
HTML Standartları
– Doctype: Her WordPress şablonu, `` ile başlamalıdır.
– HTML5: HTML5 etiketleri ve özellikleri kullanılmalıdır.
– Yorum Satırları: Yorum satırları `` şeklinde olmalı ve kodun ne yaptığını açıklamalıdır.
– Boşluklar: HTML etiketleri arasında gereksiz boşluklar bırakılmamalıdır.
– Özellikler: HTML özellikleri tırnak içinde yazılmalıdır (`class=”my-class”`).
CSS Standartları
– Girintileme: Girintileme için 4 boşluk kullanılır.
– Seçici Adlandırma: Sınıf ve ID isimleri kebab-case kullanılarak adlandırılmalıdır (örneğin, `.my-class`, `my-id`).
– Birimler: Sıfır değerler için birim belirtilmemelidir (`0` yerine `0px` değil).
– Kısaltmalar: CSS kısaltmaları kullanılabilir, ancak açıklığı artırmak için gerektiğinde tam değerler kullanılmalıdır.
– Yorum Satırları: Yorum satırları `/ /` şeklinde olmalı ve kodun ne yaptığını açıklamalıdır.
Güvenlik
WordPress, güvenlik açısından da belirli standartlar belirlemiştir:
– Veri Doğrulama: Kullanıcıdan gelen tüm veriler doğrulanmalıdır.
– Kaçış (Escaping): Veritabanına veya HTML çıktısına yazılmadan önce tüm veriler kaçış işlemine tabi tutulmalıdır.
– Nonce: Güvenli işlemler için nonce kullanımı zorunludur.
– SQL Sorguları: SQL sorguları doğrudan yazılmamalı, yerine `$wpdb` kullanılmalıdır.
Dokümantasyon
WordPress, kodun anlaşılabilirliği ve bakımı için dokümantasyonun önemini vurgular:
– PHPDoc: PHP sınıfları, metodları ve fonksiyonları için PHPDoc kullanılmalıdır.
– Yorum Satırları: Yorum satırları, kodun ne yaptığını açıklamak için kullanılmalıdır.
– Todo Yorumları: Yapılacak işler için todo yorumları eklenmelidir.
Dosya ve Klasör Yapısı
– Dosya Adlandırma: Dosya isimleri küçük harflerle ve tirelerle ayrılmalıdır (`my-plugin.php`).
– Klasör Yapısı: Eklenti veya tema dosyaları, WordPress’in beklediği klasör yapısına uygun olmalıdır.
Bu standartlar, WordPress ekosistemindeki tüm geliştiriciler için bir rehber niteliğindedir ve topluluk tarafından sürekli olarak güncellenir. WordPress kodlama standartlarına uyum, kodun okunabilirliğini, sürdürülebilirliğini ve güvenliğini artırır, ayrıca WordPress ekosistemindeki diğer geliştiricilerle uyumlu çalışmayı kolaylaştırır.
