Začátečník průvodce WordPress Plugin Development

WordPress CMS změnil tvář našeho internetu a umožnil vzestup nových nápadů k prosperitě a jeho open source hnutí má silnou přítomnost zakořeněnou ve vývoji softwaru a webu. WordPress je blogovací platforma, která má schopnost spouštět mnoho dalších skriptů, jako jsou webové fóra, pracovní desky, a dokonce i klasický webový redakční systém.

Budeme jít přes několik způsobů, jak začít s vývojem plug-inů pro WordPress. Kroky jsou poměrně jednoduché a nevyžadují velké odhodlání ke studiu. Základní znalosti PHP by byly užitečné i se základním porozuměním struktury souborů WordPress a administračního panelu.

V tomto krátkém tutoriálu budeme probírat základní kroky potřebné k vytvoření jednoduchého plug-inu WordPress. Funkčnost bude použita k vytvoření dynamických výňatků na základě čísla předaného do volání funkce. Budete muset nahrát plug-in soubor a aktivovat z panelu Admin, pak navázat na volání naší funkce z libovolných stránek, které chceme, aby se výňatek objeví. Odkazy na dokončený plug-in zdrojový kód jsou již přidány později v tomto článku :)

Proč vyvíjet pro WordPress?

Doplňky jsou skvělým způsobem, jak vylepšit funkčnost svého blogu přidáním dalších funkcí. Ty mohou být umístěny kdekoli uvnitř šablony pomocí funkčních háčků. Postupem času rozšiřitelnost plug-in systému WordPress umožnila obrovský růst a stovky softwarově dodávaných kusů softwaru..

WordPress speciálně nabízí takové pokročilé funkce v jeho CMS, že unikátní plug-iny jsou málo a daleko. Jako vývojář máte úplnou kontrolu nad specifiky backendu vašeho weblogu. Pronájem PHP vývojáře vytvořit systémový plugin by stálo mnohem více, než si můžete představit a API je poměrně snadné pracovat a učit se.

Jako vedlejší argument, rozvoj přes WordPress je skvělá praxe pro ladění sami do jiných oblastí. Vytváření menších pluginů a widgetů sidebarem ve WordPressu vám pomůže pochopit, jak funguje backendový systém. Toto není omezeno pouze na WordPress, protože získáte hlubší pochopení drtivé většiny Content Systems.

1. Struktura složky WP

Úvod do struktury složek WordPressu zobrazí základní adresáře aplikací. Uvnitř obsahu wp najdete pluginy adresář. Zde jsou umístěny všechny vaše jednotlivé pluginy, buď jednotlivé soubory nebo správně pojmenované podadresáře.

U menších zásuvných modulů, které vyžadují pouze jeden soubor .php, máte možnost toto umístit přímo do zásuvného modulu / adresáře. Když však začnete vyvíjet složitější aplikace, je mnohem užitečnější vytvořit podadresář pojmenovaný po vašem plug-inu. Uvnitř můžete umístit JavaScript, CSS a HTML včetně funkcí PHP.

A readme.txt soubor může být také užitečný, pokud plánujete nabídnout plugin ke stažení. Tento soubor by měl obsahovat vaše jméno a to, co plugin dělá. Jako autor můžete také zvážit zahrnutí podrobností o každé revizi a jaké aktualizace vyšly.

2. Spuštění vašeho PHP souboru

Při vytváření nového pluginu musíte začít s jednoduchým souborem PHP. To může být pojmenováno cokoliv, ale mělo by obecně odrážet oficiální název vašeho plug-inu. Tak například jsem vytvořil náš základní kód a pojmenoval jsem svůj soubor hongkiat-excerpt.phps.

První řádky plug-inu musí být komentářem pro analyzátor. To je velmi důležité, protože WordPress nebude schopen zpracovat váš soubor bez. Níže je příklad kódu snippit, který můžete kopírovat a formovat směrem k vlastnímu.

Název zástrčky je to, co se objeví v panelu pro správu Admin, když jdete aktivovat. Stejné jako URI, které bude umístěno v podokně podrobností v panelu plug-inů. Ačkoli není nutné zahrnout verzi nebo popis, činí váš plugin mnohem profesionálnějším.

3. WordPress Pojmenování konvencí a osvědčených postupů

Existuje několik způsobů, jak ve skutečnosti strukturu plug-inu strukturovat. Mnohokrát PHP vývojáři vytvoří celý systém třídy, aby se zabránilo kolizím s funkcemi a názvy proměnných. Pokud nejste obeznámeni s pokročilými funkcemi OOP PHP, pak je nejlepší napsat kód do vzorových funkcí.

