Hva er WordPress PHP-kodingsstandarder?

Hva er WordPress PHP kodingsstandarder? I denne videoen fra kurset mitt, Lær PHP for WordPress, lærer du alt om kodingsstandardene og hvorfor de er viktige.

WordPress PHP-kodingsstandarder

 

Hva er WordPress PHP-kodingsstandardene?

Du kan finne de fullstendige WordPress PHP-kodingsstandardene i den offisielle WordPress-håndboken.

De er egentlig et sett med beste praksis på hvordan å bruke PHP i WordPress. Vi vil gjennomgå noen eksempler på hva det betyr i praksis i resten av denne opplæringen.

Som du kan se, er det standarder ikke bare for PHP, men også for tilgjengelighet og for de andre språkene du vil bruke innen WordPress. 

Hvorfor er PHP-kodingsstandardene viktige?

Hvorfor er det viktig at vi alle holder seg til disse standardene? 

Vel, det er to grunner. En av dem handler om kvaliteten på koden, og den andre handler om konsistens. 

For det første er kvalitet viktig fordi det betyr at alle som kodes i WordPress, lager kode som vil fungere, det vil gjøre jobben sin, og den vil bli skrevet i en moderne og høykvalitets mote.

Den andre, som handler om konsistens, er like viktig. Det er veldig sannsynlig at du skal jobbe med andres kode fra tid til annen. Hvis du for eksempel lager et barnemne, kan det hende du må kopiere noe av koden fra foreldetemaet. Og hvis du lager et plugin, kan dette plugin være en gaffel av et eksisterende tredjeparts plugin som du kopierer og legger til ekstra funksjonalitet til. Det er veldig viktig at måten du kodes er i tråd med måten at alle andre som koder PHP for WordPress, skriver kode selv. 

Eksempler på PHP Coding Standards for WordPress

Så la oss ta en titt på noen av PHP-kodingsstandardene. Og jeg skal vise deg eksempler på disse i noen av filene i temaet mitt.

Naming Conventions and Cases

La oss starte med å navngi konvensjoner og saker. Når du tenker på navngivningskonvensjoner, er det fire ting å tenke på:

  1. funksjonene i temaet eller pluginet ditt
  2. filene og måten du nevner dem på
  3. noen klasser du skriver
  4. eventuelle variabler du lager

Så la oss starte med funksjoner. Her er functions.php-filen i mitt tema som et eksempel. 

Du kan se at jeg har en funksjon som jeg har definert kalt rachelmcc_register_widgets. Det er alt skrevet i små bokstaver, og jeg bruker underskrifter mellom ordene, som er hvordan du alltid skal skrive en funksjon i WordPress.

Som du også ser, har jeg brukt et prefiks. Det er for å sikre at denne funksjonen ikke kommer i konflikt med andre funksjoner som kan være gitt av mitt tema eller av et annet plugin. Så hvis jeg skrev en funksjon som bare ble kalt register_widgets og en av mine plugins hadde også en funksjon som heter register_widgets, de to kunne kollidere. Det kan hende du finner ut at en av dem overstyrer den andre, eller at pluginet ikke virker. 

Så i stedet bruker jeg en unik funksjon som er relevant for mitt tema. Mitt tema kalles rachelmccollin, så mine funksjoner har rachelmcc som prefiks. Og det er også viktig å bruke understreker for dine funksjoner og ikke å bruke bindestreker.

Du gjøre Bruk bindestreker på to steder. For det første bruker du bindestreker når du definerer CSS-klasser. Så du kan se at i min widgets definerer jeg CSS-klasser for min h3 element og også for id av det widgetområdet. Og her bruker du bindestreker.

Det andre stedet du bruker bindestrek er i filnavnene dine. Så dette er frontpage.php. 

Du bør alltid bruke bindestreker i filnavnene dine i dine temaer og pluginene dine; ikke bruk understreker. Så her er det et anrop med locate_template. Og sløyfe-frontpage.php er en fil, en maldel som jeg ringer, og du kan se at det har en bindestrek og ikke en understreking. 

På den annen side bruker min posttype-ID, som er en egendefinert innleggstype jeg har registrert, en underskrift: rmcc_blurb

Nå må du kanskje også tenke på variabler i temaet ditt. La oss se på loop-frontpage.php:

Innenfor denne bestemte filen, som er den jeg ringte fra den forrige filen, har jeg definert noen variabler, en som heter telle og en som heter tittel. Og du kan se at jeg bruker små bokstaver for begge disse. 

Det andre stedet du trenger å tenke på understreker og kapitalisering er når du bruker en klasse. La oss gå tilbake til forsiden.php:

Og du kan se her, jeg bruker WP_Query klasse. Så en klasse har et stort brev etter understreket, så vel som i begynnelsen. Så det er der du bruker kapitalisering når du definerer en klasse. Det hjelper folk som jobber med koden din, umiddelbart å identifisere at det er en klasse og ikke en funksjon.

Bruk av enkle og doble tilbud

La oss nå se på hvordan du vil bruke enkle og doble anførselstegn i PHP for WordPress. 

Du kan bruke enten enkelt anførselstegn eller dobbel anførselstegn, avhengig av hvilke som fungerer best for den spesifikke koden du jobber med.

