Title: Performance Lab
Author: Bethany Chobanian Lang
Published: October 11, 2022
Last modified: May 14, 2026

---

# Performance Lab

## In this article

 * [Getting started](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#getting-started)
    - [Prerequisites](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#prerequisites)
    - [Set up the built-in development environment](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#set-up-the-built-in-development-environment)
    - [Useful commands](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#useful-commands)
    - [Adding repo to existing WordPress development site](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#adding-repo-to-existing-wordpress-development-site)
 * [GitHub workflow](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#github-workflow)
    - [Issues](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#issues)
    - [Working on an issue](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#working-on-an-issue)
    - [Pull requests](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#pull-requests)
    - [Trac tickets](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#trac-tickets)
    - [POC responsibilities](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#poc-responsibilities)
 * [Testing](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#testing)
 * [Support forum](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#support-forum)
 * [Translations](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#translations)

The [Performance Lab plugin](https://wordpress.org/plugins/performance-lab/) is 
a collection of “[feature projects](https://make.wordpress.org/core/features/)” 
for WordPress CoreCore Core is the set of software required to run WordPress. The
Core Development Team builds WordPress. that aim to improve performance in WordPress.
These projects each are implemented as plugins themselves, and they are intended
to eventually be merged into WordPress Core. As such, Performance Lab and its suite
of plugins are considered betaBeta A pre-release of software that is given out to
a large group of users to trial under real conditions. Beta versions have gone through
alpha testing in-house and are generally fairly close in look, feel and function
to the final product; however, design changes often occur as part of the process.
testing plugins.

## 󠀁[Getting started](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#getting-started)󠁿

### 󠀁[Prerequisites](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#prerequisites)󠁿

 * [Node.js](https://nodejs.org/)
 * [Docker](https://www.docker.com/products/docker-desktop)
 * [Git](https://git-scm.com/)
 * [Composer](https://getcomposer.org/) (if you prefer to run the Composer tools
   locally)

### 󠀁[Set up the built-in development environment](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#set-up-the-built-in-development-environment)󠁿

**1. Install and configure the prerequisites noted above**

**2. Clone the repository**

Start by cloning the repository into your local machine using this command:

    ```wp-block-code
    git clone https://github.com/WordPress/performance.git
    ```

**3. Install local development dependencies**

Then, inside of the `performance` directory, install local development dependencies
and pre-commit hooksHooks In WordPress theme and development, hooks are functions
that can be applied to an action or a Filter in WordPress. Actions are functions
performed when a certain event occurs in WordPress. Filters allow you to modify 
certain functions. Arguments used to hook both filters and actions look the same.(
via Husky):

    ```wp-block-code
    npm ci
    composer install
    ```

Also, to set up the pre-commit hooks via Husky, run:

    ```wp-block-code
    npm run prepare
    ```

This is not done automatically during `npm ci` (or later via `npm install`) because
your environment may have `ignore-scripts = true` to mitigate supply-chain risk 
from dependency install scripts.

**4. Do an initial pluginPlugin A plugin is a piece of software containing a group
of functions that can be added to a WordPress website. They can extend functionality
or add new features to your WordPress websites. WordPress plugins are written in
the PHP programming language and integrate seamlessly with WordPress. These can 
be free in the WordPress.org Plugin Directory [https://wordpress.org/plugins/](https://wordpress.org/plugins/)
or can be cost-based plugin from a third-party. build**

Some of the plugins have JavaScriptJavaScript JavaScript or JS is an object-oriented
computer programming language commonly used to create interactive effects within
web browsers. WordPress makes extensive use of JS for a better user experience. 
While PHP is executed on the server, JS executes within a user’s browser. [https://www.javascript.com](https://www.javascript.com/)
assets that need to be built. So before starting the environment, build them via`
npm run build`.

**5. Start the local WordPress environment**

Run `npm run wp-env start` to start the WordPress environment. The WordPress development
siteDevelopment Site You can keep a copy of your live site in a separate environment.
Maintaining a development site is a good practice that can let you make any changes
and test them without affecting the live/production environment. will be available
at [http://localhost:8888](http://localhost:8888) and WP admin will be available
at [http://localhost:8888/wp-admin/](http://localhost:8888/wp-admin/). You can log
in to the admin using the username `admin` and password `password`.

### 󠀁[Useful commands](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#useful-commands)󠁿

 * `npm install`: Installs local development dependencies
 * `npm run wp-env start`: Starts the local development environment
 * `npm run wp-env stop`: Stops the local development environment
 * `npm run lint-php`: Lints all PHPPHP PHP (recursive acronym for PHP: Hypertext
   Preprocessor) is a widely-used open source general-purpose scripting language
   that is especially suited for web development and can be embedded into HTML. 
   [https://www.php.net/manual/en/index.php](https://www.php.net/manual/en/index.php)
   code (run after adding new code to the repository)
 * `npm run format-php`: Formats all PHP code (run after adding new code to the 
   repository)
 * `npm run test-php`: Runs PHPUnit tests for all PHP code
 * `npm run test-php-multisite`: Runs PHPUnit tests in multisiteMultisite Multisite
   is a WordPress feature which allows users to create a network of sites on a single
   WordPress installation. Available since WordPress version 3.0, Multisite is a
   continuation of WPMU or WordPress Multiuser project. WordPress MultiUser project
   was discontinued and its features were included into WordPress core. [Advanced Administration Handbook -> Create A Network.](https://developer.wordpress.org/advanced-administration/multisite/create-network/)
   for all PHP code

### 󠀁[Adding repo to existing WordPress development site](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#adding-repo-to-existing-wordpress-development-site)󠁿

The ideal environment setup is to use the built-in environment since it has been
tested to work with all the tooling. However, to get the plugin built and installed
in an arbitrary WordPress development environment so that it can at least run, you
can leverage symlinks in the following steps:

    ```wp-block-code
    cd wp-content/plugins
    git clone https://github.com/wordpress/performance
    for plugin in $( ls performance/plugins ); do 
        ln -s performance/plugins/$plugin $plugin; 
    done
    cd performance
    npm ci
    composer install
    npm run build
    ```

Note that you won’t be able to run the unit tests using this installation method.

## 󠀁[GitHub workflow](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#github-workflow)󠁿

We use GitHubGitHub GitHub is a website that offers online implementation of git
repositories that can easily be shared, copied and modified by other developers.
Public repositories are free to host, private repositories require a paid subscription.
GitHub introduced the concept of the ‘pull request’ where code changes done in branches
by contributors can be reviewed and discussed before being merged by the repository
owner. [https://github.com/](https://github.com/) to manage all code and related
discussions for the Performance Lab plugin. Please follow the workflow below to 
ensure that all issues are properly tracked.

### 󠀁[Issues](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#issues)󠁿

When [opening a new issue](https://github.com/WordPress/performance/issues/new/choose),
use the appropriate template: Bug report, Feature request, New plugin proposal, 
or Report a security vulnerability. All new issues should include the following 
labels:

 * A _[Type] _label
 * Optional: A _[Plugin] _label if the issue relates to a specific plugin as part
   of the monorepo

If it’s already clear, please also add a milestone, for instance using the next 
milestone for the plugin the issue is about. Use your best judgment here – if it’s
a smaller issue and we’re early in the release cycle, it can be assigned to the 
next release milestone. If it’s a large issue and we’re only a week out from the
release, it should not be assigned to the next milestone, but the one after.

In addition, the new issue should be assigned to an appropriate Project. By default,
new issues will automatically be added to the Backlog column within its project.
This is intended for tracking any future work that is not currently a high priority
as defined by the project’s point(s) of contact (POCs). Contributors are welcome
to work on issues in the Backlog, but response rates may be slower than they are
on prioritized issues.

### 󠀁[Working on an issue](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#working-on-an-issue)󠁿

If you’re interested in working on an issue, it’s helpful to notify the POC for 
the issue’s focus area by tagging them on the issue and/or notifying them in the
[weekly performance chat](https://make.wordpress.org/core/tag/performance/) so that
everyone is aware that someone is working on it and effort is not duplicated. For
an updated list of POCs, please [see the `CODEOWNERS` file](https://github.com/WordPress/performance/blob/trunk/.github/CODEOWNERS).

When you’re ready to begin work on an issue:

 * Assign it to yourself – Depending on your permissions levels, you may not be 
   able to self-assign an issue. Please tag @WordPress/performance-admins on an 
   issue if you need assistance with permissions. Please only assign an issue if
   you plan to work on it within a reasonable time frame, i.e. within the next 2
   weeks.
 * Change the Project column to **In Progress**
 * Remove the **Needs Dev** label, if applicable

In addition, there are several **Needs** labels that can be used to clarify next
steps on an issue.

**Needs Discussion**

Many issues require discussion and definition before development begins. For example,
multiple approaches may be considered and the community should discuss them before
a contributor proceeds with development. For those issues, add the Needs Discussion
label and raise the issue in the weekly performance chat.

**Needs Decision**

After discussion, a formal vote may be needed to determine how to proceed. If that’s
the case, please tag @WordPress/performance-admins in the issue for assistance with
setting up a vote via GitHub comment. [An example vote can be found here](https://github.com/WordPress/performance/issues/92#issuecomment-1068215411).

**Needs Dev**

If an issue requires (more) development and you are unable to complete it yourself,
remove yourself as the assignee and add a Needs Dev label.

**Needs Triage**

If you believe you may have discovered a possible bug or have an engineering-related
question about the plugin, add the Needs Triage label.

**Needs Testing**

If you have completed initial engineering and want community members to test prior
to merge, add the Needs Testing label.

### 󠀁[Pull requests](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#pull-requests)󠁿

#### 󠀁[Coding standards](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#coding-standards)󠁿

In general, all code must follow the [WordPress Coding Standards and best practices](https://developer.wordpress.org/coding-standards/).
For complete documentation about Performance Lab plugins specifications, please 
see the Writing a plugin section below.

For details about WordPress and PHP version requirements, please see the [`CONTRIBUTING.md` file](https://github.com/WordPress/performance/blob/trunk/CONTRIBUTING.md).

#### 󠀁[Branch name](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#branch-name)󠁿

Before opening a pull request, create a new branch for your suggested changes. This
branch can use almost any name, although it is recommended to include a reference
to the issue number in it. Please avoid prefixing your branch with `feature/` or`
release/` as those are reserved names for special protected branches in the Performance
Lab plugin. If you use one of those names, you will not be able to push code to 
the branch directly.

#### 󠀁[Pull request requirements](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#pull-request-requirements)󠁿

All pull requests should:

 * Be associated with an issue
 * Have _[Type] _label matching the related issue’s _[Type]_ label
 * Have either an assigned [milestone](https://github.com/WordPress/performance/milestones)
   for the plugin modified, or the _no milestone_ label if the PR touches central
   monorepo infrastructure that affects multiple plugins. Milestones should be assigned
   based upon the complexity of the PR as well as how close we are to the due date
   of the next milestone. Use your best judgment here – if it’s a smaller PR and
   we’re early in the release cycle, it can be assigned to the next release milestone.
   If it’s a large PR and we’re only a week out from the release, it should not 
   be assigned to the next milestone, but the one after. **NOTE: **PRs that have
   zero effect on the plugin end-user (e.g. documentation changes, engineering tooling,
   anything that doesn’t require a changelog) do not need a milestone, and should
   instead receive the no milestone label.

The PR title is used as the changelog entry via automated tooling, so try to use
a title that describes the change well. If the PR is about a low-level detail that
is not useful to include in the changelog, please add the _skip changelog_ label
to it.

When a PR for an issue is ready for review:

 * Change the Project column on the issue to Review
 * Add the **Needs Review** label to the issue

Reviewers will be auto-assigned based upon the issue’s assigned Project. Note that
all PRs require at least two reviewers.

### 󠀁[Trac tickets](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#trac-tickets)󠁿

[Trac](https://core.trac.wordpress.org/) is the system used to track issues related
to WordPress Core. There is a [`performance` label in Trac](https://core.trac.wordpress.org/query?status=!closed&focuses=~performance)
that has been added to over 300 issues dating back nearly 15 years.

While the Performance Team’s focus is on the work in the GitHub repo, the community
is welcome to consult with the Team on performance-related TracTrac Trac is the 
place where contributors create issues for bugs or feature requests much like GitHub.
[https://core.trac.wordpress.org/](https://core.trac.wordpress.org/). tickets. There
may also be tickets in Trac that are duplicates of planned work in the GitHub repo,
or warrant further discussion for inclusion in the plugin.

### 󠀁[POC responsibilities](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#poc-responsibilities)󠁿

Each [focus area](https://docs.google.com/spreadsheets/d/16N5oZ9wE6AkiqMz7b_707eh24vvpjMwsEG67XFAbxy8/edit#gid=0)
has a set one or more assigned points of contact (POCs), as defined in [the `CODEOWNERS` file](https://github.com/WordPress/performance/blob/trunk/.github/CODEOWNERS).
POCs are expected to:

 * Monitor new issues to ensure that new issues are appropriately designated to 
   their focus area
 * Make sure issues in their focus area are also added to the focus area’s GitHub
   Project
 * Monitor and update issues labeled with their focus area

## 󠀁[Testing](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#testing)󠁿

Since the Performance Lab plugin is intended to allow for testing and adjustments
to feature projects that will ultimately land in WordPress Core, one of the best
ways to help with the plugin is to simply install and test the existing features.
If you find any bugs or errors, please report them in GitHub using the [Bug Report issue template](https://github.com/WordPress/performance/issues/new?assignees=&labels=%5BType%5D+Bug&template=bug_report.md).

In addition, we can always use support from developers with testing features and
code _before_ they are released in the plugin. Issues that we could use additional
testing support with are labeled with the [**Needs Testing **label](https://github.com/WordPress/performance/labels/Needs%20Testing),
but feel free to review [all issues/PRs that need review](https://github.com/WordPress/performance/labels/Needs%20Review)
and assist with testing.

## 󠀁[Support forum](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#support-forum)󠁿

As a plugin on the WordPress.orgWordPress.org The community site where WordPress
code is created and shared by the users. This is where you can download the source
code for WordPress core, plugins and themes as well as the central location for 
community conversations and organization. [https://wordpress.org/](https://wordpress.org/)
repository, the Performance Lab plugin has its own [support forum](https://wordpress.org/support/plugin/performance-lab/).
Designated members of the Performance Team actively monitor the forum and reply 
to new support topics and [reviews](https://wordpress.org/support/plugin/performance-lab/reviews/).
Community members are always welcome to assist with forum topics, as well – just
be sure to follow the [WordPress.org forum guidelines](https://wordpress.org/support/guidelines/).

## 󠀁[Translations](https://make.wordpress.org/performance/handbook/performance-lab/?output_format=md#translations)󠁿

Translation of the Performance Lab plugin is done through the work of community 
volunteers as part of the [Polyglots Team](https://make.wordpress.org/polyglots/).
We would love for the plugin to be translated into as many languages as possible!
If you’d like to help, check out the [Translator’s Handbook](https://make.wordpress.org/polyglots/handbook/)
for more details.

First published

October 11, 2022

Last updated

May 14, 2026

[  Previous: Get Involved](https://make.wordpress.org/performance/handbook/get-involved/)

[  Next: Proposing a New Plugin for Performance Lab](https://make.wordpress.org/performance/handbook/performance-lab/proposing-a-new-plugin/)