This is the documentation for concrete5 version 5.6 and earlier. View Current Documentation

Introduction

When creating an addon, you first want to decide what minimum version of c5 will be required to run your addon. If your answer is something like "I am on the last bleeding cutting edge of c5," then you just don't need this howto.

Now, if you are concerned by offering this addon to the most people, then let's go on a version tour.

Version Differences

Version Numbering

First of all, you might want to understand how Concrete5 numbers its versions by reading the Version Numbering Guide. After reading that you understand that we will only consider the Generational and Primary version number (that is X an Y in 5.X.Y.Z), since the Maintenance Update Version is only here for well … maintenance reasons and will not bring or delete any feature c5 you might need.

We will limit the matrix to versions currently available in the download section of Concrete5.org. I may update this howto from time to time to add missing features.

The following is based on the release notes from http://www.concrete5.org/private/updates/version_history

Events

Events5.0.05.1.15.2.15.3.15.3.25.3.35.4.05.4.15.4.25.5.05.5.15.5.25.6.05.6.1
on_page_viewKOKOOKOKOKOKOKOKOKOKOKOKOKOK
on_before_renderKOKOOKOKOKOKOKOKOKOKOKOKOKOK
on_render_completeKOKOOKOKOKOKOKOKOKOKOKOKOKOK
on_user_change_passwordKOKOOKOKOKOKOKOKOKOKOKOKOKOK
on_user_updateKOKOOKOKOKOKOKOKOKOKOKOKOKOK
package level on_start() callKOKOOKOKOKOKOKOKOKOKOKOKOKOK
on_group_updateKOKOKOKOKOKOKOKOOKOKOKOKOKOK
on_group_addKOKOKOKOKOKOKOKOOKOKOKOKOKOK
on_page_get_iconKOKOKOKOKOKOKOKOOKOKOKOKOKOK
on_page_outputKOKOKOKOKOKOKOKOOKOKOKOKOKOK
on_user_validateKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_user_logoutKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_user_activateKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_user_deactivateKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_before_job_executeKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_job_executeKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_job_installKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_job_uninstallKOKOKOKOKOKOKOKOKOOKOKOKOKOK
on_composer_publishKOKOKOKOKOKOKOKOKOKOKOKOOKOK
on_composer_save_draftKOKOKOKOKOKOKOKOKOKOKOKOOKOK
on_composer_delete_draftKOKOKOKOKOKOKOKOKOKOKOKOOKOK
on_block_loadKOKOKOKOKOKOKOKOKOKOKOKOOKOK
closure support for events (require PHP 5.3+)KOKOKOKOKOKOKOKOKOKOKOKOOKOK
on_file_added_to_setKOKOKOKOKOKOKOKOKOKOKOKOKOOK
on_get_countries_listKOKOKOKOKOKOKOKOKOKOKOKOKOOK
on_get_states_provinces_listKOKOKOKOKOKOKOKOKOKOKOKOKOOK
on_file_removed_from_setKOKOKOKOKOKOKOKOKOKOKOKOKOOK
on_page_urlifyKOKOKOKOKOKOKOKOKOKOKOKOKOOK
on_page_body_indexKOKOKOKOKOKOKOKOKOKOKOKOKOOK

3rd libraries shipped

