Merge branch 'main' into copilot/introduce-wp-profile-requests

Author: swissspidy

.gitattributes

@@ -0,0 +1,14 @@
+/.actrc export-ignore
+/.distignore export-ignore
+/.editorconfig export-ignore
+/.github export-ignore
+/.gitignore export-ignore
+/.typos.toml export-ignore
+/AGENTS.md export-ignore
+/behat.yml export-ignore
+/features export-ignore
+/phpcs.xml.dist export-ignore
+/phpstan.neon.dist export-ignore
+/phpunit.xml.dist export-ignore
+/tests export-ignore
+/wp-cli.yml export-ignore

.github/workflows/copilot-setup-steps.yml

@@ -21,13 +21,11 @@ jobs:
 
       - name: Check existence of composer.json file
         id: check_composer_file
-        uses: andstor/file-existence-action@076e0072799f4942c8bc574a82233e1e4d13e9d6 # v3
-        with:
-          files: "composer.json"
+        run: echo "files_exists=$(test -f composer.json && echo true || echo false)" >> "$GITHUB_OUTPUT"
 
       - name: Set up PHP environment
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1 # v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: 'latest'
           ini-values: zend.assertions=1, error_reporting=-1, display_errors=On
@@ -38,7 +36,7 @@ jobs:
 
       - name: Install Composer dependencies & cache dependencies
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # v3
+        uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # v3
         env:
           COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }}
         with:

README.md

@@ -115,7 +115,7 @@ render based on the main query, and renders it.
 Profile key metrics for WordPress hooks (actions and filters).
 
 ~~~
-wp profile hook [<hook>] [--all] [--spotlight] [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]
+wp profile hook [<hook>] [--all] [--spotlight] [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>] [--search=<pattern>]
 ~~~
 
 In order to profile callbacks on a specific hook, the action or filter
@@ -161,6 +161,9 @@ will need to execute during the course of the request.
 	[--orderby=<fields>]
 		Set orderby which field.
 
+	[--search=<pattern>]
+		Filter callbacks to those matching the given search pattern (case-insensitive).
+
 **EXAMPLES**
 
     # Profile a hook.
@@ -297,7 +300,7 @@ current theme.
 
 ## Installing
 
-Installing this package requires WP-CLI v2.12 or greater. Update to the latest stable release with `wp cli update`.
+Installing this package requires WP-CLI v2.13 or greater. Update to the latest stable release with `wp cli update`.
 
 Once you've done so, you can install the latest stable version of this package with:
 
