Constants

Forum use constants to define some values, which uses in the code. Values of constants can be:

• Flag (Is debug mode enabled, etc.)
• String value (file path, etc.)
• Numeric (group id, etc.)

Forum has two groups of constants:

• Pre-defined constants
• User-defined constants.

Here is the description of most uses constants.

• Enables debug mode, which provides output detailed error messages, shows script generation time, number of queries executed in the footer. Debug mode should be disabled on production server.
• Example:

define('FORUM_DEBUG', 1);

• All SQL-queries executed with query time will be shown in the footer, if this constant was defined. Use this constant only for developing, it should never used on production server.
• Example:

define('FORUM_SHOW_QUERIES', 1);

• The version that code was written for. It is used only on installation and update process. You can get version of forum from $forum_config['o_cur_version'].

• The database revision that code was written for. It is used only on installation and update process. You can get DB reversion of forum from $forum_config['o_database_revision'].

• If this constant was defined, database layer will not to send SET NAMES 'utf8' command to the database. This constant used only to allow the update script to access non UTF-8 data.

• The relative path from the current folder to the Forum's folder. This constant defined on every forum page. If you create new forum page, you should define it manually.
• Example:

define('FORUM_ROOT', './');

• When user request some forum page, PunBB try to automatically fix the $_SERVER['REQUEST_URI'], if it doesn't valid. Defining this constant will stop Forum to do this. Use this constant for integreation, if you have some problems with URI.
• Example:

define('FORUM_IGNORE_REQUEST_URI', 1);

• If this constant was defining, code of installed extensions will not execute.
• Example:

define('FORUM_DISABLE_HOOKS', 1);

• Defining this constant stops forum CSRF protection. It is strongly not recommended to do this.
• Example:

define('FORUM_DISABLE_CSRF_CONFIRM', 1);

• Define this constant, if all administrators logged out of the forum, to turn off the maintenance mode.
• Example:

define('FORUM_TURN_OFF_MAINT', 1);

• Path to the cache directory (by default it is set to FORUM_ROOT.'cache/').
• Example:

define('FORUM_CACHE_DIR', '/tmp/punbb_cache');

• The name of forum page, which run now. This constant defined on every forum page. If you create new forum page, you should define it manually.
• Example:

define('FORUM_PAGE', 'viewtopic');