IntroductionIntroduction
  CGI and SSICGI and SSI
  <pike> tag<pike> tag
  Pike scriptPike script
  ModulesModules
    <Module types>Module types<Module types>Module types
    <create()>create()<create()>create()
    <defvar()>defvar()<defvar()>defvar()
    <query()>query()<query()>query()
    <set()>set()<set()>set()
    <query_internal_location()>query_internal_location()<query_internal_location()>query_internal_location()
    <check_variable()>check_variable()<check_variable()>check_variable()
    <info()>info()<info()>info()
    <query_name()>query_name()<query_name()>query_name()
    <register_module()>register_module()<register_module()>register_module()
    <start()>start()<start()>start()
    <status()>status()<status()>status()
    <stop()>stop()<stop()>stop()
    <find_internal()>find_internal()<find_internal()>find_internal()
  Parser modulesParser modules
  Location modulesLocation modules
  Other module typesOther module types
  Request information objectRequest information object
  ResponsesResponses
  Library methodsLibrary methods
 
check_variable()

void|string check_variable( string name, mixed value );

The check_variable() method is called when the user changes a configuration variable. If 0 is returned the variable will be changed to the new value. If a string containing an error message is returned the variable will not be changes, and the error message will be displayed in the configuration interface.

The name argument contains the name of the configuration variable while the value argument contains the intended new value of it.