Takže pro náš příkladový kód napíšeme jednu funkci pro uložení našich dat. Také musíme definovat několik proměnných, které jsou klíčové pro implementaci do našich souborů šablon. Níže je uveden příklad kódu z našeho souboru pluginů s odstraněnou logikou jádra.

Při psaní ukázkového kódu je nejlepší postupovat podle předpisů a průvodců vytvořených aplikací WordPress. Vzhledem k tomu, že existuje tolik interních funkcí, které již byly definovány, můžete se vyhnout duplicitám předponou štítku na všechny vaše proměnné a názvy funkcí.

Ve výše uvedených příkladech jsme přednastavili všechny názvy našich nastavení hongkiat. To může být nahrazeno libovolným klíčovým slovem dle vašeho výběru, které obvykle souvisí s vaším názvem pluginu. Výše uvedený kód je jen nastavení vzorku a neměly by se týkat našeho finálního plug-inu. To je jen proto, aby vám poskytlo nějaké informace o tom, jak by měly být zapsány názvy proměnných a volání funkcí.

4. Potápění do filtrů a akcí

Předtím, než skočíme do našeho surového kódu, je třeba zmínit se o jiném pojetí. Akce a filtrů jsou dva zcela odlišné pojmy, které se hluboce týkají způsobů manipulace s daty pluginu.

Tyto dva bity kódu přicházejí standardně ve WordPress API. Filtry a akce umožňují vývojářům plug-in aktualizovat bity kódu v celém panelu administrátorů WordPressu týkajícího se vašeho nového plug-inu. To znamená, že můžete přidat novou záložku v postranním panelu nebo další nastavení odkazů pro možnosti pluginu.

Vysvětlení add_filter ()

A filtr se používá na kousek textu nebo dat předávaných do WordPressu. S filtry jste doslova schopni obsah filtru prostřednictvím vlastních vlastních písemných funkcí pro libovolné změny dat.

Můžete například vytvořit filtr, který chcete změnit $ the_content což je proměnná nastavená WordPress obsahující celý příspěvek obsah článku WordPress. Pro náš plug-in budeme mít $ the_content a zkrácení délky znaků na úryvek.

Filtry se hodí, když píšete plug-iny, abyste přizpůsobili vzhled a dojem svého blogu. Ty jsou obzvláště populární při psaní widgetů s postranním panelem nebo menších funkcí pro změnu zobrazení příspěvku. Níže je ukázkový řádek kódu ukazující způsob použití filtru.

add_filter ('wp_title', 'hongkiat_func');

Zde přidáváme filtr do názvu stránky WordPress. Tento kód se nevztahuje na náš oficiální plugin a používá se pouze jako příklad.

add_filter funkce je nativní WordPress a slouží k přidání nového filtru do proměnné nalezené v obsahu stránky. V řádku nad námi cílíme $ wp_title který obsahuje název naší aktuální stránky. My pak předáváme tuto proměnnou do falešné funkce s názvem hongkiat_func () které by pak mohly manipulovat a vrátit nový název značky pro jakékoli účely.

Vysvětlení add_action ()

Akce jsou podobné filtrům v tom, že nefungují na bitech dat, ale namísto toho se zaměřují na předdefinované oblasti ve vašich šablonách a panelu administrátorů. Jako příklad můžete použít akci při aktualizaci nebo úpravě obsahu stránky. WordPress nabízí komplexní seznam akcí v jejich dokumentaci API. Níže je uveden malý seznam příkladů akcí, které se můžete seznámit s některými předem definovanými cílovými oblastmi.

• publish_post - zavolán při publikování příspěvku nebo při změně stavu “zveřejněna”
• uložit příspěvek - volání, když je příspěvek / stránka vytvořen od začátku nebo aktualizován
• wp_head - zavolá při načtení šablony a spustí wp_head () funkce
• loop_end - volání ihned po zpracování posledního příspěvku prostřednictvím smyčky WordPress
• trackback_post - zavolán, kdykoliv je do postu přidán nový trackback

Znovu vidíme, jak jednoduchý je tento bit kódu. Pokud můžete porozumět rozdílu mezi akcemi a filtry, budete mnohem blíž k budování komplexních, fungujících pluginů WordPress. Níže je další řádek kódu inicializující akční funkci na uložit příspěvek háček. Pro opětovné objasnění se to netýká našeho současného vývojového pluginu a používá se pouze jako příklad kódu pro pochopení add_action () funkce.

