phpstan wordpress

Penting

Halo semuanya! Ini adalah Viktor yang menjalankan ekstensi phpstan ini. Saya berencana untuk berhenti berkontribusi pada ekosistem WordPress karena sangat sulit dan tidak ada yang meminta saya untuk bergabung dengan timnya karena saya seorang pemikir, orang DevOps, pembuat alat (bukan pembangun).

Tolong dukung pekerjaan saya untuk menghindari meninggalkan paket ini.

Terima kasih!

Ekstensi wordpress untuk phpstan

Analisis statis untuk ekosistem WordPress.

• Phpstan
• WordPress

Fitur

• Memungkinkan Phpstan untuk menganalisis plugin dan tema WordPress.
• Memuat paket php-stubs/wordpress-stubs .
• Memberikan ekstensi tipe pengembalian dinamis untuk fungsi yang tidak tercakup dalam php-stubs/wordpress-stubs
• Mendefinisikan beberapa konstanta inti WordPress.
• Memvalidasi docblock opsional sebelum apply_filters() dan do_action() , memperlakukan jenis @param pertama sebagai definitif.

Persyaratan

• Phpstan 2.0 atau lebih tinggi
• PHP 7.4 atau lebih tinggi (diuji hingga PHP 8.3)

Instalasi

Untuk menggunakan ekstensi ini, memerlukannya di komposer:

composer require --dev szepeviktor/phpstan-wordpress

Jika Anda juga menginstal phpstan/extension-installer maka Anda sudah siap!

Instalasi Manual

Jika Anda tidak ingin menggunakan phpstan/extension-installer , sertakan extension.neon dalam konfigurasi phpstan proyek Anda:

 includes :
    - vendor/szepeviktor/phpstan-wordpress/extension.neon 

Konfigurasi

Tidak diperlukan pengaturan tambahan. ? Cukup konfigurasikan phpstan - misalnya - seperti yang ditunjukkan di bawah ini:

 parameters :
    level : 5
    paths :
        - plugin.php
        - inc/

Untuk detail lebih lanjut, kunjungi referensi konfigurasi phpstan.

Gunakan Autoloader Composer atau Autoloader Kustom!

Penggunaan

Jalankan analisis dengan:

vendor/bin/phpstan analyze

Kemudian perbaiki kesalahan dan GOTO 10 !

Anda menemukan informasi lebih lanjut di direktori examples , misalnya examples/phpstan.neon.dist

Penggunaan di Woocommerce Webshops

Rujuk ke Stubs WooCommerce untuk panduan khusus.

Penggunaan docblock apply_filters()

Ekosistem WordPress sering menggunakan phpDoc docblocks dengan cara non-standar untuk mendokumentasikan parameter yang diteruskan ke apply_filters() . Inilah contohnya:

 /**
 * Filters the page title when creating an HTML drop-down list of pages.
 *
 * @param string  $title Page title.
 * @param WP_Post $page  Page data object.
 */
$ title = apply_filters ( ' list_pages ' , $ title , $ page );

Ekstensi ini membaca docblocks ini dan menginstruksikan Phpstan untuk memperlakukan jenis pengembalian filter sebagai tertentu, berdasarkan tag @param pertama. Dalam contoh ini, Phpstan menafsirkan $title sebagai string .

Untuk hasil terbaik, pastikan tag @param pertama di docblocks ini akurat.

Membuat kode Anda bisa diuji

• Tulis Kode OOP Bersihkan: 1 Kelas per file, dan tidak ada kode tambahan di luar class Name { ... } .
• Gunakan penamaan kelas yang konsisten (WPCS atau PSR-4) dan kelas toko dalam direktori inc/ khusus.
• Tambahkan Blok PHPDOC yang tepat ke kelas, properti, metode, fungsi, dan panggilan apply_filters() .
• Pilih bagian file plugin utama Anda.
• Hindari menggunakan konstanta inti, gunakan fungsi inti.
• Hindari praktik PHP yang buruk, seperti:
  • Fungsi: eval , extract , compact , list
  • Jenis Juggling: $a = '15'; if ($a) ...
• Jika Anda membutuhkan kode yang kuat, coba hindari semua jenis juggling jenis (misalnya if membutuhkan boolean), lihat fungsi penanganan variabel
• Hindari mengaktifkan exit_error di WP_CLI::launch atau WP_CLI::runcommand untuk peningkatan testabilitas.

Dirty Corner (FAQ)

WordPress menggunakan fungsi bersyarat dan definisi kelas untuk memungkinkan overrides. Gunakan perintah sed untuk mengecualikan stubs fungsi ketika mereka sebelumnya didefinisikan.

sed -i -e ' s#function is_gd_image#function __is_gd_image# ' vendor/php-stubs/wordpress-stubs/wordpress-stubs.php