WordPressのコーディング標準は、プラットフォームの広大なコードベース全体にわたる一貫性と保守性を確保します。これらの綿密に作成されたガイドラインは、 WordPress開発のヒント、明確さと効率性を高めます。
WordPressメンテナンスに従うことで、世界中の開発者が調和のとれた貢献を行い、お互いの作業をシームレスに理解することができます。WordPress開発チームにWordPressコーディング標準を徹底して遵守させることで、高品質でスケーラブル、かつメンテナンス性に優れたソリューションを長期的に提供できます。
WordPress のコーディング標準に固執する理由は何ですか?
WordPressコーディング標準は、プロジェクト間および貢献者間でコードの一貫性を確保することを目的としています。共同開発における可読性と保守性を向上させ、WordPressエコシステム全体におけるコードレビューとベストプラクティスの遵守を促進します。.
WordPress コーディング標準とは何ですか?
WordPressコーディング規約は、コアコードからテーマやプラグインに至るまで、WordPressプロジェクトとコミュニティ全体におけるコラボレーションと一貫性の基準を提供します。WordPressコミュニティがWordPressサポートフォーラム WordPress開発者と貢献者が従うべきベストプラクティスとして機能します
コーディング標準の重要性
コーディング規約は、よくあるエラーを防ぎ、コードの可読性を向上させ、変更を簡素化するのに役立ちます。コーディング規約を遵守することで、コードはまるで一人の人間によって書かれたかのように見え、誰でも理解し、変更しやすくなります。.
WordPressコアへの貢献
WordPress コアに貢献する場合、提出されたコードは準拠する必要があるため、これらの標準をよく理解しておくことが重要です。.
WordPressコーディング標準の構成要素
この標準には、CSS、HTML、JavaScript、PHP の言語固有のガイドラインと、WCAG AA に準拠したアクセシビリティ ガイドラインが含まれています。.
また読む: HTML を WordPress テーマに変換するにはどうすればいいですか?
サードパーティライブラリの例外
ただし、WordPress に組み込まれたサードパーティ ライブラリはこれらの標準の対象外です。.
WordPressコーディング標準の例
WordPressコーディング規約を様々な例を通して検証し、実際のシナリオにおける適用方法を理解しましょう。これらの例は、WordPressで明確で保守性の高いコードを書くための推奨ベストプラクティスを示しています。.
WordPressのPHP
WordPressは、PHPのアップデートを。WordPressでコードのメンテナンス性と一貫性を保つには、PHPコーディング標準の遵守が不可欠です。PHPコーディング標準が重要な理由は次のとおりです。
改行
WordPressでは改行についてあまり規定されていませんが、ほとんどの文の後に改行を追加するのが一般的です。また、変数定義、ifブロック、配列要素は別の行に配置することをお勧めします。.
インデント
コードを読みやすくするには、インデントを使って論理構造を示しましょう。行頭にはタブを使用し、行中のインデントにはスペースを使用します。.
スペースの使用
行末の余分なスペースを削除して、コードを読みやすくしましょう。また、タブまたはノーブレークスペースを使用して空行を削除してください。括弧内にスペースを入れることで、コードがわかりやすくなります。型変換を除き、開き括弧の後と閉じ括弧の前に改行を入れてください。.
引用
WordPressでは、文字列内で何かを評価する場合を除き、文字列にはシングルクォートを使用するのが基本ルールです。文字列内で引用符が必要な場合は、シングルクォートとダブルクォートを交互に使用してください。引用符をエスケープすることは可能ですが、必要なことはほとんどありません。.
ブレース
最も簡単な方法は、常に中括弧を使用することです。標準では、同一構造内に複数行のブロックを含まない単一行の「if」文では中括弧を省略できますが、単一行のループでは省略できません。私は明瞭性のために常に中括弧を使用することを推奨します。さらに、標準では開き中括弧を最初の文と同じ行に配置するように指定されており、PHPドキュメントのように文の下に置く必要はありません。.
SQLクエリのフォーマット
SQLクエリを書く際は、キーワードを大文字で始めることを忘れないでください。複雑なクエリは複数行に分割する必要があります。クエリ、特にセキュリティ面についてよく理解することが重要です。セキュリティ面については後ほど説明します。SQLインジェクション攻撃はWordPressのセキュリティ上のミスが、ハッカーがWordPressサイトのデータベースに直接アクセスして操作できるようになります。
命名規則
WordPressコードでは、名前にキャメルケース（CamelCase）を使用しないでください。関数名は小文字を使用し、必要に応じてアンダースコアを使用してください。クラス名は、各単語の最初の文字を大文字にし、アンダースコアで区切ってください。.
ファイル名はすべて小文字で、各部分をハイフンで区切ってください。ファイルにクラスが1つだけ含まれている場合は、そのクラス名に「class-」を先頭に付けて名前を付けてください。.
関数の引数には、ブール値ではなく文字列値を使用することで、より分かりやすくなります。最も重要なルールは、説明的な名前を付けることです。共同作業の環境では、誰もがコードを理解できるように努めましょう。.
比較文
WordPressに限らず、比較の右側に変数を置くことをお勧めします。こうすることで、等号を忘れても真と評価されるのではなくエラーが発生します。三項演算子の使用は可能ですが、より明確にするために真偽値を確認することをお勧めします。例外は、!empty() を使用して空でない変数を確認する場合です。.
HTMLのフォーマット
WordPress Codexによると、W3C Validatorを使用してすべてのHTMLコードを検証することが重要です。ただし、有効なコードが必ずしも優れたコードであるとは限りません。ただし、両者の間には明確な関連性があります。.
文書型
WordPressは、2000年にW3Cが勧告したXHTML 1.0仕様に準拠しています。それにもかかわらず、WordPressのデフォルトテーマであるTwenty ElevenはHTML5を使用しています。HTML5にはXMLシリアル化が含まれており、「XHTML5」の使用が可能であるため、実質的な競合はありません。
引用符の使用
HTMLでは、引用符は主に属性とその値に使用されます。一重引用符と二重引用符のどちらでも使用できますが、一貫してどちらか一方を使用してください。個人的には、一貫性を保つために、PHPと同様に、可能な限り一重引用符を使用しています。これにより、引用符を見るだけで、行内の特殊なケースをすぐに見つけることができます。.
終了タグ
XHTML仕様では、すべてのタグを閉じることが義務付けられています。空要素は、最後の山括弧の直前にスラッシュを付けて閉じる必要があります。指定されているように、スラッシュの前には必ずスペースを1つ入れてください。.
インデント
HTMLのインデントはPHPと同じルールに従ってください。論理的な構造になるようにインデントを設定してください。PHPとHTMLを組み合わせる場合は、通常のインデントの流れに従ってPHPブロックをインデントしてください。.
CSSのフォーマット
CSSのフォーマットは、Webコンテンツの表示を整理し、スタイルを設定することで、さまざまなデバイスやブラウザ間で一貫性と読みやすさを確保します。適切にフォーマットされたCSSは、Webサイトの構造と視覚的な魅力を高め、ユーザーエクスペリエンスの向上に貢献します。.
続きを読む: WordPress で未使用の CSS を削除するにはどうすればいいですか?
インデントと構造
CSS は、大まかに以下のスキーマに従う必要があります。ルールセットに複数のセレクターを列挙する場合でも、各セレクターは別々の行に記述します。また、各プロパティと値のペアもそれぞれ別の行に記述します。開き括弧はセレクターの行に記述し、閉じ括弧は開きセレクターと同じインデントで別の行に記述します。.
命名規則
小文字のみを使用してください。セレクター内の単語はハイフンで区切ります。セレクターには人間が読める名前を付けてください。.
プロパティと値
プロパティと値の記述には、いくつかのルールがあります。既に定義されているプロパティを上書きする場合を除き、可能な限りプロパティの短縮形を使用してください。色には、可能な限り小文字の16進コードを使用してください。必要に応じて、短縮形を使用してください。プロパティの後にコロン（:）の後にはスペースを挿入してください。フォント名やベンダー固有のプロパティなど、大文字が必要な場合を除き、常に小文字を使用してください。CSSプロパティはアルファベット順に並べますが、ベンダー固有のプロパティは常に一般的なプロパティの前に記述し、寸法プロパティはグループ化する必要があります。幅と高さが指定されている場合は、幅を先に記述してください。.
コメント
CSS はブロックスタイルのコメントのみをサポートしています。インラインコメント用の別記法はありません。短いコメントは 1 行に記述し、改行は入れないでください。複数行にまたがるコメントの場合は、開始構文の直後と終了構文の直前に改行を挿入してください。コメントを使用してコードのセクションを区切る場合は、次の記法を使用してください。
CSSプリプロセッサの使用
SASS や Less などの CSS プリプロセッサを使用すると、開発者の作業は大幅に楽になりますが、欠点がないわけではありません。これらのツールで生成されるコードは通常は有効ですが、非常にクリーンであるとは言えません。手動で (そして慎重に) 生成されたスタイル シートは、Less で自動的に生成されたものよりはるかに可読性が高くなります。これは、何をしているかによって異なります。製品が商用の場合、最終目標は有効で最適化されたコードによる、優れたユーザー エクスペリエンスです。この場合は、プリプロセッサの出力をメインの CSS として使用しますが、開発者向けに元のファイルを含めます。CSS は WordPress の標準に準拠しませんが、WordPress が公式の立場をとるまでは、元のファイルを含めることでギャップをある程度埋めることができます。開発プロセスを簡素化するために (より良いユーザー エクスペリエンスを目的として) CSS コーディング標準を犠牲にすることは問題ありません。コードの有効性を犠牲にすることは問題です。.
WordPress コーディング標準にどのように貢献できますか?
コードは文章を書くのと同じで、人それぞれ独自のスタイルを持っています。あなたのHTMLは私のとは違って見えるかもしれませんし、私のJavaScriptはあなたの目を血走らせるかもしれませんし、あなたのCSSは人生を変えるほど美しいかもしれません。しかし、WordPressのようなプロジェクトで共同作業を行う場合、一貫したコーディング規約を持つことは非常に重要です。.
WordPressのコーディング規約は、コードベースに貢献するすべての人が、他の人の成果物を簡単に読み、理解し、その上で発展させることができるようにするために存在します。これらの規約に従うことで、あなたは本質的に他の貢献者と同じ言語を話していることになります。これは、全員が同じ本をシームレスに共同作業できるように、一貫した文法と書式設定のルールを使用することに同意するようなものです。.
WordPressに貢献したいなら、コーディング規約を理解し、それに従うことが重要です。そうすることで、個々のコーディングスタイルをWordPressのコードベース全体に完璧に融合させることができます。.
結論
WordPressコーディング規約を遵守することは、統一性と協調性に優れたコードベースを維持するために不可欠です。WordPressコミュニティによって策定されたこれらのガイドラインは、世界中の貢献者にとって共通言語として機能します。PHP、HTML、CSS、JavaScript、そしてアクセシビリティの標準に従うことで、開発者はコードの一貫性、可読性、そして保守性を確保できます。.
WordPress が進化し続けるにつれて、これらのコーディング標準は、コミュニティ全体にとって調和のとれた効率的な開発環境を育む上で重要な役割を果たすことになります。.
