rest_sanitize_object()


WordPressのrest_sanitize_object()関数は、REST APIで使用されるオブジェクトデータをサニタイズするための関数です。不適切なデータや危険なコードを除去し、安全な形式に変換します。

構文

rest_sanitize_object( $value );
  • $value (mixed) — サニタイズする対象のオブジェクトまたは配列

例1: 基本的なオブジェクトのサニタイズ

単純なオブジェクトをサニタイズします。

$data = rest_sanitize_object( array( 'key' => '<script>alert("test")</script>' ) );

例2: ネストされた配列のサニタイズ

ネストされた配列を含むオブジェクトを処理します。

$data = rest_sanitize_object( array( 'nested' => array( 'html' => '<b>bold</b>' ) ) );

例3: スカラー値のサニタイズ

オブジェクトではなく単一の値をサニタイズします。

$clean = rest_sanitize_object( '<div>unsafe</div>' );

例4: 数値データのサニタイズ

数値が含まれるオブジェクトを処理します。

$result = rest_sanitize_object( array( 'count' => 123, 'price' => 45.67 ) );

例5: 真偽値のサニタイズ

ブール値を持つオブジェクトをサニタイズします。

$bool_data = rest_sanitize_object( array( 'active' => true, 'valid' => false ) );

例6: NULL値のサニタイズ

NULL値が含まれる場合の処理です。

$null_check = rest_sanitize_object( array( 'test' => NULL ) );

例7: 複合データ型のサニタイズ

様々なデータ型が混在するオブジェクトを処理します。

$mixed = rest_sanitize_object( array( 'text' => 'Hello', 'num' => 42, 'html' => '<p>test</p>' ) );

注意点

  • この関数はREST APIコンテキストで主に使用されます
  • 深くネストされた構造には再帰的に適用されます
  • HTMLコンテンツはエスケープされますが、完全なXSS保護を保証するものではありません

関連機能: