Plugin database tables in Wordpress - Mini Project: Build & Apply

Create and Use Plugin Database Tables in WordPress

📖 Scenario: You are building a WordPress plugin that needs to store custom data in its own database table. This is common when plugins manage their own records, like events, contacts, or custom logs.

🎯 Goal: Build a WordPress plugin that creates a custom database table on activation and inserts data into it.

📋 What You'll Learn

Create a function to set up a custom database table named wp_custom_data with columns id (primary key, auto-increment) and info (text).

Use the WordPress dbDelta function to create or update the table.

Add an activation hook to run the table creation function.

Insert a sample row with info value 'Hello World' into the custom table.

💡 Why This Matters

🌍 Real World

Many WordPress plugins need their own tables to store custom data efficiently and separately from posts or options.

💼 Career

Understanding how to create and manage plugin database tables is essential for WordPress plugin developers and backend engineers working with WordPress.

1

Create the database table setup function

Write a function called create_custom_table that uses the global $wpdb variable and sets a variable $table_name to $wpdb->prefix . 'custom_data'. Define a SQL string $charset_collate using $wpdb->get_charset_collate(). Then create a SQL statement $sql to create a table with columns id as mediumint(9) NOT NULL AUTO_INCREMENT PRIMARY KEY and info as text NOT NULL. Use dbDelta to run the SQL.

Wordpress

# Your code here to create the function create_custom_table

Hint

Remember to use dbDelta to create or update the table safely.

2

Add activation hook to create the table

Add a WordPress activation hook using register_activation_hook that calls the create_custom_table function when the plugin is activated. Use __FILE__ as the first argument.

Wordpress

prefix . 'custom_data';
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        info text NOT NULL,
        PRIMARY KEY  (id)
    ) $charset_collate;";

    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
}

// Add activation hook here

Hint

Use register_activation_hook with __FILE__ and the function name.

3

Insert a sample row into the custom table

Inside the create_custom_table function, after calling dbDelta, insert a new row into the $table_name table with the info column set to 'Hello World' using $wpdb->insert.

Wordpress

prefix . 'custom_data';
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        info text NOT NULL,
        PRIMARY KEY  (id)
    ) $charset_collate;";

    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );

    // Insert sample row here
}

register_activation_hook( __FILE__, 'create_custom_table' );

Hint

Use $wpdb->insert with the table name and data array.

4

Complete the plugin file with header and closing PHP tag

Add the WordPress plugin header comment at the top of the file with Plugin Name: Custom Data Table. Also, ensure the PHP file ends properly without extra closing tags.

Wordpress

prefix . 'custom_data';
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        info text NOT NULL,
        PRIMARY KEY  (id)
    ) $charset_collate;";

    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );

    $wpdb->insert(
        $table_name,
        array('info' => 'Hello World'),
        array('%s')
    );
}

register_activation_hook( __FILE__, 'create_custom_table' );

Hint

The plugin header comment must be at the very top of the file.

Practice

1. Why do WordPress plugins create their own database tables instead of using existing WordPress tables?

easy

A. To avoid using any database at all

B. Because WordPress does not allow plugins to use existing tables

C. To keep plugin data separate and organized for better performance

D. To make the plugin load slower intentionally

Solution

1. Step 1: Understand plugin data management

   Plugins create their own tables to store data separately from WordPress core data.

2. Step 2: Benefits of separate tables

   This separation helps organize data and improves performance by avoiding clutter in core tables.

3. Final Answer:

   To keep plugin data separate and organized for better performance -> Option C

4. Quick Check:

   Separate tables improve organization and performance [OK]

Hint: Separate plugin data for better organization and speed [OK]

Common Mistakes:

• Thinking WordPress forbids using core tables
• Believing plugins avoid databases entirely
• Assuming slower load is intentional

2. Which of the following is the correct way to get the table name with the WordPress prefix for a plugin table named myplugin_data?

easy

A. $wpdb->prefix . 'myplugin_data'

B. $wpdb->myplugin_data

C. myplugin_data

D. $wpdb->prefix('myplugin_data')

Solution

1. Step 1: Understand $wpdb prefix usage

   $wpdb->prefix contains the WordPress table prefix, usually 'wp_'.

2. Step 2: Correct concatenation for table name

   Concatenate $wpdb->prefix with the table name string to get the full table name.

3. Final Answer:

   $wpdb->prefix . 'myplugin_data' -> Option A

4. Quick Check:

   Prefix plus table name string = correct table name [OK]

Hint: Use $wpdb->prefix . 'table_name' for plugin tables [OK]

Common Mistakes:

• Using $wpdb->myplugin_data directly
• Not adding prefix to table name
• Calling $wpdb->prefix as a function

3. Given this code snippet in a plugin activation hook:

$table_name = $wpdb->prefix . 'myplugin_data';
$sql = "CREATE TABLE $table_name (
  id mediumint(9) NOT NULL AUTO_INCREMENT,
  name varchar(100) NOT NULL,
  PRIMARY KEY  (id)
);";
dbDelta($sql);

What will happen when this code runs?

medium

A. It updates existing rows in the table

B. It creates the table with columns id and name if it doesn't exist

C. It causes a syntax error because dbDelta cannot create tables

D. It deletes the table if it exists

Solution

1. Step 1: Understand dbDelta function

   dbDelta safely creates or updates database tables based on the SQL CREATE statement.

2. Step 2: Analyze the SQL statement

   The SQL creates a table with id and name columns and a primary key on id.

3. Final Answer:

   It creates the table with columns id and name if it doesn't exist -> Option B

4. Quick Check:

   dbDelta creates or updates tables safely [OK]

Hint: dbDelta creates or updates tables from SQL CREATE statements [OK]

Common Mistakes:

• Thinking dbDelta deletes tables
• Assuming dbDelta causes syntax errors
• Confusing dbDelta with data update functions

4. A plugin developer wrote this code to create a table:

$table_name = $wpdb->prefix . 'myplugin_data';
$sql = "CREATE TABLE $table_name (
  id int NOT NULL AUTO_INCREMENT,
  name varchar(100) NOT NULL,
  PRIMARY KEY (id)
)";
dbDelta($sql);

But the table is not created after activation. What is the likely problem?

medium

A. dbDelta requires the SQL string to end with a semicolon

B. Missing semicolon at the end of the SQL statement

C. Not calling $wpdb->query() before dbDelta()

D. Using int instead of mediumint for id

Solution

1. Step 1: Check SQL syntax for dbDelta

   dbDelta requires the SQL CREATE statement to end with a semicolon to parse correctly.

2. Step 2: Identify missing semicolon

   The SQL string lacks a semicolon after the closing parenthesis, causing dbDelta to fail creating the table.

3. Final Answer:

   dbDelta requires the SQL string to end with a semicolon -> Option A

4. Quick Check:

   SQL must end with semicolon for dbDelta [OK]

Hint: Always end SQL string with semicolon for dbDelta [OK]

Common Mistakes:

• Ignoring semicolon requirement
• Thinking int vs mediumint causes failure
• Calling $wpdb->query() unnecessarily

5. You want to add a new column email varchar(255) NOT NULL to your plugin's custom table myplugin_data during an update. Which approach correctly updates the table without losing data?

hard

A. Ignore the database and store emails in a separate file

B. Drop the table and recreate it with the new column

C. Use $wpdb->query() to run ALTER TABLE and then run dbDelta() with old SQL

D. Modify the original CREATE TABLE SQL to include the new column and run dbDelta() again

Solution

1. Step 1: Understand dbDelta update behavior

   dbDelta compares the current table structure with the SQL and adds missing columns safely.

2. Step 2: Update CREATE TABLE SQL with new column

   Modify the SQL to include the new email column and run dbDelta() to update the table without data loss.

3. Final Answer:

   Modify the original CREATE TABLE SQL to include the new column and run dbDelta() again -> Option D

4. Quick Check:

   dbDelta updates tables by comparing SQL definitions [OK]

Hint: Update CREATE TABLE SQL and rerun dbDelta to add columns [OK]

Common Mistakes:

• Dropping table loses all data
• Running ALTER TABLE manually then old dbDelta
• Avoiding database updates by using files