開発（PHP）：現在のリソースのIDを取得

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

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

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

構文

戻り値

取得に成功した場合はリソースIDを返します。
型と失敗した場合の値はコードによって異なります。

コード	型
	成功時	失敗時
$id	integer or string	null
$modx->documentIdentifier	string	null
$modx->documentObject['id']	string	null
$modx->getField('id')	string	boolean

サンプルコード

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

スニペット

コード	取得の可否
$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')	可能
OnDocFormRender	$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')	不可能
OnDocFormSave	$id	可能
	$modx->documentIdentifier	不可能
	$modx->documentObject['id']	不可能
	$modx->getField('id')	不可能
OnBeforeDocFormSave	$id	可能
	$modx->documentIdentifier	不可能
	$modx->documentObject['id']	不可能
	$modx->getField('id')	不可能