WordPress 코딩 표준은 플랫폼의 방대한 코드베이스 전반에 걸쳐 일관성과 유지 관리성을 보장합니다. 세심하게 만들어진 이 가이드라인은 WordPress 개발 팁을 명확성과 효율성을 높여줍니다.
워드프레스 유지보수 따르면 전 세계 개발자들이 서로의 작업을 원활하게 이해하고 조화롭게 기여할 수 있습니다. 워드프레스 개발팀 이 워드프레스 코딩 표준을 철저히 준수하도록 하여 장기적으로 고품질, 확장성 및 유지보수성이 뛰어난 솔루션을 보장하세요.
워드프레스 코딩 표준을 고수해야 하는 이유는 무엇일까요?
WordPress 코딩 표준은 프로젝트 및 기여자 전반에 걸쳐 코드 일관성을 보장하는 것을 목표로 합니다. 이는 협업 개발을 위한 가독성과 유지보수성을 향상시키고, WordPress 생태계 전반에서 코드 검토 및 모범 사례 준수를 촉진합니다.
워드프레스 코딩 표준이란 무엇인가요?
워드프레스 코딩 표준은 핵심 코드부터 테마 및 플러그인에 이르기까지 워드프레스 프로젝트 및 커뮤니티 전반에 걸쳐 협업과 일관성을 위한 기준을 제공합니다. 워드프레스 커뮤니티가 워드프레스 지원 포럼 워드프레스 개발자 와 기여자가 따라야 할 모범 사례입니다
자세히 알아보기 : 타사 코드의 영향을 줄이는 방법은 무엇일까요?
코딩 표준의 중요성
코딩 표준은 흔히 발생하는 오류를 방지하고, 코드 가독성을 향상시키며, 수정 작업을 간소화하는 데 도움이 됩니다. 표준을 준수하면 코드가 마치 한 사람이 작성한 것처럼 보여 누구나 쉽게 이해하고 수정할 수 있습니다.
WordPress 코어에 대한 기여
WordPress 코어 개발에 참여하려면 제출하는 코드가 이러한 표준을 준수해야 하므로 이를 숙지하는 것이 매우 중요합니다.
워드프레스 코딩 표준의 구성 요소
이 표준은 CSS, HTML, JavaScript 및 PHP에 대한 언어별 지침뿐만 아니라 WCAG AA에 부합하는 접근성 지침을 다룹니다.
참고: HTML을 워드프레스 테마로 변환하는 방법은 무엇인가요?
타사 라이브러리에 대한 예외
하지만 워드프레스에 통합된 타사 라이브러리는 이러한 기준에서 제외됩니다.
워드프레스 코딩 표준의 예시
워드프레스 코딩 표준을 다양한 예제를 통해 살펴보고 실제 시나리오에서 어떻게 적용되는지 알아보겠습니다. 이러한 예제들은 워드프레스에서 명확하고 유지보수하기 쉬운 코드를 작성하기 위해 권장되는 모범 사례를 보여줍니다.
워드프레스에서 PHP 사용
WordPress는 핵심 프로그래밍 언어로 PHP를
줄 바꿈
WordPress는 줄 바꿈에 대해 자세히 명시하지는 않지만, 대부분의 문장 뒤에 줄 바꿈을 추가하는 것이 일반적입니다. 또한 변수 정의, 조건문, 배열 항목은 각각 다른 줄에 작성하는 것이 좋습니다.
톱니 모양
코드를 더 읽기 쉽게 만들려면 들여쓰기를 사용하여 논리적 구조를 나타내세요. 탭은 각 줄의 시작 부분에 사용하고, 공백은 줄 중간 들여쓰기에 사용합니다.
공간 활용
코드 가독성을 높이려면 줄 끝에 있는 불필요한 공백을 제거하세요. 또한, 탭이나 줄 바꿈 방지 공백으로 채워진 빈 줄도 없애세요. 괄호 안에 공백을 사용하여 가독성을 높이세요. 형변환을 제외하고, 여는 중괄호 뒤와 닫는 중괄호 앞에 줄 바꿈을 추가하세요.
인용 부호
WordPress에서는 문자열 내부에 있는 값을 평가하는 경우가 아니라면 문자열 전체에 작은따옴표(')를 사용하는 것이 일반적인 규칙입니다. 문자열 내부에 따옴표가 필요한 경우에는 작은따옴표와 큰따옴표를 번갈아 사용하세요. 따옴표를 이스케이프 처리하는 것도 가능하지만, 필요한 경우는 드뭅니다.
바지 멜빵
가장 간단한 방법은 항상 중괄호를 사용하는 것입니다. 표준에서는 동일한 구조 내에 여러 줄로 된 블록이 없는 한 줄짜리 "if" 문에는 중괄호를 생략할 수 있도록 허용하지만, 한 줄짜리 반복문에는 허용되지 않습니다. 저는 가독성을 위해 항상 중괄호를 사용하는 것을 선호합니다. 또한, 표준에서는 여는 중괄호를 첫 번째 문장과 같은 줄에 배치하도록 명시하고 있으며, PHP 문서에서는 첫 번째 문장 아래에 배치하는 것과 다릅니다.
SQL 쿼리 서식 지정
SQL 쿼리를 작성할 때는 키워드의 첫 글자를 대문자로 쓰는 것을 잊지 마세요. 복잡한 쿼리는 여러 줄로 나누어 작성해야 합니다. 쿼리를 잘 이해하는 것이 중요하며, 특히 보안 측면은 나중에 자세히 살펴보겠습니다. SQL 인젝션 공격은 WordPress의 보안 취약점 , 해커가 WordPress 사이트의 데이터베이스에 직접 접근하여 조작할 수 있도록 합니다.
명명 규칙
WordPress 코드에서 이름에 CamelCase를 사용하지 마세요. 함수는 소문자로 작성하고 필요한 경우 밑줄을 사용하세요. 클래스 이름은 각 단어의 첫 글자를 대문자로 쓰고 밑줄로 구분해야 합니다.
파일 이름은 모두 소문자로 작성하고 각 부분 사이에는 하이픈(-)을 사용해야 합니다. 파일에 클래스가 하나만 포함된 경우, 클래스 이름 앞에 "class-"를 붙여 파일 이름을 지정하십시오.
함수 인수에는 논리값 대신 문자열 값을 사용하여 가독성을 높이세요. 가장 중요한 규칙은 함수 이름을 설명적으로 만드는 것입니다. 협업 환경에서는 모든 사람이 코드를 쉽게 이해할 수 있도록 노력하세요.
비교문
워드프레스뿐만 아니라 다른 프로그래밍 언어에서도 변수를 비교 연산자의 오른쪽에 두는 것이 좋습니다. 이렇게 하면 등호(=)를 빼먹더라도 오류가 발생하여 참이 아닌 거짓으로 판정됩니다. 삼항 연산자를 사용해도 괜찮지만, 가독성을 높이기 위해 참 여부를 확인하는 것이 좋습니다. 단, `!empty()`를 사용하여 변수가 비어 있지 않은지 확인하는 경우는 예외입니다.
HTML 서식 지정
WordPress 코덱스에 따르면 W3C 유효성 검사기를 사용하여 모든 HTML 코드의 유효성을 검사하는 것이 중요합니다. 하지만 유효한 코드가 항상 좋은 코드를 의미하는 것은 아니며, 둘 사이에는 분명한 연관성이 있습니다.
문서 유형
WordPress는 2000년 W3C에서 권장한 XHTML 1.0 사양을 따릅니다. 하지만 WordPress의 기본 테마인 Twenty Eleven은 HTML5를 사용합니다. HTML5에는 XML 직렬화 기능이 포함되어 있어 "XHTML5" 사용이 가능하므로 실질적인 충돌은 없습니다
따옴표 사용하기
HTML에서 따옴표는 주로 속성과 그 값에 사용됩니다. 작은따옴표 또는 큰따옴표를 선택할 수 있지만, 일관성을 유지하기 위해 한 가지 종류만 사용하는 것이 좋습니다. 개인적으로 저는 PHP에서처럼 일관성을 유지하기 위해 가능한 한 작은따옴표를 사용합니다. 이렇게 하면 따옴표만 보고도 코드 줄에서 특수한 경우를 쉽게 파악할 수 있습니다.
마무리 태그
XHTML 규격은 모든 태그를 닫도록 규정하고 있습니다. 빈 요소(void)는 마지막 꺾쇠괄호(|) 바로 앞에 슬래시(/)를 붙여 닫아야 합니다. 규정대로 슬래시 앞에 공백 하나를 넣어주세요.
톱니 모양
PHP와 동일한 들여쓰기 규칙을 따라 HTML을 작성하세요. 들여쓰기를 통해 논리적인 구조를 만드는 것이 중요합니다. PHP와 HTML을 함께 사용할 때는 일반적인 들여쓰기 흐름에 따라 PHP 블록도 들여쓰기해야 합니다.
CSS 서식 지정
CSS 포맷팅은 웹 콘텐츠의 표현 방식을 구성하고 스타일링하여 다양한 기기와 브라우저에서 일관성과 가독성을 보장하는 작업입니다. 적절하게 포맷팅된 CSS는 웹사이트의 구조와 시각적 매력을 향상시켜 사용자 경험을 개선하는 데 기여합니다.
더 읽어보기: 워드프레스에서 사용하지 않는 CSS를 제거하는 방법은 무엇인가요?
함몰 및 구조
CSS 코드는 대략 다음과 같은 형식을 따라야 합니다. 여러 개의 선택자를 사용하는 경우에도 각 선택자는 별도의 줄에 작성해야 합니다. 또한, 각 속성-값 쌍도 각각 별도의 줄에 작성해야 합니다. 여는 중괄호는 선택자가 있는 줄에, 닫는 중괄호는 여는 선택자와 동일한 들여쓰기로 별도의 줄에 작성합니다.
명명 규칙
소문자만 사용하십시오. 선택자 내의 단어는 하이픈(-)으로 구분하십시오. 선택자에 사람이 읽기 쉬운 이름을 지정하십시오.
속성 및 가치
속성과 값을 작성하는 데에는 몇 가지 규칙이 있습니다. 이전에 정의된 속성을 덮어쓰는 경우를 제외하고, 가능한 한 속성의 약식 버전을 사용하십시오. 색상은 가능한 한 소문자 16진수 코드를 사용하고, 적절한 경우 더 짧은 버전을 사용하십시오. 속성 이름 뒤의 콜론 뒤에는 공백을 삽입하십시오. 글꼴 이름이나 공급업체별 속성처럼 대문자가 필요한 경우를 제외하고 항상 소문자를 사용하십시오. CSS 속성은 알파벳순으로 정렬하되, 공급업체별 속성은 항상 일반 속성보다 앞에 와야 하고, 크기 속성은 함께 그룹화해야 합니다. 너비와 높이를 모두 지정하는 경우 너비를 먼저 작성하십시오.
댓글 달기
CSS는 블록 스타일 주석만 지원하며, 인라인 주석에 대한 별도의 표기법은 없습니다. 짧은 주석은 줄 바꿈 없이 한 줄에 작성하세요. 여러 줄에 걸쳐 있는 주석의 경우, 시작 구문 바로 뒤와 종료 구문 바로 앞에 줄 바꿈을 삽입하세요. 코드의 섹션을 구분하기 위해 주석을 사용하는 경우에는 다음 표기법을 사용하세요
CSS 전처리기를 사용하기
SASS나 Less 같은 CSS 전처리 도구를 사용하면 개발자의 작업이 훨씬 수월해지지만, 단점도 있습니다. 이러한 도구로 생성된 코드는 일반적으로 유효성은 충족하지만, 깔끔하다고는 할 수 없습니다. Less로 자동 생성된 스타일시트보다 직접 (꼼꼼하게) 작성한 스타일시트가 훨씬 읽기 쉽습니다. 어떤 용도로 사용할지는 상황에 따라 다릅니다. 상용 제품을 개발하는 경우, 궁극적인 목표는 유효하고 최적화된 코드를 통해 좋은 사용자 경험을 제공하는 것입니다. 이 경우, 전처리 도구의 결과물을 메인 CSS로 사용하되, 개발자를 위해 원본 파일을 함께 제공하는 것이 좋습니다. 이렇게 하면 CSS가 WordPress 표준을 준수하지는 않더라도, WordPress에서 공식적인 입장을 발표할 때까지 어느 정도 공백을 메울 수 있습니다. 개발 과정을 간소화하고 (더 나은 사용자 경험을 위해) CSS 코딩 표준을 어느 정도 희생하는 것은 괜찮지만, 코드의 유효성을 희생하는 것은 용납할 수 없습니다.
워드프레스 코딩 표준에 기여하는 방법은 무엇일까요?
코딩은 글쓰기와 같습니다. 사람마다 고유한 스타일이 있죠. 당신의 HTML은 저와 다를 수 있고, 제 JavaScript는 눈이 아플 정도로 복잡할 수 있으며, 당신의 CSS는 세상을 바꿀 만큼 아름다울 수도 있습니다. 하지만 WordPress 같은 프로젝트에서 협업할 때는 일관된 코딩 표준을 유지하는 것이 매우 중요합니다.
워드프레스 코딩 표준은 코드베이스에 기여하는 모든 사람이 다른 사람의 작업을 쉽게 읽고 이해하고 기반으로 삼아 발전시킬 수 있도록 보장하기 위해 만들어졌습니다. 이러한 표준을 준수함으로써 다른 기여자들과 동일한 언어를 사용하는 것과 같습니다. 마치 모든 사람이 같은 책을 공동 작업할 때 문법과 서식 규칙을 일관되게 사용하기로 합의하는 것과 같습니다.
워드프레스에 기여하고 싶다면 코딩 표준을 숙지하고 준수하는 것이 중요합니다. 이를 통해 여러분의 개별적인 코딩 스타일이 워드프레스 전체 코드베이스와 완벽하게 조화를 이룰 수 있습니다.
결론
워드프레스 코딩 표준을 준수하는 것은 일관성 있고 협업적인 코드베이스를 유지하는 데 필수적입니다. 워드프레스 커뮤니티에서 개발한 이러한 가이드라인은 전 세계 기여자들을 위한 공통 언어 역할을 합니다. PHP, HTML, CSS, JavaScript 및 접근성 표준을 준수함으로써 개발자는 코드의 일관성, 가독성 및 유지보수성을 보장할 수 있습니다.
워드프레스가 계속 발전함에 따라 이러한 코딩 표준은 전체 커뮤니티를 위한 조화롭고 효율적인 개발 환경을 조성하는 데 중요한 역할을 할 것입니다.
