Koska t\u00e4m\u00e4 on j\u00e4sensis\u00e4lt\u00f6\u00e4, en haittaa, ett\u00e4 se on hieman tavallista pidempi, mutta en my\u00f6sk\u00e4\u00e4n halua sen olevan niin pitk\u00e4, ett\u00e4 sit\u00e4 on vaikea seurata. Mieluummin se olisi lyhyt luku, jossa on jotain k\u00e4yt\u00e4nn\u00f6llist\u00e4, jonka voit toteuttaa jokaisen postauksen lukemisen j\u00e4lkeen.<\/p>\n
Ja yksi asioista, jotka auttavat suuresti paremman WordPress-koodin kirjoittamisessa, on Composer.<\/p>\n
Parempi WordPress-koodi s\u00e4velt\u00e4j\u00e4n kanssa<\/h2>\n
Jos olet lukenut t\u00e4t\u00e4 blogia pidemm\u00e4n aikaa, tied\u00e4t, ett\u00e4 olen Composer-fani (en kuitenkaan suinkaan ole ainoa WordPressiss\u00e4 ty\u00f6skentelev\u00e4 henkil\u00f6).<\/p>\n
Ja vaikka olen kirjoittanut siit\u00e4 materiaalia, en ole kirjoittanut mit\u00e4\u00e4n, jonka nimenomainen tarkoitus on saada sinut k\u00e4yntiin yhden lyhyen artikkelin lukemisen loppuun menness\u00e4.<\/p>\n
Siihen asti meid\u00e4n on teht\u00e4v\u00e4 joitain kompromisseja: Nimitt\u00e4in toimitan mallim\u00e4\u00e4ritystiedoston sek\u00e4 tavan j\u00e4rjest\u00e4\u00e4 laajennuksesi hakemisto. Seuraavassa postauksessa selit\u00e4n joitain Composerin ominaisuuksia.<\/p>\n
Mik\u00e4 on s\u00e4velt\u00e4j\u00e4?<\/h3>\n
Ensinn\u00e4kin on t\u00e4rke\u00e4\u00e4 ymm\u00e4rt\u00e4\u00e4, mik\u00e4 Composer on. Ja on helppo toistaa m\u00e4\u00e4ritelm\u00e4 sivustolla, eik\u00f6 niin? Se on PHP:n riippuvuushallinta.<\/p>\n
Mutta ensinn\u00e4kin, mit\u00e4 on riippuvuus?<\/h4>\n
Joillekin se kuitenkin her\u00e4tt\u00e4\u00e4 muutaman kysymyksen:<\/p>\n
- \n
- Mik\u00e4 on riippuvuus?<\/li>\n
- Miksi minun pit\u00e4\u00e4 hallita niit\u00e4?<\/li>\n<\/ul>\n
Ja jos kaivaat hieman syvemm\u00e4lle, saatat huomata, ett\u00e4 se on paketinhallinta, ja t\u00e4m\u00e4 her\u00e4tt\u00e4\u00e4 yksinkertaisesti samat kysymykset, paitsi ett\u00e4 korvaat vain sanan "riippuvuus" sanalla "paketti", ja olet taas siin\u00e4, mist\u00e4 aloitit.<\/p>\n
Joten teen kaikkeni tehd\u00e4kseni t\u00e4m\u00e4n mahdollisimman selv\u00e4ksi:<\/p>\n
Riippuvuus tai paketti, ohjelmisto, jota koodisi k\u00e4ytt\u00e4\u00e4. Se voi olla jokin, johon se luottaa toiminnassaan suorituksen aikana, kuten tapa tehd\u00e4 HTTP-pyynt\u00f6j\u00e4<\/a>, tai se voi olla kirjasto taulukoiden muuntamiseksi XML-muotoon<\/a>.<\/p>\n
Composer helpottaa n\u00e4iden pakettien sis\u00e4llytt\u00e4mist\u00e4 kirjastoosi antamalla sinulle mahdollisuuden:<\/p>\n
- \n
- lataa ja sis\u00e4llyt\u00e4 paketti laajennukseen,<\/li>\n
- lataa laajennuksen automaattisesti ajon aikana,<\/li>\n
- helpottaa laajennuksen luomista tai kutsumista siihen tarvittaessa.<\/li>\n<\/ul>\n
T\u00e4m\u00e4 tarkoittaa, ett\u00e4 meid\u00e4n ei tarvitse t\u00e4ytt\u00e4\u00e4 koodikantamme hakemistoja monilla manuaalisesti lis\u00e4tyill\u00e4 tiedostoilla, ja se tarkoittaa, ett\u00e4 meill\u00e4 ei ole kaikkialla k\u00e4ytett\u00e4v\u00e4\u00e4 include-<\/strong> tai request<\/strong> –\u00a0 toimintoa.<\/p>\n
N\u00e4ille on oma paikkansa, josta keskustelen seuraavassa postauksessa, mutta niit\u00e4 ei tarvitse asentaa automaattisesti. Sen sijaan Composer hallinnoi niit\u00e4. Siksi riippuvuusp\u00e4\u00e4llikk\u00f6 on osa sen tarkoitusta.<\/p>\n
Nyt kun se on asennettu<\/a>, sinulla on kontekstia.<\/p>\n
S\u00e4velt\u00e4j\u00e4n k\u00e4ytt\u00f6<\/h3>\n
T\u00e4m\u00e4n osion kirjoittaminen on hieman vaikeaa, koska meill\u00e4 kaikilla on erilaiset tarpeet, eik\u00f6 niin? Mutta ainakin me kaikki voimme hy\u00f6dynt\u00e4\u00e4 automaattista latauslaitetta.<\/p>\n
Sit\u00e4 me kaikki voimme k\u00e4ytt\u00e4\u00e4.<\/p>\n
Joten t\u00e4ss\u00e4 on mit\u00e4 teen:<\/p>\n
- \n
- Perustan laajennushakemiston,<\/li>\n
- Luo tarvittavat tiedostot laajennuksen ohjaamiseen,<\/li>\n
- Luo yksinkertainen Composer-tiedosto,<\/li>\n
- Suorita se<\/li>\n<\/ol>\n
Ja sitten annan sinun n\u00e4hd\u00e4 tulokset. Voimme p\u00e4\u00e4st\u00e4 kolmansien osapuolien kirjastoihin tai muihin ominaisuuksiin tulevassa postauksessa (tai tulevissa sarjoissa).<\/p>\n
Mutta jos ei muuta, t\u00e4m\u00e4 n\u00e4ytt\u00e4\u00e4 sinulle, kuinka voit k\u00e4ytt\u00e4\u00e4 Composeria automaattisen latausohjelman m\u00e4\u00e4ritt\u00e4miseen, jotta voit keskitty\u00e4 koodin kirjoittamiseen etk\u00e4 ihmetell\u00e4, sis\u00e4llytet\u00e4\u00e4nk\u00f6 luokkiin.<\/p>\n
Plugin-hakemisto<\/h4>\n
Rakentelen laajennuksiani yleens\u00e4 n\u00e4in:<\/p>\n
- \n
- siell\u00e4 on bootstrap-tiedosto, jonka WordPress lukee,<\/li>\n
- siell\u00e4 on src<\/strong> -hakemisto, jossa kaikki hakemistot ja PHP-tiedostot s\u00e4ilytet\u00e4\u00e4n,<\/li>\n
- siell\u00e4 on huipputason omaisuushakemisto<\/strong>, jossa s\u00e4ilytet\u00e4\u00e4n kuvia, JavaScript-tiedostoja ja Sass-tiedostoja,<\/li>\n
- ja\u00a0 Composer on luonut toimittajakansion<\/strong> riippuvuuksille ja automaattiselle latausohjelmalle.<\/li>\n<\/ul>\n
Joskus saattaa olla jokin muu pariton kansio, kuten inc-<\/strong> tai lib<\/strong> -kansio, mutta se on eritt\u00e4in ep\u00e4s\u00e4\u00e4nn\u00f6llist\u00e4 t\u00e4ss\u00e4 vaiheessa tekem\u00e4ss\u00e4ni ty\u00f6ss\u00e4. Ja sen vuoksi en aio huolehtia siit\u00e4 t\u00e4m\u00e4n postauksen takia.<\/p>\n
Sen sijaan hakemistoni n\u00e4ytt\u00e4\u00e4 suunnilleen t\u00e4lt\u00e4.<\/p>\n
Toimittajahakemisto puuttuu, koska en ole viel\u00e4 luonut Composer-tiedostoa, jota k\u00e4ytet\u00e4\u00e4n suorittamaan.<\/strong> Mutta se n\u00e4hd\u00e4\u00e4n ennen postauksen loppua.<\/p>\n
Esimerkkitiedostot<\/h4>\n
Asennetaan n\u00e4ytetiedosto laajennukseen. Ja kun sanon n\u00e4yte, tarkoitan my\u00f6s yksinkertaista.<\/p>\n
T\u00e4ll\u00e4 tiedostolla on yksi tarkoitus: Tulosta viesti kojelautaan, kun kirjaudut WordPressiin.<\/p>\n
![\"Ty\u00f6kalut](\"https:\/\/wordpress.mediadoma.com\/wp-content\/uploads\/2022\/01\/post-160226-61e707e186b99.png\")
<\/a><\/p>\nMuista kuitenkin, ett\u00e4 t\u00e4m\u00e4n tarkoituksena ei ole n\u00e4ytt\u00e4\u00e4, kuinka kirjoittaa hyvin arkkitehtuuriltaan laajennus. Sen sijaan se n\u00e4ytt\u00e4\u00e4 kuinka luodaan automaattinen lataus, jotta laajennuksen tiedostot luodaan automaattisesti.<\/p>\n
Joten laajennuksen bootstrap n\u00e4ytt\u00e4\u00e4 t\u00e4lt\u00e4<\/a> :<\/p>\n
<?php\n\/**\n * The plugin bootstrap file\n *\n * This file is read by WordPress to generate the plugin information in the plugin\n * admin area. This file also includes all of the dependencies used by the plugin,\n * registers the activation and deactivation functions, and defines a function\n * that starts the plugin.\n *\n * @since 0.1.0\n * @package SamplePlugin\n *\n * @wordpress-plugin\n * Plugin Name: Sample Plugin\n * Description: A sample plugin used for a blog post.\n * Version: 0.1.0\n * Author: Tom McFarlin\n * Author URI: https:\/\/tommcfarlin.com\n * License: GPL-3.0+\n * License URI: http:\/\/www.gnu.org\/licenses\/gpl-3.0.txt\n *\/\n\nnamespace SamplePlugin;\n\nuse SamplePluginMessenger;\n\n\/\/ This file called directly.\ndefined('WPINC') || die;\n\n\/\/ Include the autoloader.\nrequire_once __DIR__. '\/vendor\/autoload.php';\n\n\/\/ Start the machine.\n(new Messenger())->start();\n<\/code><\/pre>\nJa erityisesti viestin n\u00e4ytt\u00e4misest\u00e4 vastaava tiedosto n\u00e4ytt\u00e4\u00e4 t\u00e4lt\u00e4<\/a> :<\/p>\n
<?php\n\nnamespace SamplePlugin;\n\nclass Messenger\n{\n \/**\n * Subscribers the `adminNotices` function to the admin_notices hook in WordPress.\n *\/\n public function start()\n {\n add_action('admin_notices', [$this, 'adminNotices']);\n }\n\n \/**\n * Displays the contents of the `message.html` file into the adminitrative notices\n * area on the dashboard whenever the plugin is active.\n *\/\n public function adminNotices()\n {\n if ('dashboard' !== get_current_screen()->id) {\n return;\n }\n\n include_once dirname(__FILE__). '\/Admin\/Views\/message.html';\n }\n}\n<\/code><\/pre>\nJa jos olet utelias HTML-tiedostosta, se on my\u00f6s yksinkertainen<\/a> :<\/p>\n
<div class=\"notice notice-success is-dismissible\">\n <p>This is a message from the <strong>Sample Plugin<\/strong><\/p>\n<\/div>\n<\/code><\/pre>\nSanoin, ett\u00e4 se oli yksinkertaista.<\/p>\n
S\u00e4velt\u00e4j\u00e4n m\u00e4\u00e4ritystiedosto<\/h4>\n
T\u00e4m\u00e4 tiedosto voi olla niin yksinkertainen tai monimutkainen kuin tarpeen. T\u00e4ss\u00e4 viestiss\u00e4 pid\u00e4mme asian yksinkertaisena. T\u00e4m\u00e4n viestin tavoitteena on yksinkertaisesti antaa sille nimi, kuvaus, lisenssi, tekij\u00e4t ja sitten kuinka automaattinen latausohjelma m\u00e4\u00e4ritet\u00e4\u00e4n.<\/p>\n
Katso t\u00e4st\u00e4<\/a>, ja sitten selit\u00e4n, mit\u00e4 n\u00e4et sen alla:<\/p>\n
{\n \"name\": \"tommcfarlin\/sample-plugin\",\n \"description\": \"A sample plugin used for a blog post.\",\n \"type\": \"wordpress-plugin\",\n \"license\": \"GPL-3.0-or-later\",\n \"authors\": [\n {\n \"name\": \"Tom McFarlin\",\n \"email\": \"tom@tommcfarlin.com\",\n \"homepage\": \"https:\/\/tommcfarlin.com\"\n }\n ],\n \"autoload\": {\n \"psr-4\": {\n \"SamplePlugin\": \"src\/\"\n }\n }\n }<\/code><\/pre>\nEnsinn\u00e4kin nimen, kuvauksen, tyypin ja lisenssin tulee olla riitt\u00e4v\u00e4n helposti seurattavia. My\u00f6s kirjoittaja-alue on suoraviivainen.<\/p>\n
Automaattinen lataus on alue, josta olemme t\u00e4ll\u00e4 hetkell\u00e4 huolissamme. Sen pit\u00e4isi olla melko selke\u00e4.<\/p>\n
Lyhyesti sanottuna, meill\u00e4 on ohje PSR4<\/strong> :lle, \u00a0josta voit lukea lis\u00e4\u00e4 ja sitten miss\u00e4 nimiavaruus sijaitsee. Joten yll\u00e4 olevassa esimerkiss\u00e4 mik\u00e4 tahansa nimiavaruudessa SamplePlugin<\/strong> sijaitsee src:ss\u00e4.\u00a0<\/strong><\/p>\n
T\u00e4m\u00e4 kertoo automaattiselle latausohjelmalle, mist\u00e4 etsi\u00e4 tiettyj\u00e4 tiedostoja. Ja meid\u00e4n tapauksessamme se vain etsii Messenger<\/strong> – luokkaa.<\/p>\n
Juokseva s\u00e4velt\u00e4j\u00e4<\/h4>\n
Nyt kun olemme k\u00e4sitelleet Composer-m\u00e4\u00e4ritystiedoston perusasiat, on aika suorittaa se. Muista, ett\u00e4 laajennushakemistosi pit\u00e4isi n\u00e4ytt\u00e4\u00e4 suunnilleen t\u00e4lt\u00e4:<\/p>\n
![\"Ty\u00f6kalut](\"https:\/\/wordpress.mediadoma.com\/wp-content\/uploads\/2022\/01\/post-160226-61e707e55e20b.png\")
<\/a><\/p>\nKirjoita terminaaliin seuraava komento<\/a> :<\/p>\n
Ja sinun pit\u00e4isi n\u00e4hd\u00e4 jotain t\u00e4llaista:<\/p>\n
![\"Ty\u00f6kalut](\"https:\/\/wordpress.mediadoma.com\/wp-content\/uploads\/2022\/01\/post-160226-61e707e92efb9.png\")
<\/a><\/p>\nOlettaen, ett\u00e4 kaikki on mennyt hyvin, sinun pit\u00e4isi pysty\u00e4 kirjautumaan WordPressiin ja aktivoimaan laajennus.<\/p>\n
Kaiken n\u00e4keminen yhdess\u00e4<\/h4>\n
Kun laajennus on aktivoitu, voit siirty\u00e4 sivustosi kojelautaan. Siell\u00e4 sinun pit\u00e4isi n\u00e4hd\u00e4 hyl\u00e4tt\u00e4v\u00e4 ilmoitus, joka n\u00e4ytt\u00e4\u00e4 t\u00e4sm\u00e4lleen samalta kuin n\u00e4imme viestin alussa:<\/p>\n
<\/a><\/p>\nJos olet p\u00e4\u00e4ssyt n\u00e4in pitk\u00e4lle, olet hyv\u00e4! Muussa tapauksessa tarkista syntaksisi varmistaaksesi, ett\u00e4 kaikki on hyvin. Jos jokin on vialla, et todenn\u00e4k\u00f6isesti olisi p\u00e4\u00e4ssyt n\u00e4in pitk\u00e4lle, ja olettaen, ett\u00e4 sinulla on perusvirheenkorjausvakiot asetettu<\/a>, n\u00e4et todenn\u00e4k\u00f6isesti, miss\u00e4 ongelma on.<\/p>\n
T\u00e4m\u00e4 ei ole kaikki<\/h2>\n
Composerissa on paljon muutakin, ja suosittelen sen dokumentaation lukemista. Osan n\u00e4ist\u00e4 k\u00e4sittelen tarkastellessani ty\u00f6kaluja, joita aion k\u00e4sitell\u00e4 my\u00f6hemmin t\u00e4ss\u00e4 sarjassa, mutta toistaiseksi suosittelen tutustumista joihinkin k\u00e4yt\u00e4nt\u00f6ihin.<\/p>\n
Vai niin! En suosittele myyj\u00e4hakemiston tarkistamista arkistoon. Siit\u00e4 voi my\u00f6hemmin tulla valtava hakemisto, ja se voi heikent\u00e4\u00e4 Composerin koko tarkoitusta.<\/p>\n
Seuraavassa postauksessa kerron miksi. Jotkut ihmiset tekev\u00e4t niin, ja se on okei, ja min\u00e4 olen tehnyt sen ennenkin, mutta on t\u00e4rke\u00e4\u00e4 olla harkitsevainen sen suhteen, kun teet niin.<\/p>\n
Err puolella olla tekem\u00e4tt\u00e4 sit\u00e4. Ja miksi, kerron seuraavassa postauksessa.<\/p>\n
- siell\u00e4 on huipputason omaisuushakemisto<\/strong>, jossa s\u00e4ilytet\u00e4\u00e4n kuvia, JavaScript-tiedostoja ja Sass-tiedostoja,<\/li>\n