Implement exclude revision flag to remove revision results from the search by imrraaj · Pull Request #255 · wp-cli/db-command

imrraaj · 2024-05-27T07:52:51Z

This PR implements the exclude_revisions flag for wp db search command. This flag allows users to exclude revisions from the search results.

PR fixes following issues:

Ability to Exclude Revisions from wp db search #156

Usage

wp db search <search> [--tables=<tables>] [--exclude_revisions]

…b search

…command

ernilambar · 2024-06-19T04:43:26Z

src/DB_Command.php

 	 * @var string[] Array of SQL mode names that are incompatible with WordPress.
 	 */
-	protected $sql_incompatible_modes = [
+	protected $sql_incompatible_modes = array(


Can you please revert changes in this and similar unrelated lines? For fixing code sniffer issues, please use composer run phpcbf. It seems you are using separate sniffer rules here.

ernilambar · 2024-06-19T04:47:26Z

@imrraaj Also can you please add Behat test for this new feature? Ref - https://make.wordpress.org/cli/handbook/contributions/pull-requests/#functional-tests

imrraaj · 2024-06-19T05:00:23Z

@ernilambar I'll do the necessary changes and I'll add the tests for the same

fatihturan · 2024-09-13T11:00:44Z

I hope you merge this into the new version of the WP CLI soon. I am still looking for a workaround to exclude revisions while exporting the database, but I can't find it yet.

Copilot

Pull Request Overview

This PR adds an --exclude_revisions flag to the wp db search command to filter out revision posts from search results in the wp_posts table.

Key changes:

Added --exclude_revisions parameter documentation to the search command
Implemented logic to exclude posts with post_type = 'revision' when the flag is enabled
Added test coverage for the new functionality

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
src/DB_Command.php	Added `--exclude_revisions` flag implementation with WHERE clause filtering for wp_posts table
features/db-search.feature	Added test scenario verifying revision exclusion behavior

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/DB_Command.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

codecov · 2025-11-02T15:47:41Z

Codecov Report

❌ Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/DB_Command.php	87.50%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

swissspidy · 2026-03-12T12:42:52Z

/gemini review

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-12T12:47:17Z

src/DB_Command.php

 			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 ) {


$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.

features/db-search.feature

Copilot · 2026-03-12T12:47:18Z

src/DB_Command.php

+					if ( $exclude_revisions && $wpdb->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 && $wpdb->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 ) );


--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.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

rajkp added 2 commits May 27, 2024 12:01

implement exclude revision flag to remove revision results from the d…

a94e53e

…b search

Fix indentation issues and refactor the conditions in wp db search …

aaaada6

…command

imrraaj marked this pull request as ready for review June 18, 2024 11:22

imrraaj requested a review from a team as a code owner June 18, 2024 11:22

ernilambar reviewed Jun 19, 2024

View reviewed changes

rajkp added 2 commits June 20, 2024 13:06

Fix the PHPCS formatting issue

2a9a529

Refactor the search query for exclude revision flag

c5e760d

imrraaj marked this pull request as draft June 20, 2024 08:29

rajkp added 2 commits June 20, 2024 14:31

FIx the PHPCS error for prepare statements

38ee18a

Add behat test for exclude_revisions flag

95cfad1

imrraaj marked this pull request as ready for review June 25, 2024 12:26

swissspidy requested a review from Copilot November 2, 2025 14:46

Copilot AI reviewed Nov 2, 2025

View reviewed changes

src/DB_Command.php Outdated Show resolved Hide resolved

src/DB_Command.php Outdated Show resolved Hide resolved

src/DB_Command.php Outdated Show resolved Hide resolved

Don't hardcode table name

c979679

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions bot added command:db-search scope:distribution labels Dec 22, 2025

swissspidy added 2 commits February 2, 2026 20:21

Merge branch 'main' into exclude_revisions

6f2c866

Merge branch 'main' into exclude_revisions

efbd997

swissspidy requested a review from Copilot March 12, 2026 12:42

Merge branch 'main' into exclude_revisions

0505dcb

Copilot started reviewing on behalf of swissspidy March 12, 2026 12:43 View session

This comment was marked as resolved.

Sign in to view

Copilot AI reviewed Mar 12, 2026

View reviewed changes

swissspidy and others added 2 commits March 12, 2026 14:05

Update features/db-search.feature

bcfccbe

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update features/db-search.feature

0420e71

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Conversation

imrraaj commented May 27, 2024

Usage

Uh oh!

ernilambar Jun 19, 2024

Choose a reason for hiding this comment

Uh oh!

ernilambar commented Jun 19, 2024

Uh oh!

imrraaj commented Jun 19, 2024

Uh oh!

fatihturan commented Sep 13, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Nov 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

swissspidy commented Mar 12, 2026

Uh oh!

This comment was marked as resolved.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Nov 2, 2025 •

edited

Loading