Status of the API

The PostNuke API is currently in alpha. This means that the API may well have extra functions and arguments added to it. However, all of the functions as outlined in this document will work as described, and continue to work as described for the foreseeable future. Any future versions of the API will note where functions have been superceded or deprecated, and developers will have at least 6 months between any major changes in the API being implemented and the older functions being removed from the core, allowing suitable time for migration.

This Document

This document gives an overview of the PostNuke API, and also includes a reference for each official function currently available to developers.

Related Documents

Other documents that might be of use in conjunction with this guide are the Module Development Guide, the Theme Development guide, the Categorised Data Guide, and the Output Functions Guide (all yet to be written).

Suggestions and Updates

The PostNuke API is a work-in-progress. There will be many functions that are missing from the API that developers would like. To this end, if a developer has a request for a particular function then they can submit it to the PostNuke features request list on SourceForge at the PostNuke Homepage. The same system can be used for sending in updates of current functions or new functions. If you are a developer and currently either globals directly or accessing one of the core tables to obtain or update information then please consider sending in a feature request so that the PostNuke team can develop an API to carry out the work instead. This will ensure that your code is more likely to continue working through future versions of PostNuke without modification, and that

Please note that the main requirements for the core PostNuke API are stability and a relatively small footprint. Due to this it is possible that your request for a new or updated function will get refused on the grounds that it is too specific or can easily be built from other core API functions. In such situations the PostNuke team will always try to provide a simple alternative, but please remember that submission of a new or updated part of the API does not guarantee inclusion.