Documentation du code de SPIP et de ses plugins

noiZetier

noizetier_bloc.php

Ce fichier contient l'API de gestion des blocs Z configurables par le noiZetier.

Table of Contents

Functions

bloc_noizetier_lister_defaut()  : array<string|int, mixed>
Renvoie la liste par défaut des identifiants des blocs d'une page.
bloc_noizetier_lire()  : array<string|int, mixed>|string
Retourne la description complète ou une information particulière d'un bloc donné.

Functions

bloc_noizetier_lister_defaut()

Renvoie la liste par défaut des identifiants des blocs d'une page.

bloc_noizetier_lister_defaut() : array<string|int, mixed>

Cette liste peut être modifiée via le pipeline noizetier_blocs_defaut, en particulier pour supprimer certains blocs pour l'ensemble des pages et objets.

Return values
array<string|int, mixed>

Liste des blocs

bloc_noizetier_lire()

Retourne la description complète ou une information particulière d'un bloc donné.

bloc_noizetier_lire(string $bloc[, null|string $information = '' ]) : array<string|int, mixed>|string

La description complète du bloc est inscrite dans un fichier YAML nommé bloc.yaml stocké dans le dossier du bloc concerné.

Parameters
$bloc : string

Identifiant du bloc, à savoir, le nom du dossier sous Z.

$information : null|string = ''

Champ précis à renvoyer ou cha^ne vide pour renvoyer tous les champs de l'objet.

Return values
array<string|int, mixed>|string

La description complète sous forme de tableau ou l'information précise demandée.


        
On this page

Search results