newsListFetchItems

This hook allows you to return a custom collection of \Contao\NewsModel instances to be used by the news list module. It allows you to implement custom filtering or sorting for a news list.

Parameters

  1. array $newsArchives

    The IDs of the news archives shown in this news list.

  2. bool $featuredOnly

    Whether or not to show only featured news. Can be null.

  3. int $limit

    The limit as defined in the news list module.

  4. int $offset

    The offset as defined in the news list module.

  5. \Contao\Module $module

    The front end module instance executing this hook.

Return Values

Return false if this hook should not be considered. Return a \Contao\Model\Collection otherwise. Return null if no news entries are found.

If the return value is anything other than false, no further hooks of type newsListFetchItems will be executed!

Example

// src/EventListener/NewsListFetchItemsListener.php
namespace App\EventListener;

use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;
use Contao\Module;

#[AsHook('newsListFetchItems')]
class NewsListFetchItemsListener
{
    public function __invoke(array $newsArchives, bool|null $featuredOnly, int $limit, int $offset, Module $module)
    {
        if (…) {
            // Query the database and return the records
            return \Contao\NewsModel::findBy(…);
        }

        return false;
    }
}

References