rest_sanitize_array() │ WP 5.5.0

Преобразовывает переданное значение в индексный массив. Если преобразование невозможно вернет пустой массив.

Неиндексный массив превратиться в индексный.

Алгоритм работы:

  1. Проверяет является ли переданное значение скалярным (с помощью PHP функции is_scalar()). Если является, то оно обрабатывается функцией wp_parse_list() и результат возвращается.

    Скалярные переменные - это переменные с типами int, float, string и bool. Типы array, object и resource не являются скалярными.

  2. Если передан не скаляр и не массив (object, resource и т.д.), то функция вернет пустой массив.

  3. Если передан массив, то функция соберет из его значений индексный массив и вернет его.
Работает на основе: wp_parse_list()

Хуков нет.

Возвращает

Массив. Массив (пустой или нумерованный).

Использование

rest_sanitize_array( $maybe_array );
$maybe_array(смешанный) (обязательный)
Значение для преобразования.

Примеры

0

#1 Варианты работы функции 

rest_sanitize_array( 'Вова,Миша,Тимур,Дима' );

/* вернёт
Array (
	[0] => Вова
	[1] => Миша
	[2] => Тимур
	[3] => Дима
)
*/
rest_sanitize_array( [ 
	'name' => 'Ольга', 
	'age' => 5 
] );

/* вернёт

Array (
	[0] => Ольга
	[1] => 5
)
*/

Список изменений

С версии 5.5.0 Введена.

Код rest_sanitize_array() WP 6.7.1

wp-includes/rest-api.php 
function rest_sanitize_array( $maybe_array ) {
	if ( is_scalar( $maybe_array ) ) {
		return wp_parse_list( $maybe_array );
	}

	if ( ! is_array( $maybe_array ) ) {
		return array();
	}

	// Normalize to numeric array so nothing unexpected is in the keys.
	return array_values( $maybe_array );
}

REST API