get_option()

関数の概要

get_option()は、WordPressで特定のオプション値（設定値）を取得するための関数です。オプションは、WordPressの設定ページで保存されるサイト全体の設定やプラグインの設定を指します。この関数は、テーマやプラグイン内で設定値を取得し、動的にコンテンツを表示する際に便利です。

パラメータの説明

get_option()関数は2つのパラメータを受け取ります。

  1. $option (string, 必須): 取得するオプション名。WordPressデータベース内で保存されているオプションのキー。
  2. $default (mixed, オプション): オプションが存在しない場合に返されるデフォルト値。デフォルトはfalseです。

使用例

以下は、get_option()関数を使用してサイトの設定値を取得し表示する例です。

<?php
// サイトのブログ名を取得する
$blog_name = get_option('blogname');
echo '<p>Blog Name: ' . esc_html($blog_name) . '</p>';

// サイトの管理者のメールアドレスを取得する
$admin_email = get_option('admin_email');
echo '<p>Admin Email: ' . esc_html($admin_email) . '</p>';

デフォルト値を使用する例

<?php
// カスタムオプション 'my_custom_option' を取得する。存在しない場合はデフォルト値 'default_value' を返す
$custom_option = get_option('my_custom_option', 'default_value');
echo '<p>Custom Option: ' . esc_html($custom_option) . '</p>';
?>

カスタムオプションの追加と取得

WordPressのテーマやプラグインで独自のオプションを追加し、そのオプションを取得することもできます。

カスタムオプションの追加例

<?php
// カスタムオプション 'my_custom_option' に値を追加する
add_option('my_custom_option', 'my_custom_value');

カスタムオプションの取得例

<?php
// カスタムオプション 'my_custom_option' を取得する
$custom_option = get_option('my_custom_option');
echo '<p>Custom Option: ' . esc_html($custom_option) . '</p>';
?>

関連する関数

  • update_option(): 既存のオプションの値を更新します。
  • add_option(): 新しいオプションを追加します。既に存在する場合は追加されません。
  • delete_option(): オプションを削除します。
  • get_theme_mod(): テーマカスタマイザーの設定値を取得します。
  • get_transient(): 一時的なキャッシュデータを取得します。

使用上の注意

  • get_option()関数は、サイト全体の設定やプラグインの設定を取得するために使用されます。テーマやプラグイン内で動的に設定値を利用する際に役立ちます。
  • オプション名は一意でなければならず、他のプラグインやテーマと衝突しないように名前を工夫することが重要です。