wpfts_intro_text (Filter)

Фильтр wpfts_intro_text в WP Fast Total Search позволяет разработчикам изменить текст приветственного сообщения, которое отображается на странице настроек плагина после первой установки. Этот текст содержит краткую инструкцию по началу работы с плагином и предложение начать индексацию.

Когда используется

Этот фильтр используется, если вам нужно изменить стандартный текст приветствия, например, добавить ссылки на документацию вашего аддона или предоставить дополнительную информацию для пользователей.

Аргументы

  • $intro_text (string): Стандартный текст приветственного сообщения.

Возвращаемое значение

  • $intro_text (string): Модифицированный текст приветственного сообщения.

Пример

add_filter('wpfts_intro_text', 'my_wpfts_intro_text_filter');
 
function my_wpfts_intro_text_filter($intro_text)
{
	// Добавляем ссылку на документацию аддона.
	$intro_text .= '<p>'.sprintf(__('For more information, please refer to the <a href="%s" target="_blank">documentation</a>.', 'fulltext-search'), 'https://example.com/my-addon/docs/').'</p>';
	return $intro_text;
}

Важные замечания

  • Фильтр wpfts_intro_text вызывается только один раз после активации плагина, если флаг is_new в результате работы метода WPFTS_Core::GetUpdates() равен true, и пользователь находится на странице настроек WPFTS.
  • Текст приветственного сообщения хранится в базе данных в опции wpfts_is_welcome_message.
  • После того, как пользователь закроет приветственное сообщение, оно больше не будет отображаться, и фильтр wpfts_intro_text вызываться не будет.

Этот фильтр предоставляет разработчикам возможность настроить приветственное сообщение WP Fast Total Search и предоставить пользователям дополнительную информацию о своих расширениях.