docDrupal 6 - Fiche PHPTemplate pour les développeurs
download 
Plainte Transcription
Drupal 6 - Fiche PHPTemplate pour les développeurs
DRUPAL 6
FICHE PHPTEMPLATE POUR LES DÉVELOPPEURS DE THÈME
Variables de page.tpl.php
Variables communes à tous les gabarits
http://api.drupal.org/api/file/modules/system/page.tpl.php/6
$base_path
$body_classes
$breadcrumb
$closure
$content
$css
$feed_icons
$footer
$footer_message
$front_page
$head
$head_title
$header
$help
$language
$language>language
$language->dir
$layout
$left
$logo
$messages
$mission
$node
$primary_links
$right
$scripts
$search_box
$secondary_links
$show_blocks
$site_name
$site_slogan
$styles
$tabs
$title
(str) URL de base de l'installation Drupal
(str) Classes CSS de la balise <body> ('two-sidebars',
'not-front', 'not-logged-in', 'page-node' ...)
(str) HTML pour afficher le fil d'ariane en haut de page
(str) Obligatoire en bas de page pour tous les
javascripts qui ont besoin d'être appelés une fois la
page affichée.
(str) HTML affichant le contenu principal de la page
(array) Tableau contenant le chemin de chaque fichier
CSS de la page en cours (voir aussi $styles)
(str) HTML affichant toutes les icônes de flux pour la
page courante.
(str) HTML de la région de pied de page
(str) Contenu du message de pied de page défini dans
Administrer > Configuration du site > Informations
(str) Fragment de l'URL de la page d'accueil depuis le
nom de domaine ('/' pour un domaine standard)
(str) HTML affichant le contenu de l'entête <head>.
Contient notamment les balises meta.
(str) Texte devant être affiché dans la balise title de
l'entête HTML (titre nœud|titre site).
(str) HTML de la région d'entête
(str) Affichage dynamique de l'aide (plutôt pour les
pages d'administration)
(obj) Contient les informations sur la langue principale
du site.
(str) Langue principale du site ('fr', 'en'...) Définie dans
Admin › Configuration du site > Traduction
(str) Direction d'écriture ('ltr' ou 'rtl')
(str) Indique les barres latérales actives ('none'|'left'
|'right'|'both'). Configuré dans Admin > Construction du
site > Blocs
(str) HTML affichant le contenu de la barre gauche.
Défini dans Admin > Construction du site > Blocs
(str) Chemin vers le fichier du logo du site. Défini dans
Admin > Construction du site > Thèmes
(str) HTML contenant les messages d'erreur et d'état à
afficher en haut de page
(str) Chaine contenant les objectifs du site définis dans
Admin > Configuration du site > Informations
(obj) Activé seulement lorsque la page affiche un
nœud en pleine page (pas une liste). Contient tous les
éléments d'un nœud (title, body, etc.). Par exemple :
$node->title affiche le titre du nœud.
(array) Tableau contenant les items du menu « liens
primaires » défini dans Admin › Construction du site >
Menus > Paramètres
(str) HTML affichant le contenu de la barre droite
Défini dans Admin > Construction du site > Blocs
(str) HTML contenant les scripts Javascript et les liens
permettant des les charger
(str) HTML contenant le code permettant d'afficher le
formulaire de recherche dans le site.
(array) Comme $primary_links mais pour les liens
secondaires.
(bool)
(str) Nom du site ou vide si désactivé dans Admin >
Configuration du site > Informations
(str) Slogan du site ou vide si désactivé.
(str) HTML contenant toutes les balises des feuilles de
styles devant s'afficher dans l'entête HTML de la page.
(str) HTML contenant la ligne d'onglet en haut de page
(voir, éditer, etc.)
(str) Différent de $head_title, ne contient
habituellement que le titre du nœud courant.
Ce document est inspiré de
Drupal theming cheat sheet
consacré à la va version 5 de
Drupal : http://www.minezone.org
http://drupal.org/node/226776
$db_is_active
$directory
$id
$is_admin
$is_front
$logged_in
$user
$zebra
(bool) true si la base de donnée est active. Seulement
utile pour la page de maintenance.
(str) Répertoire du thème courant relatif à l'installation
de base ; par exemple : themes/garland.
(int) Numéro d'apparition du gabarit. Incrémenté à
chaque apparition du gabarit
(bool) True si le visiteur est un administrateur
(bool) True si la page courante est la page d'accueil.
Utilisé pour gérer l'affichage des contenus.
(bool) True si le visiteur est un membre authentifié
(obj) Contient les données brutes de l'utilisateur courant
(utiliser check_plain pour sécuriser les chaines)
(str) « odd » ou « even » (pair ou impair) . Affiche la
parité du gabarit courant pour alterner les
présentations.
Variables de node.tpl.php
http://api.drupal.org/api/file/modules/node/node.tpl.php/6
$content
(str) Contenu du nœud s'il est affiché pour lui-même,
seulement l'accroche s'il s'agit d'un sommaire
$comment_count (int) Nombre de commentaires attachés au noeud
$comment
(str) '0' si les commentaires sont désactivés, '1' si
activés lecture seule, '2' si activés en lecture/écriture
$created
(int) Timestamp de la date de création du noeud
$date
(str) Date de création formatée (-> $created)
$links
(str) HTML contenant les liens liés au nœud ('ajout de
commentaire', 'en savoir plus', etc.)
$name
(str) HTML du nom de l'auteur
$node
(object) Objet contenant les données brutes du nœud
$node_url
(str) URL pointant vers le nœud courant
$page
(bool) True si le nœud est affiché pour lui-même, False si
la page affiche un sommaire ($page==0)
$picture
(str) Code HTML de l'avatar de l'auteur. Activation des
avatars dans Admin > Gestion des utilisateurs
Paramètres des utilisateurs et dans Admin >
Construction du site > Thèmes > Configurer
$promote
(bool) True si l'option de publication « promu en 1ère
page » du noeud est activée
$readmore
(bool) True si l'accroche ne contient qu'une partie du
contenu du noeud.
$status
(str) 1 si publié, 0 sinon
$sticky
(bool) True si si l'option de publication « épinglé en haut
des listes » est active
$submitted
(str) HTML affichant l'auteur et la date de création du
nœud (activation/désactivation dans Admin ›
Construction du site > Thèmes > Configurer
$taxonomy
(array) tableau des catégories du nœud
$teaser
(bool) True si le nœud est affiché en mode sommaire et
que seule l'accroche est visible.
$terms
(str) HTML de la liste (ul) des hyperliens pointant vers
les sommaires des catégories auxquelles le nœud
appartient.
$title
(str) Titre (nettoyé) du nœud
$type
(str) Type de noeud ('page', 'story', 'blog', etc.)
$uid
(int) Identifiant numérique de l'auteur du noeud
Variables de block.tpl.php
http://api.drupal.org/api/file/modules/system/block.tpl.php/6
$block->module
$block->delta
$block->subject
$block->content
$block->region
$block_id
$block_zebra
(str) Nom du module qui génére le bloc
(int|str) Identifiant du block dans le module
(str) Titre du block
(str) Contenu du bloc
(str) Nom de la région où apparaît le bloc (par défaut :
'left', 'right', 'header', 'footer' et 'content')
(int) Comme $id mais réinitialisé pour chaque région
(str) Comme $zebra mais réinitialisé pour chaque
région
2008-10-28 - Licence Creative Commons Attribution-ShareAlike 2.0 - <http://www.eric-bellot.fr>
Variables de comment.tpl.php
Les gabarits par défaut et leurs leurs dérivés
http://drupal.org/node/11815
$author
(str) Hyperlien du nom de l'auteur du commentaire
pointant vers son profil (pas de lien pour l' anonyme)
(object) Données brutes du commentaire,
(str) Texte du commentaire
(str) Date et heure formatées de postage du
commentaire
(str) HTML contenant les liens liés au commentaire
(supprimer, éditer, répondre)
Chaine contenant le mot « nouveau » localisé si le
commentaire est nouveau
(objet) Données brutes du nœud auquel est rattaché
le commentaire
(str) HTML de de l'avatar de l'auteur. Activation dans
Admin > Gestion des utilisateurs > Param. des u. et
dans Admin > Const. du site > Thèmes > Configurer
(str) HTML de la signature de l'auteur. Activation dans
Admin > Gestion des utilisateurs > Param. des u.
(str) Code HTML affichant l'auteur et la date de
création du nœud (activation/désactivation dans
Admin › Construction du site > Thèmes > Configurer
(str) Statut du commentaire ('comment-unpublished',
'comment-published' ou 'comment-preview')
(str) Hyperlien du titre pointant vers le commentaire
$comment
$content
$date
$links
$new
$node
$picture
$signature
$submitted
$status
$title
Variables de box.tpl.php
http://api.drupal.org/api/file/modules/system/box.tpl.php/6
$title
$content
Titre de la boite
Contenu de la boite
Exemple de fichier .info
http://drupal.org/node/171205 & http://drupal.org/node/171206
name = Mon joli thème
description = 2colonnes, largeur fixe de
900px
screenshot = screenshot.png
version = 1.0
core = 6.x
php = 4.3.5
engine = phptemplate
regions[header] = Entête ("header")
regions[left] = Barre de gauche
regions[right] = Barre de droite
regions[content] = Contenu ("content")
regions[footer] = Pied de page ("footer")
features[] = logo
features[] = name
features[] = slogan
; features[] = mission
features[] = node_user_picture
features[] = comment_user_picture
features[] = search
features[] = favicon
features[] = primary_links
features[] = secondary_links
stylesheets[all][] = style.css
stylesheets[print][] = print.css
; stylesheets[screen][] = screen.css
; stylesheets[projection][] = projection.css
;scripts[] = myscript.js
Intitulé du thème
Description du thème
Aperçu du thème
Version du thème
Version minimum de Drupal
Version minimum de PHP
Moteur de gabarits utilisé
Déclarations des régions
utilisées. Sans déclarations,
les régions hea , footer,
left, right et content sont
créées automatiquement
Activation/désactivation des
fonctionnalités du thème (les
fonctions désactivées
disparaissent du formulaire
de configuration du thème)
Les commentaires sont
précédés d'un pointvirgule
Déclaration des feuilles de
styles CSS
Déclarations des Javascript
Principaux fichier du thème
http://drupal.org/node/171194
block.tpl.php
favicon.ico
logo.png
mon_theme.info
node.tpl.php
page-front.tpl.php
page.tpl.php
screenshot.png
styles.css
template.php
Gabarit contrôlant l'affichage des blocs
Icône de favori
Fichier image du logo du site
Fichier .info contenant les déclarations du thème
Gabarit contrôlant l'affichage des nœuds
Gabarit contrôlant l'affichage de la page d'accueil
Fichier de gabarit principal
Aperçu d'une copie d'écran du thème
Feuille de styles
Script des redéfinitions de fonctions, les variables, etc.
http://drupal.org/node/190815
Aggregator
aggregator-feed-source.tpl.php
aggregator-item.tpl.php
aggregator-summary-item.tpl.php
aggregator-summary-items.tpl.php
aggregator-wrapper.tpl.php
Block
block.tpl.php
block-[region|[module|delta]].tpl.php
block-admin-display-form.tpl.php
Book
book-all-books-block.tpl.php
book-export-html.tpl.php
book-navigation.tpl.php
book-node-export-html.tpl.php
Comment
comment-folded.tpl.php
comment-wrapper.tpl.php
comment-wrapper-[type].tpl.php
comment.tpl.php
comment-[type].tpl.php
Forum
forum-icon.tpl.php
forum-list.tpl.php
forum-submitted.tpl.php
forum-topic-list.tpl.php
forum-topic-navigation.tpl.php
forums.tpl.php
forums-[[container|topic]forumID].tpl.php
Node
node.tpl.php
node-[type].tpl.php
La syntaxe des noms
dérivés est surlignée en
bleu pâle
Poll
poll-bar.tpl.php
poll-bar-[block].tpl.php
poll-results-block.tpl.php
poll-results.tpl.php
poll-results-[block].tpl.php
poll-vote.tpl.php
poll-vote-[block].tpl.php
Profile
profile-block.tpl.php
profile-listing.tpl.php
profile-wrapper.tpl.php
profile-wrapper-[field].tpl.php
Search
search-block-form.tpl.php
search-result.tpl.php
search-result-[searchType].tpl.php
search-results.tpl.php
search-results-[searchType].tpl.php
search-theme-form.tpl.php
User
user-picture.tpl.php
user-profile-category.tpl.php
user-profile-item.tpl.php
user-profile.tpl.php
System
page.tpl.php
page-[front|internal/path].tpl.php
maintenance-page.tpl.php
maintenance-page-[offline].tpl.php
box.tpl.php
Exemples de gabarits de page
Syntaxe : page-[front|internal/path].tpl.php
Gabarits choisis par ordre de priorité descendante
page-node-edit.tpl.php
Gabarit destiné à la page d'édition des noeuds
page-node-4.tpl.php
Gab. destiné à la page du noeud 4 (/node/4)
page-node.tpl.php
Gab; pour personnaliser des pages affichant les
nœuds seuls (pas les sommaires)
page-front.tpl.php
Gab. pour personnaliser la page d'accueil du
site
page.tpl.php
Fichier gabarit principal
Exemples de gabarits de noeuds
Syntaxe : node-[type].tpl.php
node-story.tpl.php
Gab. personnalisant l'affichage des articles
(sommaire et pleine page)
node-page.tpl.php
Gab. personnalisant l'affichage des contenus de
type 'page' (sommaire et pleine page)
Exemples de gabarits de blocs
Syntaxe : block-[region|[module|-delta]].tpl.php
Gabarits choisis par ordre de priorité descendante
block-block-1..tpl.php
Gab. du premier block simple affiché
block-block.tpl.php
Gab. des blocs simples
block-user.tpl.php
Gab. du menu de navigation (module 'user')
block-left.tpl.php
Gab. destiné aux blocs présent dans la
région 'left' (barre latérale gauche)
block.tpl.php
Gabarits général des blocs
Afficher toutes les propiétés d'un objet Drupal
<pre><?php print_r($node); ?></pre>
<pre><?php print_r($block); ?></pre>
<pre><?php print_r($comment); ?></pre>
2008-10-28 - Licence Creative Commons Attribution-ShareAlike 2.0 - <http://www.eric-bellot.fr>
