Skip to content

Improve Query Monitor setup to better support multisite installs #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JanJakes merged 3 commits into from
Jul 31, 2025
Merged

Improve Query Monitor setup to better support multisite installs #222

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0bc3d0f
Improve Query Monitor setup to better support multisite installs
JanJakes Jul 30, 2025
3a9b4b8
Check if Query Monitor is installed before querying for if it's active
JanJakes Jul 30, 2025
7b32fd0
Make sure no errors are displayed when Query Monitor activation query…
JanJakes Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 57 additions & 31 deletions integrations/query-monitor/boot.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
define( 'QM_DB_SYMLINK', false );
}

// 1. Check if we should load Query Monitor (as per the original "db.php" file).
// Check if we should load Query Monitor (as per the original "db.php" file).
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
Expand Down Expand Up @@ -56,29 +56,77 @@
}
}

/*
* Register SQLite enhancements for Query Monitor when plugins are loaded.
*
* This will also ensure that the plugin Query Monitor is fully initialized even
* when we can't load it eagerly, e.g. on a multisite install.
*/
function register_sqlite_enhancements_for_query_monitor() {
if ( ! class_exists( 'QM_Backtrace' ) ) {
return;
}

require_once __DIR__ . '/plugin.php';

if ( ! defined( 'SQLITE_QUERY_MONITOR_LOADED' ) ) {
define( 'SQLITE_QUERY_MONITOR_LOADED', true );
}
}

if ( function_exists( 'add_action' ) ) {
add_action( 'plugins_loaded', 'register_sqlite_enhancements_for_query_monitor' );
}

/*
* On a multisite install, we can't easily determine the current site eagerly.
* Therefore, let's bail out and let Query Monitor activate later as a plugin.
*/
if ( is_multisite() ) {
return;
}

/*
* Now, let's try to load Query Monitor eagerly, to start logging queries early.
* When the plugin is installed, we will check the database if it is also active.
*/
global $wpdb;
if ( ! isset( $wpdb ) ) {
return;
}

// 2. Check if Query Monitor is active.
// Check if Query Monitor is installed.
if ( defined( 'WP_PLUGIN_DIR' ) ) {
$plugins_dir = WP_PLUGIN_DIR;
} else {
$plugins_dir = WP_CONTENT_DIR . '/plugins';
}

$qm_dir = "{$plugins_dir}/query-monitor";
$qm_php = "{$qm_dir}/classes/PHP.php";

if ( ! is_readable( $qm_php ) ) {
return;
}

// Check if Query Monitor is active.
if ( null === $wpdb->options ) {
global $table_prefix;
$wpdb->set_prefix( $table_prefix ?? '' );
}

$query_monitor_active = false;
try {
$value = $wpdb->get_row(
// Make sure no errors are displayed when the query fails.
$show_errors = $wpdb->hide_errors();
$value = $wpdb->get_row(
$wpdb->prepare(
"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
'active_plugins'
)
);
/**
* $value may be null during WordPress Playground multisite setup.
* @see https://github.com/WordPress/sqlite-database-integration/pull/219.
*/
$wpdb->show_errors( $show_errors );

if ( null !== $value ) {
$query_monitor_active = in_array(
'query-monitor/query-monitor.php',
Expand All @@ -94,20 +142,7 @@
return;
}

// 3. Determine the plugins directory.
if ( defined( 'WP_PLUGIN_DIR' ) ) {
$plugins_dir = WP_PLUGIN_DIR;
} else {
$plugins_dir = WP_CONTENT_DIR . '/plugins';
}

// 4. Load Query Monitor (as per the original "db.php" file).
$qm_dir = "{$plugins_dir}/query-monitor";
$qm_php = "{$qm_dir}/classes/PHP.php";

if ( ! is_readable( $qm_php ) ) {
return;
}
// Load Query Monitor eagerly (as per the original "db.php" file).
require_once $qm_php;

if ( ! QM_PHP::version_met() ) {
Expand All @@ -129,14 +164,5 @@
define( 'SAVEQUERIES', true );
}

// 5. Mark the Query Monitor integration as loaded.
// Mark the Query Monitor integration as loaded.
define( 'SQLITE_QUERY_MONITOR_LOADED', true );

// 6. Register the SQLite enhancements for Query Monitor.
function register_sqlite_enhancements_for_query_monitor() {
require_once __DIR__ . '/plugin.php';
}

if ( function_exists( 'add_action' ) ) {
add_action( 'plugins_loaded', 'register_sqlite_enhancements_for_query_monitor' );
}