delete_user_option()

関数 WordPressdelete_user_option()は、特定のユーザーに関連付けられたオプションを削除するために使用されます。

構文

delete_user_option( int $user_id, string $option_name, bool $global = false );

引数の説明:

• $user_id (int) — 削除対象のユーザーID。
• $option_name (string) — 削除するオプション名。
• $global (bool) — trueの場合、グローバルオプションを削除します。デフォルトはfalse。

例1: ユーザーの特定のオプションを削除

以下のコードは、特定のユーザーIDに関連付けられたオプションを削除します。

<?php delete_user_option( get_current_user_id(), 'example_option' ); ?>

例2: グローバルオプションを削除

次のコードは、グローバルなスコープで特定のオプションを削除します。

<?php delete_user_option( get_current_user_id(), 'global_option', true ); ?>

例3: 条件に基づいてオプションを削除

特定の条件が満たされた場合にオプションを削除します。

<?php
if ( user_can( get_current_user_id(), 'administrator' ) ) {
    delete_user_option( get_current_user_id(), 'admin_option' );
}
?>

例4: 他のユーザーのオプションを削除

特定のユーザーIDを指定してオプションを削除します。

<?php delete_user_option( 123, 'custom_option' ); ?>

注意事項

• 削除対象のオプションが存在しない場合、この関数は何も実行しません。
• $global引数をtrueに設定する際は、グローバルオプションが意図しない形で削除されないように注意してください。
• ユーザーIDが正しく指定されていることを確認してください。