How to Customize a Source in Element Index to default to "Drafts" Status

[BenParizek]

We have a workflow where a Draft entry is created, reviewed, and published. Different people are responsible for different steps in the process and right now the folks reviewing Drafts have to go to the Source, manually select "Drafts" from the statuses to see all the drafts.

I'd love to create a second Source and just have it default to the Drafts status view so folks reviewing Drafts could just use that. Right now, they can do this if they bookmark the URL but that's yet another separate workflow that needs to be communicated and managed outside of the CMS UI.

I've tried leaning on Entry::EVENT_REGISTER_SOURCES to customize the query, injecting js via View::EVENT_BEFORE_RENDER_TEMPLATE to just manually add &status=drafts to the URL, and adding a custom behavior to the Entry Element to override the Entry::statuses() method. None of those paths have lead to anything useful.

Is there any way to have a custom source default to a specific status? If not, is this a worthwhile FR?

[brandonkelly]

right now the folks reviewing Drafts have to go to the Source, manually select "Drafts" from the statuses to see all the drafts.

Unpublished drafts are included in the “All” status as well — so long as they have been edited whatsoever beyond their initial new entry state.

I've tried leaning on Entry::EVENT_REGISTER_SOURCES to customize the query

To only show unpublished drafts, you need to include 'draftOf' => false in the criteria:

Event::on(Entry::class, Entry::EVENT_REGISTER_SOURCES, function (RegisterElementSourcesEvent $event) {
    $event->sources[] = [
        'key' => 'unpublished-drafts',
        'label' => 'Unpublished Drafts,
        'criteria' => [
            'drafts' => true,
            'draftOf' => false,
        ],
    ];
});

[BenParizek]

I might still be missing something but this example is not working for me. On Craft 5.9.20.

Using the following event in a custom module:

Event::on(
    Entry::class,
    Entry::EVENT_REGISTER_SOURCES,
    static function(RegisterElementSourcesEvent $event) {
        $event->sources[] = [
            'key' => 'draft-view',
            'label' => 'Drafts View',
            'criteria' => [
                'section' => 'targetSection',
                'drafts' => true,
            ],
        ];
    }
);

When I implement this and select the "Drafts View" source I no results in the listing (I have drafts in the section I'm testing) and I see the status bar set to "All" by default. If I select "Live" I see all the entries in my section in the results. And if I select "Drafts" I see the expected Drafts in the results. Requiring the same extra steps for the user in the default channel listing.

If I add 'draftOf' => false, to the criteria, I get the same output. I've cleared template caches and have tested that just using section in the criteria works as expected.

With the forced 'draft' => true state I'd expect that the Status dropdown either disappears or defaults to "Drafts" and that the first results displayed are just the Drafts.

[brandonkelly]

It’s working on my end. Can you try upgrading to Craft 5.10?

[BenParizek]

Interesting. I've updated to 5.10.5 and I'm still seeing the same behavior. Could the difference be that I'm adding the 'section' => 'targetSection', to the criteria? I do see Drafts returned in the query if I take that away.

[brandonkelly]

That shouldn’t have any effect. Works either way on my end.