wpfts_start_sysvars (Filter)

Фильтр wpfts_start_sysvars в WP Fast Total Search позволяет разработчикам модифицировать системные переменные, которые устанавливаются в начале обработки поискового запроса в методе WPFTS_QueryLog::Start(). Это дает возможность влиять на логику работы плагина на раннем этапе и добавлять или изменять системную информацию, которая будет доступна в течение всего процесса обработки запроса.

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

Этот фильтр может быть полезен, если вам нужно:

  • Добавить свои системные переменные: Вы можете добавить дополнительные переменные в массив $sysvars, которые будут доступны в других частях плагина.
  • Изменить значения существующих системных переменных: Например, вы можете изменить флаг is_qlog_enabled, чтобы включить или отключить логирование запросов.
  • Отладка процесса обработки запроса: Вы можете использовать этот фильтр для вывода значений системных переменных и отладки вашей интеграции с WPFTS.

Аргументы

  • $sysvars (array): Ассоциативный массив системных переменных. Содержит такие ключи, как:
    • qlog_settings (array): Настройки логирования запросов.
    • is_detailed_log (bool): Флаг детального логирования.
    • is_qlog_enabled (bool): Флаг включения логирования запросов.
    • is_main_query (bool): Флаг, указывающий, является ли запрос основным запросом WordPress.
    • is_admin (bool): Флаг, указывающий, выполняется ли запрос в административной панели.
  • $wpq (object): Объект WP_Query, содержащий параметры текущего запроса.

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

  • $sysvars (array): Модифицированный массив системных переменных.

Пример (добавление новой системной переменной)

add_filter('wpfts_start_sysvars', 'add_my_sysvar', 10, 2);
 
function add_my_sysvar($sysvars, $wpq)
{
 
	$sysvars['my_custom_var'] = 'my_custom_value';
	return $sysvars;
 
}

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

  • Фильтр wpfts_start_sysvars вызывается в методе WPFTS_QueryLog::Start().
  • Изменения, внесенные в массив $sysvars, будут доступны в других частях плагина, которые используют эти переменные.
  • Будьте осторожны при изменении системных переменных, так как это может повлиять на работу плагина.

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