スペリング

Topics

用語

次のスペリングと用語の規則は、マニュアル、Web ページ、コメント、(スペースやハイフンの使用が必要な場合を除く) 関数名と変数名に適用されます。ただし、ユーザーに表示されるドキュメントの一貫性は、コメントやコードの一貫性よりも重要です。コードリファレンスがコードから自動生成されることも忘れないでください。次の表に、いくつかの単純なケースを示します。

これらを使用するこれらの代わりに注記
アメリカのスペル (特に -ize、-or)イギリスのスペリング (特に -ise、-our) 
「a user」または「a URL」「an user」または「an URL」#31894, #36218
「Ajax」「ajax」または「AJAX」「[Ajax] という名前は、Asynchronous JavaScript + XML の略称であり、Web でできることの根本的な変化を表しています。」(ソース)
「allowed list」、「allowed」、「permitted」「whitelist」「Whitelist」は人種差別的とみなされる可能性があり、またあいまいです。提案された代替案のいずれかを使うか、実際に許可されていることをより明確に記述するように言い換えてみてください。
「Auto-update」または「auto-update」「auto update」または「autoupdate」 
「back end」(名詞)「back-end」または「backend」#34887
「back-end」(形容詞)「back end」または「backend」#34887
「backward compatibility」または「back-compat」「backwards compatibility」または「backwards compat」#36835
「block list」、「disallowed list」、「disallowed」「blacklist」「Blacklist」は人種差別的とみなされる可能性があり、またあいまいです。提案された代替案のいずれかを使うか、実際にブロックされていることをより明確に記述するように言い換えてみてください。
「block editor」または「block-based editor」「Block Editor」または「Gutenberg」新しいエディターを指す場合。
「block theme」「block-based theme」
「Classic Editor」「classic editor」Classic Editor プラグインを指す場合。
「classic editor」「Classic Editor」プラグインではなく、クラシックエディターのインターフェイスを指す場合。
「visual editor」「Visual Editor」ビジュアルエディターインターフェイスを指す場合。
「code editor」「Code Editor」コードエディターインターフェイスを指す場合。
「Customizer」「Theme Customizer」または「customizer」カスタマイザーは、必ずしもテーマ固有のものではありません。#29947
「Dark Mode」「dark mode」または「dark-mode」Twenty Twenty-One #855
「email」「e-mail」#26156
「front end」(名詞)「front-end」または「frontend」#34887
「front-end」(形容詞)「front end」または「frontend」#34887
「full site editing」「Full Site Editing」または「full-site editing」
「homepage」(名詞)「home page」#41828
「installation」(名詞)「install」「インストール」は名詞ではありません。WordPress のインスタンスを指す場合、「インストール」という言葉を使うことが正しいです。#41620
「JavaScript」「Javascript」または「javascript」#30569
「log in」(動詞)「login」「ログイン」は動詞ではありません。ログインする動作を指す場合は、「log in」が正しい表現です。#18294
「meta box」「metabox」 
「oEmbed」「embed」 
「Paragraph block」「Paragraph Block」または「paragraph block」ブロックを参照する場合は、ブロック名を大文字にし、「block」を小文字のままにしてください。github#16118
「retrieve」「retreive」または「retrive」「retreive」や「retrive」は単語ではありません。[2465]
「term meta」「termmeta」 
「WordPress」「WP」CMS、プロジェクト、コミュニティについて言及する場合は、「WordPress」が好まれます。例外として、「WP 5.0」のように特定のバージョンに言及する場合や、商標規則で「WordPress」の使用が禁止されている場合があります。

GCC Coding Convention にインスパイアされています。

Top ↑

キャピタライゼーション

  • Labels
  • Button labels
  • Actions

Top ↑

略語と頭字語

略語や頭字語は、よく知られている場合にのみ使用してください。

Top ↑

引用符

DocBlock のコメントでは、「まっすぐな」シングルクオート (') またはストレートダブルクオート (") を使用します。ユーザーから見える文字列では、「まがった」クオートを使います: 開始シングルクオートは (')、終了シングルクオートは (')、開始ダブルクオートは (")、終了ダブルクオートは (") です。

Butterick’s Practical Typography も参照してください。

原文 / 日本語訳

最終更新日: