wp-cli/eval-command

Executes arbitrary PHP code or files., _(*1)

, _(*2)

Quick links: Using | Installing | Contributing | Support, _(*3)

Using

This package implements the following commands:, _(*4)

wp eval

Executes arbitrary PHP code., _(*5)

wp eval <php-code> [--skip-wordpress]

Note: because code is executed within a method, global variables need to be explicitly globalized., _(*6)

OPTIONS, _(*7)

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

[--skip-wordpress]
    Execute code without loading WordPress.

EXAMPLES, _(*8)

# Display WordPress content directory.
$ wp eval 'echo WP_CONTENT_DIR;'
/var/www/wordpress/wp-content

# Generate a random number.
$ wp eval 'echo rand();' --skip-wordpress
479620423

wp eval-file

Loads and executes a PHP file., _(*9)

wp eval-file <file> [<arg>...] [--skip-wordpress] [--use-include]

Note: because code is executed within a method, global variables need to be explicitly globalized., _(*10)

OPTIONS, _(*11)

<file>
    The path to the PHP file to execute.  Use '-' to run code from STDIN.

[<arg>...]
    One or more positional arguments to pass to the file. They are placed in the $args variable.

[--skip-wordpress]
    Load and execute file without loading WordPress.

[--use-include]
    Process the provided file via include instead of evaluating its contents.

Installing

This package is included with WP-CLI itself, no additional installation necessary., _(*12)

To install the latest version of this package over what's included in WP-CLI, run:, _(*13)

wp package install git@github.com:wp-cli/eval-command.git

Contributing

We appreciate you taking the initiative to contribute to this project., _(*14)

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., _(*15)

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

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed., _(*17)

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., _(*18)

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., _(*19)

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., _(*20)

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., _(*21)

Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support, _(*22)

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., _(*23)