Automattic / Automattic/VIP-Coding-Standards

Improve flush_rewrite_rules warning

Offen
#701 1 Kommentar 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Type: Enhancement
Vorherrschende Sprache
PHP
Sterne
261
Forks
44
Ø Merge
19 Min.
Gemergte PRs (30 T.)
1

Beschreibung

## 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Suchen Sie nach der PHP_CodeSniffer-Regel, die die Warnung für flush_rewrite_rules ausgibt, und überprüfen Sie ihre bestehende Meldung sowie die zugehörige Dokumentation. Aktualisieren Sie die Warnung so, dass sie erklärt, warum von der Funktion abgeraten wird, wann Aktivierungs- oder Deaktivierungshooks angebracht sein können, welche Auswirkungen sie hat und auf den relevanten Link zu docs.wpvip.com verweist; überprüfen Sie die Tests der Regel, falls vorhanden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
php, wordpress
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.