{"id":1889,"date":"2018-11-02T15:08:51","date_gmt":"2018-11-02T15:08:51","guid":{"rendered":"https:\/\/reskator.fr\/?p=1889"},"modified":"2021-01-14T10:56:09","modified_gmt":"2021-01-14T10:56:09","slug":"autoload-pour-plugin-wordpress","status":"publish","type":"post","link":"https:\/\/dev9.reskator.fr\/cms\/2018\/autoload-pour-plugin-wordpress\/","title":{"rendered":"Un autoload pour plugin WordPress"},"content":{"rendered":"\n

Un plugin WordPress peut faire appel \u00e0 de nombreuses class<\/code> qu\u2019il faudra inclure via autant de require<\/code> ou include<\/code>. C\u2019est long, fastidieux et potentiellement source d'erreurs. Pourquoi s\u2019emb\u00eater avec \u00e7a quand PHP peut le faire pour nous ?<\/p>\n\n\n\n

Les conventions<\/h2>\n\n\n\n

En bon codeur respecteux des standards, on part du principe que toutes nos class<\/code> sont regroup\u00e9es dans un m\u00eame dossier et que les fichiers sont nomm\u00e9s selon ce mod\u00e8le : class-nomdemaclass.php<\/code> Si toutes nos class sont regroup\u00e9es dans un dossier includes<\/code>, on obtient quelque chose ressemblant \u00e0 ceci :<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

L\u2019autoloader<\/h2>\n\n\n\n

Nous allons cr\u00e9er notre autoloader. Et vous savez quoi ? Ce sera lui aussi une\u2026 class<\/code>. Dans le dossier includes<\/code> de notre plugin, on cr\u00e9e un fichier class-rrphf-myplugin-autoloader.php<\/code> et on y r\u00e9dige le code suivant :<\/p>\n\n\n\n

<?php defined( 'ABSPATH' ) || exit;\n\/**\n * Project: RRPhF MyPlugin\n * File: class-rrphf-myplugin-autoloader.php\n * User: reskator\n * Author: RR PhF\n *\n * @Description Class autoloader for RRPhF MyPlugin plugin\n * @since        1.0.0\n *\/\n\nif ( ! class_exists( 'RRPhF_MyPlugin_autoloader' ) ) :\n   class RRPhF_MyPlugin_autoloader {\n      \/**\n       * Singleton\n       *\n       * @var null Single instance\n       *\/\n      private static $_instance = null;\n      \n      \/**\n       * RRPhF_MyPlugin_autoloader constructor.\n       *\n       *\/\n      private function __construct() {\n         spl_autoload_register( [$this, 'load'] );\n      }\n      \n      \/**\n       * Singleton method\n       * \n       * If it has not already been done, creates and return an instance of the class\n       *\n       * @author RR PhF\n       * @since  1.0.0\n       *\n       * @static\n       * @return \\RRPhF_MyPlugin_autoloader\n       *\/\n      public static function get_instance() {\n         if ( ! self::$_instance ) {\n            self::$_instance = new self();\n         }\n         \n         return self::$_instance;\n      }\n      \n      \/**\n       * Class loader\n       *\n       * Converts the name of the class to a file name and includes the class file.\n       *\n       * @author RR PhF\n       * @since  1.0.0\n       *\n       * @param string $class_name - class to load\n       *\/\n      public function load( $class_name ) {\n         \/\/Converts the class name to a file name\n         $class_file = str_replace( '_', '-', strtolower( $class_name ) );\n         $class_file = 'class-' . $class_file;\n         $class_file = __DIR__ . '\/' . $class_file;\n         \n         \/\/ do the autoloading\n         spl_autoload( $class_file, '.php' );\n         }\n      }\n      \n      \/**\n       * Make sure an instance can't be cloned\n       *\n       * @author RR PhF\n       * @since  1.0.0\n       *\n       *\/\n      private function __clone() {\n         \/\/ do nothing\n      }\n   }\n   \n   RRPhF_MyPlugin_autoloader::get_instance();\n\nendif;\n<\/pre>\n\n\n\n
Notre class est instanci\u00e9e \u00e0 la ligne 81.<\/code> par l'appel de la m\u00e9thode\u2026 get_intance()<\/code><\/p>\n\n\n\n
RRPhF_MyPlugin_autoloader::get_instance();<\/pre>\n\n\n\n
Le fait d'instancier la class fait que PHP cherche si un constructeur est pr\u00e9sent dans la class et l'ex\u00e9cute automatiquement. \u00c7a tombe bien notre class en comporte un :<\/p>\n\n\n\n
private function __construct() {\n      spl_autoload_register( [$this, 'load'] );\n}<\/pre>\n\n\n\n
Pour sch\u00e9matiser, spl_autoload_register()<\/code> permet d'indiquer \u00e0 PHP la fonction (m\u00e9thode) qu'il devra utiliser lorsqu'il d\u00e9couvrira une nouvelle class durant l'ex\u00e9cution de notre plugin. En bonus, il se chargera de transmettre \u00e0 notre m\u00e9thode le nom de la class concern\u00e9e. Dans le cas pr\u00e9sent, comme vous pouvez le voir, nous lui indiquons d\u2019utiliser la m\u00e9thode load<\/code> :<\/p>\n\n\n\n
   *\/\n  public function load( $class_name ) {\n    \/\/Converts the class name to a file name\n    $class_file = str_replace( '_', '-', strtolower( $class_name ) );\n    $class_file = 'class-'. $class_file;\n    $class_file = __DIR__ .'\/'. $class_file;\n    \n    \/\/ do the autoloading\n    spl_autoload( $class_file, '.php' );\n  }\n<\/pre>\n\n\n\n
La m\u00e9thode load<\/code> dispose de l'argument $class_name<\/code>. C'est cet argument qui re\u00e7oit le nom de la class ayant d\u00e9clench\u00e9 l'appel _autoload. Apr\u00e8s avoir converti le nom de la class en nom de fichier (mais sans l'extension<\/em>), on appelle la m\u00e9thode PHP spl_autoload()<\/code> avec, en 1er argument, le path du fichier \u00e0 charger (toujours sans l'extension<\/em>), et en deuxi\u00e8me argument, l'extension. Notez que notre class est particuli\u00e8rement \u2018verrouill\u00e9e\u2019 :<\/p>\n\n\n\n