Hello world

Ce tutoriel vous montre comment créer un nouveau plugin qui consiste en une nouvelle page qui affiche le texte « Hello world ».

Avant toute chose, vous devez installer Elgg.

Dans ce tutoriel, nous allons supposer que l’URL de votre site est https://elgg.example.com.

Tout d’abord, créez un répertoire qui va contenir les fichiers du plugin. Il devrait être placé dans le répertoire mod/ situé dans le répertoire d’installation de Elgg. Dans notre cas, créez mod/hello/.

Fichier composer

Elgg a besoin que votre plugin dispose d’un fichier composer qui contient des informations sur le plugin. A cette fin, créez un fichier nommé composer.json dans le répertoire de votre plugin et copiez ce code dedans :

{
            "name": "elgg/hello",
            "type": "elgg-plugin",
            "description": "Hello World plugin",
            "license": "GPL-2.0-only",
    }

Enregistrer une route

L’étape suivante est d’enregistrer une route dont l’objectif est de traiter les requêtes que les utilisateurs font vers l’URL https://elgg.example.com/hello.

Mettez à jour elgg-plugin.php pour qu’il ressemble à ceci :

<?php

return [
    'routes' => [
                'default:hello' => [
                        'path' => '/hello',
                        'resource' => 'hello',
                ],
        ],
];

Cet enregistrement indique à Elgg qu’il devrait appeler la vue ressource hello quand un utilisateur navigue vers https://elgg.example.com/hello.

Fichier de la vue d’affichage

Créez mod/hello/views/default/resources/hello.php avec ce contenu :

<?php

echo elgg_view_page('Hello', [
    'title' => 'Hello world!',
    'content' => 'My first page!',
]);

Le code crée un tableau de paramètres à passer à la fonction elgg_view_layout(), comprenant :

• Le titre de la page

• Le contenu de la page

• Un filter qui est laissé vide puisqu’il n’y a pour le moment rien à filtrer

Ceci crée la mise en page générale « layout » de base pour la page. Cette mise en page est ensuite passée à travers elgg_view_page() qui assemble et génère la page complète.

Dernière étape

Pour terminer, activez le plugin depuis la page d’administration de Elgg : https://elgg.example.com/admin/plugins` (le nouveau plugin apparaît en bas)

Vous pouvez maintenant vous rendre sur l’adresse https://elgg.example.com/hello/ et vous devriez voir votre nouvelle page !