Skip to content

A repo where everyone can contribute to keeping the theme requirements relevant and easy to understand and follow

Notifications You must be signed in to change notification settings

stalukder03/Theme-Requirements

Repository files navigation

Theme Requirements

A repo where everyone can contribute to keeping the theme requirements relevant and easy to understand and follow.

https://make.wordpress.org/themes/handbook/review/required/

About

In this repo you can open issues for:

Typos

Rewording requirements that are difficult to understand

Adding new examples to existing requirements

Report duplicate requirements

Adding new requirements

Removal of requirements

Table of Contents

1. Licensing

Be GPL compatible

Include license and copyright information for the theme

Include license information for included resources

Do not clone designs

Do not display the theme authors copyright on the front

2. Naming

Do not use theme in the theme name

Do not use the parent theme's name

Spell WordPress correctly

3. Code

Use a unique prefix

There must be no PHP notices, warnings or errors

There must be no JavsScript errots

Sanitize untrusted data

Escape untrusted data

Do not remove non-presentational hooks

Core Functionality and Features

Backwards compatibility

Do not block the adminbar

Do not hardcode content

Do not modify the activation UX

Do not use features only meant for Core

Do not hide WordPress features behind a paywall

Include comments.php

Use template tags and hooks correctly

Theme tags must match theme functionality

Use the core style for admin notices

Use WordPress functionality if available

Presentation vs Functionality

Do not include custom blocks

Do not save non trivial data

Do not display demo content

Do not use placeholder content

Hide installation instructions from logged out users

Functionality not related to design is not allowed

Use generic placeholder images

Child themes

Themes must be child theme ready

Child themes must include more than minor changes

Link: Naming child themes

Options and Settings

Use the correct capability for editing options

Use the customizer for options

Use sane defaults

Save options in a single array

Using transients

Plugins

Do not include plugins

Do not require plugins

Recommending plugins

Plugin territory

Do not include plugin functionality

Stylesheets and Scripts

Do not hardcode scripts or styles

Include human readable files

Include all scripts and styles

Use core scripts

Language

Including a language file

Use the theme slug as textdomain

All text must be translation ready

Use one language

Templates

Display front page content according to settings

Including custom templates

Use standard templates

4. Accessibility

keyboard navigation

Skip link

5. Screenshot

Screenshot must be a reasonable presentation of the theme

Use the correct screenshot size and ratio

Using text in the screenshot

6. Image guidelines

Do not use images of children

7. Readme.txt file

Include a readme.txt file

8. Importing or Downloading

Do not bundle demo conten

Themes must not import content

Do not include direct links to remote files

9. Documentation

Provide enough documentation

10. Privacy

Do not collect user data

Do not phone home

Do not use url shorteners

11. Selling, credits, and links

Do not include affiliate links

Do not use obtrusive upselling

Include license information on website

Including author URI

Including theme URI

Including footer credit links

About

A repo where everyone can contribute to keeping the theme requirements relevant and easy to understand and follow

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published