adding-custom-fields-overrides

How to use custom fields in your overrides

Articles in this Series

1. Introduction
2. Parameters for all Custom Fields
3. Calendar Field
4. Checkboxes Field
5. Color Field
6. Editor Field
7. Integer Field
8. List Field
9. List of Images Field
10. Media Field
11. Radio Field
12. Repeatable Field
13. Sql Field
14. Text Field
15. Textarea Field
16. Url Field
17. User Field
18. Usergroup Field
19. How can you group custom fields
20. What components are supporting custom fields
21. Implementation into your component
22. Use custom fields in your overrides

How to use custom fields in your overrides

Introduction

The real power of custom fields is that you can use it in your own overrides. Here is a example of how you can do that.

Getting custom fields in your override

Basically you have all the custom fields corresponding to the current item accessible via a new property in your $item variable called jcfields. The $item->jcfields property is an array that holds the following data per field, where one field looks like this example:

Array
(
    [4] => stdClass Object
        (
            [id] => 4
            [title] => article-editor
            [name] => article-editor
            [checked_out] => 0
            [checked_out_time] => 0000-00-00 00:00:00
            [note] => 
            [state] => 1
            [access] => 1
            [created_time] => 2017-04-07 12:08:59
            [created_user_id] => 856
            [ordering] => 0
            [language] => *
            [fieldparams] => Joomla\Registry\Registry Object
                (
                    [data:protected] => stdClass Object
                        (
                            [buttons] => 
                            [width] => 
                            [height] => 
                            [filter] => 
                        )

                    [initialized:protected] => 1
                    [separator] => .
                )

            [params] => Joomla\Registry\Registry Object
                (
                    [data:protected] => stdClass Object
                        (
                            [hint] => 
                            [render_class] => 
                            [class] => 
                            [showlabel] => 1
                            [disabled] => 0
                            [readonly] => 0
                            [show_on] => 
                            [display] => 2
                        )

                    [initialized:protected] => 1
                    [separator] => .
                )

            [type] => editor
            [default_value] => 
            [context] => com_content.article
            [group_id] => 0
            [label] => article-editor
            [description] => 
            [required] => 0
            [language_title] => 
            [language_image] => 
            [editor] => 
            [access_level] => Public
            [author_name] => Super User
            [group_title] => 
            [group_access] => 
            [group_state] => 
            [value] => Bar
            [rawvalue] => Bar
        )

)

Render the field using the FieldsHelper

To render the field you can use FieldsHelper::render() by passing the needed values.

/**
 * Renders the layout file and data on the context and does a fall back to
 * Fields afterwards.
 *
 * @param   string  $context      The context of the content passed to the helper
 * @param   string  $layoutFile   layoutFile
 * @param   array   $displayData  displayData
 *
 * @return  NULL|string
 *
 * @since  3.7.0
 */
public static function render($context, $layoutFile, $displayData)

Example code for the override using the FieldsHelper

// Load the FieldsHelper


item->jcfields as $field) : ?>
    // Render the field using the fields render method
    context, 'field.render', array('field' => $field)); ?>

Example code for a raw override

item->jcfields as $field) : ?>
    // Render the field using the fields render method
    label . ':' . $field->value; ?>

jcfields_does_not_contain_the_fields_I_need">$item->jcfields does not contain the fields I need

The jcfields property is generated using the plugin event onContentPrepare by passing the context of the fields. The fields plugin then reads the fields from the database and adds the values to the jcfields property. So please make sure that the component you use also implements the onContentPrepare event with the context you use for the fields.

If you use the core components this should work out of the box.

Loading individual fields

In order to add individual fields to your content, start by choosing specific names for your custom fields, using the Name field, which will be used to reference your field directly in the override code. In the Options tab, select No in the Automatic Display field to prevent it from being displayed automatically in any of the standard positions.

Then, to enable direct access by name to custom fields in an override, place the code below at the beginning of your file. You should do this to every override PHP file that you want to place individual custom fields on.

jcfields as $jcfield)
     {
          $item->jcFields[$jcfield->name] = $jcfield;
     }
?>

And lastly, you should add the field placement code at the spot you want the field label or value to be shown.

To add the label of the field to your override, insert the code below, replacing name-of-field with the name of the field.

jcFields['name-of-field']->label; ?>

To add the value of the field to your override, insert the code below, replacing name-of-field with the name of the field. Beware: in the 3.x series the value is in fact the rawvalue

https://github.com/joomla/joomla-cms/issues/20216

jcFields['name-of-field']->rawvalue; ?>

You can add this code to any part of your override. Examples: The content of a div, the src in an img tag, within a CSS class attribute, etc.

Prev: Implement into your component