WP_CLI\Utils\isPiped() Edit

Checks whether the output of the current script is a TTY or a pipe / redirect


@return (bool)

Top ↑


Returns true if STDOUT output is being redirected to a pipe or a file; false is
output is being sent directly to the terminal.

If an env variable SHELL_PIPE exists, the returned result depends on its
value. Strings like 1, 0, yes, no, that validate to booleans are accepted.

To enable ASCII formatting even when the shell is piped, use the
ENV variable SHELL_PIPE=0.

SHELL_PIPE=0 wp plugin list | cat

Note that the db command forwards to the mysqlMySQL MySQL is a relational database management system. A database is a structured collection of data where content, configuration and other options are stored. https://www.mysql.com/. client, which is unaware of the env
variable. For db commands, pass the --table option instead.

wp db query --table "SELECT 1" | cat

Internal APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. documentation is generated from the WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ codebase on every release. To suggest improvements, please submit a pull request.

Top ↑

  • WP_CLI\Utils\write_csv() – Write data as CSV to a given file.
  • WP_CLI\Utils\http_request() – Make a HTTPHTTP HTTP is an acronym for Hyper Text Transfer Protocol. HTTP is the underlying protocol used by the World Wide Web and this protocol defines how messages are formatted and transmitted, and what actions Web servers and browsers should take in response to various commands. request to a remote URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org.
  • WP_CLI\Utils\get_named_sem_ver() – Compare two version strings to get the named semantic version.
  • WP_CLI\Utils\parse_ssh_url() – Parse a SSHSSH Secure SHell - a protocol for securely connecting to a remote system in addition to or in place of a password. url for its host, port, and path.
  • WP_CLI\Utils\basename() – Locale-independent version of basename()
  • WP_CLI\Utils\proc_open_compat() – Windows compatible `proc_open()`. Works around bug in 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. http://php.net/manual/en/intro-whatis.php., and also deals with *nix-like `ENV_VAR=blah cmd` environment variable prefixes.
  • WP_CLI\Utils\esc_like() – First half of escaping for LIKE special characters % and _ before preparing for MySQL.

Last updated: