Skip to content

Implement exclude revision flag to remove revision results from the search #255

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

Open
imrraaj wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Implement exclude revision flag to remove revision results from the search #255

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a94e53e
implement exclude revision flag to remove revision results from the d…
May 27, 2024
aaaada6
Fix indentation issues and refactor the conditions in `wp db search` …
May 27, 2024
2a9a529
Fix the PHPCS formatting issue
Jun 20, 2024
c5e760d
Refactor the search query for exclude revision flag
Jun 20, 2024
38ee18a
FIx the PHPCS error for prepare statements
Jun 20, 2024
95cfad1
Add behat test for `exclude_revisions` flag
Jun 25, 2024
c979679
Don't hardcode table name
swissspidy Nov 2, 2025
6f2c866
Merge branch 'main' into exclude_revisions
swissspidy Feb 3, 2026
efbd997
Merge branch 'main' into exclude_revisions
swissspidy Feb 18, 2026
0505dcb
Merge branch 'main' into exclude_revisions
swissspidy Mar 12, 2026
bcfccbe
Update features/db-search.feature
swissspidy Mar 12, 2026
0420e71
Update features/db-search.feature
swissspidy Mar 12, 2026
0ff712a
Merge branch 'main' into exclude_revisions
swissspidy Mar 23, 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
23 changes: 23 additions & 0 deletions features/db-search.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,6 +914,29 @@ Feature: Search through the database
"""
And STDERR should be empty

Scenario: Search with exclude revisions option
Given a WP install
And I run `wp post create --post_content="This is the original post content." --post_title="Original Post"`
# Create a revision
And I run `wp post update 1 --post_content="This is the updated post content."`

When I run `wp db search "updated post content"`
Then STDOUT should contain:
"""
wp_posts:post_content
1:This is the updated post content.
wp_posts:post_content
5:This is the updated post content.
"""

When I run `wp db search "updated post content" --exclude_revisions`
Then STDOUT should contain:
"""
wp_posts:post_content
1:This is the updated post content.
"""
And STDERR should be empty

Scenario: Search with custom colors
Given a WP install

Expand Down
17 changes: 15 additions & 2 deletions src/DB_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1264,6 +1264,9 @@ public function prefix() {
* [--format=<format>]
* : Render output in a particular format.
*
* [--exclude_revisions]
* : Exclude revisions from the search.
*
* The percent color codes available are:
*
* | Code | Color
Expand Down Expand Up @@ -1388,6 +1391,7 @@ public function search( $args, $assoc_args ) {
$stats = Utils\get_flag_value( $assoc_args, 'stats', false );
$fields = Utils\get_flag_value( $assoc_args, 'fields' );
$format = Utils\get_flag_value( $assoc_args, 'format' );
$exclude_revisions = Utils\get_flag_value( $assoc_args, 'exclude_revisions', false );

$column_count = 0;
$row_count = 0;
Expand Down Expand Up @@ -1452,10 +1456,19 @@ public function search( $args, $assoc_args ) {
}

foreach ( $text_columns as $column ) {
$column_sql = self::esc_sql_ident( $column );
$column_sql = self::esc_sql_ident( $column );
$post_type_sql = self::esc_sql_ident( 'post_type' );
if ( $regex ) {
Comment on lines 1666 to 1669
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$post_type_sql is computed for every text column, but it never changes and is only needed when $exclude_revisions applies. Moving this identifier escaping outside the inner $text_columns loop (or only computing it when needed) would reduce repeated work and make the control flow easier to follow.

Copilot uses AI. Check for mistakes.
if ( $exclude_revisions && 'wp_posts' === $table ) {
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Escaped through esc_sql_ident/esc_like.
$results = $wpdb->get_results( "SELECT {$primary_key_sql}{$column_sql} FROM {$table_sql} WHERE {$post_type_sql} NOT IN ( 'revision' )" );
} else {
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Escaped through esc_sql_ident/esc_like.
$results = $wpdb->get_results( "SELECT {$primary_key_sql}{$column_sql} FROM {$table_sql}" );
}
} elseif ( $exclude_revisions && 'wp_posts' === $table ) {
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Escaped through esc_sql_ident/esc_like.
$results = $wpdb->get_results( "SELECT {$primary_key_sql}{$column_sql} FROM {$table_sql}" );
$results = $wpdb->get_results( $wpdb->prepare( "SELECT {$primary_key_sql}{$column_sql} FROM {$table_sql} WHERE {$column_sql} LIKE %s AND {$post_type_sql} NOT IN ( 'revision' )", $esc_like_search ) );
Comment on lines +1670 to +1679
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--exclude_revisions is only applied when $table === $wpdb->posts, which means revisions will still appear when searching a different posts table name (e.g. wp_2_posts during --network/--all-tables-with-prefix, or when the user explicitly passes another posts table). Consider applying the filter based on the table being a posts table (e.g. suffix check + verifying a post_type column exists), rather than only the current site's $wpdb->posts value.

Copilot uses AI. Check for mistakes.
} else {
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Escaped through esc_sql_ident/esc_like.
$results = $wpdb->get_results( $wpdb->prepare( "SELECT {$primary_key_sql}{$column_sql} FROM {$table_sql} WHERE {$column_sql} LIKE %s;", $esc_like_search ) );
Expand Down