こんにちは、阿久梨絵です!
WordPress には、get_ で始まる関数が多数存在します。
例えば get_header(), get_the_title(), get_post_meta() などがあり、
「データの取得」や「特定の値を返す」処理を担当する命名規則 に沿っています。
本記事では、 WordPress の get_ 関数が持つ命名規則と使い方、カスタマイズのポイントを詳しく解説 します!
1. get_ で始まる関数の基本ルール
WordPressの get_ 関数は、基本的に 「データを取得して返す」 ために使用されます。
get_ がつく関数は、次のような共通のルールがあります。
・データを取得し、直接出力せずに値を返す
・多くの関数は「類似の the_ 関数」とセットで存在する
・フィルターフックで値を変更できることが多い
・「テンプレートタグ」「投稿データ」「サイト情報」など、多くのカテゴリに分かれる
例として、以下の関数を比較すると命名ルールが分かりやすくなります。
get_the_title() → 投稿タイトルを取得(値を返す)
the_title() → 投稿タイトルを出力(値を直接表示)
get_post_meta() → 投稿のカスタムフィールドを取得(値を返す)
the_meta() → 投稿のカスタムフィールドを表示(値を直接表示)
つまり、「get_」付きの関数はデータを返し、「the_」付きの関数はその値を直接表示する というルールがあります。
2. get_ 関数の代表的なカテゴリ
WordPressの get_ 関数には、大きく分けて 3つの主要なカテゴリ があります。
① テンプレートタグ系(サイトの共通要素取得)
関数 | 取得する情報 |
---|---|
get_header() | ヘッダーを取得 |
get_footer() | フッターを取得 |
get_sidebar() | サイドバーを取得 |
get_template_part() | 指定したテンプレートパーツを取得 |
・WordPressテーマの基本構造を形成するために使われる関数群
・共通のテンプレートを取得し、柔軟なデザイン変更が可能
② 投稿データ系(記事やページ情報を取得)
関数 | 取得する情報 |
---|---|
get_the_title() | 投稿のタイトルを取得 |
get_the_content() | 投稿の本文を取得 |
get_the_excerpt() | 投稿の抜粋を取得 |
get_post_meta() | 投稿のカスタムフィールドを取得 |
・投稿データを取得し、テーマやカスタマイズで活用できる関数群
・get_ 系関数を使うことで、カスタマイズ時にデータを変数として活用可能
例:get_the_title() を使ってカスタム出力
$title = get_the_title();
echo ‘<h2 class=”custom-title”>’ . esc_html( $title ) . ‘</h2>’;
・the_title() だと直接出力されるが、get_the_title() を使うことで 変数として保持できる
③ サイト情報系(基本設定やURLを取得)
関数 | 取得する情報 |
---|---|
get_bloginfo(‘name’) | サイト名を取得 |
get_bloginfo(‘url’) | サイトURLを取得 |
get_option(‘home’) | ホームURLを取得 |
get_option(‘siteurl’) | WordPressのインストールURLを取得 |
・WordPressサイトの基本情報を取得し、動的な出力を可能にする
・設定画面(Settings -> General)で変更された情報を反映することが可能
例:サイト名をカスタム表示
echo ‘<h1>’ . get_bloginfo(‘name’) . ‘</h1>’;
3. get_ 関数を活用したカスタマイズ
・変数として値を扱いたいときは get_ を使う
・直接HTMLに組み込む場合は the_ 関数を使う
・フィルターフックを利用して取得する値を変更することも可能
get_the_title() の値をフィルターで変更
function custom_title_filter( $title ) {
return ‘🔥 ‘ . $title;
}
add_filter( ‘the_title’, ‘custom_title_filter’ );
このフィルターを適用すると、投稿タイトルの前に「🔥」がつく
まとめ
・get_ 関数は「データを取得し、値として返す」ルールがある
・「the_」付きの関数とは異なり、取得した値を変数として活用できる
・テンプレートタグ・投稿データ・サイト情報など、主要なカテゴリに分かれる
・フィルターを活用することで、取得データを柔軟にカスタマイズできる
WordPress テーマを開発・カスタマイズする際には、get_ 関数を適切に使い分けることが重要 です!
阿久梨絵でした!