SlideShare a Scribd company logo
Akira Tachibana / 立花 明(@atachibana)
Lightning Talk:
WordPress Coding Standards At a Glance
基本の WordPress コーディング規約
自己紹介
• 立花 明
• IT 関連会社勤務 (非 WordPress)
• 好きなこと: 何かを集めること、並べること
– 人生のモットー: これ以上集め始めない、並べ始めない
• WordPress Document Team Member
– Codex / HelpHub / Release Notes etc.
• 2016年夏、WordPress コーディング規約を翻訳し
ました。LT はその抜粋です。
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
LISTEN
Standards / 規約
• WordPress オープンソースプロジェクトおよびコミュニ
ティでのコラボレーションやレビューのベースライン
• 適用範囲はコア、テーマ、プラグイン
• 統一することで、ミスの削減、コードやドキュメントの
可読性の向上、変更の容易化
• 注意! 規約のためだけのリファクタリングは禁止
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
OBEY
Quote / 引用符
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
Single ( ‘ ) Double ( “ )
PHP ✔ ✔
JavaScript ✔
HTML ✔ ✔
CSS ✔
PHP: $a = ‘hello’;
HTML: <input type="text" />
THINK
Indenting / インデント
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
if ( condition ) {
action();
}
Tab !
Not Space
TAB
Brace / 波かっこ
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
if ( condition1 ) {
action1();
} elseif ( condition2 && condition3 ) {
action2();
action3();
} else {
defaultaction();
}
Always
ALWAYS
Space / 空白文字
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
function func( $p1 = ‘x’, $p2 = ‘y' ) {
...
foreach ( (array) $foo as $bar ) { ...
$x = $foo[ $bar ];
$x = $foo['bar'];
$x = $foo[0];
No Space!
(Almost)
SPACE
Naming Convention / 命名規則
• PHP
–variable var_x (× camelCase)
–class My_Hello
–constant WINDOW_SIZE
–PHP file my-plugin-name.php
–class file class-my-hello.php
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
NO camelCase
Naming Convention / 命名規則
• JavaScript
–variable camelCase
–class camelCase
• CSS
–separator #comment-form
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
camelCase
Yoda Conditions / ヨーダ条件式
• If you miss typed “==“ as “=“, then
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
if ( true == $the_force ) {
$victorious = you_will( $be );
}
if ( true = $the_force ) => Error
if ( $the_force = true ) => Run & Debug!?
May The
Force Be
With You
Third-person singular / 三人称単数
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
/**
* Displays simple message for a post.
*
* This is detail description about
* below function...
*
* @global type $var_name Description.
*
* @param type $x Description.
* @param type $y Optional. Description.
* @return type Description.
*/
S
Reference / 参照
• Core Contributor Handbook
–WordPress Coding Standards
–WordPress Inline Documentation
Standards
• Codex 日本語版
–WordPress コーディング規約
–WordPress インラインドキュメント規約
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
This LT
was GREAT!
Thank You / ありがとうございました
2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards

More Related Content

Similar to 基本の WordPress コーディング規約 / WordCamp Tokyo 2016 LT

Sass/Compass講習会
Sass/Compass講習会Sass/Compass講習会
Sass/Compass講習会
Beeworks
 
WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)
WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)
WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)
Takashi Uemura
 
WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016
WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016
WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016
Takami Kazuya
 
テーマ作成のアプローチ
テーマ作成のアプローチテーマ作成のアプローチ
テーマ作成のアプローチSeto Takahiro
 
実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...
実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...
実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...
Akira Tachibana
 
JAWS-UG Santo 2014-07-05 Drupal on PaaS Cloud
JAWS-UG Santo 2014-07-05 Drupal on PaaS CloudJAWS-UG Santo 2014-07-05 Drupal on PaaS Cloud
JAWS-UG Santo 2014-07-05 Drupal on PaaS Cloud
ANNAI_LLC
 
20170809 AWS code series
20170809 AWS code series20170809 AWS code series
20170809 AWS code series
Atsushi Fukui
 
CloudFormation Getting Started with YAML
CloudFormation Getting Started with YAMLCloudFormation Getting Started with YAML
CloudFormation Getting Started with YAML
Yukitaka Ohmura
 
