Download the PHP package wp-cli/profile-command without Composer

On this page you can find all versions of the php package wp-cli/profile-command. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package profile-command

wp-cli/profile-command

Quickly identify what's slow with WordPress.

Testing

Quick links: Contributing

Overview

wp profile monitors key performance indicators of the WordPress execution process to help you quickly identify points of slowness.

Save hours diagnosing slow WordPress sites. Because you can easily run it on any server that supports WP-CLI, wp profile compliments Xdebug and New Relic by pointing you in the right direction for further debugging. Because it runs on the command line, using wp profile means you don't have to install a plugin and deal with the painful dashboard of a slow WordPress site. And, because it's a WP-CLI command, wp profile makes it easy to perfom hard tasks (e.g. profiling a WP REST API response).

Identify why WordPress is slow in just a few steps with wp profile.

Using

This package implements the following commands:

wp profile stage

Profile each stage of the WordPress load process (bootstrap, main_query, template).

wp profile stage [<stage>] [--all] [--spotlight] [--url=<url>] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]

When WordPress handles a request from a browser, it’s essentially executing as one long PHP script. wp profile stage breaks the script into three stages:

OPTIONS

[<stage>]
    Drill down into a specific stage.

[--all]
    Expand upon all stages.

[--spotlight]
    Filter out logs with zero-ish values from the set.

[--url=<url>]
    Execute a request against a specified URL. Defaults to the home URL.

[--fields=<fields>]
    Limit the output to specific fields. Default is all fields.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - json
      - yaml
      - csv
    ---

[--order=<order>]
    Ascending or Descending order.
    ---
    default: ASC
    options:
      - ASC
      - DESC
    ---

[--orderby=<fields>]
    Set orderby which field.

EXAMPLES

# See an overview for each stage of the load process.
$ wp profile stage --fields=stage,time,cache_ratio
+------------+---------+-------------+
| stage      | time    | cache_ratio |
+------------+---------+-------------+
| bootstrap  | 0.7994s | 93.21%      |
| main_query | 0.0123s | 94.29%      |
| template   | 0.792s  | 91.23%      |
+------------+---------+-------------+
| total (3)  | 1.6037s | 92.91%      |
+------------+---------+-------------+

# Dive into hook performance for a given stage.
$ wp profile stage bootstrap --fields=hook,time,cache_ratio --spotlight
+--------------------------+---------+-------------+
| hook                     | time    | cache_ratio |
+--------------------------+---------+-------------+
| muplugins_loaded:before  | 0.2335s | 40%         |
| muplugins_loaded         | 0.0007s | 50%         |
| plugins_loaded:before    | 0.2792s | 77.63%      |
| plugins_loaded           | 0.1502s | 100%        |
| after_setup_theme:before | 0.068s  | 100%        |
| init                     | 0.2643s | 96.88%      |
| wp_loaded:after          | 0.0377s |             |
+--------------------------+---------+-------------+
| total (7)                | 1.0335s | 77.42%      |
+--------------------------+---------+-------------+

wp profile hook

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

In order to profile callbacks on a specific hook, the action or filter will need to execute during the course of the request.

OPTIONS

[<hook>]
    Drill into key metrics of callbacks on a specific WordPress hook.

[--all]
    Profile callbacks for all WordPress hooks.

[--spotlight]
    Filter out logs with zero-ish values from the set.

[--url=<url>]
    Execute a request against a specified URL. Defaults to the home URL.

[--fields=<fields>]
    Display one or more fields.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - json
      - yaml
      - csv
    ---

[--order=<order>]
    Ascending or Descending order.
    ---
    default: ASC
    options:
      - ASC
      - DESC
    ---

[--orderby=<fields>]
    Set orderby which field.

EXAMPLES

# Profile a hook.
$ wp profile hook template_redirect --fields=callback,cache_hits,cache_misses
+--------------------------------+------------+--------------+
| callback                       | cache_hits | cache_misses |
+--------------------------------+------------+--------------+
| _wp_admin_bar_init()           | 0          | 0            |
| wp_old_slug_redirect()         | 0          | 0            |
| redirect_canonical()           | 5          | 0            |
| WP_Sitemaps->render_sitemaps() | 0          | 0            |
| rest_output_link_header()      | 3          | 0            |
| wp_shortlink_header()          | 0          | 0            |
| wp_redirect_admin_locations()  | 0          | 0            |
+--------------------------------+------------+--------------+
| total (7)                      | 8          | 0            |
+--------------------------------+------------+--------------+

wp profile eval

Profile arbitrary code execution.

wp profile eval <php-code> [--hook[=<hook>]] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]

Code execution happens after WordPress has loaded entirely, which means you can use any utilities defined in WordPress, active plugins, or the current theme.

OPTIONS

<php-code>
    The code to execute, as a string.

[--hook[=<hook>]]
    Focus on key metrics for all hooks, or callbacks on a specific hook.

[--fields=<fields>]
    Display one or more fields.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - json
      - yaml
      - csv
    ---

[--order=<order>]
    Ascending or Descending order.
    ---
    default: ASC
    options:
      - ASC
      - DESC
    ---

[--orderby=<fields>]
    Set orderby which field.

EXAMPLES

# Profile a function that makes one HTTP request.
$ wp profile eval 'wp_remote_get( "https://www.apple.com/" );' --fields=time,cache_ratio,request_count
+---------+-------------+---------------+
| time    | cache_ratio | request_count |
+---------+-------------+---------------+
| 0.1009s | 100%        | 1             |
+---------+-------------+---------------+

wp profile eval-file

Profile execution of an arbitrary file.

wp profile eval-file <file> [--hook[=<hook>]] [--fields=<fields>] [--format=<format>] [--order=<order>] [--orderby=<fields>]

File execution happens after WordPress has loaded entirely, which means you can use any utilities defined in WordPress, active plugins, or the current theme.

OPTIONS

<file>
    The path to the PHP file to execute and profile.

[--hook[=<hook>]]
    Focus on key metrics for all hooks, or callbacks on a specific hook.

[--fields=<fields>]
    Display one or more fields.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - json
      - yaml
      - csv
    ---

[--order=<order>]
    Ascending or Descending order.
    ---
    default: ASC
    options:
      - ASC
      - DESC
    ---

[--orderby=<fields>]
    Set orderby which field.

EXAMPLES

# Profile from a file `request.php` containing `<?php wp_remote_get( "https://www.apple.com/" );`.
$ wp profile eval-file request.php --fields=time,cache_ratio,request_count
+---------+-------------+---------------+
| time    | cache_ratio | request_count |
+---------+-------------+---------------+
| 0.1009s | 100%        | 1             |
+---------+-------------+---------------+

Installing

Installing this package requires WP-CLI v2.5 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:

To install the latest development version of this package, use the following command instead:

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.

This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.

All versions of profile-command with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6
wp-cli/wp-cli Version ^2.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package wp-cli/profile-command contains the following files

Loading the files please wait ....