phpstan wordpress

Important

Bonjour à tous! C'est Viktor qui gère cette extension PHPSTAN. Je prévois de cesser de contribuer à l'écosystème WordPress car c'est extrêmement difficile et personne ne me demande de rejoindre son équipe car je suis un penseur, un DevOps, un fabricant d'outils (pas un constructeur).

Veuillez soutenir mon travail pour éviter d'abandonner ce package.

Merci!

Extensions WordPress pour phpstan

Analyse statique pour l'écosystème WordPress.

• Phpstan
• Wordpress

Caractéristiques

• Permet à PhpStan d'analyser les plugins et les thèmes WordPress.
• Charge le package php-stubs/wordpress-stubs .
• Fournit des extensions de type de retour dynamique pour les fonctions qui ne sont pas couvertes dans php-stubs/wordpress-stubs
• Définit certaines constantes de base WordPress.
• Valide les appels docblocks facultatifs avant apply_filters() et do_action() , traitant le type du premier @param comme définitif.

Exigences

• Phpstan 2,0 ou plus
• PHP 7,4 ou plus (testé jusqu'à PHP 8,3)

Installation

Pour utiliser cette extension, nécessitez-le dans le compositeur:

composer require --dev szepeviktor/phpstan-wordpress

Si vous installez également PhpStan / Extension-Installer, vous êtes tous réglés!

Installation manuelle

Si vous ne souhaitez pas utiliser phpstan/extension-installer , incluez extension.neon dans la configuration phpstan de votre projet:

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

Configuration

Aucune configuration supplémentaire n'est nécessaire. ? Configurez simplement PhpStan - par exemple - comme indiqué ci-dessous:

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

Pour plus de détails, visitez la référence de configuration PHPSTAN.

Utilisez le compositeur Autoloader ou un Autoloader personnalisé!

Usage

Exécutez l'analyse avec:

vendor/bin/phpstan analyze

Corrigez ensuite une erreur et GOTO 10 !

Vous trouvez plus d'informations dans le répertoire examples , par exemple examples/phpstan.neon.dist

Utilisation dans les webshops WooCommerce

Reportez-vous aux talons WooCommerce pour des conseils spécifiques.

Utilisation d'un apply_filters() docblock

L'écosystème WordPress utilise souvent des docblocks PHPDOC de manière non standard pour documenter les paramètres passés à apply_filters() . Voici un exemple:

 /**
 * 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 );

Cette extension lit ces docblocks et demande à PhpStan de traiter le type de retour du filtre comme certains, sur la base de la première balise @param . Dans cet exemple, PhpStan interprète $title en tant que string .

Pour les meilleurs résultats, assurez-vous que la première balise @param dans ces docblocks est exacte.

Rendre votre code testable

• Écrivez le code OOP Clean: 1 classe par fichier, et aucun code supplémentaire en dehors class Name { ... } .
• Utilisez la dénomination cohérente des classes (WPCS ou PSR-4) et stockez des classes dans un répertoire inc/ dédié.
• Ajoutez des blocs PHPDOC précis aux classes, propriétés, méthodes, fonctions et appels apply_filters() .
• Choisissez vos pièces de fichier de plugin principal.
• Évitez d'utiliser les constantes de base, utilisez les fonctions centrales.
• Évitez les mauvaises pratiques PHP, comme:
  • Fonctions: eval , extract , compact , list
  • Type Juggled: $a = '15'; if ($a) ...
• Si vous avez besoin de code robuste, essayez d'éviter toutes sortes de jonglets de type (par exemple if a besoin d'un booléen), voir les fonctions de traitement des variables
• Évitez d'activer exit_error dans WP_CLI::launch ou WP_CLI::runcommand pour une testabilité améliorée.

Coin sale (FAQ)

WordPress utilise la fonction conditionnelle et la définition de la classe pour permettre les remplacements. Utilisez la commande sed pour exclure les talons de fonction lorsqu'ils sont précédemment définis.

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