Welcome to the official home of the WordPress Documentation Team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.
Want to get involved?
Start here to find out more about what we do and how to contribute:
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/
Weekly meetings
Join our discussions of documentation issues here on the blog and on Slack.
Use lowercase file, folder, and directory names. In general, separate words in filenames with hyphens, not underscores. Use standard ASCII alphanumeric characters in file, folder, and directory names.
If you’re creating and naming new files where other files have a different naming convention, see if the other files and folders can be renamed with the aforementioned guidelines. If you cannot change existing filenames, it is acceptable to use underscores or other naming conventions that are in use, to remain consistent with the existing style.
For example, if the directory already has files named as theme_1.php, theme_2.php, and theme_3.php, it’s acceptable to name the new file as theme_4.php instead of theme-4.php.
Examples
Not recommended:newcache.php, newCache.php, new-caché.php
Recommended:new-cache.php
Sometimes okay:new_cache.php
Not recommended:wpsettings1.php, wpSettings1.php, WPSettings1.php, wp-settings1.php, wpsettings-1.php
Recommended:wp-settings-1.php
Sometimes okay:wp_settings_1.php
It’s acceptable to have some inconsistency in file and folder names if it can’t be avoided otherwise. There might be predefined design and style guidelines or undocumented guidelines that are already in use. Sometimes, file naming can also be automated by the product. In those cases, it’s okay to make exceptions for those files.
If content from the file is included in the page, follow the code example guidelines and precede the code sample or content with an introductory statement that states the filename.
Example
Recommended: In the following styles.css file, set the opacity to 0.75:
Use the formal file type instead of the file extension while referring to file types. Many file types are expressed in uppercase, as they are acronyms or initialisms.
Examples
Not recommended: a .css file
Recommended: a CSSCSSCSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site. file
Not recommended: a .py file
Recommended: a Python file
The following table lists filename extensions and the corresponding file type names to use:
