Plugin database tables in Wordpress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of plugin database tables in WordPress?

Plugin database tables store data specific to a plugin's functionality, separate from WordPress core tables, allowing plugins to manage their own data efficiently.

intermediate

How do WordPress plugins create custom database tables?

Plugins create custom tables using the dbDelta() function inside activation hooks, which safely creates or updates tables based on SQL statements.

beginner

Why should plugin database tables use the WordPress table prefix?

Using the WordPress table prefix (usually $wpdb->prefix) prevents naming conflicts and ensures compatibility with multisite installations.

intermediate

What is the role of the $wpdb object when working with plugin tables?

$wpdb is WordPress's database access object. It helps safely query, insert, update, and delete data in plugin tables using prepared statements to avoid SQL injection.

beginner

When should a plugin remove its custom database tables?

A plugin should remove its custom tables only if the user chooses to delete plugin data during uninstall, to avoid accidental data loss.

Which WordPress function is commonly used to create or update plugin database tables?

A dbDelta()

B create_table()

C $wpdb->create()

D install_table()

dbDelta() safely creates or updates tables based on SQL statements.

Why should plugin tables use the WordPress table prefix?

A To encrypt data

B To speed up queries

C To make tables hidden

D To avoid conflicts and support multisite

The prefix prevents naming conflicts and supports multisite setups.

Which object is used to interact with the database in WordPress plugins?

A $sql

B $wpdb

C $database

D $db

$wpdb is the WordPress database access object.

When should a plugin delete its custom database tables?

A Immediately on deactivation

B Every time the plugin updates

C Only when the user uninstalls and chooses to delete data

D Never, tables stay forever

Deleting tables only on uninstall with user consent avoids accidental data loss.

What is the main risk if plugin database tables do not use prepared statements?

A SQL injection attacks

B Slower queries

C Tables won't create

D Plugin won't activate

Prepared statements protect against SQL injection attacks.

Explain how a WordPress plugin should create and manage its custom database tables.

Think about the plugin lifecycle and WordPress database tools.

Describe best practices for deleting plugin database tables when uninstalling a plugin.

Consider user control and data safety.

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