Automattic / Automattic/VIP-Coding-Standards

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

Ouverte
#467 2 commentaires 2 réactions 0 personnes assignées Voir sur GitHub
Standard: VIP-Go Type: Enhancement
Langage dominant
PHP
Étoiles
261
Forks
44
Merge moyen
19 min
PR mergées (30 j)
1

Description

## 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';
}
```

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
php, wordpress
Domaine
tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.