W3cubDocs

/Drupal 8

public function Schema::dropField

public Schema::dropField($table, $field)

Drop a field.

Parameters

$table: The table to be altered.

$field: The field to be dropped.

Return value

TRUE if the field was successfully dropped, FALSE if there was no field by that name to begin with.

Overrides Schema::dropField

File

core/lib/Drupal/Core/Database/Driver/mysql/Schema.php, line 420

Class

Schema
MySQL implementation of \Drupal\Core\Database\Schema.

Namespace

Drupal\Core\Database\Driver\mysql

Code

public function dropField($table, $field) {
  if (!$this->fieldExists($table, $field)) {
    return FALSE;
  }

  $this->connection->query('ALTER TABLE {' . $table . '} DROP `' . $field . '`');
  return TRUE;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Database!Driver!mysql!Schema.php/function/Schema::dropField/8.1.x