sanitize_option()


WordPress関数sanitize_option()は、オプション値をサニタイズするために使用されます。この関数を利用して、データを検証し安全な形式に変換することができます。

シンタックス

sanitize_option( string $option, mixed $value );

引数の説明

  • $option (string) — サニタイズするオプションの名前。
  • $value (mixed) — サニタイズ対象の値。

例 1. オプション値のサニタイズ

以下のコードは、admin_emailオプションの値をサニタイズします。

<?php
$sanitized_email = sanitize_option( 'admin_email', 'invalid-email@domain' );
echo $sanitized_email;
?>

例 2. 数値オプションのサニタイズ

以下は、数値を含むオプション値をサニタイズする例です。

<?php
$sanitized_number = sanitize_option( 'posts_per_page', '-10' );
echo $sanitized_number; // 出力: 0
?>

例 3. URLオプションのサニタイズ

URL形式のオプション値をサニタイズする方法を示します。

<?php
$sanitized_url = sanitize_option( 'home', 'http://example.com/test?param=<script>' );
echo $sanitized_url;
?>

例 4. 無効な値の処理

無効なオプション値が渡された場合の動作を確認します。

<?php
$sanitized_invalid = sanitize_option( 'date_format', '<invalid>' );
echo $sanitized_invalid; // デフォルト値が返されます。
?>

例 5. オプション値の更新

サニタイズした値をオプションとして保存する例です。

<?php
$option_value = sanitize_option( 'blogdescription', '<h1>My Blog</h1>' );
update_option( 'blogdescription', $option_value );
?>

注意事項

  • sanitize_option()は指定されたオプション名に応じて適切なサニタイズ関数を自動的に適用します。
  • オプション値が正しい形式でない場合、WordPressのデフォルト値が返されることがあります。
  • この関数を使用する際は、適切なオプション名を指定してください。

関連機能：