Feature Request - Custom Data

[neo314]

When using the jgrid system to build back end data pages, I had a recent bug that I resolved and is only relevant because it prompted me to think of this request. There are times when one does not necessarily want to do queries in response to custom toggles similar to publish/unpublish and similar list aware actions. It would be nice to be able to embed additional data into the jgrid item along with the cid and if list aware (multiple transactions based on back end checking of multiple records, be able to match the embedded data with the cid.

I'm specifically thinking of code like this from my helper:

switch ($crew_list_status[1]) {
            case '0':
                $task = 'crew_list_toggle_on';
                $options['tip'] = true;
                $options['active_title'] = 'COM_FIRECREW_CREW_LIST_SUBSCRIBE';
                $options['active_class'] = 'text-danger border-danger icon-unpublish';
                $options['checkbox'] = $checkbox;
                $options['prefix'] = 'fc_members.';
                break;
            case '1':
                $task = 'crew_list_toggle_off';
                $options['tip'] = true;
                $options['active_title'] = 'COM_FIRECREW_CREW_LIST_UNSUBSCRIBE';
                $options['active_class'] = 'text-success border-success icon-star';
                $options['checkbox'] = $checkbox;
                $options['prefix'] = 'fc_members.';
                break;
        }
        $html = HTMLHelper::_('jgrid.action',$index, $task, $options);

It would be nice to be able to have $options['custom'] which could contain simple or json encoded data and end up in the link as data-item-custom. I can see how to do this in jgrid easily. I have not had time to look at where and how one would also modify the code for list aware transaction. It would be nice to be able to have an array of custom data values where the members correspond to the order of the cid values when multiple records are selected. i.e. when a list of cid's are returned, if the custom option were used, a corresponding list of custom values would also be returned.

Approval Information

Approved: 01.04.2026
Minimum Target Version: 6.2
Annotation: Accepted but in a more generic way, please use an array which get imploded to data-[key]=[value]

[HLeithner]

The Joomla Maintainer Team decided at the 18.03.2025 meeting to accept this feature.

Annotation: Accepted but in a more generic way, please use an array which get imploded to data-[key]=[value]

[neo314]

Do you mean that one could have any key and more than one rather than "custom"? In other words, any key for option that is not predefined becomes a custom data item?

$options['tip'] = true;
$options['active_title'] = 'COM_FIRECREW_CREW_LIST_UNSUBSCRIBE';
$options['active_class'] = 'text-success border-success icon-star';
$options['checkbox'] = $checkbox;
$options['prefix'] = 'fc_members.';
$option['custom1'] ='Test Data';
$option['different_custom'] = 'Test Data 2';

translates to ...data-custom1="Test Data" data-different_custom="Test Data 2"...