Un système de réponse dans les commentaires

Mentions comment Authors est un plugin WordPress qui ajoute dans les commentaires la fonctionnalité de pouvoir mentionner un précédent commentateur.

Ce système facilite la discussion entre les participants qui peuvent se répondre. Il simplifie aussi la lecture des commentaires en permettant à vos lecteurs de pouvoir suivre le fil de la discussion d’une façon plus intuitive.

Le plugin s’adapte à tous les sites WordPress et peut être facilement personnalisé.

Comment ça marche

Au fur et à mesure que les commentaires sont chargés, ont récupère les noms des précédents auteurs de commentaires.

Simultanément, on recherche ces noms dans le contenu des commentaires (sanitisés et commençant par @). Chaque occurrence trouvée est transformée en bouton qui permet de naviguer entre les auteurs mentionnés et leurs annotations respectifs.

Lorsqu’un internaute rédige une observation, un script « écoute » l’utilisation de la touche @. Si celle-ci est utilisée, un système d’autocomplétion vient lui suggérer de mentionner un des précédents participant.

Le système est non-intrusif et ne modifie pas le contenu des commentaires ; il n’intervient que lors de l’affichage. Cela permet de ne pas causer de problème ou de bugs d’affichage si l’on décide plus tard de désactiver le plugin.

Suggestion et autocomplétion

Le système d’autcomplétion se base sur le plugin jQuery « Sew » développé par Mural.ly. Ce plugin se base lui même sur le plugin jQuery CaretPosition.

Malheureusement il n’est plus compatible avec jQuery 1.9 car il utilise la méthode $.browser qui a été dépréciée. Cette méthode est utile pour afficher la fenêtre d’autocomplétion en dessous du curseur, dans la zone de texte (variation entre les navigateurs).

J’ai donc compacté tout ça en implémentant en plus une méthode volée à Modernizr pour détecter le navigateur et la version. Il n’y a donc plus de souci d’incompatibilité.

Navigation entre commentaires

Dans le contenu de chaque commentaire de l’article, un marqueur invisible est ajouté avec le nom de l’auteur. Lorsque l’on clique sur une mention, le script recherche le marqueur antérieur correspondant le plus proche.

La fenêtre scroll alors vers ce commentaire qu’une classe permet également de mettre en avant via du CSS.

Envoie d’un email de notification

Lorsqu’un commentateur est mentionné, un mail lui est automatiquement envoyé pour le prévenir.

On peut cependant désactiver cette fonctionnalité grâce au filtre mca_send_email_on_mention :

// dont send notifications
add_filter( 'mca_send_email_on_mention', '__return_false' );

Ce code est à insérer dans le fichier fonctions du thème.

On peut aussi, grâce à un autre filtre (mca_filter_recipient), filtrer les personnes à qui le mail va être envoyé.

Cela peut être utile pour, par exemple, ne pas envoyer deux notifications si la personne mentionné s’est également abonné aux fil des commentaires (avec le plugin subscribe to comments).

add_filter( 'mca_filter_recipient','dont_send_user_who_already_subscribe', 100, 2 );
function dont_send_user_who_already_subscribe( $recipients, $comment ) {
    global $wpdb;
    $su = $wpdb->get_results( "
        SELECT comment_author 
        FROM {$wpdb->comments} 
        WHERE comment_subscribe = 'Y' 
        AND comment_post_ID = {$comment->comment_post_ID};", ARRAY_N );

    foreach( $su as $val )
        if( array_key_exists( sanitize_title( $val ), $recipients ) )
            unset( $recipients[ sanitize_title( $val ) ] );

    return $recipients;
}

Ce filtre permet de faire a peu près ce que l’on veut, car il prend en paramètre la liste des destinataires mais aussi le commentaire et les données qui lui sont liées. On peut donc appliquer toutes sortes de conditions.

Personnalisation

Les styles du plugin peuvent être très simplement surchargés, car il ne sont appliqués que sur une classe à chaque fois.

On peut customiser :

• la fenêtre d’autcomplétion
• les boutons de mention
• le bouton qui vient d’être cliqué
• le contenu du commentaire mis en avant après le scroll

Il est également possible de désactiver l’inclusion de la feuille de style, en ajoutant le code suivant dans le fichier functions.php de son thème :

// dequeue styles
add_filter( 'mca-load-styles', '__return_false' );

En dehors des styles, on peut aussi personnaliser totalement les corps, sujets et formes des emails de notification, grâce à quelques filtres :

// Personnaliser le corps sujets des emails
add_filter( 'mca-email-subject', 'my_email_subject', 15 ,5 );
function my_email_subject( $subject, $comment, $name, $mail, $titre ) {
    // do stuff...
    return $subject;
}

// Personnaliser le corps des emails
add_filter( 'mca-email-message', 'my_email_message', 15 ,5 );
function my_email_message( $message, $comment, $name, $mail, $titre ) {
    // do stuff...
    return $message;
}

Compatibilité ajax

Le plugin dispose de 2 modes de fonctionnement : un mode classique, et un mode pour les sites en ajax comme celui-ci.

Pour installer le plugin sur un site basé sur une navigation en ajax il faut tout d’abord ajouter ce code dans son fichier functions (ou dans un plugin) :

// enable ajax mod
add_filter( 'mcaajaxenable', '__return_true' );

Ensuite il est également nécessaire d’appeler la fonction javascript mcaAjaxChange() à chaque fois que les commentaires sont chargés dans la page (par défaut on peut l’exécuter à chaque fois que le contenu de la page change).

Le mode ajax est légèrement (de manière infime) plus gourmand en javascript et en php que le mode classique.

Par rapport au système de Reply-to

Le système présenté ici est, à mon avis, beaucoup plus performant que le système natif de WordPress. Le principe des Reply-to et des commentaires imbriqués est :

• peu pratique, car on ne peut répondre qu’à un commentaire à la fois
• mauvais en ergonomie, car les remarques s’imbriquent et le fil de la conversation est rapidement brouillé pour le lecteur
• à proscrire pour le SEO, car chaque bouton Reply-to créer un nouveau lien, ce qui dilue le jus de la page…
• le graphisme et les commentaires imbriqués… comment dire…

Voilà donc un système qui met en avant « la discussion ». Il est simple à comprendre et utiliser, et grâce aux réseau sociaux il nous est déjà familié 🙂

Il est actuellement disponible sur l’extend de WordPress en version [baw_papii info= »version » plugin= »mention-comments-authors » cache= »24″] ou directement ici.

Vous pouvez expérimenter le plugin en laissant un commentaire sur ce site où système est en place 😛