WordPress- coderingsstandaarden zorgen voor consistentie en onderhoudbaarheid in de enorme codebasis van het platform. Deze zorgvuldig opgestelde richtlijnen destilleren tips voor WordPress-ontwikkeling , waardoor duidelijkheid en efficiëntie worden bevorderd.
Door deze WordPress Onderhoudshandleidingen te volgen, dragen ontwikkelaars wereldwijd op harmonieuze wijze bij, waardoor ze elkaars werk naadloos begrijpen. Zorg ervoor dat uw WordPress- ontwikkelteam ijverig de WordPress-coderingsstandaarden volgt om hoogwaardige, schaalbare en onderhoudbare oplossingen voor de lange termijn te garanderen.
Waarom vasthouden aan de WordPress-coderingsstandaarden?
WordPress-coderingsstandaarden zijn bedoeld om codeconsistentie tussen projecten en bijdragers te garanderen. Het verbetert de leesbaarheid en onderhoudbaarheid voor gezamenlijke ontwikkeling en vergemakkelijkt codebeoordelingen en naleving van best practices in het hele WordPress-ecosysteem.
Wat zijn WordPress-coderingsstandaarden?
WordPress-coderingsstandaarden bieden een basis voor samenwerking en consistentie binnen het WordPress-project en de community, van kerncode tot thema’s en plug-ins. Deze standaarden, ontwikkeld door de WordPress-gemeenschap, in overleg met WordPress-ondersteuningsforums, dienen als best practices die WordPress-ontwikkelaars en bijdragers moeten volgen.
Meer informatie : Hoe kunt u de impact van code van derden verminderen?
Belang van coderingsnormen
Codeerstandaarden helpen veelvoorkomende fouten te voorkomen, de leesbaarheid van code te verbeteren en wijzigingen te vereenvoudigen. Door zich hieraan te houden, lijkt de code alsof deze door één persoon is geschreven, waardoor het voor iedereen gemakkelijker wordt om deze te begrijpen en aan te passen.
Bijdrage aan WordPress Core
Als u bijdraagt aan de WordPress-kern, is het van cruciaal belang dat u vertrouwd raakt met deze standaarden, omdat de ingediende code eraan moet voldoen.
Heeft u moeite om de coderingsnormen voor uw unieke WordPress-site te handhaven?
Laat onze deskundige WordPress-ontwikkelaars de hoofdpijn oplossen!
Componenten van WordPress-coderingsstandaarden
De standaarden omvatten taalspecifieke richtlijnen voor CSS, HTML, JavaScript en PHP, evenals toegankelijkheidsrichtlijnen die zijn afgestemd op WCAG AA.
Lees ook: Hoe HTML naar WordPress-thema converteren?
Uitzondering voor bibliotheken van derden
Bibliotheken van derden die in WordPress zijn opgenomen, zijn echter vrijgesteld van deze normen.
Voorbeelden van WordPress-coderingsstandaarden
Laten we de WordPress-coderingsstandaarden verkennen aan de hand van verschillende voorbeelden om de toepassing ervan in praktijkscenario's te begrijpen. Deze voorbeelden illustreren de best practices die worden aanbevolen 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:
Lijnonderbrekingen
WordPress specificeert niet veel over regeleinden, maar het is gebruikelijk om er één toe te voegen na de meeste uitspraken. Het wordt ook aanbevolen om variabeledefinities, if-blokken en array-items op afzonderlijke regels te plaatsen.
Inspringing
Om uw code gemakkelijker leesbaar te maken, gebruikt u inspringen om de logische structuur ervan weer te geven. Tabs moeten aan het begin van regels worden gebruikt, terwijl spaties worden gebruikt voor inspringing in het midden van de regel.
Gebruik van ruimte
Maak uw code gemakkelijker leesbaar door extra spaties aan het einde van de regels te verwijderen. Elimineer ook lege regels met tabs of niet-afbrekende spaties. Gebruik spaties tussen haakjes voor de duidelijkheid. Voeg een regeleinde toe na een accolade openen en vóór een accolade sluiten, behalve bij typecasting.
Citaten
In WordPress is de hoofdregel het gebruik van enkele aanhalingstekens voor tekenreeksen, tenzij je iets daarin evalueert. Als u aanhalingstekens binnen een tekenreeks nodig heeft, wissel dan af tussen enkele en dubbele aanhalingstekens. Ontsnappen aan aanhalingstekens is toegestaan, maar zelden noodzakelijk.
Beugel
De eenvoudigste manier is om altijd een beugel te gebruiken. Hoewel standaarden toestaan dat accolades worden overgeslagen voor 'if'-instructies van één regel zonder blokken van meerdere regels in dezelfde structuur, is dit niet toegestaan voor lussen van één regel. Voor de duidelijkheid geef ik er de voorkeur aan om altijd beugels te gebruiken. Bovendien specificeren standaarden dat de openingsaccolade op dezelfde regel moet worden geplaatst als de initiële instructie, en niet eronder, zoals in PHP-documentatie.
SQL-query's opmaken
Wanneer u SQL-query's schrijft, vergeet dan niet om de trefwoorden met hoofdletters te schrijven. Complexe zoekopdrachten moeten in meerdere regels worden opgesplitst. Het is belangrijk om vragen goed te begrijpen, vooral hun beveiligingsaspecten, die we later zullen bespreken. SQL-injectieaanvallen vinden plaats als gevolg van WordPress-beveiligingsfouten , waardoor hackers rechtstreeks toegang kunnen krijgen tot de database achter een WordPress-site en deze kunnen manipuleren.
Naamgevingsconventies
Vermijd in WordPress-code CamelCase voor namen. Functies moeten kleine letters gebruiken, indien nodig met onderstrepingstekens. Klassennamen moeten de eerste letter van elk woord met een hoofdletter schrijven, gescheiden door onderstrepingstekens.
Bestandsnamen moeten allemaal kleine letters zijn, met koppeltekens tussen de delen. Als een bestand één enkele klasse bevat, noem het dan naar de klasse, voorafgegaan door “class-“.
Gebruik tekenreekswaarden voor functieargumenten in plaats van booleans voor de duidelijkheid. De belangrijkste regel is om namen beschrijvend te maken. Probeer in een samenwerkingsomgeving iedereen te helpen uw code te begrijpen.
Vergelijkingsverklaringen
Een goede gewoonte, niet alleen voor WordPress, is om de variabele altijd aan de goede kant van een vergelijking te plaatsen. Op deze manier zal het, als u een gelijkteken vergeet, een fout veroorzaken in plaats van dat het als waar wordt beoordeeld. Als je graag ternaire operatoren gebruikt, is dat toegestaan, maar het wordt aanbevolen om de waarheid te controleren om de zaken duidelijker te maken. Een uitzondering hierop is het controleren op niet-lege variabelen met behulp van ! leeg().
HTML OPMAKEN
Volgens de WordPress Codex is het belangrijk om alle HTML-code te valideren met behulp van de W3C Validator. Geldige code betekent echter niet altijd dat het goede code is, hoewel er een duidelijk verband tussen beide bestaat.
Documenttype
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. U kunt enkele of dubbele aanhalingstekens kiezen, maar blijf consequent bij één type. Persoonlijk gebruik ik waar mogelijk enkele aanhalingstekens, net als in PHP, voor consistentie. Hierdoor kan ik snel speciale gevallen in een regel herkennen door alleen maar naar de aanhalingstekens te kijken.
Tags sluiten
De XHTML-specificatie schrijft voor dat alle tags moeten worden gesloten. Lege elementen dienen vlak voor de laatste hoekbeugel afgesloten te worden met een schuine streep naar voren. Zorg ervoor dat er één spatie vóór de slash staat, zoals aangegeven.
Inspringing
Laat uw HTML inspringen volgens dezelfde regels als voor PHP. Streef naar een logische structuur met uw inspringing. Wanneer u PHP en HTML combineert, laat u de PHP-blokken inspringen op basis van de gebruikelijke inspringing.
CSS FORMATTEREN
Het formatteren van CSS omvat het organiseren en stylen van de presentatie van webinhoud, waardoor consistentie en leesbaarheid op verschillende apparaten en browsers wordt gegarandeerd. Goed geformatteerde CSS verbetert de structuur en visuele aantrekkingskracht van websites, wat bijdraagt aan een betere gebruikerservaring.
Lees meer: Hoe ongebruikte CSS in WordPress verwijderen?
Inkeping en structuur
Uw CSS zou dit ruwe schema moeten volgen: Schrijf elke selector op een aparte regel, zelfs als u meerdere selectors voor een regelset opsomt. Bovendien moet elk eigenschap-waardepaar op een eigen regel staan. Plaats het openingsaccolade op de lijn van de selector en plaats het accolade sluiten op een aparte regel met dezelfde inkeping als die van de openingsselector.
Naamgevingsconventies
Gebruik alleen kleine letters. Scheid woorden binnen een selector met een koppelteken. Geef uw selectors voor mensen 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 de HEX-code in kleine letters voor kleuren. Gebruik indien nodig de kortere versie. Voeg een spatie in na de dubbele punt na 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 aan hun algemene tegenhanger moeten voorafgaan, en dimensionale eigenschappen, die moeten worden gegroepeerd. Als breedte en hoogte zijn opgegeven, schrijf dan eerst de breedte.
Commentaar geven
CSS ondersteunt slechts één type commentaar: blokstijl; het heeft geen aparte notatie voor inline-opmerkingen. Schrijf korte opmerkingen op één regel, zonder een regeleinde eronder. Voor commentaar dat meerdere regels beslaat, voegt u een regeleinde in vlak na de openingssyntaxis en een regeleinde vlak vóór de slotsyntaxis. Als u opmerkingen gebruikt om delen 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 eenvoudiger, maar ze zijn niet zonder nadelen. De code die door deze tools wordt geproduceerd, is meestal geldig, maar kan niet als erg schoon worden beschouwd. Een stylesheet die handmatig (en zorgvuldig) is geproduceerd, zal veel leesbaarder zijn dan een stylesheet die automatisch door Less wordt geproduceerd. Het hangt af van wat je doet. Als uw product commercieel is, dan is het uiteindelijke doel een goede gebruikerservaring, met geldige 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 ontwikkelingsproces te vereenvoudigen (met als doel een betere gebruikerservaring) is oké. Het opofferen van de geldigheid van code is dat niet.
Hoe kunt u bijdragen aan de WordPress-coderingsnormen?
Coderen is 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 gaat om samenwerken aan een project als WordPress, is het hebben van consistente codeerstandaarden cruciaal.
De WordPress-coderingsstandaarden 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 normen te houden, spreek je in wezen dezelfde taal als andere bijdragers. Het is alsof je afspreekt om consistente grammatica- en opmaakregels te gebruiken, zodat iedereen naadloos aan hetzelfde boek kan samenwerken.
Als u wilt bijdragen aan WordPress, is het van cruciaal belang dat u vertrouwd raakt met de codeerstandaarden en deze volgt. Het zorgt ervoor dat uw individuele codeerstijl perfect aansluit bij de grotere WordPress-codebasis.
Conclusies
Het vasthouden aan de WordPress-coderingsstandaarden is essentieel voor het onderhouden van een samenhangende en samenwerkende codebasis. Deze richtlijnen, ontwikkeld door de WordPress-gemeenschap, dienen als een gemeenschappelijke taal voor bijdragers over de hele wereld. Door de standaarden voor PHP, HTML, CSS, JavaScript en toegankelijkheid te volgen, kunnen ontwikkelaars ervoor zorgen dat hun code consistent, leesbaar en onderhoudbaar is.
Terwijl WordPress zich blijft ontwikkelen, zullen deze coderingsstandaarden een cruciale rol spelen bij het bevorderen van een harmonieuze en efficiënte ontwikkelomgeving voor de hele gemeenschap.
