phpstan wordpress

Importante

¡Hola a todos! Este es Viktor que ejecuta esta extensión de Phpstan. Estoy planeando dejar de contribuir al ecosistema de WordPress porque es extremadamente difícil y nadie me pide que me una a su equipo ya que soy pensador, una persona de DevOps, un fabricante de herramientas (no un constructor).

Apoye mi trabajo para evitar abandonar este paquete.

¡Gracias!

Extensiones de WordPress para Phpstan

Análisis estático para el ecosistema de WordPress.

• Phpstan
• WordPress

Características

• Permite a PHPSTAN analizar complementos y temas de WordPress.
• Carga el paquete php-stubs/wordpress-stubs .
• Proporciona extensiones de tipo de retorno dinámico para funciones que no están cubiertas en php-stubs/wordpress-stubs
• Define algunas constantes de núcleo de WordPress.
• Valida las llamadas Opcionales DocBlocks antes de apply_filters() y do_action() , tratando el tipo de primer @param como definitivo.

Requisitos

• Phpstan 2.0 o superior
• PHP 7.4 o superior (probado hasta PHP 8.3)

Instalación

Para usar esta extensión, requiere en compositor:

composer require --dev szepeviktor/phpstan-wordpress

Si también instala PHPSTAN/Extension-Installer, ¡está listo!

Instalación manual

Si no desea utilizar phpstan/extension-installer , incluya extension.neon en la configuración PHPSTAN de su proyecto:

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

Configuración

No se necesita una configuración adicional. ? Simplemente configure phpstan, por ejemplo, como se muestra a continuación:

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

Para obtener más detalles, visite la referencia de configuración de Phpstan.

¡Use el compositor AutoDoLaader o un AutoDoLaader personalizado!

Uso

Ejecute el análisis con:

vendor/bin/phpstan analyze

¡Luego corrige un error y GOTO 10 !

Encuentra más información en el directorio de examples , por ejemplo examples/phpstan.neon.dist

Uso en WooCommerce WebShops

Consulte los trozos de WooCommerce para obtener una guía específica.

Uso de un apply_filters() docblock

El ecosistema de WordPress a menudo utiliza phpdoc docblocks de una manera no estándar para documentar los parámetros pasados ​​a apply_filters() . Aquí hay un ejemplo:

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

Esta extensión lee estos docblocks e instruye a PHPSTAN que trate el tipo de retorno del filtro como cierto, en función de la primera etiqueta @param . En este ejemplo, Phpstan interpreta $title como string .

Para obtener los mejores resultados, asegúrese de que la primera etiqueta @param en estos docblocks sea precisa.

Haga que su código sea probable

• Escriba el código OOP Clean: 1 clase por archivo, y sin código adicional de código fuera de class Name { ... } .
• Use el nombre consistente de clases (WPCS o PSR-4) y almacene clases en un directorio inc/ Directorio dedicado.
• Agregue bloques PHPDOC precisos a clases, propiedades, métodos, funciones y llamadas apply_filters() .
• Elija las piezas de su archivo de complemento principal.
• Evite usar constantes centrales, use funciones centrales.
• Evite las malas prácticas de PHP, como:
  • Funciones: eval , extract , compact , list
  • Tipo de malabarismo: $a = '15'; if ($a) ...
• Si necesita un código robusto, intente evitar todo tipo de malabarismo de tipo (por ejemplo, if necesita un booleano), vea las funciones de manejo de variables
• Evite habilitar exit_error en WP_CLI::launch o WP_CLI::runcommand para mejorar la capacidad de prueba.

Esquina sucia (preguntas frecuentes)

WordPress utiliza la función condicional y la definición de clase para permitir anulaciones. Use el comando sed para excluir a los trozos de funciones cuando se definen previamente.

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