Функция get_sample_permalink() в WordPress позволяет получить пример постоянной ссылки (перманентного URL) для поста. Это полезно, когда необходимо определить, как будет выглядеть URL нового поста или страницы до их создания.
get_sample_permalink() возвращает пример перманентной ссылки для поста, используя текущие настройки постоянных ссылок и шаблоны.
get_sample_permalink( int|WP_Post $post_id = 0, string $post_title = '', string $post_name = '' )$post_id(int|WP_Post) — ID или объект записи, для которого необходимо получить пример постоянной ссылки. Если параметр не указан или равен 0, используется ID текущего поста.$post_title(string) — Заголовок поста, который будет использоваться для создания ярлыка ссылки (post_name). Этот параметр игнорируется, если$post_nameне пустой.$post_name(string) — Ярлык записи (slug), который заменит текущий ярлык. Если указан не пустой, то этот параметр перезапишет заголовок, переданный в$post_title.
Возвращаемое значение
Функция возвращает массив из двух элементов:
- Первый элемент — пример постоянной ссылки, например,
https://example.com/%postname% - Второй элемент — ярлык записи, который используется в URL, например,
post-slug.
Пример использования
Предположим, вы хотите получить URL для нового поста с заданными заголовком и слагом. Для этого можно использовать функцию get_sample_permalink().
// Предположим, что у вас есть ID поста, заголовок и слаг
$post_id = 0; // ID поста, 0 означает, что будет использован текущий пост
$post_title = 'Мой новый пост';
$post_name = 'noviy-post';
// Получение перманентной ссылки
$permalinks = get_sample_permalink( $post_id, $post_title, $post_name );
// Вывод полученной ссылки
echo 'Sample permalink: ' . $permalinks[0];
В этом примере функция вернет URL для поста с заголовком «Мой новый пост» и слагом «noviy-post». Результат может выглядеть примерно так: http://example.com/noviy-post/.
Примечания
get_sample_permalink()учитывает настройки постоянных ссылок, установленные в административной панели WordPress.- Если вы передаете
$post_id, он должен быть валидным ID поста. Если значение равно 0, функция будет использовать настройки для текущего поста или страницы. - Функция может быть полезна при создании плагинов или тем, где требуется работа с постоянными ссылками, не создавая реальных постов или страниц.
Заключение
Функция get_sample_permalink() предоставляет разработчикам мощный инструмент для предугадывания структуры URL для новых постов или страниц в WordPress. Это позволяет создавать более гибкие и динамичные решения, учитывая текущие настройки постоянных ссылок и шаблоны.