Automattic / Automattic/VIP-Coding-Standards

Check files in the vip-config/ directory for WordPress functions

Aperta
#467 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub
Standard: VIP-Go Type: Enhancement
Lingua principale
PHP
Stelle
261
Fork
44
Merge medio
19m
PR unite (30g)
1

Descrizione

## What problem would the enhancement address for VIP?

The VIP app repo has a [`vip-config/` directory](https://github.com/Automattic/vip-go-skeleton/tree/master/vip-config) which contains files that run before WordPress is loaded. Usually there's just a `vip-config/vip-config.php` file, but clients can create other files in this directory and include/require them from the default file.

Since WordPress is not loaded when these files are read, WordPress-defined functions are not available, but this can be easy to forget. Using a WP function when not defined, gives a fatal error which can take down a site.

## Describe the solution you'd like

A new sniff that can be applied to files in the `vip-config/` directory, and look for any functions that are not defined yet. We can use [`get_defined_functions()` function](https://www.php.net/manual/en/function.get-defined-functions.php) to look for defined functions. The `internal` index key will verify against PHP native functions, but we also need to consider functions that may be defined within the files of `vip-config/` itself. It may also depend on if a function call is done before or after the definition in the same file. There may be some false positives cases, but these are more likely to be edge cases vs capturing functions only defined in WordPress.

Early in the `process()`, use `$phpcs->getFilename()` which can give the complete file path, to abort the sniff early if not correct. The sniff should have a public property with the default pattern of files which should be scanned.

## What code should be reported as a violation?

```php
// In vip-config/vip-config.php:
home_url();
wp_redirect( ... );
// etc.
```

## What code should *not* be reported as a violation?

```php
// In vip-config/vip-config.php:
function foo() {
return 'foo';
}
foo();

bar();
function bar() {
return 'bar';
}
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start with the new sniff's process() and use $phpcs->getFilename() to confirm the public file pattern matches vip-config/vip-config.php; review get_defined_functions() and function definitions and calls in that file. Done means calls such as home_url() and wp_redirect() are reported, while functions defined in the same file, such as foo() and bar(), are not.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
php, wordpress
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.