Triggered in: Cms\Classes\CmsObject.php

Provides opportunity to filter the items returned by a call to CmsObject::listInTheme()

Parameters provided are $cmsObject (the object being listed) and $objectList (a collection of the CmsObjects being returned).

Note: The $objectList provided is an object reference to a CmsObjectCollection, to make changes you must use object modifying methods.

Example usage (filters all pages except for the 404 page on the CMS Maintenance mode settings page):

// Extend only the Settings Controller
\System\Controllers\Settings::extend(function ($controller) {
    // Listen for the cms.object.listInTheme event
    \Event::listen('cms.object.listInTheme', function ($cmsObject, $objectList) {
        // Get the current context of the Settings Manager to ensure we only affect what we need to affect
        $context = \System\Classes\SettingsManager::instance()->getContext();
        if ($context->owner === 'winter.cms' && $context->itemCode === 'maintenance_settings') {
            // Double check that this is a Page List that we're modifying
            if ($cmsObject instanceof \Cms\Classes\Page) {
                // Perform filtering with an original-object modifying method as $objectList is passed by reference (being that it's an object)
                foreach ($objectList as $index => $page) {
                    if ($page->url !== '/404') {

Keep informed

Sign up to our newsletter to receive updates on Winter CMS releases, new features in the works, and much more.
We'll never spam or give this address away.

Latest blog post

October CMS as you know it is Dead

Published April 12, 2021
We regret to inform you that October CMS as you have known it for the past 7 years is no more. The founders have decided to make it a paid proprietary product; unfortunately abandoning the open source community in the process as "source partially available" is not open source. The core maintainers of the project have forked, and will continue development as Winter CMS....

View this post Read all posts

Latest Winter CMS release


Released April 26, 2021
3 UX/UI Improvements, 19 API Changes, 23 Bug Fixes, 3 Security Improvements, 4 Translation Improvements, 1 Community Improvement, 2 Dependencies

View details View all releases