Benutzerdefinierte Felder

Einleitung

Benutzerdefinierte Felder erlauben es, die Datenbank der Inhalte mit eigenen Feldern zu erweitern. Diese Felder können verwendet werden, wenn ein neuer Inhalt angelegt oder ein Inhalt bearbeitet wird.

Beispiel

Um ein Feld Untertitel hinzuzufügen, wird im Admnistrationsbereich der Reiter Benutzerdefinierte Felderaufgerufen unter

Einstellungen > Allgemein

Dann wird folgendes im JSON-Format in den Textbereich eingegeben und durch Klicken des Buttons Speichern gespeichert:

{
    "Untertitel": {
        "type": "string",
        "placeholder": "Untertitel der Seite",
    "position": "bottom"
    }
}

Jetzt kann eine neue Seite angelegt werden unter Neuer Inhalt.

As you can see there is a new field at the bottom of the editor requesting a "Subtitle for the page". Complete the "Title", "Content" and the new field "Subtitle for the page" and click on the button "Save".

Struktur

Die Struktur eines benutzerdefinierten Feldes wird im Format JSON definiert und unterstützt folgende Schlüssel.

The structure is defined as a JSON format and supports the following keys:

• (required) type: Type of the custom field, supported values (string, bool).
• (optional) label: The label for the custom field.
• (optional) tip: Small text for the user to describe the custom field.
• (optional) default: Default value for the custom field.
• (optional) placeholder: Small text inside the field.
• (optional) position: Position in the editor, supported values (top, bottom).

Eigene Felder hinzufügen

To add custom fields go to:

Settings > General > Custom fields

To define custom field you need to generate a JSON structure. Check the following examples.

Custom field as string and the key name youtube:

{
    "youtube": {
        "type": "string",
        "label": "YouTube",
        "tip": "Write the YouTube URL."
    }
}

Custom field as boolean and the key name inStock:

{
    "inStock": {
        "type": "bool",
        "label": "In Stock",
        "tip": "Select this field if you have stock."
    }
}

Two custom fields with different types.

{
    "product": {
        "type": "string",
        "label": "Product",
        "tip": "Write the product name."
    },
    "inStock": {
        "type": "bool",
        "label": "In Stock",
        "tip": "Select this field if you have stock."
    }
}

Three custom fields with different types and different position in the editor.

{
    "product": {
        "type": "string",
        "placeholder": "Product name",
        "position": "top"
    },
    "inStock": {
        "type": "bool",
        "tip": "Select this field if you have stock.",
        "position": "top"
    },
    "imageURL": {
        "type": "string",
        "placeholder": "Image URL",
        "position": "bottom"
    }
}

Get custom field

The class page provides the method custom() which returns the value of the field.

The following example prints the value of the field youtube from the above example.

<?php
    echo $page->custom('youtube');
?>

Check the boolean value from the field inStock from the above example.

<?php
    if ($page->custom('inStock')) {
        echo "There is stock!";
    } else {
        echo "No more products";
    }
?>

Delete custom field

To delete a custom field you just need to remove the entry from the JSON structure. The custom fields are not complete deleted from the database but are invalidated.

If you want to remove all custom fields just set an empty JSON in the textarea, as following:

{}