Skip to content

php:script

Run a php script after a full Drupal bootstrap.

A useful alternative to eval command when your php is lengthy or you can't be bothered to figure out bash quoting. If you plan to share a script with others, consider making a full Drush command instead, since that's more self-documenting. Drush provides commandline options to the script via a variable called $extra.

See https://www.drush.org/latest/examples/helloworld.script for an example script.

Examples

  • php:script example --script-path=/path/to/scripts:/another/path
  • php:script -
  • php:script foo -- apple --cider

Arguments

  • [extra].... Script name and arguments. First argument is script name, remaining are passed to the script.

Options

  • --format=FORMAT. An alternative output format such as json or yaml. By default the returned value prints via var_export(). [possible values: yaml, json]

Global Options

  • -h, --help. Display help for the given command. When no command is given display help for the list command
  • --silent. Do not output any message
  • -q, --quiet. Only errors are displayed. All other output is suppressed
  • -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • -V, --version. Display this application version
  • --ansi. Force (or disable --no-ansi) ANSI output
  • --no-ansi. Negate the --ansi option.
  • -n, --no-interaction. Do not ask any interactive question
  • --url=URL. A base URL (e.g. example.com). Used for building links, selecting a multi-site, etc.
  • -e, --env=ENV. The Environment name. [default: prod]
  • --no-debug. Switches off debug mode.

Aliases

  • scr
  • php-script

Legend

  • An argument or option with square brackets is optional.
  • Any default value is listed at end of arg/option description.
  • An ellipsis indicates that an argument accepts multiple values separated by a space.