ワードプレスのsanitize_key関数の使用方法・解説

概要

sanitize_key 関数は、サイト内識別子向けにサニタイズするための機能を提供します。この関数は、主に以下のようなシナリオで使用されます：

1. カスタムフィールドのキー
2. オプション名
3. タクソノミーのスラッグ
4. 投稿タイプのスラッグ
5. ユーザーのメタデータのキー
6. ウィジェットの識別子
7. 設定ページのフィールド名
8. リクエストパラメータのキー

構文

sanitize_key( string $key )

パラメータ

• $key: サニタイズする文字列 (string)

戻り値

• サニタイズされた文字列 (string)

関連する関数

• sanitize_text_field
• sanitize_title
• esc_sql

使用可能なバージョン

• WordPress v2.0.0 以降

コアファイルのパス

• wp-includes/formatting.php

サンプルコード

サンプル1：カスタムフィールドのキーをサニタイズ

このサンプルコードは、カスタムフィールドのキーをサニタイズし、安全に保存するためのものです。

$key = "my_custom_field_key!";
$sanitized_key = sanitize_key($key);
echo $sanitized_key; // 出力: my_custom_field_key

サンプル2：オプション名をサニタイズ

この例では、オプション名をサニタイズして、悪意のあるコードが保存されるのを防ぎます。

$option_name = "my_option_name#";
$sanitized_option_name = sanitize_key($option_name);
update_option($sanitized_option_name, "option_value");

サンプル3：タクソノミーのスラッグのサニタイズ

タクソノミーを登録する際に、スラッグをサニタイズする例です。

$taxonomy_slug = "my-taxonomy!@#$";
$sanitized_taxonomy_slug = sanitize_key($taxonomy_slug);
register_taxonomy($sanitized_taxonomy_slug, 'post', array());

サンプル4：ユーザーメタデータのキーをサニタイズ

このコードは、ユーザーメタデータのキーをサニタイズしている例です。

$meta_key = "user_meta!@#";
$sanitized_meta_key = sanitize_key($meta_key);
update_user_meta($user_id, $sanitized_meta_key, "meta_value");

サンプル5：リクエストパラメータのキーをサニタイズ

リクエストパラメータのキーをサニタイズしてから、データを処理します。

$request_key = "request_param#";
$sanitized_request_key = sanitize_key($request_key);
$value = isset($_REQUEST[$sanitized_request_key]) ? $_REQUEST[$sanitized_request_key] : '';

この関数のアクションでの使用可能性

アクション	使用例
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

非推奨または削除されたバージョン

• 特定のバージョンで非推奨または削除された情報はありません。