Automattic / Automattic/VIP-Coding-Standards

Improve flush_rewrite_rules warning

Ouverte
#701 1 commentaire 4 réactions 0 personnes assignées Voir sur GitHub
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?

Right now here's the rule that we see when you try to use `flush_rewrite_rules()`:

> 🚫 Error( severity 5 ): flush_rewrite_rules should not be used in any normal circumstances in the theme code (WordPressVIPMinimum.Functions.RestrictedFunctions.flush_rewrite_rules_flush_rewrite_rules).

I feel like adding more context here as to "why" would be helpful, and also adding cases where this might be appropriate? For example, what about in a plugin activation/deactivation hook?

## Describe the solution you'd like

1. Why should you not use it
2. When it might be ok to use
3. What the effect of using it would have
4. Link to a doc on docs.wpvip.com to more details

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Trouvez la règle PHP_CodeSniffer qui émet l’avertissement concernant flush_rewrite_rules et examinez son message actuel ainsi que la documentation associée. Mettez à jour l’avertissement afin d’expliquer pourquoi la fonction est déconseillée, dans quels cas les hooks d’activation ou de désactivation peuvent être appropriés, ses effets et le lien pertinent vers docs.wpvip.com ; vérifiez les tests de la règle s’ils existent.

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

Évaluation

Stack technique
php, wordpress
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
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.