Plugin file structure in Wordpress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main file of a WordPress plugin called?

The main file is usually named after the plugin and contains the plugin header comment. It acts as the entry point for the plugin.

beginner

Why do WordPress plugins have a folder with multiple files instead of just one file?

To organize code better, separate features, and keep assets like CSS, JavaScript, and images in their own folders for clarity and maintainability.

intermediate

Name three common folders you might find inside a WordPress plugin folder.

Common folders include includes (for PHP code), assets (for CSS, JS, images), and languages (for translation files).

beginner

What is the purpose of the 'readme.txt' file in a WordPress plugin folder?

It provides information about the plugin like description, installation steps, changelog, and author details. It helps users understand the plugin.

beginner

How does the plugin header comment help WordPress recognize a plugin?

The header comment contains metadata like Plugin Name, Description, Version, and Author. WordPress reads this to list and activate the plugin.

Which file must contain the plugin header comment for WordPress to recognize the plugin?

A The main plugin PHP file

B readme.txt

C style.css

D functions.php

The main plugin PHP file contains the header comment that WordPress uses to identify the plugin.

Where should you place CSS and JavaScript files in a plugin folder?

A In the includes folder

B In the assets folder

C In the languages folder

D In the root plugin folder

Assets like CSS and JavaScript are best organized inside an assets folder.

What is the purpose of the 'languages' folder in a plugin?

A To store CSS files

B To store PHP code

C To store images

D To store translation files

The languages folder holds translation files to support multiple languages.

Which file provides users with plugin description and installation instructions?

A readme.txt

B index.php

C main plugin PHP file

D license.txt

The readme.txt file contains plugin details and instructions for users.

Why is it important to organize plugin files into folders?

A To confuse users

B To make the plugin load faster

C To keep code and assets organized and maintainable

D To reduce plugin size

Organizing files helps keep the plugin easy to understand and maintain.

Describe the typical file and folder structure of a WordPress plugin and explain the purpose of each part.

Think about how you would organize a small project with code, styles, and instructions.

Explain how WordPress recognizes a plugin and what role the plugin header comment plays.

Imagine WordPress scanning files to find plugins by looking for special comments.

Practice

1. Which file is required as the main entry point for a WordPress plugin?

easy

A. A PHP file with plugin header comments

B. A CSS file for styling the plugin

C. A JavaScript file for plugin scripts

D. An image file for the plugin icon

Solution

1. Step 1: Understand the main plugin file role

   The main plugin file must be a PHP file that contains header comments describing the plugin. This file acts as the entry point for WordPress to recognize and load the plugin.

2. Step 2: Differentiate file types in plugin structure

   CSS, JavaScript, and image files are used for styling, scripting, and visuals but are not the main plugin file.

3. Final Answer:

   A PHP file with plugin header comments -> Option A

4. Quick Check:

   Main plugin file = PHP with header [OK]

Hint: Main plugin file always has PHP header comments [OK]

Common Mistakes:

• Choosing CSS or JS files as main plugin file
• Thinking image files can be main plugin file
• Ignoring the required plugin header comments

2. Which of the following is the correct way to organize plugin files for better structure?

easy

A. Put all PHP, CSS, and JS files in the root plugin folder

B. Keep only the main PHP file and no folders

C. Place all files inside a single 'assets' folder

D. Separate PHP files into a 'includes' folder and assets into 'assets' folder

Solution

1. Step 1: Understand folder organization best practices

   Separating PHP files into an 'includes' folder and assets like CSS and JS into an 'assets' folder keeps the plugin organized and easier to maintain.

2. Step 2: Evaluate other options

   Putting all files in root or a single folder makes the plugin messy. Having no folders limits scalability.

3. Final Answer:

   Separate PHP files into a 'includes' folder and assets into 'assets' folder -> Option D

4. Quick Check:

   Organize by type in folders = B [OK]

Hint: Use 'includes' for PHP and 'assets' for CSS/JS [OK]

Common Mistakes:

• Mixing all files in root folder
• Putting everything inside 'assets' folder
• Not using folders at all

3. Given this plugin folder structure:

my-plugin/
  my-plugin.php
  includes/
    functions.php
  assets/
    style.css
    script.js

Which file should contain the plugin header comments?

medium

A. includes/functions.php

B. my-plugin.php

C. assets/script.js

D. assets/style.css

Solution

1. Step 1: Identify the main plugin file

   The main plugin file is the one in the root folder named after the plugin, here 'my-plugin.php'. This file must have the plugin header comments.

2. Step 2: Understand roles of other files

   Files in 'includes' and 'assets' folders hold supporting code and styles/scripts but do not contain the plugin header.

3. Final Answer:

   my-plugin.php -> Option B

4. Quick Check:

   Main plugin file = my-plugin.php [OK]

Hint: Plugin header is in root PHP file named after plugin [OK]

Common Mistakes:

• Putting header in includes/functions.php
• Thinking CSS or JS files hold plugin info
• Confusing folder files with main plugin file

4. You see this plugin structure:

plugin-folder/
  plugin-folder.php
  includes.php
  assets/
    style.css

What is wrong with this structure?

medium

A. The 'assets' folder should be named 'styles'

B. The main plugin file should be named differently

C. The 'includes.php' file should be a folder named 'includes'

D. There should be no CSS files in the plugin

Solution

1. Step 1: Check folder vs file naming conventions

   Typically, 'includes' is a folder holding PHP files, not a single PHP file named 'includes.php'. This breaks organization.

2. Step 2: Validate other options

   The main plugin file name is fine if it matches the folder. 'assets' is a common folder name for CSS/JS. CSS files are allowed.

3. Final Answer:

   The 'includes.php' file should be a folder named 'includes' -> Option C

4. Quick Check:

   'includes' must be a folder, not a file [OK]

Hint: 'includes' is a folder, not a single PHP file [OK]

Common Mistakes:

• Renaming main plugin file unnecessarily
• Renaming 'assets' folder incorrectly
• Thinking CSS files are not allowed

5. You want to add language support to your plugin. Which is the best way to organize your plugin files?

hard

A. Add a 'languages' folder for translation files and keep main PHP file in root

B. Put translation files inside the 'assets' folder with CSS and JS

C. Include translation files directly inside the main PHP file

D. Create a separate plugin just for translations

Solution

1. Step 1: Understand language file organization

   WordPress plugins commonly use a 'languages' folder to store translation files (.mo, .po). This keeps translations separate and organized.

2. Step 2: Evaluate other options

   Putting translations in 'assets' mixes code and assets. Including translations in PHP file is not practical. Separate plugin for translations is unnecessary.

3. Final Answer:

   Add a 'languages' folder for translation files and keep main PHP file in root -> Option A

4. Quick Check:

   Use 'languages' folder for translations [OK]

Hint: Use 'languages' folder for translations, not 'assets' [OK]

Common Mistakes:

• Mixing translation files with CSS/JS
• Embedding translations inside PHP code
• Creating separate plugin for translations