Wordpress

Fes una ullada més de prop als estàndards de codificació de WordPress

Segons W3tech, el 65.1% dels llocs web que utilitzen un sistema de gestió de continguts funcionen amb WordPress. És un CMS de codi obert reconegut escrit en llenguatge PHP. A causa de la seva diversa gamma de temes i complements personalitzats, molts proveïdors de SaaS i agències de màrqueting digital utilitzen WordPress per crear llocs web.

Per què WordPress va introduir estàndards de codificació?

Com que WordPress és un programari de codi obert massiu, consta d'un codi font enorme per executar. Això es deu a la contribució de diversos desenvolupadors fins a aquesta data. Com que la codificació es pot fer en diversos estils, els desenvolupadors poden afegir qualsevol tipus de codi que coneguin a la plataforma WordPress. Això pot provocar complicacions a WordPress.

Si s'implementessin diversos estils de codificació al codi font de WordPress, el complex que es convertiria en diferents desenvolupadors de programari llegir i ampliar les aplicacions del programari. El personal de DevOps que escanejava diferents estils de codi tindria dificultats per identificar errors. Això pot provocar que els llocs web es bloquegin en el moment del llançament, causant danys en termes de pèrdua de clients a les empreses.

Per evitar aquestes circumstàncies, WordPress va introduir estàndards de codificació. Aquestes eren un conjunt de regulacions que els desenvolupadors han de seguir obligatòriament quan amplien la funcionalitat de WordPress.

Els estàndards de codificació simplifiquen el procés de manipulació i avaluació de volums de mostres de codi. Això es deu al fet que segueixen els mateixos estils de format, cosa que facilita als diferents desenvolupadors entendre què passa al codi font. En general, els estàndards de codificació ajuden a mantenir la qualitat dels codis font aportats per altres desenvolupadors.

Quins estàndards de codificació utilitza WordPress?

WordPress no depèn únicament del llenguatge PHP. També utilitza HTML, CSS i JavaScript. Així, els seus estàndards de codificació varien en funció d'aquests llenguatges de programació. Si voleu crear el vostre propi complement de WordPress i millorar la plataforma de WordPress, aquí teniu els estàndards de codificació que heu de seguir mentre creeu el vostre codi.

1. Codificació amb PHP

Per a la contribució d'una codificació uniforme, neta i comprensible, WordPress va introduir estàndards de codificació per al marcatge PHP. Si feu algun projecte de WordPress mitjançant el marcatge PHP, seguiu les normes de codificació següents.

  • Ús de cotitzacions

WordPress recomana utilitzar cometes simples i dobles en condicions adequades. Les cometes simples es poden utilitzar dins d'una cadena quan no s'avalua res. Quan utilitzeu cometes, reserveu un estil de cita per utilitzar-lo dins d'una cadena i l'altre per incloure tota la cadena.

No es recomana escapar de cometes en una cadena.

  • Sagnia

Quan s'utilitzen sagnies, WordPress posa èmfasi en l'ús de tecles de tabulació en lloc de tecles de barra espaiadora per indicar línies de codi sagnades. L'avantatge d'això és que el vostre codi es fa compatible amb diferents editors que l'utilitzen en diferents plataformes.

El sagnat ajuda a destacar les àrees lògiques del codi, fent-les clares i comprensibles

Si utilitzeu matrius associatives i conté diversos elements, cada element d'aquesta matriu hauria de tenir la seva pròpia línia nova. Al final de l'últim element de la matriu, afegiu una coma. Això fa que sigui més fàcil afegir nous elements a la matriu o canviar-ne l'ordre.

  • Etiquetes PHP

Quan s'utilitzen fragments de codi PHP en blocs HTML, les etiquetes d'obertura i tancament de PHP haurien d'estar en una línia independent.

WordPress prohibeix l'ús d'etiquetes PHP abreviades, ja que poden causar problemes durant l'execució del codi.

  • Tirants

