van WordPress De codeerstandaarden tips voor WordPress-ontwikkelingen bevorderen duidelijkheid en efficiëntie.
Door deze WordPress- onderhoudsrichtlijnen te volgen, kunnen ontwikkelaars wereldwijd harmonieus samenwerken en elkaars werk naadloos begrijpen. Zorg ervoor dat uw WordPress-ontwikkelteam de WordPress-coderingsstandaarden nauwgezet volgt om hoogwaardige, schaalbare en onderhoudbare oplossingen voor de lange termijn te garanderen.
Waarom vasthouden aan de codeerstandaarden van WordPress?
De codeerstandaarden van WordPress zijn bedoeld om codeconsistentie te garanderen tussen projecten en bijdragers. Dit verbetert de leesbaarheid en onderhoudbaarheid bij gezamenlijke ontwikkeling en vergemakkelijkt codebeoordelingen en het naleven van best practices binnen het WordPress-ecosysteem.
Wat zijn de codeerstandaarden van WordPress?
De WordPress-coderingsstandaarden bieden een basis voor samenwerking en consistentie binnen het WordPress-project en de community, van de kerncode tot thema's en plug-ins. Deze standaarden, ontwikkeld door de WordPress-community in overleg met WordPress-ondersteuningsforums dienen als best practices die WordPress-ontwikkelaars en -bijdragers zouden moeten volgen.
Meer informatie: Hoe verminder je de impact van code van derden?
Het belang van codeerstandaarden
Codeerstandaarden helpen veelvoorkomende fouten te voorkomen, de leesbaarheid van code te verbeteren en aanpassingen te vereenvoudigen. Door je eraan te houden, lijkt de code alsof hij door één persoon is geschreven, waardoor iedereen hem gemakkelijker kan begrijpen en aanpassen.
Bijdrage aan de WordPress-kern
Als je bijdraagt aan de WordPress-kern, is het essentieel dat je vertrouwd raakt met deze standaarden, aangezien de ingediende code hieraan moet voldoen.
Vindt u het lastig om de codeerstandaarden voor uw unieke WordPress-website te handhaven?
Laat onze ervaren WordPress-ontwikkelaars het gedoe voor u oplossen!
Onderdelen van de WordPress-coderingsstandaarden
De standaarden omvatten taalspecifieke richtlijnen voor CSS, HTML, JavaScript en PHP, evenals toegankelijkheidsrichtlijnen die zijn afgestemd op WCAG AA.
Lees ook: Hoe converteer je HTML naar een WordPress-thema?
Uitzondering voor bibliotheken van derden
Externe bibliotheken die in WordPress zijn geïntegreerd, zijn echter vrijgesteld van deze normen.
Voorbeelden van WordPress-coderingsstandaarden
Laten we de WordPress-codeerstandaarden eens nader bekijken aan de hand van verschillende voorbeelden om te begrijpen hoe ze in de praktijk worden toegepast. Deze voorbeelden illustreren de aanbevolen werkwijzen voor het schrijven van duidelijke en onderhoudbare code in WordPress.
PHP IN WORDPRESS
WordPress gebruikt PHP als de belangrijkste programmeertaal. Het naleven van de PHP-codeerstandaarden is cruciaal voor onderhoudbare en consistente code in WordPress. Hieronder leggen we uit waarom PHP-codeerstandaarden belangrijk zijn:
Regelafbrekingen
WordPress geeft niet veel specificaties over regeleinden, maar het is gebruikelijk om er na de meeste statements een toe te voegen. Het is ook aan te raden om variabele definities, if-blokken en array-items op aparte regels te plaatsen.
Inkeping
Om je code beter leesbaar te maken, gebruik je inspringingen om de logische structuur aan te geven. Gebruik tabs aan het begin van regels en spaties midden in een regel.
Ruimtegebruik
Maak je code leesbaarder door overbodige spaties aan het einde van regels te verwijderen. Vervang lege regels ook door tabs of niet-brekende spaties. Gebruik spaties binnen haakjes voor de duidelijkheid. Voeg een regelovergang toe na een openende accolade en vóór een sluitende accolade, behalve bij typeconversie.
Citaten
In WordPress is de belangrijkste regel het gebruik van enkele aanhalingstekens voor tekenreeksen, tenzij je iets binnenin evalueert. Als je aanhalingstekens binnen een tekenreeks nodig hebt, wissel dan af tussen enkele en dubbele aanhalingstekens. Het escapen van aanhalingstekens is toegestaan, maar zelden nodig.
Beugel
De eenvoudigste manier is om altijd accolades te gebruiken. Hoewel standaarden toestaan dat accolades worden weggelaten bij eenregelige "if"-instructies zonder meerregelige blokken in dezelfde structuur, is dit niet toegestaan bij eenregelige lussen. Ik geef er de voorkeur aan om altijd accolades te gebruiken voor de duidelijkheid. Bovendien schrijven standaarden voor dat de openingsaccolade op dezelfde regel moet staan als de eerste instructie, en niet eronder zoals in de PHP-documentatie.
SQL-query's formatteren
Bij het schrijven van SQL-query's is het belangrijk om de trefwoorden met een hoofdletter te schrijven. Complexe query's moeten over meerdere regels worden verdeeld. Het is essentieel om query's goed te begrijpen, met name de beveiligingsaspecten, die we later zullen bespreken. SQL-injectieaanvallen vinden plaats door beveiligingsfouten in WordPress, waardoor hackers rechtstreeks toegang krijgen tot de database achter een WordPress-site en deze kunnen manipuleren.
Naamgevingsconventies
Vermijd in WordPress-code het gebruik van CamelCase voor namen. Functies moeten kleine letters gebruiken, eventueel met een underscore. Klassenamen moeten met een hoofdletter beginnen, gescheiden door een underscore.
Bestandsnamen moeten volledig in kleine letters zijn, met koppeltekens tussen de onderdelen. Als een bestand slechts één klasse bevat, geef het dan de naam van de klasse, voorafgegaan door "klasse-".
Gebruik voor de duidelijkheid tekenreekswaarden in plaats van booleaanse waarden voor functieargumenten. De belangrijkste regel is om beschrijvende namen te gebruiken. Streef er in een samenwerkingsomgeving naar dat iedereen je code begrijpt.
Vergelijkende uitspraken
Een goede gewoonte, niet alleen voor WordPress, is om de variabele altijd aan de rechterkant van een vergelijking te plaatsen. Op die manier, als je een gelijkheidsteken vergeet, krijg je een foutmelding in plaats van dat de vergelijking als waar wordt geëvalueerd. Het gebruik van ternaire operatoren is toegestaan, maar het is aan te raden om te controleren op waarheid om de zaken duidelijker te maken. Een uitzondering hierop is het controleren op niet-lege variabelen met !empty().
HTML-OPMAAK
Volgens de WordPress Codex is het belangrijk om alle HTML-code te valideren met de W3C Validator. Geldige code betekent echter niet altijd dat het goede code is, hoewel er wel een duidelijk verband tussen beide bestaat.
Doctype
WordPress volgt de XHTML 1.0-specificatie, aanbevolen door het W3C in 2000. Desondanks gebruikt het Twenty Eleven-thema, een standaardthema in WordPress, HTML5. Er is geen echt conflict, omdat HTML5 XML-serialisatie ondersteunt, waardoor het gebruik van "XHTML5" is toegestaan
Citaten gebruiken
In HTML worden aanhalingstekens voornamelijk gebruikt voor attributen en hun waarden. Je kunt kiezen voor enkele of dubbele aanhalingstekens, maar houd je wel aan één type. Persoonlijk gebruik ik waar mogelijk enkele aanhalingstekens, net als in PHP, voor de consistentie. Dit helpt me om snel eventuele bijzondere gevallen in een regel te herkennen door alleen naar de aanhalingstekens te kijken.
Afsluitende tags
De XHTML-specificatie schrijft voor dat alle tags moeten worden afgesloten. Lege elementen moeten worden afgesloten met een schuine streep vlak voor de laatste punthaak. Zorg ervoor dat er één spatie voor de schuine streep staat, zoals voorgeschreven.
Inkeping
Gebruik dezelfde inspringregels voor je HTML als voor PHP. Streef naar een logische structuur in je inspringing. Wanneer je PHP en HTML combineert, gebruik dan de gebruikelijke inspringingsregels voor de PHP-blokken.
CSS-OPMAAK
Het formatteren van CSS omvat het organiseren en vormgeven van de presentatie van webcontent, waardoor consistentie en leesbaarheid op verschillende apparaten en browsers worden gewaarborgd. Goed geformatteerde CSS verbetert de structuur en visuele aantrekkingskracht van websites en draagt bij aan een betere gebruikerservaring.
Lees meer: Hoe verwijder je ongebruikte CSS in WordPress?
Inkeping en structuur
Je CSS moet grofweg aan dit schema voldoen: schrijf elke selector op een aparte regel, zelfs als je meerdere selectors voor een regelset gebruikt. Ook moet elk eigenschap-waardepaar op een eigen regel staan. Plaats de openingshaak op de regel van de selector en de sluitingshaak op een aparte regel met dezelfde inspringing als de openingshaak van de selector.
Naamgevingsconventies
Gebruik uitsluitend kleine letters. Scheid woorden binnen een selector met een koppelteken. Geef uw selectors leesbare namen.
Eigenschappen en waarden
Er zijn nogal wat regels voor het schrijven van eigenschappen en waarden. Gebruik waar mogelijk verkorte versies van eigenschappen, behalve wanneer u een eerder gedefinieerde eigenschap overschrijft. Gebruik waar mogelijk kleine letters voor de hexadecimale code van kleuren. Gebruik indien van toepassing de kortere versie. Voeg een spatie in na de dubbele punt die volgt op een eigenschap. Gebruik altijd kleine letters, behalve wanneer een hoofdletter vereist is, zoals bij lettertypenamen en leverancierspecifieke eigenschappen. Organiseer CSS-eigenschappen alfabetisch, met uitzondering van leverancierspecifieke eigenschappen, die altijd vóór hun algemene tegenhanger moeten komen, en dimensionale eigenschappen, die bij elkaar moeten worden gegroepeerd. Als breedte en hoogte zijn gespecificeerd, schrijf dan eerst de breedte.
Reageren
CSS ondersteunt slechts één type commentaar: blokcommentaar; er is geen aparte notatie voor inline-commentaar. Schrijf korte commentaren op één regel, zonder een regelafbreking eronder. Voor commentaren die over meerdere regels lopen, voeg je een regelafbreking in direct na de openingssyntaxis en een regelafbreking vlak voor de sluitingssyntaxis. Als je commentaren gebruikt om secties van de code af te bakenen, gebruik dan de volgende notatie:
CSS-preprocessors gebruiken
Het gebruik van CSS-preprocessors zoals SASS en Less maakt ons leven als ontwikkelaars een stuk gemakkelijker, maar ze hebben ook nadelen. De code die door deze tools wordt gegenereerd is meestal geldig, maar kan niet bepaald 'clean' genoemd worden. Een handmatig (en zorgvuldig) geschreven stylesheet is veel leesbaarder dan een stylesheet die automatisch door Less wordt gegenereerd. Het hangt ervan af wat je doet. Als je product commercieel is, is het uiteindelijke doel een goede gebruikerservaring met geldige en geoptimaliseerde code. In dat geval kun je de output van de preprocessor gebruiken als de hoofd-CSS, maar voeg je het originele bestand toe voor ontwikkelaars. Hoewel je CSS dan niet voldoet aan de WordPress-standaarden, overbrugt het toevoegen van het originele bestand de kloof enigszins totdat WordPress een officieel standpunt inneemt. Het opofferen van CSS-codeerstandaarden om het ontwikkelingsproces te vereenvoudigen (met als doel een betere gebruikerservaring) is prima. Het opofferen van de geldigheid van de code is dat echter niet.
Hoe kun je bijdragen aan de codeerstandaarden van WordPress?
Coderen is net als schrijven – iedereen heeft zijn eigen unieke stijl. Jouw HTML ziet er misschien anders uit dan de mijne, mijn JavaScript kan je ogen pijn doen en jouw CSS kan adembenemend mooi zijn. Maar als het gaat om samenwerken aan een project zoals WordPress, zijn consistente codeerstandaarden cruciaal.
De WordPress-codeerstandaarden zijn er om ervoor te zorgen dat iedereen die bijdraagt aan de codebase het werk van anderen gemakkelijk kan lezen, begrijpen en erop kan voortbouwen. Door je aan deze standaarden te houden, spreek je in feite dezelfde taal als andere bijdragers. Het is alsof je afspreekt om consistente grammatica- en opmaakregels te gebruiken, zodat iedereen naadloos kan samenwerken aan hetzelfde boek.
Als je wilt bijdragen aan WordPress, is het essentieel om je vertrouwd te maken met de codeerstandaarden en deze te volgen. Zo sluit jouw persoonlijke codeerstijl perfect aan op de grotere WordPress-codebasis.
Conclusies
Het naleven van de WordPress-coderingsstandaarden is essentieel voor het behoud van een samenhangende en collaboratieve codebase. Deze richtlijnen, ontwikkeld door de WordPress-community, dienen als een gemeenschappelijke taal voor bijdragers wereldwijd. Door de standaarden voor PHP, HTML, CSS, JavaScript en toegankelijkheid te volgen, kunnen ontwikkelaars ervoor zorgen dat hun code consistent, leesbaar en onderhoudbaar is.
Naarmate WordPress zich verder ontwikkelt, zullen deze codeerstandaarden een cruciale rol spelen bij het bevorderen van een harmonieuze en efficiënte ontwikkelomgeving voor de hele community.
