開発(PHP):現在のリソースのIDを取得

現在のリソースのIDを取得するには、次のうちの何れかを使用します。

  • $id
  • $modx->documentIdentifier
  • $modx->documentObject['id']
  • $modx->getField('id')

これらは、スニペットやプラグインのシステムイベントによって取得できるものとそうでないものがあります。
取得可能かどうかについては各コードの取得可能かどうかをご覧ください。

構文

戻り値 = $id;

戻り値 = $modx->documentIdentifier;

戻り値 = $modx->documentObject['id'];

戻り値 = $modx->getField('id');

戻り値

取得したリソースIDを文字列で返します。

サンプルコード

if ($modx->documentIdentifier > 1) {
	...
}

各コードの取得可能かどうか

スニペット

コード 取得の可否
$id 不可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 可能
$modx->getField('id') 可能

プラグインのシステムイベント

  • ※ イベントは一部のみ掲載しています。
イベント コード 取得の可否
OnWebPageInit $id 不可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 不可能
$modx->getField('id') 可能
OnLoadWebDocument $id 不可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 可能
$modx->getField('id') 可能
OnParseDocument $id 不可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 可能
$modx->getField('id') 可能
OnWebPagePrerender $id 不可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 可能
$modx->getField('id') 可能
OnWebPageComplete $id 不可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 可能
$modx->getField('id') 可能
OnDocFormPrerender $id 可能
$modx->documentIdentifier 不可能
$modx->documentObject['id'] 可能
$modx->getField('id') 不可能
OnDocFormRender $id 可能
$modx->documentIdentifier 可能
$modx->documentObject['id'] 可能
$modx->getField('id') 可能
OnBeforeDocFormSave $id 可能
$modx->documentIdentifier 不可能
$modx->documentObject['id']
$modx->getField('id') 不可能
OnDocFormSave $id 可能
$modx->documentIdentifier 不可能
$modx->documentObject['id'] 不可能
$modx->getField('id') 不可能

CMS「MODX Evolution」逆引きリファレンス一覧へ戻る