Manuel:$wgOut
| Objet global : $wgOut | |
|---|---|
| Objet OutputPage pour les réponses HTTP. | |
| Paramètres : | aucun |
| Classe : | OutputPage |
| Situé dans : | OutputPage.php |
Détails
L'objet OutputPage est la variable de sortie qui peut être modifiée pour changer l'aspect généré de la page. Il encapsule la page HTML entière qui sera envoyée en réponse à toute demande venant du serveur.
L'objet OutputPage est utilisé en appelant ses fonctions pour ajouter du texte, des entêtes, etc., dans n'importe quel ordre, puis en appelant output() pour envoyer l'ensemble. L'objet OutputPage guide également l'encodage de la sortie.
Exemples
Vous pouvez par exemple ajouter des information de debogage.
global $wgOut;
$wgOut->mDebugtext .= "Ceci est un texte pour le debogage";
(si vous utilisez l'habillage par défaut MonoBook, vous devrez décommenter la ligne « $this->text( 'debug' ); » de MonoBook.php)
Autres exemples utilisant $wgOut :
$wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
$wgOut->setRobotpolicy( 'noindex,nofollow' );
$wgOut->setArticleRelated( false );
$wgOut->addWikiMsg( 'descriptionpage' );
$wgOut->addHTML( '<script src="/w/index.php?title=User:Example&action=raw"></script>' );
$wgOut->getPageTitle();
// Obtenir toutes les catégories de la page actuelle:
$title = Title::newFromText( $wgOut->getPageTitle() );
$title->getParentCategories();
// Fait une redirection 302 vers la même page avec un paramètre ajouté à la chaine de requêtes.
$wgOut->redirect( $this->getTitle()->getLocalUrl( "foo=$bar" ) );
Obsolescence
Comme avec les autres variables globales, l'utilisation de $wgOut doit être évitée lorsque des méthodes alternatives existent.
Par exemple, lorsque vous écrivez une special page, utilisez la méthode getOutput() fournie par la classe SpecialPage, par exemple:
$outputPage = $this->getOutput();
$outputPage->addHTML( 'Hello world!' );