You can easily add new page types through the concrete5 user interface, but there are some situations that can require you to create page types dynamically using PHP code.
First, you will need to create an associative array that contains the data of the page type that you are creating.
The array can contain the following fields:
We will create a page type using only the required fields: ctHandle
and ctName
. The steps are as follows:
Open
/config/site_post.php
in your preferred code editor.Declare the handle of the new page type to be created.
$handle = 'page_type_handle';
Declare the array that contains the data for the
ctHandle
andctName
fields.$data = array( 'ctHandle' => $handle, 'ctName' => 'Page Type Name' );
Check to see if the page type already exists by loading it by the new handle.
$pageType = CollectionType::getByHandle($handle);
If the page type does not exist, create it.
if (!$pageType) { $newPageType = CollectionType::add($data); }
If it does exist, assign the existing page type to the new page type variable.
else { $newPageType = $pageType; }
Dump the new page type variable to ensure that it worked.
my_debug($newPageType);
concrete5 will take the data array that you pass in and use it to create a new CollectionType
record in the database. concrete5 will also automatically generate a Master Collection page in the database. The Master Collection is a template page that concrete5 will use as base for all pages of that type. Any blocks, attributes, or other data assigned to the Master Collection will automatically be added to any new pages created with that page type.
If you are creating this page type in a custom package, you will need to pass in your package object to the add()
function, so concrete5 knows that this page type belongs to your package. That way, when users uninstall your package, they will have the option of removing all of the page types that it created.
Assuming that you know the handle of your package, use the following code to create a page type with it:
$data = array( 'ctHandle' => $handle, 'ctName' => 'Page Type Name' ); $pkg = Package::getByHandle('my_package'); $newPageType = CollectionType::add($data, $pkg);