function Connection::escapeField

Same name in this branch
  1. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Connection.php \Drupal\Core\Database\Driver\mysql\Connection::escapeField()
  2. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php \Drupal\Core\Database\Driver\pgsql\Connection::escapeField()
Same name in other branches
  1. 9 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::escapeField()
  2. 10 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::escapeField()
  3. 11.x core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::escapeField()

Escapes a field name string.

Force all field names to be strictly alphanumeric-plus-underscore. For some database drivers, it may also wrap the field name in database-specific escape characters.

Parameters

string $field: An unsanitized field name.

Return value

string The sanitized field name.

2 calls to Connection::escapeField()
Connection::escapeField in core/lib/Drupal/Core/Database/Driver/mysql/Connection.php
Escapes a field name string.
Connection::escapeField in core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php
Escapes a field name string.
2 methods override Connection::escapeField()
Connection::escapeField in core/lib/Drupal/Core/Database/Driver/mysql/Connection.php
Escapes a field name string.
Connection::escapeField in core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php
Escapes a field name string.

File

core/lib/Drupal/Core/Database/Connection.php, line 1028

Class

Connection
Base Database API class.

Namespace

Drupal\Core\Database

Code

public function escapeField($field) {
    if (!isset($this->escapedNames[$field])) {
        $this->escapedNames[$field] = preg_replace('/[^A-Za-z0-9_.]+/', '', $field);
    }
    return $this->escapedNames[$field];
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.