這個API用於存取模組的設定檔會非常便利。不過由於每次用這個API取用variable資料時都必須要搜尋一次資料庫,因此要注意儘量不要用這個方法貯存大量的資料。
本文適用drupal4.6-drupal7
4.6 – 6 variable_get($name, $default)
7 variable_get($name, $default = NULL)
使用情境
Drupal的資料庫中有一張名為variable的資料表。如圖(一)所示,這個資料表只有name、value兩個欄位。而variable_get()API顧名思義就是從這張資料表中取出和寫入變數資料。
圖(一) variable資料表
這個API用於存取模組的設定檔會非常便利。不過由於每次用這個API取用variable資料時都必須要搜尋一次資料庫,因此要注意儘量不要用這個方法貯存大量的資料。
輸入參數
$name 欲回傳之變數的name。
$default 若variable資料表中查無此name則回傳$default變數中的值。
回傳值
variable資料表中的value或輸入的$default value。
範例
variable_get('cache', 0),這個函數的意思就是先去variable表裡找尋name欄位為cache的值,如果cache欄位有值,那麼就取cache裡的值回傳,如果cache欄位裡面没有值,那麼就以預設值0回傳。
參考資料
http://api.drupal.org/api/drupal/includes--bootstrap.inc/function/variable_get/6