3rd Party Libs5.0.05.1.15.2.15.3.15.3.25.3.35.4.05.4.15.4.25.5.05.5.15.5.25.6.05.6.1
ADODB 5.02OKOKOKOKOKOKOKOKOKOKOKOKOKOK
jQuery 1.2.6OKOKOKOKOKOKOKOKOKOKOKOKOKOK
jQueryUI 1.5.2OKOKOKOKOKOKOKOKOKOKOKOKOKOK
TinyMCE 3.0.9OKOKOKOKOKOKOKOKOKOKOKOKOKOK
ADODB 5.07KOKOKOOKOKOKOKOKOKOKOKOKOKOK
jQuery 1.3.2KOKOKOOKOKOKOKOKOKOKOKOKOKOK
jQueryUI 1.7.1KOKOKOOKOKOKOKOKOKOKOKOKOKOK
TinyMCE 3.2.2.3KOKOKOOKOKOKOKOKOKOKOKOKOKOK
Secureimage 1.0.3.1KOKOKOOKOKOKOKOKOKOKOKOKOKOK
ADODB 5.10KOKOKOKOKOKOOKOKOKOKOKOKOKOK
jQuery 1.4KOKOKOKOKOKOOKOKOKOKOKOKOKOK
TinyMCE 3.3KOKOKOKOKOKOOKOKOKOKOKOKOKOK
TinyMCE 3.3.9.2KOKOKOKOKOKOKOOKOKOKOKOKOKOK
jQuery 1.4.2KOKOKOKOKOKOKOOKOKOKOKOKOKOK
jQueryUI 1.8.4KOKOKOKOKOKOKOOKOKOKOKOKOKOK
TinyMCE 3.3.9.3KOKOKOKOKOKOKOKOOKOKOKOKOKOK
jQuery 1.6.2KOKOKOKOKOKOKOKOOKOKOKOKOKOK
jQueryUI 1.8.14KOKOKOKOKOKOKOKOOKOKOKOKOKOK
jQuery Forms 2.82KOKOKOKOKOKOKOKOOKOKOKOKOKOK
Secureimage 2.0.1betaKOKOKOKOKOKOKOKOOKOKOKOKOKOK
TinyMCE 3.4.6KOKOKOKOKOKOKOKOKOOKOKOKOKOK
jQuery 1.7KOKOKOKOKOKOKOKOKOOKOKOKOKOK
jQuery 1.7.1KOKOKOKOKOKOKOKOKOKOOKOKOKOK
JQueryUI 1.8.16KOKOKOKOKOKOKOKOKOKOOKOKOKOK
Zend::CurrencyKOKOKOKOKOKOKOKOKOKOOKOKOKOK
Bootstrap 2KOKOKOKOKOKOKOKOKOKOKOKOOKOK
SimplePie 1.3.1KOKOKOKOKOKOKOKOKOKOKOKOKOOK

that can be summarized as :

3rd Party Libs5.0.05.1.15.2.15.3.15.3.25.3.35.4.05.4.15.4.25.5.05.5.15.5.25.6.05.6.1
ADODB5.025.075.10
jQuery1.2.61.3.21.41.4.21.6.21.71.7.1
jQueryUI1.5.21.7.11.8.41.8.141.8.16
TinyMCE3.0.93.2.2.33.33.3.9.23.3.9.33.4.6
SecureimageKOKOKO1.0.3.12.0.1b
jQuery Forms2.82
Zend::CurrencyKOKOKOKOKOKOKOKOKOKOOKOKOKOK
Bootstrap 22
SimplePie1.3.1

Helpers :

Helpers5.0.05.1.15.2.15.3.15.3.25.3.35.4.05.4.15.4.25.5.05.5.15.5.25.6.05.6.1
JsONKOOKOKOKOKOKOKOKOKOKOKOKOKOK
CaptchaKOKOOKOKOKOKOKOKOKOKOKOKOKOK
MarketplaceKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Rating AttributeKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Page SelectorKOKOKOOKOKOKOKOKOKOKOKOKOKOK
form/colorKOKOKOKOKOOKOKOKOKOKOKOKOKOK
form/user_selectorKOKOKOKOKOOKOKOKOKOKOKOKOKOK
html/v2KOKOKOKOKOKOOKOKOKOKOKOKOKOK
InterfaceKOKOKOKOKOKOKOOKOKOKOKOKOKOK
image helper crop abilityKOKOKOKOKOKOKOKOOKOKOKOKOKOK
securityKOKOKOKOKOKOKOKOKOKOKOKOKOOK
ajaxKOKOKOKOKOKOKOKOKOKOKOKOKOOK

Features

