WordPress option

設定保存場所

WordPress の各インストール毎の設定や、プラグイン等の設定を保存しておくことができます。

オプションとは

オプションとは、ワードプレスの個別の設定(admin_url 等)を保存する場所です。データベースでは、options テーブルに格納されています。

各オプションについて、オプション名、値、deprecated(現在は使われていない)、オートロード(オブジェクトキャッシュに常にロードするかどうか)、を保存しています。

プラグインを作成するときに、プラグイン特有の設定を保存しておくのに便利です。

オプションリスト

http://codex.wordpress.org/Option_Reference に、ワードプレスオプションの一覧が掲載されています。 (最新の情報とは限りませんので、ご注意ください。) この他にも、プラグイン等が独自にオプションを追加している場合がありますので、MYSQL データベースで確認したほうが良いでしょう。

オプション値の取得

オプションの値を取得するには、get_optionを利用します。

get_option( $name, $value )

「$name」は取得したいオプションの名前です。例えば一ページの記事数なら、posts_per_page です。「$value」は、オプションが存在しなかった場合に返す値です。オプションが存在せず、デフォルト値も設定していない場合は、false が返されます。

オプションの追加と編集

新規オプションを追加するには add_option を使用します。既存オプションを編集するには update_option を使用します。

add_option( $name, $value, $deprecated, $autoload )
update_option( $name, $value )

「$name」はオプションの名前です。「$value」は、設定する値です。「$deprecated」は、現在使用されていませんので、空欄にしておきます。「$autoload」は、オブジェクトキャッシュに常にロードするかを決めます。デフォルトは yes です。

既に存在するオプションに add_option を使用しても、何も行われません。存在しないオプションに update_option を使用すると、オプションに新規追加します。($autoload は yes になります。)

オプション名は、他のプラグインの使用しているオプション名と被らないようにする必要があります。

オプションの削除

オプションを削除するには delete_option を使用します。

delete_option( $name )