delete_option

(1.2.0以降)
delete_option - サイトオプションを削除する

説明

bool delete_option( string $option )
サイトオプションを削除する。

パラメータ

  • $option
    サイトオプション名を指定。

返り値

$optionで指定した名前のサイトオプションを削除できた場合はtrue、それ以外はfalseを返す。

注意

削除を行う前に$optionで指定された名前のサイトオプションがあるかどうかを調べ、存在しない場合はすぐにfalseを返す。

使用例

  • 'mytheme_setting'というサイトオプションを削除する。
    <?php delete_option( 'mytheme_setting' ); ?>

フィルター

実行するフィルターはありません。

アクション

パラメータ$optionで指定されたオプション値を取得した直後、delete_optionアクションを実行する。
do_action( 'delete_option', $option );
パラメータ$optionで指定されたオプション値を削除した直後、delete_option_$option$optionが'test'の場合はdelete_option_testアクションとなる)とdeleted_optionアクションを実行する。
do_action( "delete_option_$option", $option ); do_action( 'deleted_option', $option );

ソースファイル

/wp-includes/functions.php

関連

  • add_option - サイトオプションを追加する
  • get_option - オプションの値を取得する
  • get_theme_mods - 現在のテーマ固有のプロパティをすべて取得する
  • remove_theme_mods - 現在のテーマ固有のプロパティをすべて削除する
  • update_option - サイトオプションの値を更新する

お勧めコンテンツ

各種リンクを取得する関数一覧(2014年6月12日 登録)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2011年5月2日 登録)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

ページを表示する直前の前処理にtemplate_redirectアクションを(2013年4月13日 登録)

リクエストに応じてページを表示する直前の準備として何かしらの処理を行っておきたいケースがある。そんな時、テーマの各テンプレートファイルの先頭部分に処理内容をずらずらと記述していませんか。

投稿日の検索が自由自在に(2013年10月30日 登録)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろんquery_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月7日 登録)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

最終更新日時 : 2012-06-08 14:53