理解した!WordPress関数の引数についての私的見方

Feb 09, 2014

理解した!WordPress私的マニュアルの私的見方

前回の記事を書いたときに、WordPressの関数でつまずいたので、記事にしようかと思いました。

たぶん、WordPressを触っていたらWordPress Codex 日本語版WordPress私的マニュアルとか見ることあると思います。

正直、見てもわかりませんよね。

僕もわかりませんでしたがじっと見ているとこれからなというものがありましたので今回はこれかなというものを共有したいと思います。

わからないところ

例えば、「get_post_time」の使い方を知りたいと思います。そこでWordPress私的マニュアルで見てみると下記のように書いてあるんですね。

mixed get_post_time( [ string $d = 'U' [ , bool $gmt = false [ , mixed $post = null [ , bool $translate = false ] ] ] ] )

string…カッコ…$…d……U!!? まったく意味わかりません。
こうなったら他のもっと詳しく解説してくれているところを見にいこうかなと思います。(僕の場合は笑)けど、こういったサイトは辞書みないなものですので、知っておいて損はありません。僕の周りのデキる人は活用してますし。

とりあえず、stringうんたらかんたら書かれているパラメーター部分から見て行きたいと思います。

パラメータ

  • $d
  • $gmt
  • $post
  • $translate

「=」で書かれているのは省略時の値です。また変数($dなど)の前に「string」とか「bool」があると思いますがこれは「型」といって値の書き方の指定するものです。$dなどには値を入れていって今回なら投稿時間を取得するという流れです。

見方(順番編)

さて、ここから本題に入ります。僕はパラメーターの順番のところで躓いてましたのでそこの説明をしたいと思います。
まず注目するべきところはカッコ[]です。カッコ[]は省略できるという印です。
get_post_timeを見るとカッコ[]が入れ子状態になっています。
これは引数を入れる順番を指します。

今回のget_post_timeの順番は$d、$gmt、$post、$translateなので、はじめに$dの値を入れるのはOKです。

ただ、$dを入れずに$gmtを入れることはできません。
$gmtの親カッコ[]に$dがありますので$dの指定は必須となります。

わかりましたか?もし$gmtのところまで指定してい場合は$dもちゃんと指定しましょう。

同様に$postを指定したい場合は、$d、$gmtの指定は必須となります。

簡単ですね。これでこの関数はどういった値を入れたらいいのだろうということが少しは解消できるかと思いますので覚えておいて損はないと思います。