Vad är WordPress PHP kodningsstandarder? I den här videon från min kurs, Lär dig PHP för WordPress, lär du dig allt om kodningsstandarderna och varför de är viktiga.
Du kan hitta de fullständiga WordPress PHP-kodningsstandarderna i den officiella WordPress-handboken.
De är i grunden en uppsättning bästa praxis på hur man använder PHP i WordPress. Vi ska gå igenom några exempel på vad det betyder i praktiken i resten av denna handledning.
Som du kan se finns det standarder inte bara för PHP utan också för tillgänglighet och för de andra språk som du skulle använda inom WordPress.
Varför är det viktigt att vi alla följer dessa normer?
Tja, det finns två skäl. En av dem handlar om kvaliteten på koden, och den andra handlar om konsistens.
För det första är kvalitet viktigt eftersom det betyder att alla som kodar i WordPress skapar kod som kommer att fungera, som kommer att göra sitt jobb, och det kommer att skrivas i ett aktuellt och högkvalitativt mode.
Den andra, som handlar om konsistens, är lika viktig. Det är mycket troligt att du kommer att arbeta med andras kod från tid till annan. Om du till exempel skapar ett barntema kanske du kanske måste kopiera en del av koden från modertemat. Och om du skapar ett plugin, kan det här pluginet vara en gaffel av ett existerande tredjeparts plugin som du kopierar och lägger till extra funktionalitet till. Det är verkligen viktigt att det sätt du kodar är förenligt med det sätt som alla andra som kodar PHP för WordPress skriver själva själva koden.
Så låt oss ta en titt på några av PHP-kodningsstandarderna. Och jag ska visa dig exempel på dessa i några av filerna i mitt tema.
Låt oss börja med namngivna konventioner och fall. När du tänker på namngivna konventioner finns det fyra saker att tänka på:
Så låt oss börja med funktioner. Här är funktionen.php-filen i mitt tema som ett exempel.
Du kan se att jag har en funktion som jag har definierat kallad rachelmcc_register_widgets
. Det är allt skrivet i små bokstäver, och jag använder underskrifter mellan orden, vilket är hur du alltid ska skriva en funktion i WordPress.
Som du också ser har jag använt ett prefix. Det är för att säkerställa att denna funktion inte kolliderar med några andra funktioner som kan tillhandahållas av mitt tema eller av ett annat plugin. Så om jag skrev en funktion som just ringde register_widgets
och en av mina plugins hade också en funktion som heter register_widgets
, de två kunde kollidera. Det kan hända att en av dem åsidosätter den andra eller att plugin inte fungerar.
Så istället använder jag en unik funktion som är relevant för mitt tema. Mitt tema heter rachelmccollin
, så mina funktioner har rachelmcc
som ett prefix. Och det är också viktigt att använda understreck för dina funktioner och inte använda bindestreck.
Du do Använd bindestreck på två ställen. För det första använder du bindestreck när du definierar CSS-klasser. Så du kan se att inom mina widgets definierar jag CSS-klasser för mina h3
element och även för id
av det där widgetområdet. Och här använder du bindestreck.
Den andra platsen du använder bindestreck är i dina filnamn. Så det här är frontpage.php.
Du bör alltid använda bindestreck i dina filnamn inom dina teman och plugin-program. använd inte underskrifter. Så här finns ett samtal med locate_template
. Och loop-frontpage.php
är en fil, en malldel som jag ringer, och du kan se att det har en bindestreck och inte en understrykning.
Å andra sidan använder min posttyp ID, som är en anpassad posttyp jag har registrerat, en underskrift: rmcc_blurb
.
Nu kanske du också behöver tänka på variabler inom ditt tema. Låt oss titta på loop-frontpage.php:
Inom den här filen, som jag ringde från den tidigare filen, har jag definierat några variabler, en som heter räkna
och en kallad titel
. Och du kan se att jag använder små bokstäver för båda dessa.
Den andra platsen där du behöver tänka på understreck och kapitalisering är när du använder en klass. Låt oss gå tillbaka till frontpage.php:
Och du kan se här, jag använder WP_Query
klass. Så en klass har en bokstav efter underskriften, liksom i början. Så det är där du använder kapitalisering när du definierar en klass. Det hjälper människor som arbetar med din kod direkt att identifiera att det är en klass och inte en funktion.
Låt oss nu titta på hur du skulle använda enkla och dubbla citat i PHP för WordPress.
Du kan använda antingen enkla citat eller dubbla citat, beroende på vilket som fungerar bäst för den specifika koden du jobbar med.
Anledningen till att dubbla citat ibland kan vara mer användbart är att de gör det enklare att arbeta med specialtecken. Här är ett exempel:
Säg att du skriver en sökmallfil, search.php. Och om det inte hittades något, skulle du lägga en paragraf som säger: "Jag är ledsen, din sökning hittade ingenting. Varför försöker du inte igen?"
Jag har lagt det inom dubbla citat eftersom texten innehåller apostrofer. Låt mig visa dig hur det skulle fungera om vi gjorde det i enkla citat.
Du måste sätta ett backslash innan apostrophesna för att de ska matas ut korrekt i HTML-filen annars kommer det att ge dig fel. Nu vet jag inte om dig, men jag vill hellre bara skriva det normalt inom dubbla citat än gör allt detta inom enkla citat.
Det andra du behöver komma ihåg är att om du behöver sätta citat i citat anger du antingen enkla citat inom dubbla citat eller vice versa. Det spelar ingen roll vilken väg, men du kan inte sätta enkla citat inom enkla citat eller dubbla citat inom dubbla citat.
Så här är ett exempel som går tillbaka till min functions.php-fil.
Inom här har jag enstaka citat för värdet av before_widget
, och sedan inom det har jag dubbla citat för ID och klassen av det. Jag kunde inte använda dubbla citat här och sedan sätta dubbla citat inuti det, så det är därför jag använder enkla citat där, eftersom det är bättre att använda dubbla citat med din CSS.
Nu ska vi titta på indryckning. Och låt oss fortsätta titta på funktionerna .php-filen, vilket är ett ganska bra exempel eftersom jag har insprutat ett antal rader av kod inom den.
Du kan se att funktionsnamnet är till vänster och sedan inom det register_sidebar
funktionen är indragen på en nivå. Och innehållet i det är indragna igen.
Så varje gång du sätter in innehåll inom hängslen eller häftiga hängslen, ska allt inuti det vara inryckt. Och även för inryckning bör du använda raster.
Så låt oss ta en titt på en annan fil där det finns enkla linjer och dubbla linjer.
Så här kan du se att jag har en om
uttalande som har två linjer kod inom den. Så jag har satt en radbrytning ovanför och under dessa två rader kod.
Om det bara fanns en rad kod inom det, skulle jag inte behöva sätta dessa linjer i-jag skulle bara sätta det rakt inuti mina hängslen.
Genom att använda mellanslag så här blir det tydligt var dina block med kod är. Och du kan också se att indryckningen har använts. Så det finns flera lager av indragning.
Den andra sak du behöver tänka på är var du öppnar och stänger din PHP-tagg och om det ligger på samma rad som din kod eller en annan linje. Och det beror också på om du kodar ett block med kod eller en enda rad.
Där du har ett block med kod placerar du din öppnings tagg på en rad och din stängningskod på en annan linje. Det hjälper till att göra det uppenbart att det är ett block av PHP och att allt inom dessa taggar är PHP.
Det andra du måste se till att du gör är att använda en helt öppen PHP-tagg. Så använd inte bara ett frågetecken, som du kanske har gjort i några andra system som använder PHP, eftersom i WordPress måste du använda hela PHP-taggen.
Om jag skrev något PHP som bara var på en rad, skulle jag placera PHP-öppnings- och stängningskoderna på samma rad.
Du kan se att vi har några PHP som är alla i en rad, och sedan har jag HTML. Så öppnings- och stängningskoderna går i samma linje som min kod.
Det är en introduktion till några av elementen i WordPress PHP-kodningsstandarderna, och jag har visat några exempel på dem i mina filer och ändrats som jag har gått för att visa dig hur saker och ting görs på rätt sätt.
Om du vill veta mer om kodningsstandarderna finns det dokumentation på WordPress-webbplatsen. Och du kan också kolla in denna Envato Tuts + -serien, som går in i alla delar av kodningsstandarden i detalj.
Under hela kursen, Lär dig PHP för WordPress, lär du dig allt om PHP, det programmeringsspråk som WordPress är inbyggt i.
Jag ger dig en översikt över vad PHP är och hur det används för WordPress-teman och plugins, med exempel. Du fortsätter att lära dig hur du skapar en PHP-fil och använder den för att skriva ut HTML. Då lär du dig att använda funktioner, loopar och om uttalanden för kodning av anpassade WordPress-teman och plugins.
Du kan ta kursen direkt med en abonnemang på Envato Elements. För en enda månatlig avgift får du inte bara tillgång till kursen utan också till vårt växande bibliotek med över 1000 videokurser och branschledande e-böcker på Envato Tuts+.
Dessutom får du obegränsade nedladdningar från det enorma Envato Elements-biblioteket med 580 000 + kreativa tillgångar. Skapa med unika teckensnitt, foton, grafik och mallar, och leverera bättre projekt snabbare.