WordPress / WordPress/WordPress-Coding-Standards
Verify method of detecting WordPress.Files.FileName.InvalidTemplateTagFileName
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 2.8k
- Forks
- 521
- Avg merge
- 5d 20h
- Merged PRs (30d)
- 1
Description
Bug Description
The WordPress.Files.FileName.InvalidTemplateTagFileName sniff incorrectly throws an error on src/wp-includes/template.php. This file is part of the Template subpackage, but doesn't contain template tags.
Minimal Code Snippet
$ vendor/bin/phpcs --sniffs=WordPress.Files.FileName src/wp-includes/template.php
E 1 / 1 (100%)
FILE: src/wp-includes/template.php
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1 | ERROR | Files containing template tags should have "-template" appended to the end of the file name. Expected template-template.php, but found template.php.
| | (WordPress.Files.FileName.InvalidTemplateTagFileName)
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
For bugs with fixers: How was the code fixed? How did you expect the code to be fixed?
Error Code
WordPress.Files.FileName.InvalidTemplateTagFileName
Environment
| Question | Answer |
|---|---|
| PHP version | 7.1.23 |
| PHP_CodeSniffer version | 3.3.1 |
| WPCS version | 1.0.0 |
| WPCS install type | Composer project local |
Tested Against develop branch?
- I have verified the issue still exists in the
developbranch of WPCS.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the report with vendor/bin/phpcs --sniffs=WordPress.Files.FileName src/wp-includes/template.php, then inspect WordPress/Sniffs/Files/FileNameSniff.php around lines 213-242. Done means this file no longer triggers InvalidTemplateTagFileName while files that actually contain template tags retain the expected filename check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100