wp transient
Adds, gets, and deletes entries in the WordPress Transient Cache.
By default, the transient cache uses the WordPress database to persist values between requests. On a single site installation, values are stored in the wp_options table. On a multisite installation, values are stored in the wp_options or the wp_sitemeta table, depending on use of the --network flag.
When a persistent object cache drop-in is installed (e.g. Redis or Memcached), the transient cache skips the database and simply wraps the WP Object Cache.
Subcommands
| Command | Description |
|---|---|
wp transient delete | Deletes a transient value. |
wp transient get | Gets a transient value. |
wp transient list | Lists transients and their values. |
wp transient patch | Update a nested value from a transient. |
wp transient pluck | Get a nested value from a transient. |
wp transient set | Sets a transient value. |
wp transient type | Determines the type of transients implementation. |
wp transient set
Sets a transient value.
Synopsis
wp transient set <key> <value> [<expiration>] [--network]Options
<key>
: Key for the transient.
<value>
: Value to be set for the transient.
[<expiration>]
: Time until expiration, in seconds.
[--network]
: Set the value of a network|site transient.
Examples
$ wp transient set sample_key "test data" 3600
Success: Transient added.wp transient get
Gets a transient value.
Synopsis
wp transient get <key> [--format=<format>] [--network]Options
<key>
: Key for the transient.
[--format=<format>]
: Render output in a particular format. Default: table. Options: table, csv, json, yaml.
[--network]
: Get the value of a network|site transient.
Examples
$ wp transient get sample_key
test data
$ wp transient get random_key
Warning: Transient with key "random_key" is not set.wp transient delete
Deletes a transient value.
Synopsis
wp transient delete [<key>] [--network] [--all] [--expired]Options
[<key>]
: Key for the transient.
[--network]
: Delete the value of a network|site transient.
[--all]
: Delete all transients.
[--expired]
: Delete all expired transients.
Examples
# Delete transient.
$ wp transient delete sample_key
Success: Transient deleted.
# Delete expired transients.
$ wp transient delete --expired
Success: 12 expired transients deleted from the database.
# Delete all transients.
$ wp transient delete --all
Success: 14 transients deleted from the database.
# Delete all transients in a multisite.
$ wp transient delete --all --network && wp site list --field=url | xargs -n1 -I % wp --url=% transient delete --allwp transient list
Lists transients and their values.
Synopsis
wp transient list [--search=<pattern>] [--exclude=<pattern>] [--network] [--unserialize] [--human-readable] [--fields=<fields>] [--format=<format>]Available Fields
Default fields: name, value, expiration.
Examples
# List all transients
$ wp transient list
+------+-------+---------------+
| name | value | expiration |
+------+-------+---------------+
| foo | bar | 39 mins |
| foo2 | bar2 | no expiration |
| foo3 | bar2 | expired |
| foo4 | bar4 | 4 hours |
+------+-------+---------------+wp transient type
Determines the type of transients implementation.
Synopsis
wp transient typeExamples
$ wp transient type
Transients are saved to the database.Examples
# Set transient.
$ wp transient set sample_key "test data" 3600
Success: Transient added.
# Get transient.
$ wp transient get sample_key
test data
# Delete transient.
$ wp transient delete sample_key
Success: Transient deleted.
# Delete expired transients.
$ wp transient delete --expired
Success: 12 expired transients deleted from the database.
# Delete all transients.
$ wp transient delete --all
Success: 14 transients deleted from the database.