Sparkにプルリク投げてみた
Sparkにプルリク投げてみたSparkにプルリク投げてみた
Sparkにプルリク投げてみた
Noritaka Sekiyama
 
頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜
頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜
頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜
宗 大栗
 
Azure でサーバーレス、 Infrastructure as Code どうしてますか?
Azure でサーバーレス、 Infrastructure as Code どうしてますか?Azure でサーバーレス、 Infrastructure as Code どうしてますか?
Azure でサーバーレス、 Infrastructure as Code どうしてますか?
Kazumi IWANAGA
 
CMSMix Sapporo vol.3 (Drupal の回)
CMSMix Sapporo vol.3 (Drupal の回)CMSMix Sapporo vol.3 (Drupal の回)
CMSMix Sapporo vol.3 (Drupal の回)
Kenji Shirane
 
日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜
日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜
日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜
Kazue Igarashi
 
WordPress + JSON-LDで構造化するこれからのマークアップ
WordPress + JSON-LDで構造化するこれからのマークアップWordPress + JSON-LDで構造化するこれからのマークアップ
WordPress + JSON-LDで構造化するこれからのマークアップ
Takami Kazuya
 
Rake
RakeRake
Web Site Optimization for Beginners
Web Site Optimization for BeginnersWeb Site Optimization for Beginners
Web Site Optimization for Beginners
masaaki komori
 
Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪
Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪
Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪
真吾 吉田
 
[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24
[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24
[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24
Kazuhiro Sera
 
WordPress JSON REST API 〜さらばPHP、さらばWordPressテーマ
WordPress JSON REST API 〜さらばPHP、さらばWordPressテーマWordPress JSON REST API 〜さらばPHP、さらばWordPressテーマ
WordPress JSON REST API 〜さらばPHP、さらばWordPressテーマ
Kazue Igarashi
 
WordPress 高速化 Pro Tips: フロントエンドの最適化
WordPress 高速化 Pro Tips: フロントエンドの最適化WordPress 高速化 Pro Tips: フロントエンドの最適化
WordPress 高速化 Pro Tips: フロントエンドの最適化
masaaki komori
 

Similar to 基本の WordPress コーディング規約 / WordCamp Tokyo 2016 LT (20)

Sass/Compass講習会
Sass/Compass講習会Sass/Compass講習会
Sass/Compass講習会
 
WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)
WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)
WordPressのオススメスライドとか記事とか集めました。(2012.10.13 WordBench神戸)
 
WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016
WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016
WordPress+JSON-LDで構造化するこれからのマークアップ WordFes Nagoya 2016
 
テーマ作成のアプローチ
テーマ作成のアプローチテーマ作成のアプローチ
テーマ作成のアプローチ
 
実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...
実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...
実録 WordPress Twenty Sixteen のカスタマイズ | WordBench東京 2月勉強会 「みんなのテーマ開発」〜自分の好きな作り方...
 
JAWS-UG Santo 2014-07-05 Drupal on PaaS Cloud
JAWS-UG Santo 2014-07-05 Drupal on PaaS CloudJAWS-UG Santo 2014-07-05 Drupal on PaaS Cloud
JAWS-UG Santo 2014-07-05 Drupal on PaaS Cloud
 
20170809 AWS code series
20170809 AWS code series20170809 AWS code series
20170809 AWS code series
 
CloudFormation Getting Started with YAML
CloudFormation Getting Started with YAMLCloudFormation Getting Started with YAML
CloudFormation Getting Started with YAML
 
Sparkにプルリク投げてみた
Sparkにプルリク投げてみたSparkにプルリク投げてみた
Sparkにプルリク投げてみた
 
頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜
頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜
頑張らないクラウド最適化 〜クラウドネイティブだけでないAWS活用〜
 
Azure でサーバーレス、 Infrastructure as Code どうしてますか?
Azure でサーバーレス、 Infrastructure as Code どうしてますか?Azure でサーバーレス、 Infrastructure as Code どうしてますか?
Azure でサーバーレス、 Infrastructure as Code どうしてますか?
 
CMSMix Sapporo vol.3 (Drupal の回)
CMSMix Sapporo vol.3 (Drupal の回)CMSMix Sapporo vol.3 (Drupal の回)
CMSMix Sapporo vol.3 (Drupal の回)
 
日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜
日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜
日本語フォーラムで回答してみよう!~誰でも出来るWordPressへの貢献〜
 
WordPress + JSON-LDで構造化するこれからのマークアップ
WordPress + JSON-LDで構造化するこれからのマークアップWordPress + JSON-LDで構造化するこれからのマークアップ
WordPress + JSON-LDで構造化するこれからのマークアップ
 
Rake
RakeRake
Rake
 
Web Site Optimization for Beginners
Web Site Optimization for BeginnersWeb Site Optimization for Beginners
Web Site Optimization for Beginners
 
Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪
Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪
Anchors Aweigh!! - re:Invent報告@re:Port 2016 大阪
 
[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24
[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24
[Japanese] Skinny Framework で始める Scala #jjug_ccc #ccc_r24
 
WordPress JSON REST API 〜さらばPHP、さらばWordPressテーマ
WordPress JSON REST API 〜さらばPHP、さらばWordPressテーマWordPress JSON REST API 〜さらばPHP、さらばWordPressテーマ
WordPress JSON REST API 〜さらばPHP、さらばWordPressテーマ
 
WordPress 高速化 Pro Tips: フロントエンドの最適化
WordPress 高速化 Pro Tips: フロントエンドの最適化WordPress 高速化 Pro Tips: フロントエンドの最適化
WordPress 高速化 Pro Tips: フロントエンドの最適化
 

基本の WordPress コーディング規約 / WordCamp Tokyo 2016 LT

  • 1. Akira Tachibana / 立花 明(@atachibana) Lightning Talk: WordPress Coding Standards At a Glance 基本の WordPress コーディング規約
  • 2.
  • 3. 自己紹介 • 立花 明 • IT 関連会社勤務 (非 WordPress) • 好きなこと: 何かを集めること、並べること – 人生のモットー: これ以上集め始めない、並べ始めない • WordPress Document Team Member – Codex / HelpHub / Release Notes etc. • 2016年夏、WordPress コーディング規約を翻訳し ました。LT はその抜粋です。 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
  • 5. Standards / 規約 • WordPress オープンソースプロジェクトおよびコミュニ ティでのコラボレーションやレビューのベースライン • 適用範囲はコア、テーマ、プラグイン • 統一することで、ミスの削減、コードやドキュメントの 可読性の向上、変更の容易化 • 注意! 規約のためだけのリファクタリングは禁止 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
  • 7. Quote / 引用符 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards Single ( ‘ ) Double ( “ ) PHP ✔ ✔ JavaScript ✔ HTML ✔ ✔ CSS ✔ PHP: $a = ‘hello’; HTML: <input type="text" />
  • 9. Indenting / インデント 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards if ( condition ) { action(); } Tab ! Not Space
  • 10. TAB
  • 11. Brace / 波かっこ 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards if ( condition1 ) { action1(); } elseif ( condition2 && condition3 ) { action2(); action3(); } else { defaultaction(); } Always
  • 13. Space / 空白文字 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards function func( $p1 = ‘x’, $p2 = ‘y' ) { ... foreach ( (array) $foo as $bar ) { ... $x = $foo[ $bar ]; $x = $foo['bar']; $x = $foo[0]; No Space!
  • 15. Naming Convention / 命名規則 • PHP –variable var_x (× camelCase) –class My_Hello –constant WINDOW_SIZE –PHP file my-plugin-name.php –class file class-my-hello.php 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
  • 17. Naming Convention / 命名規則 • JavaScript –variable camelCase –class camelCase • CSS –separator #comment-form 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
  • 19. Yoda Conditions / ヨーダ条件式 • If you miss typed “==“ as “=“, then 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards if ( true == $the_force ) { $victorious = you_will( $be ); } if ( true = $the_force ) => Error if ( $the_force = true ) => Run & Debug!?
  • 21. Third-person singular / 三人称単数 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards /** * Displays simple message for a post. * * This is detail description about * below function... * * @global type $var_name Description. * * @param type $x Description. * @param type $y Optional. Description. * @return type Description. */
  • 22. S
  • 23. Reference / 参照 • Core Contributor Handbook –WordPress Coding Standards –WordPress Inline Documentation Standards • Codex 日本語版 –WordPress コーディング規約 –WordPress インラインドキュメント規約 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
  • 25. Thank You / ありがとうございました 2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards