CLI_Alias_Command::add()
Creates an alias.
OPTIONS
- <key>
- Key for the alias.
- [--set-user=<user>]
- Set user for alias.
- [--set-url=<url>]
- Set url for alias.
- [--set-path=<path>]
- Set path for alias.
- [--set-ssh=<ssh>]
- Set ssh for alias.
- [--set-http=<http>]
- Set http for alias.
- [--grouping=<grouping>]
- For grouping multiple aliases.
- [--config=<config>]
- Config file to be considered for operations.
--- default: global options:
- global
- project
EXAMPLES
# Add alias to global config. $ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli Success: Added '@prod' alias.
# Add alias to project config. $ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli --config=project Success: Added '@prod' alias.
# Add group of aliases. $ wp cli alias add @multiservers --grouping=servera,serverb Success: Added '@multiservers' alias.
Метод класса: CLI_Alias_Command{}
Хуков нет.
Возвращает
null
. Ничего (null).
Использование
$CLI_Alias_Command = new CLI_Alias_Command(); $CLI_Alias_Command->add( $args, $assoc_args );
- $args (обязательный)
- -
- $assoc_args (обязательный)
- -
Код CLI_Alias_Command::add() CLI Alias Command::add WP-CLI 2.8.0-alpha
public function add( $args, $assoc_args ) { $config = ( ! empty( $assoc_args['config'] ) ? $assoc_args['config'] : 'global' ); list( $config_path, $aliases ) = $this->get_aliases_data( $config, '', true ); $this->validate_config_file( $config_path ); $alias = $args[0]; $grouping = Utils\get_flag_value( $assoc_args, 'grouping' ); $this->validate_input( $assoc_args, $grouping ); if ( isset( $aliases[ $alias ] ) ) { WP_CLI::error( "Key '{$alias}' exists already." ); } if ( null === $grouping ) { $aliases = $this->build_aliases( $aliases, $alias, $assoc_args, false ); } else { $aliases = $this->build_aliases( $aliases, $alias, $assoc_args, true, $grouping ); } $this->process_aliases( $aliases, $alias, $config_path, 'Added' ); }