Automattic / Automattic/VIP-Coding-Standards
New sniff: Flag unusable query parameters
- Lenguaje dominante
- PHP
- Estrellas
- 261
- Forks
- 44
- Merge medio
- 19 min
- PR fusionados (30 d)
- 1
Descripción
## What problem would the enhancement address for VIP?
On VIP, a selection of [query parameters](https://docs.wpvip.com/technical-references/caching/page-cache/#h-query-parameters) are stripped at the edge which so that the URLs are not cached as separate variants. These parameters are predominantly used for analytics. As such, `$_GET['...']` and other ways of reading the values of the query parameters will return `null` on production and non-production environments.
Helping customers to appreciate when a query parameter isn't going to work on a VIP-hosted site, should save some hours of debugging.
## Describe the solution you'd like
A new sniff to create violations when trying to read one of the documented parameters.
## What code should be reported as a violation?
Substitute `foo` for any of the params in the documentation.
```php
$_GET['foo']
$_REQUEST['foo']
filter_input( INPUT_GET, 'foo'[, ...[, ...]])
$qs = filter_input_array( INPUT_GET[, ...[, ...]] )
$qs['foo'];
```
There may well be other ways to retrieve query string parameters as well.
## What code should *not* be reported as a violation?
```php
$_GET['not-foo']
$_POST['foo']
filter_input( INPUT_POST, 'foo'[, ...[, ...]])
```
Guía de contribución
Línea de trabajo
No se nombra ningún archivo de implementación ni ninguna prueba. Comienza localizando los sniffs existentes de PHP_CodeSniffer y sus pruebas; después, compara los parámetros VIP documentados con las formas de acceso GET enumeradas; se considera terminado cuando se informan esas formas, pero no POST ni los parámetros no relacionados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- php
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100