delete_user_option

（3.0.0以降）
delete_user_option - ユーザオプション情報を削除する

説明

bool delete_user_option( int $user_id, string $option_name [ , bool $global = false ] )
ユーザオプション情報を削除する。

パラメータ

  • $user_id
    ユーザIDを指定。
  • $option_name
    オプション名を指定。
  • $global
    マルチサイト時に全サイト共有にする場合はtrueを指定（省略時はfalse）。

返り値

オプション情報を削除できた場合はtrueを、削除できなかった場合はfalseを返す。

注意

本関数では delete_user_meta関数を呼び出してオプション情報を削除している。

パラメータ$globalがfalseの場合、パラメータ$option_nameの前にブログプレフィックス（$wpdb->get_blog_prefix()）が追加され、それが実際のオプション名となる。

使用例

  • 'plugin-option'という名前のオプション値を削除する。
    delete_user_option( $user->ID, 'plugin-option' );

フィルター

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

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/user.php

最終更新 : 2021年06月02日 10:55

関連

参考

Code Reference: delete_user_option

お勧め

時代はWP_Queryなのか（2011年8月1日 更新）

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

3.6リリース直前チェック（2013年7月26日 更新）

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨（deprecated）になる。

テーブルブロックを投稿メタ（カスタムフィールド）に保存する（2022年1月5日 更新）

ふと「テーブルブロックの内容を投稿メタ（カスタムフィールド）として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

さくらのVPSでKUSANAGI（2018年5月27日 更新）

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

投稿画面のウェジェットを2列にする（2013年4月17日 更新）

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。