Skip to content

Improve docs for SHELL_PIPE #5729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 1 commit into from
Jan 17, 2023
Merged

Improve docs for SHELL_PIPE #5729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions php/utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1175,14 +1175,23 @@ function basename( $path, $suffix = '' ) {
/**
* Checks whether the output of the current script is a TTY or a pipe / redirect
*
* Returns true if STDOUT output is being redirected to a pipe or a file; false is
* 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, returned result depends on its
* value. Strings like 1, 0, yes, no, that validate to booleans are accepted.
* 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.
* ENV variable `SHELL_PIPE=0`.
* ```
* SHELL_PIPE=0 wp plugin list | cat
* ```
*
* Note that the db command forwards to the mysql client, which is unaware of the env
* variable. For db commands, pass the `--table` option instead.
* ```
* wp db query --table "SELECT 1" | cat
* ```
*
* @access public
*
Expand Down