Lors de la conception du thème « NewBurn » pour ce blog, j’ai été confronté à un sérieux problème de conception. Je voulais qu’il soit « widget ready » MAIS les widgets d’origine (et notamment les widgets « Recherche » et « Pages ») ne me convenaient pas du tout.

« Recherche » car il ne tenait pas compte du fichier « searchform.php » du thème (étonnant d’ailleurs vu que ce n’est pas le comportement original de la sidebar, c’est un truc que je ne m’explique toujours pas au niveau de WP2.2) et « Pages » car il ne permet d’exclure des pages de la liste (celle de « Navigations » dans mon cas) ou de personnaliser la moindre l’affichage du listing.

Après moults recherche sur le forum de WordPress-fr et dans le Codex WordPress ainsi qu’avec l’aide de l’article de CSS4Designr, j’ai trouvé une solution qui ne me convenait guère (solution 1) et qui ne permet d’ajouter des éléments « perso » à la sidebar. C’est finalement dans la documentation de l’API du moteur de widget de WP2.2 que j’ai trouvé la solution que j’ai adopté pour ce thème (solution 2).

Solution 1 – Editer le fichier « wp-include/widget.php« 

C’est une solution radicale et qui sera valable pour tous les thèmes de votre blog. A effectuer avec beaucoup de précaution donc et bien sûr, commencez par sauvegarder le fichier original « wp-include/widget.php ».

Pour l’exemple, nous allons éditer ce fichier afin de faire en sorte que le widget « Recherche » se comporte comme la partie « Recherche » originale de la Sidebar, à savoir en utilisant le « searchform.php » du thème et non un code à part.

Commencer par ouvrir le fichier « wp-include/widget.php » dans votre éditeur préféré et aller à la ligne 369, c’est là que se trouve le code de ce widget.

fonction originale

function wp_widget_search($args) {
    extract($args);
?>
        <?php echo $before_widget; ?>
            <form id="searchform" method="get" action="<?php bloginfo('home'); ?>">
            <div>
            <input type="text" name="s" id="s" size="15" /><br />
            <input type="submit" value="<?php echo attribute_escape(__('Search')); ?>" />
            </div>
            </form>
        <?php echo $after_widget; ?>
<?php
}

Nous allons modifier ce code ainsi :

fonction modifiée

function wp_widget_search($args) {
    extract($args);
    echo $before_widget;    include ( TEMPLATEPATH . "/searchform.php" );
    echo $after_widget;
}

Voilà comment on peut ré-définir l’affichage global des widgets originaux de WordPress 2.2. Le seul avantage que je trouve de la méthode est que c’est rapide. Par contre, ce n’est guère propre, cela impactera tous les thèmes que vous pourriez installer/faire par la suite ET surtout, ce sera à recommencer à chaque mise à jour de votre blog… Autant dire que c’est plutôt contraignant et que ça manque vraiment d’élégance !

Solution 2 – re-définir les fonctions pour le thème seulement

La documention de l’API des widgets nous explique qu’un widget peut être défini dans un plug-ins ou dans le fichier « functions.php » d’un thème et qu’il doit finalement être enregistré (registered) avec un nom d’appel à l’aide de la fonction « register_sidebar_widget » (ou supprimer à l’aide d’ »unregister_sidebar_widget« ). Grâce à cette méthode, on peut également ré-définir (ou plutôt remplacer) les fonctions des widgets originaux.

Un plug-ins ne m’arrangeait pas forcément vu que l’organisation de ma sidebar est induite par mon thème, c’est donc tout naturellement que je me suis plutôt intéressé à la méthode consistant à modifier le fichier « functions.php » de mon thème.

Nous allons utiliser cette méthode afin de faire en sorte que le widget « pages » exclu certaines des pages de notre blog de son listing.

Je voulais exclure les liens vers « Archives », « Liens » et « Nuage de tags » afin de de les séparer dans une rubrique à part. Ces pages sont identifiées respectivement par les n°131, 132 et 133.

Le code dans une sidebar classique serait donc :

<?php wp_list_pages('exclude=131,132,133&title_li='); ?>

Je vous renvoie à la page du codex pour détails de la fonction « wp_list_pages« . Nous allons donc définir un widget pour notre thème qui renverra le même affichage. Pour cela ouvrons le fichier « functions.php » situé à la racine de notre thème et ajoutons une fonctions « widget_montheme_pages »

function widget_newburn_pages(){
    wp_list_pages('exclude=131,132,133&title_li=<h2>Et encore...</h2>');
}

Et pour que WordPress en tienne compte en lieu et place du widget « Pages » normal, ajoutons également la condition suivante :

if ( function_exists('register_sidebar_widget') ){
    register_sidebar_widget('pages', 'widget_newburn_pages');
}

Cette dernière va simplement dire à WordPress que le widget « pages » à utiliser n’est pas celui d’origine mais celui que nous venons de définir avec la fonction « widget_newburn_pages« .

Conclusion

On pourrait utiliser la même méthode pour créer un nouveau widget spécialement dédié pour ce thème (et donc non-réutilisable directement pour un autre). Il suffirait de créer une autre fonction « widget_nom-de-mon-widget » et de l’ajouter à la condition en faisant un register_sidebar_widget('Mon Widget', 'widget_nom-de-mon-widget'); et c’est tout !

Voilà, j’espère que ce (long) billet vous aura plu et qu’il pourra peut-être vous aider lorsque vous voudrez modifier simplement et rapidement les widgets originaux de WP2.2 afin qu’ils collent plus à l’esprit du design de votre blog.