開発(PHP):キャッシュを消去

キャッシュを消去するには、$modx->clearCacheメソッドを使用します。

構文

戻り値 = $modx->clearCache(消去対象/消去内容);
引数名 初期値 説明
第一引数 消去対象/
消去内容
integer
または
string
または
array
array(
    'showReport' => false,
    'target' => 'pagecache,sitecache'
)
消去するリソースのIDまたは'full'または消去する詳細の内容(連想配列)
'full'を指定した場合は初期値と同じ。
消去する詳細の内容を指定する場合は、次のキーを持つ連想配列で指定する。
'showReport' ... 不明
'target' ... 消去する対象(次のいずれかあるいは両方を指定)
    'pagecache' ... リソース(ページ)
    'sitecache' ... 不明
  • ※ MODXのバージョン1.0.21J以降では、引数をarray以外で指定すると、Illegal string offset "showReport"というエラーが発生します。

戻り値

キャッシュの消去に成功した場合はtrue、失敗した場合はfalseを返します。

サンプルコード

$modx->clearCache();

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