De coderingsstandaarden van WordPress zorgen voor consistentie en onderhoudbaarheid in de uitgebreide codebase van het platform. Deze zorgvuldig opgestelde richtlijnen distilleren WordPress ontwikkelingstips en bevorderen duidelijkheid en efficiëntie.
Door deze WordPress Onderhoudsgidsen te volgen, kunnen ontwikkelaars wereldwijd harmonieus samenwerken en elkaars werk naadloos begrijpen. Laat je WordPress ontwikkelteam de WordPress coderingsstandaarden nauwgezet volgen om te zorgen voor hoogwaardige, schaalbare en onderhoudbare oplossingen voor de lange termijn.
Waarom vasthouden aan de coderingsstandaarden van WordPress?
WordPress coderingsstandaarden hebben als doel om codeconsistentie te garanderen tussen projecten en medewerkers. Het verbetert de leesbaarheid en onderhoudbaarheid voor gezamenlijke ontwikkeling en vergemakkelijkt codebeoordelingen en het naleven van best practices in het hele WordPress ecosysteem.
Wat zijn WordPress codeerstandaarden?
De WordPress coderingsstandaarden bieden een basis voor samenwerking en consistentie binnen het WordPress project en de WordPress gemeenschap, van kerncode tot thema's en plugins. Deze standaarden zijn ontwikkeld door de WordPress gemeenschap, in overleg met WordPress support foums en dienen als best practices die WordPress ontwikkelaars en medewerkers zouden moeten volgen.
Meer informatie: Hoe verminder je de impact van code van derden?
Het belang van coderingsstandaarden
Codeerstandaarden helpen veelgemaakte fouten te voorkomen, verbeteren de leesbaarheid van code en vereenvoudigen wijzigingen. Door je eraan te houden lijkt code alsof het door één persoon is geschreven, waardoor het voor iedereen makkelijker te begrijpen en aan te passen is.
Bijdrage aan WordPress Kern
Als je bijdraagt aan WordPress core, is het cruciaal om bekend te zijn met deze standaarden, omdat ingediende code hieraan moet voldoen.
Moeite met het handhaven van coderingsstandaarden voor je unieke WordPress site?
Laat onze deskundige WordPress ontwikkelaars de hoofdpijn maar oplossen!
Onderdelen van WordPress codeerstandaarden
De standaarden bevatten taalspecifieke richtlijnen voor CSS, HTML, JavaScript en PHP, evenals toegankelijkheidsrichtlijnen die zijn afgestemd op WCAG AA.
Lees ook: Hoe HTML converteren naar WordPress Theme?
Uitzondering voor bibliotheken van derden
Bibliotheken van derden die in WordPress zijn opgenomen, zijn echter vrijgesteld van deze standaarden.
Voorbeelden van WordPress codeerstandaarden
Laten we de WordPress codeerstandaarden verkennen aan de hand van verschillende voorbeelden om de toepassing ervan in de echte wereld te begrijpen. Deze voorbeelden illustreren de aanbevolen best practices voor het schrijven van duidelijke en onderhoudbare code in WordPress.
PHP IN WORDPRESS
WordPress gebruikt PHP-updates als belangrijkste programmeertaal. Het naleven van PHP coderingsstandaarden is cruciaal voor onderhoudbare en consistente code in WordPress. Dit is waarom PHP coderingsstandaarden belangrijk zijn:
Regelscheidingen
WordPress specificeert niet veel over regeleinden, maar het is gebruikelijk om er een toe te voegen na de meeste verklaringen. Het wordt ook aanbevolen om variabele definities, if-blokken en array-items op aparte regels te zetten.
Inkeping
Om je code gemakkelijker leesbaar te maken, gebruik je inspringing om de logische structuur weer te geven. Tabs moeten worden gebruikt aan het begin van regels, terwijl spaties worden gebruikt voor inspringen in het midden van de regel.
Ruimtegebruik
Maak je code leesbaarder door extra spaties aan het einde van regels te verwijderen. Verwijder ook lege regels met tabs of niet-brekende spaties. Gebruik spaties binnen haakjes voor de duidelijkheid. Voeg een regeleinde toe na een accolade en voor een accolade, behalve bij typecasting.
Citaten
In WordPress is de belangrijkste regel om enkele aanhalingstekens te gebruiken voor strings, tenzij je er iets in evalueert. Als je aanhalingstekens nodig hebt binnen een string, wissel dan af tussen enkele en dubbele aanhalingstekens. Aanhalingstekens escapen is toegestaan, maar zelden nodig.
Bretels
De eenvoudigste manier is om altijd accolades te gebruiken. Hoewel de standaarden het overslaan van accolades toestaan voor eenregelige "als"-statements zonder blokken van meerdere regels in dezelfde structuur, is dit niet toegestaan voor eenregelige lussen. Ik gebruik liever altijd accolades voor de duidelijkheid. Bovendien schrijven de standaarden voor dat de openingsaccolade op dezelfde regel moet staan als het initiële statement, niet eronder zoals in de PHP documentatie.
SQL-query's opmaken
Wanneer je SQL-query's schrijft, vergeet dan niet de trefwoorden met een hoofdletter te schrijven. Complexe queries moeten worden opgesplitst in meerdere regels. Het is belangrijk om queries goed te begrijpen, vooral hun beveiligingsaspecten, die we later zullen bespreken. SQL injectie aanvallen komen voor als gevolg van WordPress beveiligingsfouten, waardoor hackers direct toegang krijgen tot de database achter een WordPress site en deze kunnen manipuleren.
Conventies voor naamgeving
Vermijd CamelCase voor namen in WordPress code. Functies moeten kleine letters gebruiken, met underscores indien nodig. Klassenamen moeten de eerste letter van elk woord met een hoofdletter schrijven, gescheiden door underscores.
Bestandsnamen moeten allemaal kleine letters zijn, met koppeltekens tussen de delen. Als een bestand een enkele klasse bevat, noem het dan naar de klasse, voorafgegaan door "class-".
Gebruik tekenreeksen voor functieargumenten in plaats van booleans voor de duidelijkheid. De belangrijkste regel is om namen beschrijvend te maken. Probeer in een omgeving waar wordt samengewerkt iedereen te helpen om je code te begrijpen.
Vergelijkende verklaringen
Een goede gewoonte, niet alleen voor WordPress, is om de variabele altijd aan de rechterkant van een vergelijking te plaatsen. Op deze manier, als je een gelijkheidsteken vergeet, zal het een fout veroorzaken in plaats van te evalueren naar waar. Als je graag ternaire operatoren gebruikt, is het toegestaan, maar het is aan te raden om te controleren op waarheid om het duidelijker te maken. Een uitzondering is het controleren op niet-lege variabelen met ! empty().
HTML OPMAKEN
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 een duidelijk verband is tussen de twee.
Doctype
WordPress volgt de XHTML 1.0-specificatie die in 2000 door het W3C werd aanbevolen. Desondanks gebruikt het Twenty Eleven thema, een standaard in WordPress, HTML5. Er is geen echt conflict omdat HTML5 XML serialisatie bevat, waardoor het gebruik van "XHTML5" mogelijk is.
Citaten gebruiken
In HTML worden aanhalingstekens voornamelijk gebruikt voor attributen en hun waarden. Je kunt kiezen voor enkele of dubbele aanhalingstekens, maar houd het consequent bij één type. Persoonlijk gebruik ik waar mogelijk enkele aanhalingstekens, net als in PHP, voor consistentie. Dit helpt me om snel eventuele speciale gevallen in een regel te herkennen door gewoon naar de aanhalingstekens te kijken.
Tags sluiten
De XHTML-specificatie schrijft voor dat alle tags moeten worden gesloten. Lege elementen moeten worden afgesloten met een voorwaartse schuine streep net voor de laatste haak. Zorg ervoor dat er één spatie voor de schuine streep staat, zoals aangegeven.
Inkeping
Laat je HTML inspringen volgens dezelfde regels als voor PHP. Streef naar een logische structuur met je inspringing. Als je PHP en HTML combineert, laat de PHP-blokken dan inspringen op basis van de gebruikelijke manier van inspringen.
CSS OPMAKEN
Het opmaken van CSS heeft betrekking op het organiseren en stylen van de presentatie van webinhoud en zorgt voor consistentie en leesbaarheid op verschillende apparaten en browsers. Goed opgemaakte 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?
Indentatie en structuur
Je CSS zou dit ruwe schema moeten volgen: Schrijf elke selector op een aparte regel, zelfs als je meerdere selectors voor een regelset opsomt. Ook moet elk eigenschap-waarde paar op zijn eigen regel staan. Zet de openingsaccolade op de regel van de selector en zet de afsluitende accolade op een aparte regel met dezelfde inspringing als die van de openende selector.
Conventies voor naamgeving
Gebruik alleen kleine letters. Scheid woorden binnen een selector met een koppelteken. Geef je selectors menselijk leesbare namen.
Eigenschappen en waarden
Er zijn nogal wat regels voor het schrijven van eigenschappen en waarden. Gebruik waar mogelijk steno versies van eigenschappen, behalve bij het overschrijven van een eerder gedefinieerde eigenschap. Gebruik waar mogelijk kleine HEX-codes voor kleuren. Gebruik indien nodig 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 verkoperspecifieke eigenschappen, die altijd voor hun algemene tegenhanger moeten staan, en eigenschappen met afmetingen, die gegroepeerd moeten worden. Als breedte en hoogte zijn gespecificeerd, schrijf dan eerst de breedte.
Reactie
CSS ondersteunt slechts één type commentaar - blokstijl; het heeft geen aparte notatie voor inline commentaar. Schrijf korte commentaren op één regel, zonder een regeleinde eronder. Voor commentaar dat meerdere regels beslaat, voeg je een regeleinde in net na de openingszin en een regeleinde net voor de afsluitende zin. Als je commentaar gebruikt om delen van de code af te bakenen, gebruik dan de volgende notatie:
CSS-preprocessoren gebruiken
Het gebruik van CSS-preprocessors zoals SASS en Less maakt ons leven als ontwikkelaars een stuk eenvoudiger, maar ze zijn niet zonder nadelen. De code die door deze tools wordt geproduceerd is meestal geldig, maar niet erg schoon. Een stylesheet die handmatig (en doordacht) wordt gemaakt, zal veel leesbaarder zijn dan een die automatisch door Less wordt gemaakt. Het hangt af van wat je doet. Als je product commercieel is, dan is het uiteindelijke doel een goede gebruikerservaring, met valide en geoptimaliseerde code. Gebruik in dit geval de uitvoer van de preprocessor als de belangrijkste CSS, maar voeg het originele bestand toe voor ontwikkelaars. Hoewel je CSS niet zal voldoen aan de standaarden van WordPress, overbrugt het opnemen van het originele bestand de kloof enigszins totdat WordPress een officieel standpunt inneemt. Het opofferen van CSS coderingsstandaarden om het ontwikkelproces te vereenvoudigen (met als doel een betere gebruikerservaring) is OK. De geldigheid van code opofferen is dat niet.
Hoe kun je bijdragen aan de codeerstandaarden van WordPress?
Code 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 doen bloeden en jouw CSS kan levensveranderend mooi zijn. Maar als het aankomt op samenwerken aan een project als WordPress, is het hebben van consistente coderingsstandaarden cruciaal.
De WordPress coderingsstandaarden bestaan om ervoor te zorgen dat iedereen die bijdraagt aan de codebase het werk van anderen gemakkelijk kan lezen, begrijpen en erop voortbouwen. Door je aan deze standaarden te houden, spreek je in wezen dezelfde taal als andere medewerkers. Het is net als afspreken om consistente grammatica en opmaakregels te gebruiken zodat iedereen naadloos kan samenwerken aan hetzelfde boek.
Als je wilt bijdragen aan WordPress, is het belangrijk dat je de coderingsstandaarden kent en volgt. Het zorgt ervoor dat je individuele codeerstijl perfect past in de grotere WordPress codebase.
Conclusies
Het naleven van de WordPress codeerstandaarden is essentieel voor het onderhouden van een samenhangende en collaboratieve codebase. Deze richtlijnen, ontwikkeld door de WordPress gemeenschap, 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 blijft ontwikkelen, zullen deze coderingsstandaarden een cruciale rol spelen in het bevorderen van een harmonieuze en efficiënte ontwikkelomgeving voor de hele gemeenschap.
