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

概要

wp_is_numeric_array 関数は、配列が数値キーのみを持つかどうかを調べるための関数です。この関数は、データの整合性を確認する必要がある場面でよく利用されます。例えば、次のような機能を実装する際によく使用されます。

1. カスタムメニューの生成
2. オプション設定のバリデーション
3. データベースから取得したデータのチェック
4. APIレスポンスの検証
5. ユーザー入力のフィルタリング
6. 多次元配列の解析
7. ショートコードの引数バリデーション
8. テーマオプションの管理

構文

wp_is_numeric_array( array $array )

パラメータ

• $array: 確認したい配列。

戻り値

• 数値キーのみの配列であれば true、それ以外は false.

関連する関数

• https://refwp.com/?titleonly=1&s=wp_is_numeric_array

使用可能なバージョン

wp_is_numeric_array関数は、WordPress 4.9.0以降で使用可能です。

コアファイルのパス

wp-includes/functions.php

サンプルコード

サンプルコード 1: 数値キーの配列チェック

$array = [0 => 'apple', 1 => 'banana', 2 => 'cherry'];
if ( wp_is_numeric_array( $array ) ) {
    echo "配列は数値キーのみを持っています。";
} else {
    echo "配列は数値キー以外のキーを持っています。";
}

このサンプルコードは、数値キーのみを持つ配列を確認し、その結果を出力します。

サンプルコード 2: 文字列キーを含む配列チェック

$array = ['0' => 'apple', '1' => 'banana', '2' => 'cherry'];
if ( wp_is_numeric_array( $array ) ) {
    echo "配列は数値キーのみを持っています。";
} else {
    echo "配列は数値キー以外のキーを持っています。";
}

このサンプルコードでは、文字列キーを含む配列を確認し、結果を出力します。

サンプルコード 3: 空の配列のチェック

$array = [];
if ( wp_is_numeric_array( $array ) ) {
    echo "配列は数値キーのみを持っています。";
} else {
    echo "配列は数値キー以外のキーを持っています。";
}

このサンプルコードは、空の配列を確認し、結果を出力します。

サンプルコード 4: ミックス配列のチェック

$array = [0 => 'apple', 'key' => 'banana', 2 => 'cherry'];
if ( wp_is_numeric_array( $array ) ) {
    echo "配列は数値キーのみを持っています。";
} else {
    echo "配列は数値キー以外のキーを持っています。";
}

このサンプルでは、数値キーと文字列キーが混在する配列を確認し、結果を出力します。

サンプルコード 5: 多次元配列のチェック

$array = [
    'fruits' => [0 => 'apple', 1 => 'banana'], 
    'vegetables' => [0 => 'carrot', 'key' => 'potato']
];
foreach ($array as $subarray) {
    if ( wp_is_numeric_array( $subarray ) ) {
        echo "サブ配列は数値キーのみを持っています。";
    } else {
        echo "サブ配列は数値キー以外のキーを持っています。";
    }
}

このサンプルコードでは、多次元配列内の各サブ配列を確認し、それぞれの結果を出力します。

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

アクション	使用可能性
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_is_numeric_array関数は、特定のバージョンで非推奨または削除された記録はありません。