【WordPress】関数の使い方の基本

WordPressでは、関数を必ず使います。

そのため関数をいかに理解して柔軟に使いこなせるかが、WordPressのカスタマイズレベルにも繋がります。

WordPressは使用しているサイトも多いため、何かわからないことがあるとGoogleで調べれば、大抵のお悩みは解決します。

関数も同じです。

しかし調べた関数をWordPressにコピペするだけでは、思いもよらぬ依頼やトラブルに対応することができなくなります。

関数の概念をしっかり理解し、使いこなせるようになる必要があります。

この記事では、関数の概念と使い方の基本について解説をしていきます。

ツクルカツクルカ

関数の概念への理解がWordPressへの理解にも影響する!

WordPressの関数とは?

関数を用いるとデータを呼び出して表示をしたり、取得したり、ページ情報をチェックしたりすることができます。

たとえば、

  • 投稿の日付を表示したい場合・・・the_date()
  • 投稿のサムネイルを取得したい場合・・・get_the_postthumbnail()
  • ページ情報があるかどうかチェックする場合・・・is_front_page()

などができます。

関数の具体的例

<ul>
<?php if(have_posts()): while(have_posts()): the_post();?>
<li>
<a href="<?php the_permalink();?>">
<div><?php the_title();?></div>
</a>
</li>
<?php endwhile;?>
<?php endif;?>
</ul>

上記の例では、「the_permalink();」と「the_title();」が関数にあたり、関数を記述する際はPHPで囲んで使います。

ちなみに上記の例では、the_permalink();で記事のURLを出力し、the_title();で記事のタイトルを出力します。

関数の使い方

WordPressの関数の使い方を理解するためには、パラメータの使い方を理解する必要があります。

関数で表示、取得する値(データ)の詳細を指定することがあるからです。

パラメータの使用例

<?php the_title($before,$after,$echo); ?>

the_titleが関数で、()の中の値がパラメータとなります。

the_title();の関数には、パラメータが3つあるのが特徴で、それぞれ以下のような順序で記述を行います。

  • $before・・・タイトルの前に置くテキスト
  • $after・・・タイトルの後に置くテキスト
  • $echo・・・タイトルを表示or取得

パラメータの具体例

<ul>
<?php if(have_posts()):;while(have_posts()):the_post();?>
<li>
<a href="<?php the_permalink();?>">
<div><?php the_title('<h3>','</h3>');?></div></a>
</li>
<?php endwhile;?>
<?php endif;?>
</ul>

上記の例では、タイトルの前後をh3タグで囲んでいます。

こうすることで表示される一覧のタイトルをh3タグで表記することができるようになります。

ちなみに、パラメータには文字列を入れることもできれば、何も入れないこともあります。パラメータに値を入れなければ、初期値となるので詳細な指定をしたい場合は、パラメータに値を入れて対応しましょう。

パラメータに配列を使う場合

パラメータは文字列やタグだけでなく、配列を代入することもできます。

<?php $categories = get_categories($args); ?>
<?php $args = array(
'orderby' => 'name',
'order' => 'desc',
'exclude' => '2'
);
?>

get_categories関数に変数argsを入れています。

その下では変数argsに配列arrayが代入されており、変数argsはget_categoriesのパラメータに配列として代入されていることになります。

配列を使うことで、get_categoriesに3つの値が渡すことができます。

パラメータのない関数

パラメータは3つあるものもあれば、1つしかないものもあり、またパラメータのない関数もあります。

<?php the_posts(); ?>

ループの中でしか使えない関数

使用範囲が制限されている関数もあります。

  • the_permalink
  • the_title

これらの関数はループ(have_postsで回している繰り返し構文)の中でしか使えない関数です。

関数における表示と取得の違い

関数には、実際のウェブサイトに表示できる関数とプログラムを処理するためのデータとして取得するための関数があります。

表示で使う関数例

the_permalinkや
the_title

これらの関数は、PHPタグで囲ってウェブサイトのソースに貼り付けるだけで、ウェブサイトに内容を表示することができます。

取得で使う関数

get_the_title();
get_the_date();
get_categories();

表示と取得の違いは、getだけでは表示に至らないことです。

getした値を変数に渡し、表示で使う関数のようにPHPで囲んでウェブサイトのソースに貼り付ける必要があります。

現在のページ情報をチェックする関数

is_front_pageなどのようにページの情報をチェックする関数もあります。

条件分岐タグとも呼ばれ、チェックした関数があれば、処理を返します。

is_single();・・・記事ページかどうかをチェック
is_archive();・・・記事一覧ページかどうかをチェック
has_post_thumbnail();・・・投稿にアイキャッチ画像があるかをチェック

などがあります。

まとめ

  • WordPressにおけて関数の理解は大切
  • 関数を使いこなせれば、カスタマイズできる幅が広がる
  • 関数を使って、データを表示、取得、チェックしたりできる
  • 関数にパラメータを入れることで、詳細な情報を表示、取得できる
  • パラメータには複数の種類がある
  • 関数における表示と取得の違いを理解しておく