WordPress関数初心者ガイド｜2.よく使われるWordPress関数

関数

Word Press関数とは？

テーマに特定の機能を追加する際には、PHPでのプログラミングが求められます。

WordPress関数やその使用方法を理解しておくと、非常に役立ちます。

この記事を参考にしながら、WordPressテーマの自作やカスタマイズに挑戦してみてください。

2.1 投稿に関する関数

the_title()

the_title()は、WordPressにおいて投稿やページのタイトルを表示するための関数です。この関数は主にループ内で使用され、現在の投稿のタイトルをHTML形式で出力します。

引数の種類

the_title()には、以下の2つの引数を指定できます。

  1. $before: タイトルの前に表示するテキストやHTMLを指定します。
  2. $after: タイトルの後に表示するテキストやHTMLを指定します。

これにより、タイトルをカスタマイズして表示することが可能です。

使用方法

the_title()は特に引数を取らない場合でも使用できますが、引数を指定することでタイトルの見た目を調整できます。通常、ループ内で呼び出し、タイトルを表示するのが一般的です。

サンプルコード

以下は、the_title()を使用した基本的なサンプルコードです。このコードは、WordPressのループ内で投稿のタイトルを表示します。

<?php
if ( have_posts() ) :
    while ( have_posts() ) : the_post(); ?>
        <h2>
            <?php the_title('タイトル: ', ' - 詳細'); ?>  <!-- カスタムテキストを追加 -->
        </h2>
        <div>
            <?php the_content(); ?>  <!-- 投稿の内容を表示 -->
        </div>
    <?php endwhile;
else :
    echo '<p>投稿が見つかりませんでした。</p>';
endif;
?>

引数の使用例

上記のコードでは、the_title()に引数を指定しています。'タイトル: 'がタイトルの前に、' - 詳細'がタイトルの後に追加されます。これにより、ユーザーにとってわかりやすい形式でタイトルを表示できます。

まとめ

このように、the_title()を使用することで、投稿やページのタイトルを簡単に表示し、カスタマイズすることができます。特にテーマ開発やカスタマイズの際に非常に便利な関数です。

the_content()

the_content()は、WordPressにおいて投稿やページの本文を表示するための関数です。この関数は主にループ内で使用され、現在の投稿の内容をHTML形式で出力します。

引数の種類

the_content()は、以下の引数を取ることができます。

  1. $more_link_text: 投稿が「続きを読む」などで分割されている場合、続きのリンクに表示するテキストを指定します。
  2. $strip_teaser: この引数をtrueに設定すると、投稿のティーザー部分を削除し、全文を表示します。デフォルトはfalseです。

使用方法

the_content()は、通常、WordPressのループ内で呼び出され、投稿の内容を表示するために使用されます。特に、投稿が複数ページにわたる場合や、特定のテキストを表示したい場合に便利です。

サンプルコード

以下は、the_content()を使用した基本的なサンプルコードです。このコードは、WordPressのループ内で投稿の内容を表示します。

<?php
if ( have_posts() ) :
    while ( have_posts() ) : the_post(); ?>
        <h2><?php the_title(); ?></h2>  <!-- 投稿のタイトルを表示 -->
        <div>
            <?php the_content('続きを読む...'); ?>  <!-- 投稿の内容を表示 -->
        </div>
    <?php endwhile;
else :
    echo '<p>投稿が見つかりませんでした。</p>';
endif;
?>

引数の使用例

上記のコードでは、the_content('続きを読む...')を使用しています。これにより、投稿が分割されている場合、リンクテキストとして「続きを読む…」が表示されます。このリンクをクリックすると、投稿の残りの部分が表示されます。

まとめ

このように、the_content()を使用することで、投稿やページの内容を簡単に表示し、カスタマイズすることができます。特に、テーマ開発やカスタマイズの際に非常に役立つ関数です。投稿の内容を柔軟に扱うために、the_content()は欠かせない要素です。

get_posts()

get_posts()は、WordPressにおいて特定の条件に基づいて投稿を取得するための関数です。この関数は、配列として投稿オブジェクトを返し、カスタムクエリを簡単に実行できます。

引数の種類

get_posts()は、以下のような引数を取ることができます。

  1. $args: 投稿を取得するための条件を指定する連想配列。主なパラメータには以下があります：
  • numberposts: 取得する投稿の数（デフォルトは5）。
  • post_type: 取得する投稿タイプ（例：'post', 'page'）。
  • orderby: 投稿を並べ替える基準（例：'date', 'title'）。
  • order: 並べ替えの順序（'ASC'または'DESC'）。
  • category: 特定のカテゴリーの投稿を取得。

使用方法

get_posts()は、主にカスタムループを作成したい場合に使用されます。通常、WP_Queryと同様の引数を指定して、特定の条件に合った投稿を簡単に取得できます。

サンプルコード

以下は、get_posts()を使用して最新の投稿を取得し表示する基本的なサンプルコードです。

<?php
$args = array(
    'numberposts' => 5,        // 取得する投稿数
    'post_type'   => 'post',   // 投稿タイプ
    'orderby'     => 'date',    // 並べ替え基準
    'order'       => 'DESC'     // 降順
);

$recent_posts = get_posts($args); // 投稿を取得

if ( !empty($recent_posts) ) :
    foreach ( $recent_posts as $post ) : setup_postdata($post); ?>
        <h2><?php the_title(); ?></h2>  <!-- 投稿のタイトルを表示 -->
        <div><?php the_excerpt(); ?></div>  <!-- 投稿の抜粋を表示 -->
    <?php endforeach;
    wp_reset_postdata(); // グローバル$postをリセット
else :
    echo '<p>投稿が見つかりませんでした。</p>';
endif;
?>

まとめ

このように、get_posts()を使用することで、特定の条件に基づいて投稿を簡単に取得し、表示することができます。特に、カスタムクエリを必要とする場合や、特定の投稿を取得したい場合に非常に便利な関数です。テーマ開発やカスタマイズの際に、get_posts()は非常に役立つツールとなります。

2.2 カスタムフィールドとメタデータ

get_post_meta()

get_post_meta()は、WordPressにおいて特定の投稿に関連するメタデータ（カスタムフィールド）を取得するための関数です。この関数を使用することで、投稿に追加された情報を簡単に取得できます。

引数の種類

get_post_meta()は、以下の3つの引数を取ります。

  1. $post_id: メタデータを取得する対象の投稿のID。
  2. $key: 取得したいメタデータのキー（特定のカスタムフィールド名）。
  3. $single: trueを指定すると、単一の値を返し、falseを指定すると、配列として複数の値を返します。デフォルトはfalseです。

使用方法

get_post_meta()は、投稿のカスタムフィールドやメタ情報を取得するために使用されます。特に、投稿に関連する追加情報を表示したい場合に便利です。

サンプルコード

以下は、get_post_meta()を使用して特定の投稿のカスタムフィールドを取得し表示する基本的なサンプルコードです。

<?php
$post_id = get_the_ID(); // 現在の投稿のIDを取得

// カスタムフィールドの値を取得
$custom_field_value = get_post_meta($post_id, 'custom_field_key', true);

if ( !empty($custom_field_value) ) {
    echo '<div>カスタムフィールドの値: ' . esc_html($custom_field_value) . '</div>'; // 値を表示
} else {
    echo '<div>カスタムフィールドが見つかりませんでした。</div>';
}
?>

引数の使用例

上記のコードでは、get_post_meta($post_id, 'custom_field_key', true)を使用して、custom_field_keyというカスタムフィールドの値を取得しています。trueを指定することで、単一の値として返されます。

まとめ

このように、get_post_meta()を使用することで、投稿に関連するカスタムフィールドやメタデータを簡単に取得し、表示することができます。特に、カスタム投稿タイプや追加情報を扱う際に非常に役立つ関数です。テーマ開発やプラグインの作成において、get_post_meta()は重要なツールとなります。

update_post_meta()

update_post_meta() は、WordPress で投稿やページにカスタムフィールドを追加または更新するための関数です。以下にその詳細を説明します。

引数の種類

  1. $post_id (int) – 更新する投稿のID。
  2. $meta_key (string) – 更新するメタデータのキー。
  3. $meta_value (mixed) – 更新するメタデータの値。
  4. $prev_value (mixed) – （オプション）以前の値。これと一致するメタデータのみが更新されます。

使用方法

この関数は、指定した投稿のカスタムフィールドを更新します。もし指定したメタキーが存在しない場合は、新たに追加されます。

サンプルコード

$post_id = 123; // 投稿ID
$meta_key = 'custom_field_key'; // メタキー
$meta_value = '新しい値'; // メタデータの値

// メタデータを更新
update_post_meta($post_id, $meta_key, $meta_value);

引数の使用例

$post_id = 123;
$meta_key = 'views_count';
$meta_value = 150;

// 以前の値が100の場合のみ更新
update_post_meta($post_id, $meta_key, $meta_value, 100);

この例では、views_count が100の場合にのみ150に更新されます。これにより、データの整合性を保つことができます。

update_post_meta() を使用することで、簡単にカスタムフィールドの管理が可能になります。

2.3 タクソノミー関連の関数

get_terms()

get_terms() は、WordPress においてタクソノミーから用語（ターム）を取得するための関数です。この関数を使用することで、カテゴリーやタグなどのタクソノミーに関連する情報を簡単に取得できます。

引数の種類

  1. $taxonomy (string) – 取得するタクソノミーのスラッグ（例：category、post_tag）。
  2. $args (array) – （オプション）取得する際の追加の引数。以下のようなオプションがあります：
  • ‘hide_empty’ (bool) – 空のタームを含めるかどうか（デフォルトは true）。
  • ‘orderby’ (string) – ソート基準（例：name、count）。
  • ‘order’ (string) – ソート順（ASC または DESC）。
  • ‘number’ (int) – 取得するタームの数。

使用方法

get_terms() を利用して、指定したタクソノミーからタームを取得し、配列形式で返します。この配列には、各タームの情報が含まれています。

サンプルコード

$taxonomy = 'category'; // タクソノミー
$args = array(
    'hide_empty' => true,
    'orderby' => 'name',
    'order' => 'ASC'
);

// タームを取得
$terms = get_terms($taxonomy, $args);

// タームの表示
if (!empty($terms) && !is_wp_error($terms)) {
    foreach ($terms as $term) {
        echo $term->name . '<br>';
    }
}

引数の使用例

$taxonomy = 'post_tag';
$args = array(
    'hide_empty' => false,
    'number' => 5,
    'orderby' => 'count',
    'order' => 'DESC'
);

// タームを取得
$top_tags = get_terms($taxonomy, $args);

// タームの表示
if (!empty($top_tags) && !is_wp_error($top_tags)) {
    foreach ($top_tags as $tag) {
        echo $tag->name . ' (' . $tag->count . ')<br>';
    }
}

この例では、タグの中で最も使用されている5つのタームを取得し、その名前と使用回数を表示します。get_terms() を活用することで、タクソノミーに関連する情報を柔軟に取得できます。

wp_set_post_terms()

wp_set_post_terms() は、WordPress で特定の投稿にタクソノミータームを設定するための関数です。この関数を使用することで、投稿に関連するカテゴリーやタグを簡単に管理できます。

引数の種類

  1. $post_id (int) – タームを設定する投稿のID。
  2. $terms (mixed) – 設定するタームの配列またはカンマ区切りの文字列。
  3. $taxonomy (string) – タームを設定するタクソノミーのスラッグ（例：category、post_tag）。
  4. $append (bool) – （オプション）既存のタームに追加するかどうか（デフォルトは false）。

使用方法

wp_set_post_terms() を使うことで、指定した投稿に対してタクソノミータームを設定します。既存のタームを上書きすることも、追加することも可能です。

サンプルコード

$post_id = 123; // 投稿ID
$terms = array('ニュース', '更新'); // 設定するターム
$taxonomy = 'category'; // タクソノミー

// タームを設定
wp_set_post_terms($post_id, $terms, $taxonomy);

引数の使用例

$post_id = 456;
$terms = '特集, テクノロジー'; // カンマ区切りの文字列
$taxonomy = 'post_tag';

// 既存のタグに追加
wp_set_post_terms($post_id, $terms, $taxonomy, true);

この例では、post_id 456 の投稿に対して、特集 と テクノロジー タグを追加します。

まとめ

wp_set_post_terms() は、投稿に対するタクソノミータームの管理を簡単に行うための便利な関数です。タームを設定する際には、投稿ID、ターム、タクソノミーを指定し、必要に応じて既存のタームに追加することができます。この関数を活用することで、投稿の分類が効率的に行え、サイトの整理整頓にも寄与します。

↓前後の記事はこちら↓

コメント

タイトルとURLをコピーしました