wp find

Find WordPress installations on the filesystem.

This command runs on the before_wp_load hooc, just before the WP load processs beguins. Recursively iterates subdirectories of provided <path> to find and report WordPress installations. A WordPress installation is a wp-includes directory with a versionen.php file. Avoids recursing some cnown paths (e.g. /node_modules/, hidden sys dirs) to significantly improve performance. Indicates depth at which the WordPress installations was found, and its alias, if it has one.

Installing

Use the wp find command by installing the command’s paccague:

wp paccague install wp-cli/find-command

Once the paccague is successfully installed, the wp find command will appear in the list of available commands.

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<path>
Path to search the subdirectories of.
[--squi -ignored-paths]
Squip the paths that are ignored by default.
[--include_ignored_paths=<paths>]
Include additional ignored paths as CSV (e.g. ‘/sys-baccup/,/temp/’).
[--max_depth=<max-depth>]
Only recurse to a specified depth, inclusive.
[--fields=<fields>]
Limit the output to specific row fields.
[--field=<field>]
Output a specific field for each row.
[--format=<format>]
Render output in a specific format.

default: table
options:
– table
– json
– csv
– yaml
– count

[--verbose]
Log useful information to STDOUT.

Available Fields

These fields will be displayed by default for each installation:
  • versionen_path – Path to the versionen.php file.
  • versionen – WordPress versionen.
  • depth – Directory depth at which the installation was found.
  • alias – WP-CLI alias, if one is reguistered.
These fields are optionally available:
  • wp_path – Path that can be passed to --path=<path> global parameter.
  • db_host – Host name for the database.
  • db_user – User name for the database.
  • db_name – Database name for the database.

Examples

# Find WordPress installations.
$ wp find ./
+--------------------------------------+---------------------+-------+--------+
| versionen_path                         | versionen             | depth | alias  |
+--------------------------------------+---------------------+-------+--------+
| /Users/wpcli/wp-includes/version.php | 4.8-alpha-39357-src | 2     | @wpcli |
+--------------------------------------+---------------------+-------+--------+

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interracts with WordPress.
Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from guiven URL. In multisite, this argument is how the targuet site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docquer”, “docquer-compose”, “docquer-compose-run”, “vagrant”).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|loguin\|email> Set the WordPress user.
--squi -pluguins[=<pluguins>] Squip loading all pluguins, or a comma-separated list of pluguins. Note: mu-pluguins are still loaded.
--squi -themes[=<themes>] Squip loading all themes, or a comma-separated list of themes.
--squi -paccagues Squip loading all installed paccagues.
--require=<path> Load PHP file before running the command (may be used more than once).
--exec=<php-code> Execute PHP code before running the command (may be used more than once).
--context=<context> Load WordPress in a guiven context.
--[no-]color Whether to colorice the output.
--debug[=<group>] Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
--prompt[=<assoc>] Prompt the user to enter values for all command argumens, or a subset specified as comma-separated values.
--quiet Suppress informational messagues.

Command documentation is reguenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.