@@ -333,5 +336,9 @@ Want to contribute a new feature? Please first [open a new issue](https://github
 
 Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.
 
+### License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
 
 *This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

composer.json

@@ -7,7 +7,7 @@
   "authors": [],
   "require": {
     "php": ">=7.2.24",
-    "wp-cli/wp-cli": "^2.12"
+    "wp-cli/wp-cli": "^2.13"
   },
   "require-dev": {
     "wp-cli/wp-cli-tests": "^5"

features/profile-hook.feature

@@ -1,6 +1,5 @@
 Feature: Profile a specific hook
 
-  @require-wp-4.0
   Scenario: Profile all hooks when a specific hook isn't specified
     Given a WP install
 
@@ -12,7 +11,6 @@ Feature: Profile a specific hook
       | template_redirect |
     And STDERR should be empty
 
-  @require-wp-4.4
   Scenario: Profile all callbacks when --all flag is used
     Given a WP install
 
@@ -21,21 +19,6 @@ Feature: Profile a specific hook
       | callback                   | cache_hits | cache_misses |
       | sanitize_comment_cookies() | 0          | 0            |
 
-  @less-than-php-7 @require-wp-4.0
-  Scenario: Profile an intermediate stage hook
-    Given a WP install
-
-    When I run `wp profile hook wp_head:before --fields=callback,cache_hits,cache_misses`
-    Then STDOUT should be a table containing rows:
-      | callback                       | cache_hits | cache_misses |
-      | parse_blocks()                 | 0          | 0            |
-      | _get_wptexturize_split_regex() | 0          | 0            |
-    And STDOUT should not contain:
-      """
-      WP_CLI\Profile\Profiler->wp_tick_profile_begin()
-      """
-
-  @require-wp-4.0
   Scenario: Profile a hook before the template is loaded
     Given a WP install
 
@@ -44,7 +27,6 @@ Feature: Profile a specific hook
       | callback          |
     And STDERR should be empty
 
-  @require-wp-4.0
   Scenario: Profile a hook without any callbacks
     Given a WP install
 
@@ -66,7 +48,7 @@ Feature: Profile a specific hook
       <meta name="generator"
       """
 
-  @require-wp-4.0 @less-than-wp-6.9
+  @less-than-wp-6.9
   Scenario: Profile the shutdown hook
     Given a WP install
     And a wp-content/mu-plugins/shutdown.php file:
@@ -108,7 +90,6 @@ Feature: Profile a specific hook
       | total (3)              | 0              | 1                |
     And STDERR should be empty
 
-  @require-wp-4.0
   Scenario: Indicate where a callback is defined with profiling a hook
     Given a WP install
     And a wp-content/mu-plugins/custom-action.php file:
@@ -128,64 +109,67 @@ Feature: Profile a specific hook
       | total (1)                   |                                           | 0          | 1            |
     And STDERR should be empty
 
-  @require-wp-4.4
-  Scenario: Hooks should only be called once
+  Scenario: Search for callbacks by name pattern on a specific hook
     Given a WP install
-    And a wp-content/mu-plugins/action-test.php file:
+    And a wp-content/mu-plugins/search-test.php file:
       """
       <?php
-      add_action( 'init', function(){
-        static $i;
-        if ( ! isset( $i ) ) {
-          $i = 0;
-        }
-        $i++;
-        WP_CLI::warning( 'Called ' . $i );
-      });
+      function wp_cli_search_hook_one() {}
+      function wp_cli_search_hook_two() {}
+      function unrelated_callback() {}
+      add_action( 'init', 'wp_cli_search_hook_one' );
+      add_action( 'init', 'wp_cli_search_hook_two' );
+      add_action( 'init', 'unrelated_callback' );
       """
 
-    When I try `wp profile hook init`
-    Then STDERR should be:
+    When I run `wp profile hook init --fields=callback --search=wp_cli_search_hook`
+    Then STDOUT should contain:
       """
-      Warning: Called 1
+      wp_cli_search_hook_one()
       """
-
-  @less-than-php-7 @require-wp-4.0
-  Scenario: Profile the mu_plugins:before hook
-    Given a WP install
-    And a wp-content/mu-plugins/awesome-file.php file:
+    And STDOUT should contain:
       """
-      <?php
-      function awesome_func() {
-        // does nothing
-      }
-      awesome_func();
+      wp_cli_search_hook_two()
       """
-
-    When I run `wp profile hook muplugins_loaded:before --fields=callback`
-    Then STDOUT should contain:
+    And STDOUT should not contain:
       """
-      wp-content/mu-plugins/awesome-file.php
+      unrelated_callback()
       """
+    And STDERR should be empty
 
-  @less-than-php-7 @require-wp-4.0
-  Scenario: Profile the :after hooks
+  Scenario: Search for callbacks by name pattern across all hooks
     Given a WP install
+    And a wp-content/mu-plugins/search-all-test.php file:
+      """
+      <?php
+      function wp_cli_search_all_hook() {}
+      add_action( 'init', 'wp_cli_search_all_hook' );
+      """
 
-    When I run `wp profile hook wp_loaded:after`
+    When I run `wp profile hook --all --fields=callback --search=wp_cli_search_all_hook`
     Then STDOUT should contain:
       """
-      do_action()
+      wp_cli_search_all_hook()
       """
+    And STDERR should be empty
 
-    When I run `wp profile hook wp:after`
-    Then STDOUT should contain:
+  Scenario: Hooks should only be called once
+    Given a WP install
+    And a wp-content/mu-plugins/action-test.php file:
       """
-      do_action_ref_array()
+      <?php
+      add_action( 'init', function(){
+        static $i;
+        if ( ! isset( $i ) ) {
+          $i = 0;
+        }
+        $i++;
+        WP_CLI::warning( 'Called ' . $i );
+      });
       """
 
-    When I run `wp profile hook wp_footer:after`
-    Then STDOUT should contain:
+    When I try `wp profile hook init`
+    Then STDERR should be:
       """
-      do_action()
+      Warning: Called 1
       """

features/profile-stage.feature

@@ -134,6 +134,17 @@ Feature: Profile the template render stage
       Error: Invalid stage. Must be one of bootstrap, main_query, template, or use --all.
       """
 
+  @require-wp-4.0
+  Scenario: Invalid field name supplied to --fields
+    Given a WP install
+
+    When I try `wp profile stage template --fields=test`
+    Then STDERR should contain:
+      """
+      Invalid field(s): test
+      """
+    And the return code should be 1
+
   @require-wp-4.0
   Scenario: Identify callback_count for each hook
     Given a WP install
@@ -160,3 +171,32 @@ Feature: Profile the template render stage
       | hook              |
       | init              |
       | wp_loaded:after   |
+
+  @require-wp-4.0
+  Scenario: Admin URL runs as a backend request and skips frontend stages
+    Given a WP install
+
+    When I run `wp profile stage --url=example.com/wp-admin/ --context=admin --fields=stage`
+    Then STDOUT should be a table containing rows:
+      | stage     |
+      | bootstrap |
+    And STDOUT should not contain:
+      """
+      main_query
+      """
+    And STDOUT should not contain:
+      """
+      template
+      """
+    And STDERR should be empty
+
+  @require-wp-4.0
+  Scenario: Admin URL without --context=admin emits an error
+    Given a WP install
+
+    When I try `wp profile stage --url=example.com/wp-admin/ --fields=stage`
+    Then STDERR should contain:
+      """
+      Profiling an admin URL requires --context=admin.
+      """
+    And the return code should be 1

features/profile.feature

@@ -8,7 +8,7 @@ Feature: Basic profile usage
       """
       usage: wp profile eval <php-code> [--hook[=<hook>]] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]
          or: wp profile eval-file <file> [--hook[=<hook>]] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]
-         or: wp profile hook [<hook>] [--all] [--spotlight] [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]
+         or: wp profile hook [<hook>] [--all] [--spotlight] [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>] [--search=<pattern>]
          or: wp profile requests [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]
          or: wp profile stage [<stage>] [--all] [--spotlight] [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]
 

src/Command.php

@@ -127,6 +127,7 @@ class Command {
 	 *     | total (7)                | 1.0335s | 77.42%      |
 	 *     +--------------------------+---------+-------------+
 	 *
+	 * @skipglobalargcheck
 	 * @when before_wp_load
 	 */
 	public function stage( $args, $assoc_args ) {
@@ -233,6 +234,9 @@ public function stage( $args, $assoc_args ) {
 	 * [--orderby=<fields>]
 	 * : Set orderby which field.
 	 *
+	 * [--search=<pattern>]
+	 * : Filter callbacks to those matching the given search pattern (case-insensitive).
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     # Profile a hook.
@@ -251,6 +255,7 @@ public function stage( $args, $assoc_args ) {
 	 *     | total (7)                      | 8          | 0            |
 	 *     +--------------------------------+------------+--------------+
 	 *
+	 * @skipglobalargcheck
 	 * @when before_wp_load
 	 */
 	public function hook( $args, $assoc_args ) {
@@ -291,6 +296,13 @@ public function hook( $args, $assoc_args ) {
 		if ( Utils\get_flag_value( $assoc_args, 'spotlight' ) ) {
 			$loggers = self::shine_spotlight( $loggers, $metrics );
 		}
+		$search = Utils\get_flag_value( $assoc_args, 'search', false );
+		if ( false !== $search && '' !== $search ) {
+			if ( ! $focus ) {
+				WP_CLI::error( '--search requires --all or a specific hook.' );
+			}
+			$loggers = self::filter_by_callback( $loggers, $search );
+		}
 		$formatter->display_items( $loggers, true, $order, $orderby );
 	}
 
@@ -606,4 +618,20 @@ private static function shine_spotlight( $loggers, $metrics ) {
 
 		return $loggers;
 	}
+
+	/**
+	 * Filter loggers to only those whose callback name matches a pattern.
+	 *
+	 * @param array  $loggers
+	 * @param string $pattern
+	 * @return array
+	 */
+	private static function filter_by_callback( $loggers, $pattern ) {
+		return array_filter(
+			$loggers,
+			function ( $logger ) use ( $pattern ) {
+				return isset( $logger->callback ) && false !== stripos( $logger->callback, $pattern );
+			}
+		);
+	}
 }