Feature5.0.05.1.15.2.15.3.15.3.25.3.35.4.05.4.15.4.25.5.05.5.15.5.25.6.05.6.1
LocalizationKOOKOKOKOKOKOKOKOKOKOKOKOKOK
TinyMCE FixesKOOKOKOKOKOKOKOKOKOKOKOKOKOK
User/Group DeletionKOOKOKOKOKOKOKOKOKOKOKOKOKOK
Cheap Hosting supportKOOKOKOKOKOKOKOKOKOKOKOKOKOK
GoDaddy fixesKOOKOKOKOKOKOKOKOKOKOKOKOKOK
Events SupportKOOKOKOKOKOKOKOKOKOKOKOKOKOK
Area Block LimitKOOKOKOKOKOKOKOKOKOKOKOKOKOK
Custom thumbnails sizeKOOKOKOKOKOKOKOKOKOKOKOKOKOK
Guestbook CaptchaKOKOOKOKOKOKOKOKOKOKOKOKOKOK
PageType deletionKOKOOKOKOKOKOKOKOKOKOKOKOKOK
PageList/ItemList frameworkKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Customizable ThemesKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Marketplace IntergrationKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Global Tracking CodeKOKOOKOKOKOKOKOKOKOKOKOKOKOK
"Featured" page in PageListKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Signin as other usersKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Dashboard subpages in navKOKOOKOKOKOKOKOKOKOKOKOKOKOK
dialog "element" syntax supportKOKOOKOKOKOKOKOKOKOKOKOKOKOK
c5 consolidated custom logsKOKOOKOKOKOKOKOKOKOKOKOKOKOK
New c5 interfaceKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Integration with PicNik.com editorKOKOKOOKOKOKOKOKOKOKOKOKOKOK
File VersionningKOKOKOOKOKOKOKOKOKOKOKOKOKOK
File SetsKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Star FilesKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Files MetadataKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Alternate File Storage LocationKOKOKOOKOKOKOKOKOKOKOKOKOKOK
File APIKOKOKOOKOKOKOKOKOKOKOKOKOKOK
c5 help systemKOKOKOOKOKOKOKOKOKOKOKOKOKOK
ScrapBooksKOKOKOOKOKOKOKOKOKKOKOKOKOKO
OpenIDKOKOKOOKOKOKOKOKOKOKOKOKOKOK
IP BanlistKOKOKOOKOKOKOKOKOKOKOKOKOKOK
PageList paginationKOKOKOOKOKOKOKOKOKOKOKOKOKOK
C5 indexing framework (MySQL fulltext search)KOKOKOOKOKOKOKOKOKOKOKOKOKOK
Automatic Block CSS and JS loadingKOKOKOOKOKOKOKOKOKOKOKOKOKOK
page_not_found supportKOKOKOOKOKOKOKOKOKOKOKOKOKOK
custom templates for global blocksKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Block Types always removableKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Logs filterable by typeKOKOKOOKOKOKOKOKOKOKOKOKOKOK
multiple scrapbooksKOKOKOKOOKOKOKOKOKKOKOKOKOKO
"Page Type Icons" FileSetKOKOKOKOOKOKOKOKOKOKOKOKOKOK
robots.txt embeded in c5 distributionKOKOKOKOOKOKOKOKOKOKOKOKOKOK
Logging in rederect to the wanted pageKOKOKOKOOKOKOKOKOKOKOKOKOKOK
Files "Date Added" and "Active Version"KOKOKOKOOKOKOKOKOKOKOKOKOKOK
Exclude From Nav in PageListKOKOKOKOOKOKOKOKOKOKOKOKOKOK
Package::uninstall() supportKOKOKOKOOKOKOKOKOKOKOKOKOKOK
File, Page and User Attributes unified FrameworkKOKOKOKOKOOKOKOKOKOKOKOKOKOK
Native storage for attributesKOKOKOKOKOOKOKOKOKOKOKOKOKOK
Address attribute for usersKOKOKOKOKOOKOKOKOKOKOKOKOKOK
Addon Upgrade supportKOKOKOKOKOOKOKOKOKOKOKOKOKOK
Timed groupsKOKOKOKOKOOKOKOKOKOKOKOKOKOK
Mail Importers POP3 supportKOKOKOKOKOOKOKOKOKOKOKOKOKOK
Private MessagingKOKOKOKOKOOKOKOKOKOKOKOKOKOK
PHP 5.3 supportKOKOKOKOKOOKOKOKOKOKOKOKOKOK
PHP 5.1 supportOKOKKOKOKOOKOKOKOKOKOKOKOKOK
Builtin PHP Zip usageKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Layout engineKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Task Based PermissionsKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Zend_Cache usageKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Files StatsKOKOKOKOKOKOOKOKOKOKOKOKOKOK
File Type AttributeKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Permissions on ScrapbooksKOKOKOKOKOKOOKOKOKKOKOKOKOKO
SSL/TLS smtp supportKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Block::validate() supportKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Addon localization supportKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Jobs support in packagesKOKOKOKOKOKOOKOKOKOKOKOKOKOK
elements support in packagesKOKOKOKOKOKOOKOKOKOKOKOKOKOK
Areas/Blocks Custom designs via Design EngineKOKOKOKOKOKOOKOKOKOKOKOKOKOK
File "Originally Added To" fieldKOKOKOKOKOKOKOOKOKOKOKOKOKOK
Blog related BlocksKOKOKOKOKOKOKOOKOKOKOKOKOKOK
nav_target custom attributeKOKOKOKOKOKOKOOKOKOKOKOKOKOK
dates localizationKOKOKOKOKOKOKOOKOKOKOKOKOKOK
ComposerKOKOKOKOKOKOKOKOOKOKOKOKOKOK
PHP 5.4.3 deprecation compatKOKOKOKOKOKOKOKOOKOKOKOKOKOK
5.5 like new interfaceKOKOKOKOKOKOKOKOKOOKOKOKOKOK
StacksKOKOKOKOKOKOKOKOKOOKOKOKOKOK
white labelling supportKOKOKOKOKOKOKOKOKOOKOKOKOKOK
Attribute SetsKOKOKOKOKOKOKOKOKOOKOKOKOKOK
Content Exporter Format (XML)KOKOKOKOKOKOKOKOKOOKOKOKOKOK
Global Areas in themesKOKOKOKOKOKOKOKOKOOKOKOKOKOK
Dashboard blocksKOKOKOKOKOKOKOKOKOOKOKOKOKOK
concrete5 new js dialog KOKOKOKOKOKOKOKOKOOKOKOKOKOK
dashboard elements can be added in packagesKOKOKOKOKOKOKOKOKOOKOKOKOKOK
builtin image editorKOKOKOKOKOKOKOKOKOKOKOOKOKOK
New Permission systemKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Group rights combinationsKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Group SetsKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Fine grained permissionsKOKOKOKOKOKOKOKOKOKOKOKOOKOK
New Workflow systemKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Mobile supportKOKOKOKOKOKOKOKOKOKOKOKOOKOK
New SEO ManagerKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Versionnable Page Themes propertyKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Versionnable Page Types propertyKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Html Tab based comparison for pagesKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Garavatar supportKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Log "user" entryKOKOKOKOKOKOKOKOKOKOKOKOOKOK
Packaged theme overrideKOKOKOKOKOKOKOKOKOKOKOKOOKOK
New Page Cache LibraryKOKOKOKOKOKOKOKOKOKOKOKOKOOK