add_action ('save_post', 'upozornit');

Tak tady vidíme podobné nastavení jako dříve add_filter (). Potřebujeme 2 proměnné, první drží název našeho háku, na který míříme. V tomto případě uložit příspěvek což znamená, že kdykoliv je nový příspěvek uložen, zavoláme funkci definovanou ve druhé pozici (oznámit()). Pravděpodobně můžete aktualizovat upozornění na jakýkoliv název funkce, kterou chcete spustit, ale to není nutné pro náš současný příklad plug-inu.

Dokončení logiky Plugin

Dokončení na naší cestě přidáme naši konečnou funkci přímo do našeho plug-in souboru. Dokumentace API je velmi specifická a poskytuje vynikající zdroje pro vývojáře, kteří mohou mít pokročilé otázky. Materiál se může zdát obtížný, pokud nejste obeznámeni s PHP, ale vezměte si čas s koncepty a věci začnou plynout přirozeně!

Níže uvedená funkce by měla být přidána přímo po komentáři záhlaví pluginu. Alternativně by to mohlo být také umístěno ve vašem motivu functions.php soubor. Kód se používá k vytvoření dynamického obsahu příspěvku založeného na omezeném rozsahu znaků.

Takže pro náš příklad můžeme omezit úryvky z příběhů o délce pouze 55 znaků hk_trim_content () funkce. Tento kousek kódu můžete snadno zavolat z widgetu sidebar nebo jednoho ze souborů motivů, které chcete nahradit $ the_content.

= $ limit) array_pop ($ content); $ content = implode ("", $ content). '…';  else $ content = implode ("", $ content);  $ content = preg_replace ('/ \ _. + .]/', ", $ content); $ content = apply_filters ('the_content', $ content); return $ content;?> 

Nemělo by se očekávat, že plně pochopíte všechny interní proměnné nebo funkce zde použité. Velmi dobré pochopení toho, jak by vaše funkce měly být psány a jak by vypadal příkladový soubor, je jen velmi dobré.

Můžete si také všimnout, že používáme hovor apply_filters což je další funkce specifická pro WordPress. To je další aspekt, který nemusíte plně pochopit, ale pomáhá s budoucím programováním přes WP. Další podrobnosti a nejčastější dotazy k tomuto tématu naleznete na referenční stránce apply_filters.

Hlavní funkce uvedená výše je pojmenována hk_trim_content (). To vyžaduje pouze jeden parametr pojmenovaný $ limit. To by mohlo být také zkráceno na $ lim který by měl ukládat celé číslo určující, kolik znaků má omezit váš výňatek. Obsah je používán na stránkách s plnou poštou a také na statických stránkách (o nás, kontaktu).

Abychom mohli tuto funkci zavolat, museli bychom přidat parametr do našich souborů šablon. To by bylo umístěno někde možná ve vašem index.php nebo loop.php a budete muset nejprve nainstalovat plugin. Příklad níže:

Instalace a spuštění modulu Plugin

Vytvořil jsem ukázkový soubor pro plugin k demo, pokud chcete přeskočit hard kódování. Stačí si tento soubor stáhnout (přejmenovat na .php) nebo zkopírovat / vložit kód do nového dokumentu PHP a nahrát jej na svůj / wp-content / plugins adresář.

Po dokončení budete chtít přistupovat k panelu pro správu aplikace WordPress a procházet aktuální sadu zásuvných modulů pro nainstalované demo. Jakmile aktivujete nic nového se nestane, dokud ne ručně přidáme do našeho volání funkce. K tomu jednoduše navigovat Vzhled -> Editor a hledejte single.php.

Tento soubor obsahuje všechny šablony HTML / CSS pro základní stránku článku příspěvku. Přejděte dolů, dokud nenajdete obsah() a nahradit výše uvedeným příkladem kódu. Tím se omezí všechny stránky článku na 55 znaků bez ohledu na to, jaký pohled se používá. Do této funkce můžete také přidat podobné stránky ve vašem adresáři šablon, například search.php nebo archive.php.

Závěr

To jsou některé ze základů, které vám umožní začít pracovat ve vývoji WordPress. Zásuvný systém je rozsáhlý a obsahuje velké množství interních funkcí. Pokud již máte nápad na plug-in vyzkoušet na místní instalaci WordPress pro praxi těchto témat.

Pokud jste stále zmateni velkou část informací, můžete si prohlédnout dokumentaci WordPress a vyhledat odpověď tam. Rozvojová komunita je plná užitečných uživatelů a fóra uchovávají archivy s dotazy z let zpět.