PHP マニュアル: テキスト型フィールドに挿入するために、識別子をエスケープする

説明

string pg_escape_identifier(PgSql\Connection $connection = ?, string $data)

pg_escape_identifier は、データベースへの問い合わせに使う識別子 (テーブル名やフィールド名など) をエスケープします。 PostgreSQL サーバー用にエスケープされた識別子を返します。 pg_escape_identifier は、データの前後にダブルクォートを追加します。ユーザーが自分で追加してはいけません。この関数は、クエリ内で使う識別子のパラメータに有用です。SQL リテラル (bytea 以外のパラメータ) には、pg_escape_literal あるいは pg_escape_string を使わなければなりません。 bytea 型のフィールドには、pg_escape_bytea を使わなければなりません。

注意:
この関数は内部的なエスケープコードを使い、PostgreSQL 8.4 より前のバージョンでも使えます。

パラメータ

connection

PgSql\Connection クラスのインスタンス。 connection が指定されない場合は、デフォルトの接続を使います。デフォルトの接続とは、pg_connect または pg_pconnect によって確立された直近の接続です。

警告

PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

data

エスケープするテキスト文字列。

戻り値

エスケープされたデータを文字列で返します。

変更履歴

バージョン	説明
8.1.0	`connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、リソースを期待していました。

例

例1 pg_escape_identifier の例

<?php 
  // データベースに接続します
  $dbconn = pg_connect('dbname=foo');
  
  // テーブル名をエスケープします
  $escaped = pg_escape_identifier($table_name);
  
  // $table_name から行を取得します
  pg_query("SELECT * FROM {$escaped};");
?>

参考

pg_escape_literal
pg_escape_bytea
pg_escape_string