Plugin header and activation in Wordpress - Mini Project: Build & Apply

WordPress Plugin Header and Activation

📖 Scenario: You want to create a simple WordPress plugin that can be activated and recognized by WordPress.This plugin will have a proper header so WordPress can identify it, and it will run a function when activated.

🎯 Goal: Build a WordPress plugin file with a correct plugin header and an activation hook that runs a function.

📋 What You'll Learn

Create a plugin header with the exact plugin name 'My Sample Plugin'

Add an activation hook that calls a function named 'my_sample_plugin_activate'

Define the 'my_sample_plugin_activate' function with a simple comment inside

Ensure the plugin file is valid PHP with opening tags

💡 Why This Matters

🌍 Real World

WordPress plugins need a proper header and activation hooks to integrate with the WordPress system and perform setup tasks.

💼 Career

Understanding plugin headers and activation hooks is essential for WordPress developers creating custom plugins or maintaining existing ones.

1

Create the plugin header

Create a PHP file starting with <?php and add a plugin header comment block with the exact plugin name My Sample Plugin.

Wordpress

<?php

// Your code here

Hint

The plugin header must be a PHP comment block starting with /* and include Plugin Name: My Sample Plugin.

2

Add the activation hook

Add a line that registers an activation hook using register_activation_hook with __FILE__ and the function name my_sample_plugin_activate.

Wordpress

<?php
/*
Plugin Name: My Sample Plugin
*/

// Your code here

Hint

Use register_activation_hook(__FILE__, 'my_sample_plugin_activate'); to link the activation event to your function.

3

Define the activation function

Define the function my_sample_plugin_activate with an empty body containing only a comment // Activation code here.

Wordpress

<?php
/*
Plugin Name: My Sample Plugin
*/

register_activation_hook(__FILE__, 'my_sample_plugin_activate');

// Your code here

Hint

Define the function exactly as function my_sample_plugin_activate() {} and add the comment inside.

4

Complete the plugin file

Ensure the plugin file starts with <?php, includes the plugin header, the activation hook, and the activation function as defined before.

Wordpress

<?php
/*
Plugin Name: My Sample Plugin
*/

register_activation_hook(__FILE__, 'my_sample_plugin_activate');

function my_sample_plugin_activate() {
    // Activation code here
}

// Your code here

Hint

Check that all parts are present and correctly spelled in the plugin file.

Practice

1. What is the main purpose of the plugin header in a WordPress plugin?

easy

A. To style the plugin's admin page

B. To run code when the plugin is activated

C. To connect the plugin to the WordPress database

D. To provide WordPress with information about the plugin like name and version

Solution

1. Step 1: Understand the role of the plugin header

   The plugin header is a comment block at the top of the main plugin file that tells WordPress details like the plugin's name, version, author, and description.

2. Step 2: Differentiate header from activation code

   Activation code runs when the plugin is turned on, but the header only provides metadata to WordPress.

3. Final Answer:

   To provide WordPress with information about the plugin like name and version -> Option D

4. Quick Check:

   Plugin header = plugin info [OK]

Hint: Plugin header is metadata, not code execution [OK]

Common Mistakes:

• Confusing header with activation hook
• Thinking header runs code
• Assuming header styles plugin pages

2. Which of the following is the correct way to start a plugin header in a WordPress plugin file?

easy

A.

B.

C. /*\nPlugin Name: My Plugin\n*/

D. "

Solution

1. Step 1: Recognize the plugin header format

   The plugin header must be a PHP comment block at the top of the main plugin file, starting with and ending with */ ?>.

2. Step 2: Check each option's syntax

   uses the correct PHP comment block format. uses a single-line comment which WordPress does not recognize as a header. /*\nPlugin Name: My Plugin\n*/ is a string, not a comment. " is an HTML comment, which WordPress ignores.

3. Final Answer:

   <?php /* Plugin Name: My Plugin */ ?> -> Option B

4. Quick Check:

   Plugin header = PHP comment block [OK]

Hint: Plugin header must be inside PHP comment block [OK]

Common Mistakes:

• Using single-line comments for header
• Using HTML comments instead of PHP comments
• Not starting with php

3. Given this plugin activation code snippet, what will happen when the plugin is activated?

register_activation_hook(__FILE__, function() {
    update_option('my_plugin_activated', true);
});

medium

A. The option 'my_plugin_activated' will be set to true in the database

B. Nothing happens because the hook is incorrect

C. The plugin will deactivate immediately

D. An error will occur because update_option is not allowed

Solution

1. Step 1: Understand register_activation_hook usage

   This function runs the given callback once when the plugin is activated.

2. Step 2: Analyze the callback function

   The callback calls update_option to set 'my_plugin_activated' to true in the WordPress options table.

3. Final Answer:

   The option 'my_plugin_activated' will be set to true in the database -> Option A

4. Quick Check:

   Activation hook runs callback once [OK]

Hint: Activation hook runs code once on plugin activation [OK]

Common Mistakes:

• Thinking activation hook runs on every page load
• Confusing activation with deactivation hooks
• Assuming update_option causes errors

4. Identify the error in this plugin activation code:

register_activation_hook(__FILE__, 'activate_plugin');

function activate_plugin() {
    add_option('plugin_activated', true);
}

medium

A. Using add_option instead of update_option causes failure if option exists

B. register_activation_hook must use an anonymous function, not named

C. The function activate_plugin is missing a return statement

D. The __FILE__ constant is not allowed in register_activation_hook

Solution

1. Step 1: Understand add_option vs update_option

   add_option adds a new option only if it does not exist. If the option exists, it fails silently. update_option adds or updates the option.

2. Step 2: Check the activation code behavior

   If the plugin is activated multiple times or the option already exists, add_option will not update the value, possibly causing unexpected behavior.

3. Final Answer:

   Using add_option instead of update_option causes failure if option exists -> Option A

4. Quick Check:

   Use update_option to ensure option is set [OK]

Hint: Use update_option in activation to avoid silent failures [OK]

Common Mistakes:

• Confusing add_option and update_option
• Thinking named functions can't be used
• Misunderstanding __FILE__ usage

5. You want your plugin to create a custom database table only once when activated. Which is the best way to do this in your plugin activation hook?

hard

A. Create the table inside the plugin's main file without any condition

B. Create the table every time the plugin runs, outside any hook

C. Use register_activation_hook with a function that checks if the table exists, then creates it if missing

D. Use the plugin header to define the table creation SQL

Solution

1. Step 1: Understand when to create database tables

   Database tables should be created once on plugin activation to avoid errors and performance issues.

2. Step 2: Use activation hook with existence check

   The activation hook runs once. Checking if the table exists before creating prevents errors if the plugin is reactivated.

3. Step 3: Avoid creating tables on every page load or in headers

   Creating tables outside activation or without checks can cause repeated attempts and errors.

4. Final Answer:

   Use register_activation_hook with a function that checks if the table exists, then creates it if missing -> Option C

5. Quick Check:

   Activation hook + check = safe table creation [OK]

Hint: Create tables only once inside activation hook with checks [OK]

Common Mistakes:

• Creating tables on every page load
• Putting SQL in plugin header
• Not checking if table exists before creating