概要
wp_unslash関数は、クォートされた文字列のクォート部分を取り除くために使用されるWordPressの関数です。主に、外部からのデータを処理する際に、クォートが追加された文字列を元の形式に戻すために利用されます。この関数は、特に以下のような機能を実装する際によく使用されます：
1. フォームからの入力データの処理
2. データベースから取得したデータのクレンジング
3. JSONデータのデコード
4. カスタム投稿タイプの作成時
5. ユーザー入力のバリデーション
6. プラグイン設定の保存
7. REST APIレスポンスの生成
8. スクリプトやスタイルのエンキュー時のパラメータ処理
構文
wp_unslash( $string );
パラメータ
$string(mixed): クォートされた文字列または配列。
戻り値
- (mixed): クォート部分が取り除かれた文字列または配列。
関連する関数
バージョン
wp_unslash関数は、WordPress 2.8.0以降で利用可能です。
コアファイルのパス
wp-includes/formatting.php
サンプルコード
サンプルコード1: 文字列のデモ
$input = "O'Reilly";
$result = wp_unslash( $input );
echo $result; // O'Reilly
このサンプルコードでは、クォートされた文字列”O’Reilly”をwp_unslash関数で処理し、元の形式のまま出力します。
サンプルコード2: 配列のデモ
$input_array = array("name" => "O'Reilly", "age" => "30");
$result = wp_unslash( $input_array );
print_r($result); // Array ( [name] => O'Reilly [age] => 30 )
このコードは、クォートされた配列をwp_unslashで処理し、正常な形式に戻します。
サンプルコード3: フォームデータの処理
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
$data = wp_unslash($_POST['data']);
// データを使った処理
}
この例では、POSTリクエストで送信されたデータのクォートを取り除いています。
サンプルコード4: オプションの保存
add_option('my_option', wp_unslash($input_option));
ここでは、オプションをデータベースに保存する際に、クォートを取り除くためにwp_unslashを利用しています。
サンプルコード5: REST APIレスポンス
$response = array(
'message' => wp_unslash($input_message)
);
return $response;
このサンプルでは、REST APIレスポンスを作成する際、メッセージのクォートを取り除いています。
この関数のアクションでの使用可能性
| アクション名 | 使用可否 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | 〇 |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
wp_unslash関数は、特定のWordPressバージョンで非推奨または削除の対象ではありません。