Grunnen til at doble anførselstegn noen ganger kan være mer nyttig, er at de gjør det enklere å jobbe med spesialtegn. Her er et eksempel:

Si at du skriver en søkemalenfil, search.php. Og i det, hvis ingenting ble funnet, ville du sette et avsnitt som sier: "Beklager, søket fant ikke noe. Hvorfor prøver du ikke igjen?"

Jeg har satt det i to sitater fordi teksten inneholder apostrofer. La meg vise deg hvordan det ville fungere hvis vi gjorde det i enkelt sitater. 

Du må sette et tilbakeslag for apostrophene for at de skal bli sendt riktig ut i HTML-koden, ellers vil det gi deg feil. Nå vet jeg ikke om deg, men jeg vil heller bare skrive det normalt innen dobbelt anførselstegn enn gjøre alt dette innen enkelt anførselstegn.

Den andre tingen du trenger å huske er at hvis du trenger å sette sitater i anførselstegn, kan du enten sette enkelt anførselstegn i dobbelt anførselstegn, eller omvendt. Det spiller ingen rolle hvilken vei, men du kan ikke sette enkelt anførselstegn i enkelt anførselstegn eller dobbel anførselstegn innen dobbelt anførselstegn.

Så her er et eksempel å gå tilbake til min funksjoner.php-fil. 

Innenfor har jeg enkelt anførselstegn for verdien av before_widget, og så har jeg dobbelt anførselstegn for ID og klassen av det. Jeg kunne ikke bruke doble anførselstegn her og deretter sette dobbelt anførselstegn inne i det, så det er derfor jeg bruker enkle anførselstegn der, fordi det er bedre å bruke dobbelt anførselstegn med CSS. 

innrykk

Nå, la oss se på innrykk. Og la oss fortsette å se på functions.php-filen, noe som er et godt eksempel fordi jeg har inngått en rekke kodelinjer i den. 

Du kan se at funksjonsnavnet er til venstre, og deretter innenfor det register_sidebar funksjonen er innrykket på ett nivå. Og innholdet av det er innrykket igjen. 

Så hver gang du setter inn innhold i braces eller krøllete braces, bør alt inni det være innrykket. Og også for innrykk, bør du bruke linjeskift. 

Så la oss ta en titt på en annen fil hvor det er enkeltlinjer og dobbel linjer. 

Så her kan du se jeg har en hvis uttalelse som har to linjer med kode i den. Så jeg har satt en linjeskift over og under disse to kodelinjene.

Hvis det bare var en linje med kode i det, ville jeg ikke ha å sette disse linjene inn - jeg ville bare sette det rett inn i armbrakene mine. 

Å bruke avstand som dette bidrar til å gjøre det klart hvor blokkene dine er. Og du kan også se at innrykk har blitt brukt. Så det er flere lag av innrykk. 

Den andre tingen du må huske på er hvor du åpner og lukker PHP-taggen din, og om den er på samme linje som koden din eller en annen linje. Og det avhenger også av om du koder en blokk med kode eller en enkelt linje.

Hvor du har en blokk med kode, legger du åpningskoden på en linje og lukkekoden på en annen linje. Det bidrar til å gjøre det klart at det er en blokk med PHP, og at alt innenfor disse kodene er PHP.

Den andre tingen du må sørge for at du gjør, er å bruke en full åpning av PHP-taggen. Så ikke bare bruk et spørsmålstegn, som du kanskje har gjort i noen andre systemer som bruker PHP, fordi i WordPress må du bruke hele PHP-taggen. 

Hvis jeg skrev noen PHP som bare var på en linje, ville jeg sette PHP-åpnings- og lukkekoder på samme linje.

Du kan se at vi har noen PHP som er alt i en linje, og deretter har jeg HTML. Så åpnings- og lukkekodene går på samme linje som koden min. 

Konklusjon

Det er en introduksjon til noen av elementene i WordPress PHP-kodingsstandardene, og jeg har vist deg noen eksempler på dem i filene mine og endret noe som jeg har gått sammen for å vise deg hvordan ting gjøres riktig. 

Hvis du vil vite mer om kodingsstandardene, er det dokumentasjon på WordPress-nettstedet. Og du kan også sjekke ut denne Envato Tuts + serien, som går inn i alle elementene i kodingsstandardene i detalj.

Se hele kurset

I hele kurset, Lær PHP for WordPress, lærer du alt om PHP, programmeringsspråket som WordPress er innebygd.  

Jeg gir deg en oversikt over hva PHP er og hvordan det brukes til WordPress-temaer og plugins, med eksempler. Du fortsetter å lære å lage en PHP-fil og bruke den til å skrive ut HTML. Deretter lærer du å bruke funksjoner, sløyfer og om setninger for koding av egendefinerte WordPress-temaer og plugins.

Du kan ta dette kurset med en gang med et abonnement på Envato Elements. For en enkelt månedlig avgift får du tilgang ikke bare til dette kurset, men også til vårt voksende bibliotek med over 1000 videokurser og bransjeledende e-bøker på Envato Tuts+. 

I tillegg får du ubegrensede nedlastinger fra det enorme Envato Elements-biblioteket med 580 000 + kreative eiendeler. Lag med unike skrifttyper, bilder, grafikk og maler, og lever bedre bedre prosjekter raskere.