Ajout de références à WordPress

Hop, premier papier dans la catégorie geekage informatique. D’une manière générale les articles postés ici seront surtout des mémos des différents bricolages que j’effectue, ça me permettra d’en garder une trace et donc de ne pas tout perdre dès que je fais une mise-à-jour 🙄

Premier truc donc, ajouter un système de gestion de référence à WordPress. En d’autre terme, faire en sorte que si vous placez dans votre article : Ceci est un texte <ref>et ceci une référence.</ref>

Vous obteniez : Ceci est un texte [1]

Et à la fin de l’article une boite listant toutes les références données.

J’avais initialement bricolé un petit truc perso en 3 ou 4 lignes de Php, mais c’était pas génial car implanté comme un porc dans le code même de WordPress, donc à chaque mise-à-jour il fallait l’insérer de nouveau. De plus il y a (au moins) un plugin qui fait en gros cela, mais il se base directement sur des liens, donc pas exactement ce que je veux. C’est le plugin List of references, et c’est par ici pour le télécharger : http://wordpress.org/extend/plugins/auto-list-of-references/. Comme il ne fait pas exactement ce que je veux, à savoir gérer des tags spécifiques et compter dynamiquement mes références, je l’ai adapté à mes besoins. Le code est assez compréhensible je crois, et j’ai pas mal commenté :

/**
   * Plugin Name: List of references reload
   * Plugin URI: http://wordpress.org/extend/plugins/auto-list-of-references/
   * Description: Personnal adaptation of "List of references" plugin by Christian Weichel (http://32leaves.net)
   * Version: 1.1
   * Author: Charlie Merland
   * Author URI: http://32leaves.net/
   */

// basic format for our ref links
$FORMAT = "<small>[<a id={id}>{uid}</a>]</small> {content}";

class ListOfReferencesGenerator {
	private $_id;
	private $_text;
	
	public function __construct($text) {
		$this->_id = rand();
		$this->_text = $text;
		$this->_text = $this->setOldRef($text);
	}

	/**
	 * Deal with older manual references
	 * @param string $text the post content
	 * @return string the text where all :int: and [int] have been replaced by anchors and links
	 */
	private function setOldRef($text) {
		// remplacement
		$text = preg_replace("((:)(d+)(:))", "<small>[<a id="".$this->_id."$2">$2</a>]</small>", $text);
		$text = preg_replace("(([)(d+)(]))", "<small>[<a href="#".$this->_id."$2">$2</a>]</small>", $text);
		// return
		return $text;
	}

	/**
	 * Search for every reference in the text
	 * @return array all references found
	 */
	private function parseReferences() {
		// <ref>this is a reference</ref>
		preg_match_all("#<ref>s*(.*?)</ref>#i", $this->_text, $matches);
		return $matches;
	}

	/**
	 * Create the list that will be displayed
	 * @return string the references list
	 */
	private function prepareReferencesList() {
		// how to present our references
		global $FORMAT;
		// list to store those references
		$list = array();
		// parsing those refs
		$parsed_refs = $this->parseReferences();
		// init id
		$id = 0;
		// for each ref
		for($i = 0; $i < count($parsed_refs[0]); $i += 1) {
			$id += 1;
			// strip " "
			$text = str_replace('"', '', $parsed_refs[1][$i]);
			// every reference has a text and an ID
			$list[$text] = array($text, $id);
		}
		$this->list = $list;
		
		$result = "<fieldset class="ref"><legend>Références :</legend>";
		// for each ref of the list
		foreach($list as $ref => $content) {
			// get text
			$text = $content[0];
			// get ID
			$id = "".$this->_id."".$content[1];
			// get ID to show
			$uid = $content[1];
			// replace each tag
			$result .= str_replace("{id}", $id, str_replace("{uid}", $uid, str_replace("{content}", $text, $FORMAT)));
		}
		$result .= "</fieldset>";
		
		return $result;
	}

	/**
	 * Replace every reference declaration with a simple link
	 * @return string the link
	 */
	public function replace_link_callback($matches) {
		// strip " "
		$id = $this->list[str_replace('"', '', $matches[1])];
		// return a simple link to the anchor
		return $result = "<small>[<a href="#$tid$id[1]">$id[1]</a>]</small>";
	}

	/**
	 * Replace every reference declaration with a simple link
	 * @return string the link
	 */
	public function process() {
		// checking ref presence
		if(!$this->isEnabled()) return $this->_text;

		// prepare the list
		$list = $this->prepareReferencesList();
		// this must be useful
		$result = preg_replace_callback("#<ref>s*(.*?)</ref>#i", array(&$this, 'replace_link_callback'), $this->_text);
		// add the references list
		$result = str_replace("<references />", $list, $result);
		// return
		return $result;
	}
	
	/**
	 * Check for a <references /> tag indicating we actually have references
	 * @return boolean any ref or not?
	 */
	private function isEnabled() {
		return strpos($this->_text, '<references />') !== false;
	}
	
}

function filter_list_of_references($text) {
	$processor = new ListOfReferencesGenerator($text);
	return $processor->process();
}

add_filter('the_content', 'filter_list_of_references');

Ainsi il vous suffit de mettre toutes vos références de la forme <ref>ma référence</ref>, ajouter un <references /> à la fin de votre article, et toutes les références y seront listées, numérotées et liées. Ça n’a l’air de rien, mais c’est quand même bien pratique…