CLI_Alias_Command::delete() │ public │ WP-CLI 1.0

Deletes an alias.

OPTIONS

<key>
Key for the alias.
[--config=<config>]
Config file to be considered for operations.
--- options:
  • global
  • project

EXAMPLES

# Delete alias.
$ wp cli alias delete @prod
Success: Deleted '@prod' alias.
# Delete project alias.
$ wp cli alias delete @prod --config=project
Success: Deleted '@prod' alias.

Method of the class: CLI_Alias_Command{}

No Hooks.

Return

null. Nothing (null).

Usage

$CLI_Alias_Command = new CLI_Alias_Command();
$CLI_Alias_Command->delete( $args, $assoc_args );
$args (required)
-
$assoc_args (required)
-

CLI_Alias_Command::delete() code WP-CLI 2.8.0-alpha

wp-cli/php/commands/src/CLI_Alias_Command.php 
public function delete( $args, $assoc_args ) {

	list( $alias ) = $args;

	$config = ( ! empty( $assoc_args['config'] ) ? $assoc_args['config'] : '' );

	list( $config_path, $aliases ) = $this->get_aliases_data( $config, $alias );

	$this->validate_config_file( $config_path );

	if ( empty( $aliases[ $alias ] ) ) {
		WP_CLI::error( "No alias found with key '{$alias}'." );
	}

	unset( $aliases[ $alias ] );
	$this->process_aliases( $aliases, $alias, $config_path, 'Deleted' );

}