rest_url_prefix │ хук-фільтр │ WP 4.4.0

Дозволяє змінити базу (префікс маршрутів) REST API. Наприклад, wp-jsonз api.

Використання

add_filter( 'rest_url_prefix', 'wp_kama_rest_url_prefix_filter');

/**
 * Function for `rest_url_prefix` filter-hook.
 *
 * @param string $prefix URL prefix.
 *
 * @return string
 */
function wp_kama_rest_url_prefix_filter( $prefix ){

	// Filter...
	return $prefix;
}

$prefix (рядок): Поточний префікс всіх марушут REST API.

За замовчуванням: ‘wp-json’

Приклади

#1 Змінимо префікс REST API з `wp-json` на `api`

## Змінює префікс REST API з `wp-json` на `api`
add_filter( 'rest_url_prefix', 'change_rest_api_prefix' );
function change_rest_api_prefix( $slug ){
	return 'api';
}

## Разом зі зміною префікса, добре додати нове ім'я до чорного списку
add_filter( 'subdirectory_reserved_names', function( $names ){
	$names[] = 'api';
	return $names;
} );

Тепер потрібно оновити правила перезапису – зайти на сторінку адмінки «Постійні посилання».

Все, тепер абсолютно всі маршрути REST будуть починатися з /api/а не з /wp-json/.

Наприклад, ендпоінт (маршрут, посилання) перегляду запису з ID 1 буде таким:

http://example.com/api/wp/v2/posts/1

список змін

З версії 4.4.0

Введено.

Де викликається хук

rest_get_url_prefix()

rest_url_prefix

wp-includes/rest-api.php 415

return apply_filters( 'rest_url_prefix', 'wp-json');

Де використовується хук у WordPress

Використання не знайдено.