How to Get All CMS Pages In System Configuration in Magento 2

CMS pages are static pages that allow adding text, video, photos, etc and provide the facility to create rich content and the ease of managing multiple contents.

The default Magento 2 CMS pages include:

• Home Page
• Category Page
• Product Page
• About Us Page
• Customer service Page
• Privacy policy
• 404 not found
• Enable cookies
• 503 service unavailable

Moreover, the store owner can also create a custom CMS page as per requirements.

One often has to work with CMS pages while working with Magento 2 extension development or customization.

For instance, the admin needs to choose and exclude CMS page from a list of all CMS pages in system configuration as mentioned in the below image:

In that scenario, you need to get all CMS pages in system configuration in Magento 2.

Use the below code the right way and you are done!

Steps to Get All CMS Pages In System Configuration in Magento 2

1. Create registration.php file at app/code/Vendor/Module.
   
   <?php use Magento\Framework\Component\ComponentRegistrar; ComponentRegistrar::register( ComponentRegistrar::MODULE, 'Vendor_Module', __DIR__ );

   1 2 3 4 5 6 7 8 9

   <?php   use Magento\Framework\Component\ComponentRegistrar;   ComponentRegistrar::register(     ComponentRegistrar::MODULE,     'Vendor_Module',     __DIR__ );

2. Create module.xml at app/code/Vendor/Module/etc and use the below code.
   
   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd"> <module name="Vendor_Module" setup_version="1.0.0"> </module> </config>

   1 2 3 4 5 6

   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">     <module name="Vendor_Module" setup_version="1.0.0">     </module> </config>

3. Create system.xml at app/code/Vendor/Module/etc/adminhtml.
   
   
   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd"> <system> <tab id="vendor" translate="label" sortOrder="100"> <label>vendor</label> </tab> <section id="section_id" translate="label" type="text" sortOrder="320" showInDefault="1" showInWebsite="1" showInStore="1"> <label>Module Name</label> <tab>vendor</tab> <group id="general" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1"> <label>CMS Pages</label> <field id="cms_pages" translate="label" type="multiselect" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1"> <label>CMS Pages</label> <source_model>\Vendor\Module\Model\Config\Source\CmsPages</source_model> </field> </group> </section> </system> </config>

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">     <system>         <tab id="vendor" translate="label" sortOrder="100">             <label>vendor</label>         </tab>         <section id="section_id" translate="label" type="text" sortOrder="320" showInDefault="1" showInWebsite="1"                  showInStore="1">             <label>Module Name</label>             <tab>vendor</tab>             <group id="general" translate="label" type="text" sortOrder="10" showInDefault="1"                    showInWebsite="1" showInStore="1">                 <label>CMS Pages</label>                 <field id="cms_pages" translate="label" type="multiselect" sortOrder="50" showInDefault="1"                        showInWebsite="1" showInStore="1">                     <label>CMS Pages</label>                     <source_model>\Vendor\Module\Model\Config\Source\CmsPages</source_model>                 </field>             </group>         </section>     </system> </config>

4. Create CmsPages.php file at app/code/Vendor/Module/Model/Config/Source.
   
   <?php namespace Vendor\Module\Model\Config\Source; use Magento\Cms\Api\Data\PageInterface; use Magento\Cms\Api\PageRepositoryInterface; use Magento\Framework\Api\SearchCriteriaBuilder; use Magento\Framework\App\ObjectManager; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Option\ArrayInterface; use Psr\Log\LoggerInterface; /** * Class CmsPages * @package Vendor\Module\Model\Config\Source */ class CmsPages implements ArrayInterface { /** * @var PageRepositoryInterface */ private $pageRepositoryInterface; /** * @var SearchCriteriaBuilder */ private $searchCriteriaBuilder; /** * CmsPages constructor. * @param PageRepositoryInterface $pageRepositoryInterface * @param SearchCriteriaBuilder $searchCriteriaBuilder */ public function __construct( PageRepositoryInterface $pageRepositoryInterface, SearchCriteriaBuilder $searchCriteriaBuilder ) { $this->pageRepositoryInterface = $pageRepositoryInterface; $this->searchCriteriaBuilder = $searchCriteriaBuilder; } /** * @return array */ public function toOptionArray() { $optionArray = []; try { $pages = $this->getCmsPageCollection(); if ($pages instanceof LocalizedException) { throw $pages; } $cnt = 0; foreach ($pages as $page) { $optionArray[$cnt]['value'] = $page->getIdentifier(); $optionArray[$cnt++]['label'] = $page->getTitle(); } } catch (LocalizedException $e) { ObjectManager::getInstance()->get(LoggerInterface::class)->info($e->getMessage()); } catch (\Exception $e) { ObjectManager::getInstance()->get(LoggerInterface::class)->info($e->getMessage()); } return $optionArray; } /** * @return \Exception|PageInterface[]|LocalizedException */ public function getCmsPageCollection() { $searchCriteria = $searchCriteria = $this->searchCriteriaBuilder->create(); try { $collection = $this->pageRepositoryInterface->getList($searchCriteria)->getItems(); } catch (LocalizedException $e) { return $e; } return $collection; } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

   <?php   namespace Vendor\Module\Model\Config\Source;   use Magento\Cms\Api\Data\PageInterface; use Magento\Cms\Api\PageRepositoryInterface; use Magento\Framework\Api\SearchCriteriaBuilder; use Magento\Framework\App\ObjectManager; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Option\ArrayInterface; use Psr\Log\LoggerInterface;   /** * Class CmsPages * @package Vendor\Module\Model\Config\Source */ class CmsPages implements ArrayInterface {     /**      * @var PageRepositoryInterface      */     private $pageRepositoryInterface;       /**      * @var SearchCriteriaBuilder      */     private $searchCriteriaBuilder;       /**      * CmsPages constructor.      * @param PageRepositoryInterface $pageRepositoryInterface      * @param SearchCriteriaBuilder $searchCriteriaBuilder      */     public function __construct(         PageRepositoryInterface $pageRepositoryInterface,         SearchCriteriaBuilder $searchCriteriaBuilder     )     {         $this->pageRepositoryInterface = $pageRepositoryInterface;         $this->searchCriteriaBuilder = $searchCriteriaBuilder;     }       /**      * @return array      */     public function toOptionArray()     {         $optionArray = [];         try {             $pages = $this->getCmsPageCollection();             if ($pages instanceof LocalizedException) {                 throw $pages;             }             $cnt = 0;             foreach ($pages as $page) {                 $optionArray[$cnt]['value'] = $page->getIdentifier();                 $optionArray[$cnt++]['label'] = $page->getTitle();             }         } catch (LocalizedException $e) {             ObjectManager::getInstance()->get(LoggerInterface::class)->info($e->getMessage());         } catch (\Exception $e) {             ObjectManager::getInstance()->get(LoggerInterface::class)->info($e->getMessage());         }         return $optionArray;     }       /**      * @return \Exception|PageInterface[]|LocalizedException      */     public function getCmsPageCollection()     {         $searchCriteria = $searchCriteria = $this->searchCriteriaBuilder->create();         try {             $collection = $this->pageRepositoryInterface->getList($searchCriteria)->getItems();         } catch (LocalizedException $e) {             return $e;         }         return $collection;     } }

    

That’s it. Make your extensions work expectedly by certain configurations that are made to have particular values for that you need to set Magento 2 default value system configuration.

Any doubts on this topic can be discussed in the Comments section below. I’d be happy to solve them.

Feel free to share the above solution with fellow developers via social media.

Thanks.