Skip to content

DB/SlowDBQuery: add XML documentation #2699

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
dingo-d merged 4 commits into from
Mar 5, 2026
Merged

DB/SlowDBQuery: add XML documentation #2699

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c550a2
docs: add documentation for `WordPress.DB.SlowDBQuery`
petitphp Jun 24, 2024
585ebfc
Improve documentation for `WordPress.DB.SlowDBQuery`
rodrigoprimo Feb 10, 2026
63ff8ec
Apply suggestions from code review
rodrigoprimo Feb 26, 2026
4e8f54c
Use different variable name for query string examples
rodrigoprimo Mar 5, 2026
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
33 changes: 33 additions & 0 deletions WordPress/Docs/DB/SlowDBQueryStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Slow DB Query"
>
<standard>
<![CDATA[
Usage of the meta_query, meta_key, meta_value, and tax_query keys in array assignments and query-parameter strings is discouraged and should be carefully evaluated. When passed to WordPress database query APIs, these keys can lead to slow queries, especially on large datasets.
]]>
</standard>
<code_comparison>
<code title="Valid: No potentially slow query keys.">
<![CDATA[
$query = new WP_Query( array(
'post_type' => 'post',
) );


$args = 'post_type=post&orderby=date';
]]>
</code>
<code title="Invalid: Using potentially slow query keys.">
<![CDATA[
$query = new WP_Query( array(
'<em>meta_key</em>' => 'color',
'<em>meta_value</em>' => 'blue',
) );

$args = 'post_type=post&<em>meta_key</em>=featured';
]]>
</code>
</code_comparison>
</documentation>
Loading