
url-site, jpath-base
separator
syntaxe
{up jinfo=motclé}- get: motclé
Le principe
Aucune option à part un mot-clé pour l'option principale
Un exemple pour récupérer l'URL du site :
L'URL de la page d'accueil de ce site est : {up get=site-root}
L'URL de la page d'accueil de ce site est : https://up.lomart.fr/
Les mots-clés
| Motclé | Description |
|---|---|
| version-joomla | n° de la version Joomla utilisée |
| version-php | version PHP du serveur |
| user-ip | adresse IP du visiteur |
| user-id | id de l'utilisateur connecté en frontend ou zéro |
| user-name | identifiant de connexion de l'utilisateur ou "invité" |
| user-username | nom complet de l'utilisateur ou "invité" |
| site-root | URL de la page d'accueil du site |
| site-path | chemin vers le dossier racine du site |
| ds | séparateur valide sur le serveur |
| up-path | chemin relatif vers le dossier de UP |
| up-actions-path | chemin relatif vers le dossier des actions de UP |
| up-action-path | chemin relatif vers le dossier de l'action en cours |
Plus toutes les autres informations que vous allez me suggérer !
Vos mots-clés
Avec quelques notions de PHP, vous pouvez ajouter vos mots-clés.
Un exemple simple
Ajouter un mot-clé demo qui retourne le texte Démonstration de l'action Get
Etape 1 : créer un fichier demo.php dans le dossier plugins/content/up/actions/get/lib avec le code ci-dessous :
<?php // le contenu est un script PHP
defined('_JEXEC') or die(); // on quitte, si le script n'est pas appelé par Joomla
function demo() // fonction de même nom que le fichier
{
return 'TEST'; // on retourne la valeur à afficher
}
Etape 2 : c'est tout, on peut l'utiliser comme ceci :
{up get=demo}
Attention, le mot-clé est utilisé comme nom du fichier et nom de la fonction PHP.
Il est donc sensible minuscule/majuscule et ne peut contenir que des lettres, chiffres et le signe souligné (_).
Comme pour le nom des actions de UP, les tirets sont convertis en underscore.
Un exemple avec l'API Joomla!
Le mot-clé demo-today retourne les date et heure actuelles
Le shortcode{up get=demo-today}
Le résultat
le Mercredi 14 Janvier 2026 à 2h11
Le fichier plugins/content/up/actions/get/lib/demo_today.php
<?php
defined('_JEXEC') or die();
use Joomla\CMS\Date\Date;
use Joomla\CMS\Factory;
function demo_today()
{
$date = new Date('now');
$date->setTimezone(Factory::getUser()->getTimezone());
return $date->format('\l\e l d F Y à G\hi');
}
Cet exemple a uniquement comme but de montrer l'utilisation des API de Joomla. Il est possible de faire plus simple 😉
lib seront préservés.
Les fichiers demo.php et demo_today.php sont disponibles pour vos tests. Ils seront écrasés à la prochaine mise à jour.
Les avantages
Avant la création de cette action, on pouvait obtenir ces informations avec l'action php.
Quelques exemples pour mettre en avant ses avantages :
- un code plus simple
- un code centralisé. En cas d'évolution du PHP ou de Joomla, il suffit de mettre à jour l'action get
<p>Sur ce site, je suis connu comme
{up php=
use Joomla\CMS\Factory;
$user = Factory::getUser();
echo ($user->guest!=1) ? $user->name : 'invité';
}</p><p>Sur ce site, je suis connu comme
{up get=user-name}
</p>{up
php=echo (!empty($_SERVER['HTTP_CLIENT_IP'])) ?
$_SERVER['HTTP_CLIENT_IP'] : ((!empty($_SERVER['HTTP_X_FORWARDED_FOR']))
? $_SERVER['HTTP_X_FORWARDED_FOR'] : $_SERVER['REMOTE_ADDR']);}
{up get=user-ip}L'url vers le dossier images est :
{up php=use Joomla\CMS\Uri\Uri; echo Uri::root();}/images
L'url vers le dossier images est : https://up.lomart.fr//images
L'url vers le dossier images est :
{up get=site-root}images
https://up.lomart.fr/images
Un conseil
Si vous ajoutez vos propres scripts, je vous conseille de les documenter dans le fichier \plugins\content\up\actions\get\custom\help.txt
Pour être pris en compte dans le plugin de l'éditeur, vous devez utiliser l'action upbtn-makefile pour reconstruire ses données.
Exemple pour les 2 scripts fournis en exemple :
demo : affiche le mot TEST
demo_today : affiche la date et heure actuelle
grid (1) span (1) upactionslist (1) get (3) csv2table (1) flexauto (3) div (1) php (1) jcontent-info (1)
