Available Positions

Since the 1.3 version of VikRestaurants it is possible to render standard form fields simply by constructing an associative array in a specific way. The following JSON represents a basic structure used to display a new field (fieldname) into the fieldset position.

{
    "fieldset": {
        "fieldname": {
            "type": "[TYPE]",
            "label": "[LABEL]",
            "value": "[VALUE]"
        }
    }
}

In case the specified fieldset is supported by the page, the fields will be pushed within the related position. Otherwise they will be added in a completely new section.

Detect Supported Positions

It is possible to detect the supported positions only by inspecting the source code of the pages through a browser inspector. Once the source of the page has been displayed, it is possible to search by the "customizer" word. At this point you should be able to find some occurrences similar to this one:

{"rule":"customizer","event":"onDisplayView{PAGE}","key":"{FIELDSET}","type":"[field|fieldset|...]"}

This is an HTML comment that describes the following information:

• event - the callback (or method) name to use while developing your own plugin;
• key - the name of the section in which the fields should be pushed;
• type - the type of the container.

Important, the event mentioned by the HTML comment should be always adjusted to a supported plugin hook. Here are listed all the steps to follow to adjust the onDisplayViewStatuscode event:

1. get rid of the initial "on" → DisplayViewStatuscode
2. add an underscore between every camel-case intersection ([a-z][A-Z]) → Display_View_Statuscode
3. convert the string in lower case →display_view_statuscode
4. insert "vikrestaurants_" at the beginning → vikrestaurants_display_view_statuscode

Practical Example

Let's assume that we want to enhance the management of the status codes by adding 3 additional fields:

• an input number to manually enter the ordering amount of the status code;
• a checkbox to assign an important role to the status code;
• a text area to type a PHP callback to invoke every time the status is selected.

add_filter('vikrestaurants_display_view_statuscode', function($forms, $view) {
    if (!is_array($forms)) {
        $forms = [];
    }

    // define the extra fields
    $extraFields = [
        // target "status" fields box
        'status' => [
            // create "ordering" field
            'ordering' => [
                'type' => 'number',
                'label' => 'Ordering',
                'value' => $view->status->ordering ?? null,
                'min' => 1,
                'step' => 1,
            ],
        ],
        // target "roles" fields box
        'roles' => [
            // create new "important" field
            'important' => [
                'type' => 'checkbox',
                'label' => 'Important',
                'checked' => $view->status->important ?? false,
            ],
        ],
        // add a new "application" fields box
        'Application' => [
            // create new "callback" field
            'callback' => [
                'type' => 'textarea',
                'label' => 'PHP Callback',
                'value' => $view->status->callback ?? null,
                'height' => 80,
            ],
        ],
    ];

    // iterate all the extra fields position by position
    foreach ($extraFields as $position => $fields) {
        // in case the position does not exist, create it
        if (!isset($forms[$position])) {
            $forms[$position] = '';
        }

        // render fields and append them at the end of the requested position
        $forms[$position] .= VikWPLayoutHelper::render('form.fields', [
            'fields' => $fields,
        ]);
    }

    return  $forms;
}, 10, 2);

This is how the management page of a status code will look after applying the mentioned example code.

Changelog