API Reference

The following pages have a complete PostNuke API reference. Any functions that are not listed in this section are to be considered internal and should not be used by developers.

Table of Contents

pnBlockGetInfo - get block information

pnBlockLoad - load a block

pnBlockShow - set configuration variable

pnConfigDelVar - delete a configuration variable

pnConfigGetVar - get configuration variable

pnConfigSetVar - set configuration variable

pnDBGetConn - get database connection

pnDBGetTables - get database tables

pnDBInit - initialise PostNuke database connection

pnExceptionFree - reset exception status

pnExceptionId - return current exception identifier

pnExceptionMajor - return current exception major number

pnExceptionSet - raise an exception

pnExceptionValue - return current exception value

pnGetBaseURI - get base URI for PostNuke

pnGetBaseURL - obtain base URL for this site

pnGetStatusMsg - obtain status message

pnInit - initialise PostNuke

pnModAPIFunc - execute a module API function

pnModAPILoad - load a module API

pnModAvailable - check if a module is available

pnModCallHooks - carry out hook operations for module

pnModDBInfoLoad - load database infor for a module

pnModDelVar - delete a module variable

pnModFunc - execute a module function

pnModGetAdminMods - get list of administration modules

pnModGetIDFromName - get module id from name

pnModGetInfo - get module info

pnModGetName - get name of current top-level module

pnModGetUserMods - get list of user modules

pnModGetVar - get module variable

pnModLoad - load module

pnModRegisterHook - register a hook function

pnModSetVar - set module variable

pnModUnregisterHook - unregister a hook function

pnModURL - create module URL

pnRedirect - redirect to another page

pnSecAddSchema - add security schema

pnSecAuthAction - authorise attempted action

pnSessionDelVar - delete session variable

pnSessionGetVar - get session variable

pnSessionInit - initialse session

pnSessionSetup - setup session

pnSessionSetVar - set session variable

pnThemeLoad - load display theme

pnUserGetAll - get basic information on all users

pnUserGetLang - get current language

pnUserGetTheme - get current theme

pnUserGetVar - get user variable

pnUserGetVars - get all user variables

pnUserLoggedIn - check if user is logged in

pnUserLogIn - log user in

pnUserLogOut - log user out

pnUserSetVar - set user variable

pnUserValidateVar - validate user variable

pnVarCensor - remove censored words from variable

pnVarCleanFromInput - obtain form variable

pnVarPrepForDisplay - prepare variable for display

pnVarPrepForOS - prepare variable for operating system

pnVarPrepForStore - prepare variable for database storage

pnVarPrepHTMLDisplay - prepare variable for display, preserving some HTML tags

pnVarValidate - validate a variable