Skip to content

[Update] Documentation for sniff WordPress.Files.FilesName #2590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open

[Update] Documentation for sniff WordPress.Files.FilesName #2590

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6d1f6bb
Add: documentation for FileName sniff
Nic-Sevic Sep 17, 2024
4f4f541
fix: syntax issues
Nic-Sevic Sep 17, 2024
a08e092
initial edits, breaking up standards
jasonkenison Aug 26, 2025
68a2773
updated examples, added new mimetype examples
jasonkenison Aug 26, 2025
200cdfa
clarified code examples and standard text
jasonkenison Sep 2, 2025
768e4a9
updated for spelling in broken "some" word
jasonkenison Sep 2, 2025
82cd070
requested updates
jasonkenison Sep 14, 2025
76d5c00
removed prefix from invalid line
jasonkenison Oct 24, 2025
6620ea9
improve examples
jasonkenison Oct 28, 2025
5458327
mixed case invalid example
jasonkenison Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions WordPress/Docs/Files/FileNameStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="File Name"
>
<standard>
<![CDATA[
Filenames should be all lowercase with hyphens separating words.
]]>
</standard>
<code_comparison>
<code title="Valid: Lowercase and `-` separators.">
<![CDATA[
<em>taxonomy-my-term</em>.inc
<em>some-file</em>.inc
<em>other-punctuation</em>.inc
]]>
</code>
<code title="Invalid: Other punctuation or mixed case.">
<![CDATA[
taxonomy-my<em>_</em>term.inc
<em>Some</em>-<em>File</em>.inc
other<em>+</em>punctuation<em>#</em>.inc
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Class file names should be based on the class name with `class-` prepended.
]]>
</standard>
<code_comparison>
<code title="Valid: File name matches class name with proper prefix.">
<![CDATA[
<em>class-bulk-updater</em>.php // `Bulk_Updater`.
<em>class-user-profile</em>.php // `User_Profile`.
<em>class-export-data</em>.php // `Export_Data`.
]]>
</code>
<code title="Invalid: File name does not match class name or the prefix is incorrect.">
<![CDATA[
class-<em>update-in-bulk</em>.php // `Bulk_Updater`.
<em></em>user-profile.php // `User_Profile`.
<em>class.</em>export-data.php // `Export_Data`.
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Non-class files in the directory `wp-includes` with a "@subpackage Template" tag should use the `-template` suffix.
]]>
</standard>
<code_comparison>
<code title="Valid: File name with proper suffix.">
<![CDATA[
general<em>-template</em>.php
]]>
</code>
<code title="Invalid: File name missing suffix.">
<![CDATA[
<em>general</em>.php
]]>
</code>
</code_comparison>
</documentation>
Loading