cloudcatch/user-roles-table

A WordPress plugin that boosts WP_User_Query performance by adjusting SQL queries to use a custom user roles table, reducing overhead and improving scalability.

1.1.1 2024-12-13 14:28 UTC

Requires

• php: >=8.0

Requires (Dev)

• automattic/vipwpcs: ^3.0
• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• php-stubs/woocommerce-stubs: ^9.4
• php-stubs/wordpress-globals: ^0.2.0
• php-stubs/wp-cli-stubs: ^2.11
• phpcompatibility/phpcompatibility-wp: ^2.1
• phpunit/phpunit: ^9
• wp-coding-standards/wpcs: ^3.1
• yoast/phpunit-polyfills: ^2.0

GPL-2.0-or-later

• CloudCatch

• performance
• user
• wordpress
• query
• capabilities
• roles

README

A lightweight and efficient WordPress plugin that mirrors user roles into a custom database table to optimize performance for WP_User_Query and get_users() calls. By offloading role-based queries to a dedicated table, this plugin reduces database overhead, making large-scale user management faster and more reliable.

Installation

Install and activate the plugin. This should automatically install the database table: wp_user_roles.

Run the following command to copy all user role data to the new wp_user_roles table:

wp user-roles-table migrate

This command will extract all users roles and capabilities from wp_postmeta, and insert this data is a more performant schema in the wp_user_roles database table.

Running Unit Tests

To ensure the plugin works as expected, you can run the included unit tests. Follow the steps below:

Prerequisites

• Make sure you have Docker installed and running on your machine (required for wp-env).
• Ensure you have Composer installed to manage PHP dependencies.

Steps to Run Tests

1. Start the WordPress Environment: Use wp-env to spin up a local WordPress environment:

   wp-env start

2. Install Dependencies: If you haven't already, install the Composer dependencies:

   composer install

3. Run the Tests: Execute the Composer test script to run the unit tests:

   composer test