WordPress kodningsstandarder säkerställer konsekvens och underhållbarhet över plattformens stora kodbas. Dessa noggrant utformade riktlinjer sammanfattar WordPress utvecklingstips , vilket främjar tydlighet och effektivitet.
Genom att följa dessa WordPress- underhållsguider bidrar utvecklare världen över harmoniskt och förstår varandras arbete sömlöst. Få ditt WordPress-utvecklingsteam att noggrant följa WordPress-kodningsstandarder för att säkerställa högkvalitativa, skalbara och underhållbara lösningar på lång sikt.
Varför hålla sig till WordPress kodningsstandarder?
WordPress kodningsstandarder syftar till att säkerställa kodkonsekvens mellan projekt och bidragsgivare. Det förbättrar läsbarhet och underhållbarhet för gemensam utveckling och underlättar kodgranskningar och efterlevnad av bästa praxis i hela WordPress ekosystem.
Vad är WordPress kodningsstandarder?
WordPress kodningsstandarder ger en baslinje för samarbete och konsekvens inom WordPress-projektet och communityn, från kärnkod till teman och plugins. Dessa standarder, utvecklade av WordPress-communityn i samråd med WordPress supportgrupper, fungerar som bästa praxis som WordPress-utvecklare och bidragsgivare bör följa.
Läs mer : Hur man minskar effekten av tredjepartskod?
Vikten av kodningsstandarder
Kodningsstandarder hjälper till att förhindra vanliga fel, förbättra kodens läsbarhet och förenkla modifieringar. Genom att följa dem ser koden ut som om den vore skriven av en enda person, vilket gör den lättare för alla att förstå och modifiera.
Bidrag till WordPress Core
Om du bidrar till WordPress kärna är det avgörande att du bekantar dig med dessa standarder, eftersom inskickad kod måste följa dem.
Kämpar du med att upprätthålla kodningsstandarder för din unika WordPress-webbplats?
Låt våra experter på WordPress-utvecklare ta hand om huvudvärken!
Komponenter i WordPress kodningsstandarder
Standarderna omfattar språkspecifika riktlinjer för CSS, HTML, JavaScript och PHP, samt tillgänglighetsriktlinjer i linje med WCAG AA.
Läs också: Hur konverterar man HTML till ett WordPress-tema?
Undantag för tredjepartsbibliotek
Tredjepartsbibliotek som är integrerade i WordPress är dock undantagna från dessa standarder.
Exempel på WordPress-kodningsstandarder
Låt oss utforska WordPress kodningsstandarder genom olika exempel för att förstå deras tillämpning i verkliga scenarier. Dessa exempel illustrerar de bästa metoderna som rekommenderas för att skriva tydlig och lättskött kod i WordPress.
PHP I WORDPRESS
WordPress använder PHP-uppdateringar som sitt kärnprogrammeringsspråk. Att följa PHP-kodningsstandarder är avgörande för underhållbar och konsekvent kod i WordPress. Här är varför PHP-kodningsstandarder är viktiga:
Radbrytningar
WordPress specificerar inte mycket om radbrytningar, men det är vanligt att lägga till en efter de flesta uttryck. Det rekommenderas också att placera variabeldefinitioner, if-block och arrayelement på separata rader.
Indrag
För att göra din kod lättare att läsa, använd indentering för att visa dess logiska struktur. Tabbar bör användas i början av rader, medan mellanslag används för indentering mitt på rader.
Utrymmesanvändning
Gör din kod lättare att läsa genom att ta bort eventuella extra mellanslag i slutet av rader. Ta även bort tomma rader med tabbtecken eller fasta mellanslag. Använd mellanslag inom parenteser för tydlighetens skull. Lägg till en radbrytning efter en inledande klammerparentes och före en avslutande klammerparentes, förutom vid typsnitt.
Citat
I WordPress är huvudregeln att använda enkla citattecken för strängar om du inte utvärderar något inuti. Om du behöver citattecken inom en sträng, växla mellan enkla och dubbla citattecken. Escape-citattecken är tillåtna men sällan nödvändiga.
Hängslen
Det enklaste sättet är att alltid använda klammerparenteser. Medan standarder tillåter att man hoppar över klammerparenteser för enkelradiga "if"-satser utan flerradiga block i samma struktur, är detta inte tillåtet för enkelradiga loopar. Jag föredrar att alltid använda klammerparenteser för tydlighetens skull. Dessutom specificerar standarder att den inledande klammerparentesen placeras på samma rad som den initiala satsen, inte under den som i PHP-dokumentationen.
Formatering av SQL-frågor
När du skriver SQL-frågor, kom ihåg att skriva nyckelorden med versaler. Komplexa frågor bör delas upp i flera rader. Det är viktigt att förstå frågor väl, särskilt deras säkerhetsaspekter, som vi kommer att diskutera senare. SQL-injektionsattacker uppstår på grund av säkerhetsmisstag i WordPress , vilket gör det möjligt för hackare att direkt komma åt och manipulera databasen bakom en WordPress-webbplats.
Namngivningskonventioner
I WordPress-kod, undvik CamelCase för namn. Funktioner bör använda gemener, med understreck om det behövs. Klassnamn bör skriva den första bokstaven i varje ord med versal, separerade med understreck.
Filnamn ska vara gemener, med bindestreck mellan delarna. Om en fil innehåller en enda klass, namnge den efter klassen, med prefixet "klass-".
Använd strängvärden för funktionsargument istället för booleska värden för tydlighetens skull. Den viktigaste regeln är att namnen ska vara beskrivande. I en samarbetsmiljö, sträva efter att hjälpa alla att förstå din kod.
Jämförelseuttalanden
En bra vana, inte bara för WordPress, är att alltid placera variabeln till höger om en jämförelse. På så sätt, om du glömmer ett likhetstecken, kommer det att orsaka ett fel istället för att utvärderas till sant. Om du gillar att använda ternära operatorer är det tillåtet, men det rekommenderas att kontrollera för sant för att göra saker tydligare. Ett undantag är när man kontrollerar icke-tomma variabler med !empty().
FORMATERING AV HTML
Enligt WordPress Codex är det viktigt att validera all HTML-kod med hjälp av W3C Validator. Giltig kod betyder dock inte alltid att det är bra kod, även om det finns ett tydligt samband mellan de två.
Doktyp
WordPress följer XHTML 1.0-specifikationen som rekommenderades av W3C år 2000. Trots detta använder Twenty Eleven-temat, ett standardtema i WordPress, HTML5. Det finns ingen egentlig konflikt eftersom HTML5 inkluderar XML-serialisering, vilket tillåter användning av "XHTML5"
Använda citat
I HTML används citattecken främst för attribut och deras värden. Du kan välja enkla eller dubbla citattecken, men håll dig till en typ konsekvent. Personligen använder jag enkla citattecken där det är möjligt, precis som jag gör i PHP, för konsekvensens skull. Detta hjälper mig att snabbt upptäcka eventuella specialfall på en rad bara genom att titta på citattecknen.
Stängande taggar
XHTML-specifikationen kräver att alla taggar stängs. Void-element måste stängas med ett snedstreck precis före den sista vinkelparentesen. Se till att det finns ett mellanslag före snedstrecket, enligt specifikationerna.
Indrag
Indrag din HTML enligt samma regler som för PHP. Sträva efter en logisk struktur med din indentering. När du kombinerar PHP och HTML, indrag PHP-blocken baserat på det vanliga indenteringsflödet.
FORMATERING AV CSS
Formatering av CSS innebär att organisera och utforma presentationen av webbinnehåll, vilket säkerställer konsekvens och läsbarhet på olika enheter och webbläsare. Korrekt formaterad CSS förbättrar webbplatsers struktur och visuella attraktionskraft, vilket bidrar till en bättre användarupplevelse.
Läs mer: Hur tar man bort oanvänd CSS i WordPress?
Indragning och struktur
Din CSS bör följa detta grova schema: Skriv varje väljare på en separat rad, även om du listar flera väljare för en regeluppsättning. Dessutom bör varje egenskapsvärdepar stå på en egen rad. Placera den inledande klammerparentesen på väljarens rad och placera den avslutande klammerparentesen på en separat rad med samma indrag som den inledande väljarens.
Namngivningskonventioner
Använd endast gemener. Separera ord inom en väljare med ett bindestreck. Ge dina väljare namn som är läsbara för människor.
Egenskaper och värden
Det finns en hel del regler för att skriva egenskaper och värden. Använd förkortade versioner av egenskaper där det är möjligt, förutom när du skriver över en tidigare definierad egenskap. Använd gemener HEX-kod för färger där det är möjligt. Använd den kortare versionen om det är lämpligt. Infoga ett mellanslag efter kolon efter en egenskap. Använd alltid gemener, förutom när en versal krävs, till exempel med teckensnittsnamn och leverantörsspecifika egenskaper. Organisera CSS-egenskaper alfabetiskt, med undantag för leverantörsspecifika egenskaper, som alltid ska föregå sina allmänna motsvarigheter, och dimensionsegenskaper, som ska grupperas tillsammans. Om bredd och höjd anges, skriv bredden först.
Kommenterar
CSS stöder bara en typ av kommentering – blockstil; den har ingen separat notation för inbäddade kommentarer. Skriv korta kommentarer på en rad, utan radbrytning nedanför. För kommentarer som sträcker sig över flera rader, infoga en radbrytning precis efter den inledande syntaxen och en radbrytning precis före den avslutande syntaxen. Om du använder kommentarer för att avgränsa avsnitt i koden, använd följande notation:
Använda CSS-förprocessorer
Att använda CSS-förbehandlare som SASS och Less gör våra liv som utvecklare mycket enklare, men de är inte utan nackdelar. Koden som produceras av dessa verktyg är vanligtvis giltig men kan inte sägas vara särskilt ren. En stilmall som produceras manuellt (och genomtänkt) kommer att vara mycket mer läsbar än en som produceras automatiskt av Less. Det beror på vad du gör. Om din produkt är kommersiell är det slutgiltiga målet en bra användarupplevelse, med giltig och optimerad kod. I det här fallet, använd utdata från förbehandlaren som huvudsaklig CSS, men inkludera originalfilen för utvecklare. Även om din CSS inte kommer att följa WordPress standarder, överbryggar inkluderandet av originalfilen gapet något tills WordPress tar en officiell ställning. Att offra CSS-kodningsstandarder för att förenkla utvecklingsprocessen (med målet om en bättre användarupplevelse) är okej. Att offra kodens giltighet är det inte.
Hur kan du bidra till WordPress kodningsstandarder?
Kod är som att skriva – alla har sin egen unika stil. Din HTML kan se annorlunda ut än min, mitt JavaScript kan få dina ögon att blöda och ditt CSS kan vara livsförändrande vackert. Men när det gäller att samarbeta i ett projekt som WordPress är det avgörande att ha konsekventa kodstandarder.
WordPress kodningsstandarder finns för att säkerställa att alla som bidrar till kodbasen enkelt kan läsa, förstå och bygga vidare på andras arbete. Genom att följa dessa standarder talar du i princip samma språk som andra bidragsgivare. Det är som att gå med på att använda konsekventa grammatik- och formateringsregler så att alla kan samarbeta smidigt i samma bok.
Om du vill bidra till WordPress är det viktigt att du bekantar dig med och följer kodningsstandarderna. Det gör att din individuella kodningsstil passar perfekt in i WordPress större kodbas.
Slutsatser
Att hålla sig till WordPress kodningsstandarder är avgörande för att upprätthålla en sammanhängande och samarbetsinriktad kodbas. Dessa riktlinjer, utvecklade av WordPress-communityn, fungerar som ett gemensamt språk för bidragsgivare över hela världen. Genom att följa standarderna för PHP, HTML, CSS, JavaScript och tillgänglighet kan utvecklare säkerställa att deras kod är konsekvent, läsbar och underhållbar.
I takt med att WordPress fortsätter att utvecklas kommer dessa kodningsstandarder att spela en avgörande roll för att främja en harmonisk och effektiv utvecklingsmiljö för hela communityn.
