Automattic / Automattic/VIP-Coding-Standards
Flag incorrect use of filter (instead of action) before AlwaysReturnSniff
- Vorherrschende Sprache
- PHP
- Sterne
- 261
- Forks
- 44
- Ø Merge
- 19 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
## What problem would the enhancement address for VIP?
Code that uses a filter instead of an action are being flagged with `WordPressVIPMinimum.Filters.AlwaysReturn.missingReturnStatement` when the correct developer remediation for the problematic code should be to change it to `add_action`
## Describe the solution you'd like
Flag use of `add_filter` on hooks that are most definitely only supposed to use `add_action`
Even better, use GitHub "suggestions" to show the correct change.
## What code should be reported as a violation?
`add_filter( 'rss2_item', 'attached_images' );`
## What code should *not* be reported as a violation?
`add_filter( 'the_content', 'my_filter_content' );`
## Additional context
If this raises a flag, then the `WordPressVIPMinimum.Filters.AlwaysReturn.missingReturnStatement` sniff should NOT.
Beitragsleitfaden
Rechercherichtung
Beginne mit der Untersuchung des Sniffs WordPressVIPMinimum.Filters.AlwaysReturn.missingReturnStatement und wie er Aufrufe von add_filter behandelt. Vergleiche die bereitgestellten Beispiele rss2_item und the_content und definiere anschließend die Hook-Liste und die erforderliche Interaktion, sodass nur für Aktionen verwendete Hooks markiert werden, die Verletzung wegen fehlender Rückgabe jedoch nicht; fertig ist es, wenn diese beiden Beispiele die angeforderten Ergebnisse liefern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- devtools, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100