Behaviors

Behaviors5.0.05.1.15.2.15.3.15.3.25.3.35.4.05.4.15.4.25.5.05.5.15.5.25.6.05.6.1
setAttribute refresh cacheKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Group SelectorKOKOOKOKOKOKOKOKOKOKOKOKOKOK
$appVersionRequired in addonsKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Loader::element local search firstKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Advanced Permissions fixedKOKOOKOKOKOKOKOKOKOKOKOKOKOK
addHeaderItem remove duplicatesKOKOOKOKOKOKOKOKOKOKOKOKOKOK
Dialog css classes split from coreKOKOOKOKOKOKOKOKOKOKOKOKOKOK
inc() search in local templateKOKOOKOKOKOKOKOKOKOKOKOKOKOK
c5 content encoding fixKOKOKOOKOKOKOKOKOKOKOKOKOKOK
Area::getTotalBlocksInArea()KOKOKOOKOKOKOKOKOKOKOKOKOKOK
ENABLE_DELEVOPER_OPTIONSKOKOKOOKOKOKOKOKOKOKOKOKOKOK
BlockController::getCollectionObject()KOKOKOOKOKOKOKOKOKOKOKOKOKOK
IE6 warning to usersKOKOKOKOOKOKOKOKOKOKOKOKOKOK
autoload css/js fix for simple blocks having only view.phpKOKOKOKOOKOKOKOKOKOKOKOKOKOK
addHeaderItem() support in BlockController::edit and addKOKOKOKOKOOKOKOKOKOKOKOKOKOK
getTemporaryDirectory() stays in files KOKOKOKOKOOKOKOKOKOKOKOKOKOK
Color Picker works with IE7/8KOKOKOKOKOOKOKOKOKOKOKOKOKOK
event::extend() multiple hooks for one event typeKOKOKOKOKOKOKOOKOKOKOKOKOKOK
BlockView::getThemePath() fixKOKOKOKOKOKOKOOKOKOKOKOKOKOK
ccm.sitemap js and css load through helperKOKOKOKOKOKOKOOKOKOKOKOKOKOK
Loader::model() ltakes local files firstKOKOKOKOKOKOKOOKOKOKOKOKOKOK
Loader::library() takes local files firstKOKOKOKOKOKOKOOKOKOKOKOKOKOK
Loader::packageElements() takes local files firstKOKOKOKOKOKOKOOKOKOKOKOKOKOK
EMAIL_ADDRESS_REGISTER_NOTIFICATIONKOKOKOKOKOKOKOOKOKOKOKOKOKOK
EMAIL_ADDRESS_REGISTER_NOTIFICATION_FROMKOKOKOKOKOKOKOOKOKOKOKOKOKOK
MailHelper::replyTo()KOKOKOKOKOKOKOOKOKOKOKOKOKOK
BlockView::getBlockPath() takes local files firstKOKOKOKOKOKOKOOKOKOKOKOKOKOK
Loader::controller() takes local files firstKOKOKOKOKOKOKOOKOKOKOKOKOKOK
Automatic Block Add/Edit templateKOKOKOKOKOKOKOKOKOOKOKOKOKOK
get() and post() default parametersKOKOKOKOKOKOKOKOKOOKOKOKOKOK
Stack::display()KOKOKOKOKOKOKOKOKOKOOKOKOKOK
FormHelpers::label miscFields supportKOKOKOKOKOKOKOKOKOKOOKOKOKOK
max/max Width/Height for editor supportKOKOKOKOKOKOKOKOKOKOKOOKOKOK
Color Picker UI consistent with 5.5KOKOKOKOKOKOKOKOKOKOKOKOOKOK
css()/javascript() uniqueness paramKOKOKOKOKOKOKOKOKOKOKOKOOKOK
BASE_URL_SSL constantKOKOKOKOKOKOKOKOKOKOKOKOOKOK
__call() controller task supportKOKOKOKOKOKOKOKOKOKOKOKOOKOK
dashboard eleements install_post in packageKOKOKOKOKOKOKOKOKOKOKOKOOKOK
including t2() localization functionKOKOKOKOKOKOKOKOKOKOKOKOOKOK
SITEMAP_APPROVE_IMMEDIATELYKOKOKOKOKOKOKOKOKOKOKOKOKOOK
ENABLE_TRANSLATE_LOCALE_EN_USKOKOKOKOKOKOKOKOKOKOKOKOKOOK

If you find any discrepancies in the above data, please a new forum topic below.

Loading Conversation