DocsWP — WordPress Help

Issue Reproduction

Issue reproduction is a critical step in communicating and confirming how to trigger the undesired behavior that was reported in the ticket.

Provide as much of the environment information as possible and any special configuration considerations (using Docker, 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. with subdomains, etc). Delete any sections from the report that are not applicable.

Example reproduction reports:

Generating Reports with the Test Reports 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/ or can be cost-based plugin from a third-party.

Instead of filling out the template manually, you can use the Test Reports plugin to auto-generate reproduction reports pre-filled with your environment details.

What it does

The plugin automatically captures your WordPress version, 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 version, active theme, plugins, browser, and OS — eliminating manual data entry for the Environment section.

Where to get it

Install Test Reports directly from wordpress.org/plugins/test-reports.

How to use it

  1. Install and activate the plugin on your test site.
  2. Navigate to Tools > Test Reports or click Test Reports in the admin toolbar.
  3. Select the Report Type (Bug Reproduction) and Report Location (TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. or 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/) — the plugin will format the output accordingly.
  4. Fill in only the fields that require manual input: Steps taken, Expected behavior, and Additional Notes.

Plugin Screenshot

Test Reports plugin: admin toolbar menu, Report Type and Report Location selection, and generated reproduction report output

Tips

  • For GitHub issues, the plugin outputs Markdown-formatted reports ready to paste directly.
  • For Trac tickets, the plugin outputs Wiki-formatted reports compatible with Trac’s syntax.
  • Always review the auto-filled environment details before posting to confirm accuracy.

Reproduction Report Template

Trac template

Use this version when posting a reproduction report to a Trac ticket:

== Reproduction Report

=== Environment
- WordPress: X.Y-Z
- PHP: X.Y.Z
- Server: Server Name X.Y.Z
- Database: Database Name X.Y.Z
- Browser: Browser Name X.Y.Z
- OS: Operating System X.Y.Z
- Theme: Theme Name X.Y.Z
- MU Plugins:
  - MU Plugin 1 X.Y.Z
- Plugins:
  - Plugin 1 X.Y.Z
  - Plugin 2 X.Y.Z

=== Steps taken
1. Step one
2. Step two
x. 🐞 Bug occurs: Describe what happened / ❌ Bug is not occurring

=== Expected behavior
- Explain what behaviour you were expecting from the ticket information.

=== Additional Notes
- Any additional details worth mentioning.

=== Screenshots/Screencast with results
- Screenshot showcasing the problem or the bug not occurring.

=== Support Content
- Here you can add any support content useful for testing.
  1. Blueprint JSON
  2. Website Playground URL with parameters
  3. Snippets of code
  4. Additional Screenshots
  5. etc...

GitHub template

Use this version when posting a reproduction report to a GitHub issue:

## Reproduction Report

### Environment

- WordPress: X.Y-Z
- PHP: X.Y.Z
- Server: Server Name X.Y.Z
- Database: Database Name X.Y.Z
- Browser: Browser Name X.Y.Z
- OS: Operating System X.Y.Z
- Theme: Theme Name X.Y.Z
- MU Plugins:
  - MU Plugin 1 X.Y.Z
- Plugins:
  - Plugin 1 X.Y.Z
  - Plugin 2 X.Y.Z

### Steps taken

1. Step one
2. Step two
x. 🐞 Bug occurs: Describe what happened / ❌ Bug is not occurring

### Expected behavior

- Explain what behaviour you were expecting from the ticket information.

### Additional Notes

- Any additional details worth mentioning.

### Screenshots/Screencast with results

- Screenshot showcasing the problem or the bug not occurring.

### Support Content

- Here you can add any support content useful for testing.
  1. Blueprint JSON
  2. Website Playground URL with parameters
  3. Snippets of code
  4. Additional Screenshots
  5. etc...