rest_stabilize_value()


WordPressのrest_stabilize_value()関数は、REST APIを通じて受信したデータを安定化し、適切な形式に変換するために使用されます。この関数は、特にカスタムフィールドやメタデータを扱う際に役立ちます。

構文

rest_stabilize_value( mixed $value, string $type, string $subtype = '' );

引数の説明:

  • $value(mixed) — 安定化する値。文字列、数値、配列、オブジェクトなどが指定可能です。
  • $type(string) — 値のタイプ。例えば、’string’, ‘integer’, ‘boolean’, ‘array’などが指定されます。
  • $subtype(string) — オプション。サブタイプを指定します。例えば、’date’, ‘email’などが使用されます。

例1: 文字列の安定化

文字列を安定化する基本的な例です。

<?php $stabilized_value = rest_stabilize_value( 'example', 'string' ); ?>

例2: 整数の安定化

整数値を安定化する例です。

<?php $stabilized_value = rest_stabilize_value( 123, 'integer' ); ?>

例3: ブール値の安定化

ブール値を安定化する例です。

<?php $stabilized_value = rest_stabilize_value( true, 'boolean' ); ?>

例4: 配列の安定化

配列を安定化する例です。

<?php $stabilized_value = rest_stabilize_value( array( 'apple', 'banana' ), 'array' ); ?>

例5: 日付の安定化

日付を安定化する例です。

<?php $stabilized_value = rest_stabilize_value( '2023-10-01', 'string', 'date' ); ?>

例6: メールアドレスの安定化

メールアドレスを安定化する例です。

<?php $stabilized_value = rest_stabilize_value( 'example@example.com', 'string', 'email' ); ?>

例7: カスタムフィールドの安定化

カスタムフィールドの値を安定化する例です。

<?php $stabilized_value = rest_stabilize_value( get_post_meta( get_the_ID(), 'custom_field', true ), 'string' ); ?>

例8: オブジェクトの安定化

オブジェクトを安定化する例です。

<?php $stabilized_value = rest_stabilize_value( (object) array( 'key' => 'value' ), 'object' ); ?>

注意点

  • この関数は、REST APIのコンテキストで使用されることを前提としています。
  • 不正な値が渡された場合、関数はnullを返すことがあります。
  • サブタイプを指定する場合、適切な形式でデータを渡す必要があります。

関連機能：