WordPress fa que sigui obligatori utilitzar claus al codi. S'ha de col·locar una clau d'obertura a la línia de la declaració inicial. Les claus només s'ometen per a les declaracions d'una sola línia. Les declaracions de bucle també han d'incloure claus. Si s'utilitzen declaracions de diversos blocs, calen claus.

  • Ús de l'espai

S'ha de posar espai als dos costats dels operadors d'assignació, lògics, de comparació i de cadena i després de comes. També s'ha de posar espai després d'obrir i abans de tancar els parèntesis, llevat de les mecanografiades. S'han de suprimir els espais en blanc al final de cada línia de codi.

  • Instruccions SQL

Els estàndards de codificació de WordPress fomenten l'escriptura de declaracions SQL en majúscules. Aquestes declaracions es poden escriure en una sola línia sempre que siguin breus i fàcils de llegir. Per a consultes SQL complexes, s'aconsella dividir-les en diverses línies, sagnant cada instrucció SQL.

  • Principis de denominació

Els desenvolupadors han de seguir les normatives de WordPress mentre anomenen funcions, classes i fitxers per evitar errors desordenats. Quan es creen funcions o variables, els noms s'han d'escriure en minúscules i camelCase està estrictament prohibit. Si s'utilitzen diverses paraules per nomenar-les, separeu-les amb un guió baix.

Similar és el cas dels noms de fitxer, excepte que si s'utilitzen diverses paraules, s'han de separar per un guionet. Si el vostre fitxer consta d'una classe, el nom del fitxer s'ha d'escriure en el format classe-nom de classe en minúscules i cada guió baix substituït per un guionet.

Si s'estan llegint o afegint fitxers que consisteixen en etiquetes de plantilla a la carpeta wp-includes, cal afegir -template al nom del fitxer.

Quan es creen classes, els noms de les classes s'han de posar en majúscula. Si s'utilitzen diverses paraules, s'han de separar amb un guió baix i cada paraula s'ha de posar en majúscula.

2. Codificació amb HTML

La normativa de codificació estableix que els fragments de codi HTML s'han d'executar a través del validador W3C abans de la comprovació manual del codi. Això ajuda a detectar i corregir qualsevol error de marcatge al vostre codi. S'han de seguir els estàndards següents en afegir codificació HTML.

  • Etiquetes de tancament automàtic

Les etiquetes de tancament automàtic en HTML s'han de manejar amb cura, especialment amb l'espaiat. El W3C indica que l'espai ha de precedir la barra inclinada de tancament automàtic quan s'utilitzen etiquetes de tancament automàtic.

  • Etiquetes i atributs

Les etiquetes ajuden a dissenyar l'estructura d'una pàgina HTML. Envolten la web contenen i permeten al navegador determinar el tipus de contingut que es tracta. Atributs proporciona detalls addicionals sobre els elements HTML.

Les normatives de codificació de WordPress aconsellen que totes les etiquetes i atributs HTML s'han d'escriure en minúscules. Els valors dels atributs també s'han d'escriure en minúscules per a la interpretació de la màquina. En el cas de fer que les dades siguin llegibles pels humans, es pot utilitzar una majúscula adequada.

  • Cotitzacions

Les cometes dobles o simples són necessàries per utilitzar-les quan s'escriuen valors d'atributs en XHTML. Els estàndards de codificació de WordPress per a HTML aconsellen el mateix format per evitar problemes de seguretat en el codi HTML.

3. Codificació amb CSS

CSS és un altre llenguatge de programació essencial per dissenyar el disseny i el tema de les vostres pàgines web. WordPress va introduir estàndards de codificació per a la codificació CSS ​​perquè els desenvolupadors poguessin crear codi coherent, net i llegible per als projectes. Aquí teniu les pautes recomanades.

  • estructura

 CSS ofereix moltes opcions per dissenyar el vostre full d'estil. Tanmateix, WordPress proporciona directrius bàsiques en CSS per fer codi clar i diferent. Això ajuda a altres desenvolupadors a col·laborar amb vosaltres per entendre el flux del vostre document.

La directriu aconsella utilitzar pestanyes per sagnar totes les propietats utilitzades al vostre codi. Els blocs de codificació que pertanyen a la mateixa porció han de tenir un espai en blanc entre cada bloc. Per diferenciar les peces de codificació, s'han d'afegir 2 línies en blanc entre cada peça de codificació.

Si enumereu diversos selectors per a un conjunt de regles, cada selector s'ha d'escriure en una línia independent. Per als parells propietat-valor, cadascun hauria de tenir la seva pròpia línia, utilitzar una pestanya de sagnat i acabar amb un punt i coma. Quan només s'utilitza un selector, s'ha de col·locar una clau d'obertura a la línia d'aquest selector.

En cas contrari, la clau d'obertura s'hauria d'afegir a l'última línia del selector i la clau de tancament s'hauria de col·locar en una línia separada a la mateixa sagnat que el selector d'obertura.

  • Selectors

L'estàndard de codificació per als selectors és similar als estàndards de codificació PHP per als noms de fitxer. Mentre es nomenen els selectors, s'han d'escriure en minúscules i s'han d'utilitzar guions per separar diverses paraules. Està prohibit l'ús de camelCase i guions baixos.

Els noms dels selectors haurien de poder donar una breu descripció dels elements que estilen. Aquests noms haurien de ser llegibles pels humans. Per als selectors d'atributs, s'han de posar cometes dobles al voltant dels seus valors.

  • Propietats

WordPress desaconsella l'ús de propietats específiques que poden provocar una disminució de la flexibilitat del disseny. El seu estàndard de codificació aconsella que cada propietat ha d'anar seguida de dos punts i d'un espai.

Les propietats i els valors s'han d'escriure en minúscules, excepte els noms de tipus de lletra. Per afegir colors, es prefereix codis hexadecimals o rgba() i s'han d'utilitzar lletres minúscules. Es recomana l'ús de propietats abreviades per als valors de fons, vora, tipus de lletra, estil de llista, marge i farciment.

4. Codificació amb JavaScript

JavaScript és un llenguatge de programació essencial per crear aplicacions de WordPress. WordPress va formular normatives de codificació perquè els desenvolupadors puguin aportar coherència mentre dissenyen el codi JavaScript. A continuació s'esmenten pocs d'aquests estàndards de codificació.

  • Refactorització del codi font

A causa de les inconsistències presents a l'estructura del codi de WordPress per a JavaScript, la refactorització dels codis font era important per mantenir-lo actualitzat. WordPress està resolent aquest problema a poc a poc. Recomana que els desenvolupadors que treballen en codi JavaScript segueixin les directrius necessàries actuals. Mentre que per als fitxers JavaScript més antics, la refactorització no és necessària.

  • Ús de l'espaiat

WordPress recomana utilitzar espais adequats per millorar la llegibilitat del vostre codi font, optimitzant-lo perquè els navegadors el processin.

La normativa de codificació avala que la pestanya s'ha d'utilitzar per al sagnat. Els espais en blanc s'han d'eliminar a les línies en blanc i al final de les línies. Cada línia de codi no ha de superar els 80 caràcters. S'han d'utilitzar claus per als blocs if/for/try i s'han d'introduir en diverses línies.

Conclusió

L'objectiu dels estàndards de codificació és ajudar els desenvolupadors a formar codi llegible. Com més net sembli el codi, més fàcil serà per als altres entendre i implementar-lo. WordPress és una aplicació de codi obert que compta amb el suport de les contribucions d'una comunitat creixent de seguidors.

Per tant, mentre creeu el vostre projecte de WordPress, recordeu seguir les normes de codificació per poder aportar una codificació de qualitat.   

Articles Relacionats

답글 남기기

이메일 주소는 공개되지 않습니다.

Torna al botó superior