Den ultimative guide til WordPress-kodningsstandarder: Vigtig for udviklere

WordPress- kodningsstandarder sikrer konsistens og vedligeholdelse på tværs af platformens enorme kodebase. Disse omhyggeligt udformede retningslinjer indeholder WordPress-udviklingstips, der fremmer klarhed og effektivitet. 

Ved at følge disse WordPress-vedligeholdelsesvejledninger bidrager udviklere verden over harmonisk og forstår hinandens arbejde problemfrit. Få dit WordPress-udviklingsteam til flittigt at følge WordPress-kodningsstandarder for at sikre løsninger af høj kvalitet, der er skalerbare og vedligeholdelsesvenlige på lang sigt.

Hvorfor holde sig til WordPress kodningsstandarder?

WordPress-kodningsstandarder har til formål at sikre kodekonsistens på tværs af projekter og bidragydere. Det forbedrer læsbarheden og vedligeholdelsen for samarbejdsbaseret udvikling og letter kodegennemgange og overholdelse af bedste praksis på tværs af WordPress-økosystemet.

Hvad er WordPress-kodningsstandarder?

WordPress-kodningsstandarder giver et grundlag for samarbejde og konsistens på tværs af WordPress-projektet og -fællesskabet, fra kernekode til temaer og plugins. Disse standarder, udviklet af WordPress-fællesskabet i samråd med WordPress-supportgrupper, fungerer som bedste praksis, som WordPress-udviklere og -bidragydere bør følge.

Lær mere: Hvordan reducerer man effekten af ​​tredjepartskode?

Vigtigheden af ​​kodningsstandarder

Kodningsstandarder hjælper med at forhindre almindelige fejl, forbedrer læsbarheden af ​​kode og forenkler ændringer. Ved at overholde dem fremstår koden, som om den er skrevet af én person, hvilket gør den lettere for alle at forstå og ændre.

Bidrag til WordPress Core

Hvis du bidrager til WordPress core, er det afgørende at gøre dig bekendt med disse standarder, da den indsendte kode skal overholde disse.

Komponenter i WordPress-kodningsstandarder

Standarderne dækker sprogspecifikke retningslinjer for CSS, HTML, JavaScript og PHP, samt tilgængelighedsretningslinjer i overensstemmelse med WCAG AA.

Læs også: Hvordan konverterer man HTML til WordPress-tema?

Undtagelse for tredjepartsbiblioteker

Tredjepartsbiblioteker, der er indarbejdet i WordPress, er dog undtaget fra disse standarder.

Eksempler på WordPress-kodningsstandarder

Lad os udforske WordPress-kodningsstandarder gennem forskellige eksempler for at forstå deres anvendelse i virkelige scenarier. Disse eksempler illustrerer de bedste fremgangsmåder, der anbefales til at skrive klar og vedligeholdelig kode i WordPress.

PHP I WORDPRESS

WordPress bruger PHP-opdateringer som sit kerneprogrammeringssprog. Overholdelse af PHP-kodningsstandarder er afgørende for vedligeholdelsesvenlig og ensartet kode i WordPress. Her er hvorfor PHP-kodningsstandarder er vigtige:

Linjeskift

WordPress specificerer ikke meget om linjeskift, men det er almindeligt at tilføje et efter de fleste sætninger. Det anbefales også at placere variabeldefinitioner, if-blokke og arrayelementer på separate linjer.

Indrykning

For at gøre din kode nemmere at læse, skal du bruge indrykning til at vise dens logiske struktur. Tabulatorer bør bruges i begyndelsen af ​​linjer, mens mellemrum bruges til indrykning midt på linjen.

Pladsforbrug

Gør din kode lettere at læse ved at fjerne eventuelle ekstra mellemrum i slutningen af ​​linjer. Fjern også tomme linjer med tabulatorer eller faste mellemrum. Brug mellemrum i parenteser for klarhedens skyld. Tilføj et linjeskift efter en indledende parentes og før en afsluttende parentes, undtagen ved typecasting.

Citater

I WordPress er hovedreglen at bruge enkelte anførselstegn til strenge, medmindre du evaluerer noget indeni. Hvis du har brug for anførselstegn i en streng, skal du skifte mellem enkelte og dobbelte anførselstegn. Escape-anførselstegn er tilladt, men sjældent nødvendigt.

Bøjler

Den enkleste måde er altid at bruge parenteser. Standarder tillader at springe parenteser over for "if"-sætninger på én linje uden blokke med flere linjer i samme struktur, men dette er ikke tilladt for løkker på én linje. Jeg foretrækker altid at bruge parenteser for klarhedens skyld. Derudover specificerer standarder at placere den indledende parentes på samme linje som den oprindelige sætning, ikke under den som i PHP-dokumentationen.

Formatering af SQL-forespørgsler

Når du skriver SQL-forespørgsler, skal du huske at skrive nøgleordene med stort begyndelsesbogstav. Komplekse forespørgsler bør opdeles i flere linjer. Det er vigtigt at forstå forespørgsler godt, især deres sikkerhedsaspekter, som vi vil diskutere senere. SQL-injektionsangreb opstår på grund af WordPress-sikkerhedsfejl, der giver hackere direkte adgang til og manipulerer databasen bag et WordPress-websted.

Navngivningskonventioner

I WordPress-kode skal du undgå CamelCase til navne. Funktioner skal bruge små bogstaver, med understregninger om nødvendigt. Klassenavne skal skrive det første bogstav i hvert ord med stort, adskilt af understregninger.

Filnavne skal være små bogstaver med bindestreger mellem delene. Hvis en fil indeholder en enkelt klasse, skal den navngives efter klassen med præfikset "klasse-".

Brug strengværdier til funktionsargumenter i stedet for booleske værdier for klarhedens skyld. Den vigtigste regel er at gøre navnene beskrivende. I et samarbejdsmiljø skal du sigte mod at hjælpe alle med at forstå din kode.

Sammenlignende udsagn

En god praksis, ikke kun for WordPress, er altid at placere variablen i højre side af en sammenligning. På denne måde, hvis du glemmer et lighedstegn, vil det forårsage en fejl i stedet for at evalueres til sandt. Hvis du kan lide at bruge ternære operatorer, er det tilladt, men det anbefales at kontrollere for sandhed for at gøre tingene tydeligere. En undtagelse er når man kontrollerer for ikke-tomme variabler ved hjælp af !empty().

FORMATERING AF HTML

Ifølge WordPress Codex er det vigtigt at validere al HTML-kode ved hjælp af W3C Validator. Gyldig kode betyder dog ikke altid, at det er god kode, selvom der er en klar forbindelse mellem de to.

Doktype

WordPress følger XHTML 1.0-specifikationen, som blev anbefalet af W3C i 2000. På trods af dette bruger Twenty Eleven-temaet, som er standard i WordPress, HTML5. Der er ingen reel konflikt, fordi HTML5 inkluderer XML-serialisering, hvilket tillader brugen af ​​"XHTML5"

Brug af citater

I HTML bruges anførselstegn primært til attributter og deres værdier. Du kan vælge enkelte eller dobbelte anførselstegn, men hold dig konsekvent til én type. Personligt bruger jeg enkelte anførselstegn, hvor det er muligt, ligesom jeg gør i PHP, for at opnå konsistens. Dette hjælper mig med hurtigt at få øje på eventuelle særlige tilfælde i en linje blot ved at se på anførselstegnene.

Lukkemærker

XHTML-specifikationen kræver lukning af alle tags. Void-elementer skal lukkes med et skråstreg lige før den sidste vinkelparentes. Sørg for, at der er et mellemrum før skråstregen, som angivet.

Indrykning

Indryk din HTML efter de samme regler som for PHP. Sigt efter en logisk struktur med din indrykning. Når du kombinerer PHP og HTML, skal du indrykke PHP-blokkene baseret på den sædvanlige indrykningsproces.

FORMATERING AF CSS 

Formatering af CSS involverer organisering og styling af præsentationen af ​​webindhold, hvilket sikrer ensartethed og læsbarhed på tværs af forskellige enheder og browsere. Korrekt formateret CSS forbedrer strukturen og den visuelle appel af websteder, hvilket bidrager til en bedre brugeroplevelse.

Læs mere: Sådan fjerner du ubrugt CSS i WordPress?

Indrykning og struktur

Din CSS skal følge dette grove skema: Skriv hver selektor på en separat linje, selvom du angiver flere selektorer for et regelsæt. Derudover skal hvert egenskabsværdipar stå på sin egen linje. Placer den indledende parentes på selektorens linje, og den afsluttende parentes på en separat linje med samme indrykning som den indledende selektors.

Navngivningskonventioner

Brug kun små bogstaver. Adskil ord i en selektor med en bindestreg. Giv dine selektorer navne, der er læsbare for mennesker.

Egenskaber og værdier

Der er en hel del regler for skrivning af egenskaber og værdier. Brug forkortede versioner af egenskaber, hvor det er muligt, undtagen når du overskriver en tidligere defineret egenskab. Brug HEX-kode med lille bogstav til farver, hvor det er muligt. Brug den kortere version, hvis det er relevant. Indsæt et mellemrum efter kolonet efter en egenskab. Brug altid små bogstaver, undtagen når et stort tegn er påkrævet, f.eks. med skrifttypenavne og leverandørspecifikke egenskaber. Organiser CSS-egenskaber alfabetisk, med undtagelse af leverandørspecifikke egenskaber, som altid skal stå før deres generelle modstykke, og dimensionelle egenskaber, som skal grupperes sammen. Hvis bredde og højde er angivet, skal bredden skrives først.

Kommentering

CSS understøtter kun én type kommentering — blokstil; den har ikke en separat notation for indlejrede kommentarer. Skriv korte kommentarer på én linje uden linjeskift nedenunder. For kommentarer, der strækker sig over flere linjer, skal du indsætte et linjeskift lige efter den indledende syntaks og et linjeskift lige før den afsluttende syntaks. Hvis du bruger kommentarer til at afgrænse sektioner af koden, skal du bruge følgende notation:

Brug af CSS-præprocessorer

Brug af CSS-præprocessorer som SASS og Less gør vores liv som udviklere meget lettere, men de er ikke uden ulemper. Koden, der produceres af disse værktøjer, er normalt gyldig, men kan ikke siges at være særlig ren. Et stylesheet, der produceres manuelt (og omhyggeligt), vil være meget mere læsbart end et, der produceres automatisk af Less. Det afhænger af, hvad du laver. Hvis dit produkt er kommercielt, er det ultimative mål en god brugeroplevelse med gyldig og optimeret kode. I dette tilfælde skal du bruge præprocessorens output som den primære CSS, men inkludere den originale fil for udviklere. Selvom din CSS ikke vil overholde WordPress' standarder, vil det at inkludere den originale fil bygge bro over kløften, indtil WordPress tager en officiel holdning. Det er okay at ofre CSS-kodningsstandarder for at forenkle udviklingsprocessen (med målet om en bedre brugeroplevelse). Det er ikke okay at ofre kodens gyldighed.

Hvordan kan du bidrage til WordPress kodningsstandarder?

Kode er som at skrive – alle har deres egen unikke stil. Din HTML kan se anderledes ud end min, mit JavaScript kan få dine øjne til at bløde, og din CSS kan være livsændrende smuk. Men når det kommer til samarbejde på et projekt som WordPress, er det afgørende at have ensartede kodningsstandarder.

WordPress' kodningsstandarder eksisterer for at sikre, at alle, der bidrager til kodebasen, nemt kan læse, forstå og bygge videre på andres arbejde. Ved at overholde disse standarder taler du i bund og grund det samme sprog som andre bidragydere. Det er som at acceptere at bruge ensartede grammatik- og formateringsregler, så alle problemfrit kan samarbejde om den samme bog.

Hvis du vil bidrage til WordPress, er det vigtigt at gøre dig bekendt med og følge kodningsstandarderne. Det giver din individuelle kodningsstil mulighed for at passe perfekt ind i den større WordPress-kodebase.

Konklusioner

Det er vigtigt at overholde WordPress' kodningsstandarder for at opretholde en sammenhængende og samarbejdsorienteret kodebase. Disse retningslinjer, udviklet af WordPress-fællesskabet, fungerer som et fælles sprog for bidragydere verden over. Ved at følge standarderne for PHP, HTML, CSS, JavaScript og tilgængelighed kan udviklere sikre, at deres kode er ensartet, læsbar og vedligeholdelsesvenlig.

I takt med at WordPress fortsætter med at udvikle sig, vil disse kodningsstandarder spille en afgørende rolle i at fremme et harmonisk og effektivt udviklingsmiljø for hele fællesskabet.