Opened 9 years ago
Closed 9 years ago
#33701 closed task (blessed) (fixed)
Standardize core file headers
Reported by: | DrewAPicture | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | 4.5 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description (last modified by )
Every file in WordPress should have file headers that follow the recommendations set out in the inline documentation standards.
This ticket will track my progress of overhauling core php file headers.
Change History (89)
#1
@
9 years ago
- Description modified (diff)
- Owner set to DrewAPicture
- Status changed from new to accepted
#21
@
9 years ago
I'd like to see this consistency applied to the empty index.php
files found inside wp-content
, plugins
, and themes
too. Currently there is just the following for each:
<?php // Silence is golden.
It could be made a little less cryptic for those viewing the files, and adhering to code standards with something like:
<?php /** * Intentionally empty file * * This file exists to stop directory listings on poorly configured servers. */
The Summary could be adapted for each index.php
to include the reference to which directory it is in, to avoid duplicate Summaries. The @package
and other tags may be added if this has any value for wp-parser.
Note: See
TracTickets for help on using
tickets.
In 33869: