概要
get_options 関数は、WordPress で設定されたオプションをデータベースから取得するために使用されます。この関数は、サイトの構成や動作を設定する際に、特定のオプションの値を取得するために頻繁に利用されます。以下は、get_options 関数がよく使用されるシーンの例です：
- サイト全般の設定を取得する。
- プラグインの設定を読み込む。
- テーマのカスタマイズオプションを取得する。
- ウィジェットエリアの設定を確認する。
- ユーザーの設定を取得する。
- SEO設定を管理する。
- セキュリティ関連のオプションを確認する。
- APIや外部サービスとの統合に関する設定を取得する。
構文
$options = get_option( $option, $default );
パラメータ
$option(string) : 取得したいオプションの名前。$default(mixed) : 指定したオプションが存在しない場合に返されるデフォルト値（省略可能）。
戻り値
指定したオプション名が存在する場合はその値を返し、存在しない場合はデフォルト値を返します。
関連する関数
使用可能なバージョン
get_option は、WordPress のすべてのバージョンで利用可能です。
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | 〇 |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
非推奨または削除されたバージョン
この関数は特定のバージョンで非推奨又は削除されていません。
サンプルコード
サンプルコード1: オプションの取得
$site_name = get_option('blogname', 'デフォルトのサイト名');
echo $site_name;
このコードは、WordPress のオプション「blogname」を取得し、存在しない場合は「デフォルトのサイト名」というデフォルト値を表示します。
サンプルコード2: 設定オプションの取得
$header_image = get_option('header_image', 'default.jpg');
?>
<img src="<?php echo esc_url($header_image); ?>" alt="Header Image">
このコードは、ヘッダー画像のオプションを取得し、画像が設定されていない場合には「default.jpg」を表示します。
サンプルコード3: プラグイン設定の確認
$plugin_setting = get_option('my_plugin_setting');
if ($plugin_setting) {
// プラグインが有効
echo "プラグインが有効です。";
}
このコードは、特定のプラグインの設定値を取得し、その設定が存在する場合にメッセージを表示します。
サンプルコード4: カスタマイズ設定の取得
$custom_color = get_option('custom_color_scheme', '#ffffff');
?>
<div style="background-color: <?php echo esc_attr($custom_color); ?>;">
カスタムカラー
</div>
このコードは、カスタムカラー設定を取得し、それを使用して背景色を変更します。
サンプルコード5: URL設定の取得
$api_url = get_option('api_url', 'https://default.api.com');
echo $api_url;
このコードは、APIのURL設定を取得し、存在しない場合はデフォルトのURLを表示します。