handbook/commands/config/is-true.md
2024-08-08 03:57:27 +02:00

54 lines
2.5 KiB
Markdown

# wp config is-true
Determines whether value of a specific defined constant or variable is truthy.
This command runs on the `before_wp_load` hook, just before the WP load process begins.
This determination is made by evaluating the retrieved value via boolval().
### OPTIONS
<name>
: Name of the wp-config.php constant or variable.
[\--type=<type>]
: Type of config value to retrieve. Defaults to 'all'.
\---
default: all
options:
- constant
- variable
- all
\---
[\--config-file=<path>]
: Specify the file path to the config file to be read. Defaults to the root of the WordPress installation and the filename "wp-config.php".
### EXAMPLES
# Assert if MULTISITE is true
$ wp config is-true MULTISITE
$ echo $?
0
### GLOBAL PARAMETERS
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
| **Argument** | **Description** |
|:----------------|:-----------------------------|
| `--path=<path>` | Path to the WordPress files. |
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
| `--user=<id\|login\|email>` | Set the WordPress user. |
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
| `--skip-packages` | Skip loading all installed packages. |
| `--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 given context. |
| `--[no-]color` | Whether to colorize 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 arguments, or a subset specified as comma-separated values. |
| `--quiet` | Suppress informational messages. |