Functions

Contains filters are case sensitive
Namesort descending Location Description
drush_save_config includes/context.inc Save the settings in a specific context to the applicable configuration file This is useful is you want certain settings to be available automatically the next time a command is executed.
drush_save_data_to_temp_file includes/filesystem.inc Save a string to a temporary file. Does not depend on Drupal's API. The temporary file will be automatically deleted when drush exits.
drush_scan_directory includes/filesystem.inc Finds all files that match a given mask in a given directory. Directories and files beginning with a period are excluded; this prevents hidden files and directories (such as SVN working directories and GIT repositories) from being scanned.
drush_search_index commands/core/search.drush.inc
drush_search_reindex commands/core/search.drush.inc
drush_search_status commands/core/search.drush.inc
drush_select_bootstrap_class includes/bootstrap.inc Select the bootstrap class to use. If this is called multiple times, the bootstrap class returned might change on subsequent calls, if the root directory changes. Once the bootstrap object starts changing the state of the system, however, it will be…
drush_select_engine includes/engines.inc Selects an engine between the available ones.
drush_select_fields includes/output.inc Select the fields that should be used.
drush_select_output_fields includes/output.inc Select the fields from the input array that should be output.
drush_server_home includes/environment.inc Return the user's home directory.
drush_set_arguments includes/context.inc Set the arguments passed to the drush.php script.
drush_set_command includes/context.inc Set the command being executed.
drush_set_config_options includes/context.inc
drush_set_config_special_contexts includes/context.inc There are certain options such as 'site-aliases' and 'command-specific' that must be merged together if defined in multiple drush configuration files. If we did not do this merge, then the last configuration file that defined any…
drush_set_context includes/context.inc Set a specific context.
drush_set_default includes/context.inc A small helper function to set the value in the default context
drush_set_default_outputformat commands/core/outputformat.drush.inc Dynamically switch to a new output format. Does NOT override user-selected output format.
drush_set_engine includes/engines.inc Called by the Drush command (to cache the active engine instance.
drush_set_environment_vars includes/environment.inc Set Env. Variables for given site-alias.
drush_set_error includes/drush.inc Set an error code for the error handling system.
drush_set_option includes/context.inc Set an option in one of the option contexts.
drush_shell_alias_replace includes/command.inc Check if a shell alias exists for current request. If so, re-route to core-execute and pass alias value along with rest of CLI arguments.
drush_shell_cd_and_exec includes/exec.inc Executes a shell command at a new working directory. The old cwd is restored on exit.
drush_shell_exec includes/exec.inc Executes a shell command. Output is only printed if in verbose mode. Output is stored and can be retrieved using drush_shell_exec_output(). If in simulation mode, no action is taken.
drush_shell_exec_interactive includes/exec.inc Executes a command in interactive mode.
drush_shell_exec_output includes/exec.inc Returns the output of the most recent shell command as an array of lines.
drush_shell_exec_proc_build_options includes/exec.inc Used by definition of ssh and other commands that call into drush_shell_proc_build() to declare their options.
drush_shell_proc_build includes/exec.inc Build an SSH string including an optional fragment of bash. Commands that use this should also merge drush_shell_proc_build_options() into their command options.
drush_shell_proc_open includes/exec.inc Execute bash command using proc_open().
drush_shift includes/command.inc Pop an argument off of drush's argument list
drush_show_help commands/core/help.drush.inc Prints out help for a given command.
drush_shutdown includes/preflight.inc Shutdown function for use while Drush and Drupal are bootstrapping and to return any registered errors.
drush_sitealias_add_db_settings includes/sitealias.inc If the alias record does not contain a 'databases' or 'db-url' entry, then use backend invoke to look up the settings value from the remote or local site. The 'databases' form is preferred; 'db_url' will be…
drush_sitealias_add_db_url includes/sitealias.inc If the alias record does not contain a 'databases' or 'db-url' entry, then use backend invoke to look up the settings value from the remote or local site. The 'db_url' form is preferred; nothing is done if…
drush_sitealias_add_to_alias_path includes/sitealias.inc Add a path to the array of paths where alias files are searched for.
drush_sitealias_alias_base_directory includes/sitealias.inc If there is a directory 'site-aliases' in the specified search location, then search ONLY in that directory for aliases. Otherwise, search anywhere inside the specified directory for aliases.
drush_sitealias_alias_path includes/sitealias.inc Return the array of paths where alias files are searched for.
drush_sitealias_alias_record_to_spec includes/sitealias.inc Convert from an alias record to a site specification
drush_sitealias_bootstrapped_site_name includes/sitealias.inc Get the name of the current bootstrapped site
drush_sitealias_build_record_from_settings_file includes/sitealias.inc
drush_sitealias_cache_alias_by_path includes/sitealias.inc Cache the specified alias in the alias path cache. The alias path cache creates a lookup from the site folder (/path/to/drupal/sites/default) to the provided alias record.
drush_sitealias_cache_db_settings includes/sitealias.inc
drush_sitealias_check_arg includes/sitealias.inc Check to see if the first command-line arg or the -l option is a site alias; if it is, copy its record values to the 'alias' context.
drush_sitealias_check_arg_and_site_set includes/sitealias.inc Check to see if the user specified an alias in an arguement, or via site-set. If so, return the name of the alias.
drush_sitealias_check_site_env includes/sitealias.inc
drush_sitealias_command_default_options includes/command.inc
drush_sitealias_convert_databases_to_db_url includes/sitealias.inc Create a db-url from the databases record.
drush_sitealias_convert_db_from_db_url includes/sitealias.inc Convert from an old-style database URL to an array of database settings
drush_sitealias_convert_db_spec_to_db_url includes/sitealias.inc Drush still accepts --db-url format database specifications as cli parameters; it is therefore useful to be able to convert from a database record back to a db-url sometimes.

Pages