データベースでテーブルにつける名称について「アンダースコア」をつける理由とは？

Question

WordPressで開発中に、メタデータへの名前の付け方で疑問に感じたことを質問させてください。

多くのプラグインなどではキーに「_name」のように、「アンダースコア」が入っています。

これはなぜでしょうか？

メリットデメリットがございましたらご指南頂けますと幸いです。

よろしくお願い致します。

Answer 1

「カスタムフィールドのフィールド名の先頭にアンダースコアがある場合があるのはなぜか？」というご質問だと理解しました。もしこの理解が正しければ、以下それへの回答です。

キーの先頭にアンダースコアを付けるのはそのフィールドを private 扱いにするためのルールで、そうしておくと編集ページに表示されない、といったところではないでしょうか。メリットは「管理画面にログインしたユーザが値を編集してしまうのを防ぐことができる」ですかね。

以下 Codex からの引用です。

If you are a plugin or theme developer and you are planning to use custom fields to store parameters related to your plugin or template, it is interesting to note that WordPress will not show custom fields which have keys starting with an "_" (underscore) in the custom fields list on the post edit screen or when using the the_meta() template function. This can be for example used to show these custom fields in an unusual way by using the add_meta_box() function.

• Function Reference/add post meta | wordpress.org

以下その他参考ページです。

• Underscores in custom fields - WordPress Development Stack Exchange
• custom field - Difference between meta keys with _ and without _ - WordPress Development Stack Exchange

Comments

[dakarakarad]

とても納得のいくお答えでした。ありがとうございました。

Answer 2

一般的なRDBMSではテーブル名に使える文字には制限があり、アルファベット、数字、アンダーバー程度である事が多いです。
となると、単語を連結させる文字としては「_」が使われるのが当然ですよね。
CustomerAddressとか、(アッパー)キャメルケースで書くこともできますが、テーブル名に大文字と小文字を混在させるとミドルウェアのバージョンアップ時等に問題になることもありますので、避けた方が面倒がなくていい。
WordPressに限らず、他の一般的なテーブル命名規則はスネークケース仕様になっていると思いますよ。

Comments

[dakarakarad]

ありがとうございます。難しいですね。たとえば投稿に日付のメタデータを自分で付与するとして、「meta_date」よりも「_date」の方が一般的なのでしょうか？

[kunai]

Wordpressにはあまり詳しくないのでピンポイントな回答は出来ませんが。
仮に「post(投稿)」というテーブルがある場合に、それに関連した「投稿日時」のテーブルを作りたいと考えるのであれば、私でしたら「投稿に付随する関連情報」として「post_meta」とか「post_extra」とかそういう感じの名前にしますかね。
その上で、カラム名として「post_date」とかつける感じで。

ただ、Wordpress上の命名規則があるのであれば当然それに従ってください。

また、「_」はあくまで単語の連結に使用するものですので、文頭に「_」がついた「_date」等のテーブル名は意味がありません。
調べてませんが、DBMSによっては先頭文字に「_」を使うことを禁止しているものもあるんじゃないかなと思えます。

[dakarakarad]

なるほど、ありがとうございます。gh640様のご回答によれば、どうやらWordpress上の命名規則とやらがあるようでした。

Answer 3

WordPress詳しいわけではないですが、単純にWordPressの命名規則のようなものではないでしょうか。
中には予約語との衝突を避ける役割だったりプレフィックス(接頭辞。これも予約語との衝突避けたり「このシステムの」という区別をつけるために使われます)だったり、あると思います。

追記
WordPressの予約語との衝突を避けるためかもしれませんね。

Comments

[dakarakarad]

なるほど、ありがとうございます。自分で開発するのであれば、「my_」をつけておけば良さそうでしょうか。

[m.ts10806]

それは仕様なので、WordPress側の推奨する仕様とあわせて決めてください。
もし問題が出てもそこは変更すればいいだけの話です(もちろん公開するのであればそれなりに検証してくださいね)

[dakarakarad]

使い方の多様性に合わせての「_xx」であればそうすでべきなのでしょうけど、どのような多様性に起因してのものなのか、悩ましいところです。引き続き調べてみます。ありがとうございました。