site.ini [SiteSearchSuggestSettings] #

The block [SiteSearchSuggestSettings] of settings/site.ini, with 10 setting(s).

Suggestions under the header search field of a site's design while the visitor types (the include
design:parts/front_search_suggest.tpl in the design's search form; the script javascript/page/search_suggest.js asks
content/sitesuggest/(text)/<text>, expSearchSuggest::siteSuggest()). Per siteaccess: switch it off in the
siteaccess's site.ini.append.php. Guide: doc/eng-us/help/searching.md ("Suggestions on the site").

Only content objects the user may read are suggested (the anonymous user: what is public), with their name, address,
class name and a small image; never user accounts, content classes, administration pages or settings. The view
needs the policy content/read, as content/search.

Never edit settings/site.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/site.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/site.ini.append.php for one siteaccess,
• extension/<extension>/settings/site.ini.append.php in an extension (read when the extension is active).

Enabled #

true or false. false: the field is a plain search field, content/sitesuggest answers 404.

Default: true.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
Enabled=true
*/ ?>

MinLength #

The fewest characters typed before suggestions are asked for.

Default: 3.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
MinLength=3
*/ ?>

Limit #

The most suggestions (0 to 20).

Default: 6.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
Limit=6
*/ ?>

ExcludeClasses #

Classes never suggested (besides every class with a user account attribute, which never is).

Default: a list of 2: user, user_group.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
# an empty "ExcludeClasses[]" first replaces the shipped list; without it the items are added
ExcludeClasses[]
ExcludeClasses[]=user
ExcludeClasses[]=user_group
*/ ?>

IncludeClasses #

Only these classes are suggested and offered in the content type filter of the search page
(content/front_search_page.tpl); empty: every class not excluded above. A site whose tree holds other sites' classes
(a multisite package) names its own here, in the siteaccess's site.ini.append.php.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
# an empty "IncludeClasses[]" first replaces the shipped list; without it the items are added
IncludeClasses[]
*/ ?>

ThumbnailAlias #

The image alias of the small picture of a suggestion (image.ini), from the object's first image attribute; empty:
the class icon only.

Default: small.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
ThumbnailAlias=small
*/ ?>

Wildcard #

auto, enabled or disabled, as admininterface.ini [SearchSuggestSettings] Wildcard.

Default: auto.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
Wildcard=auto
*/ ?>

PublicCacheTTL #

Seconds an anonymous answer is kept (on the server and as Cache-Control: public, max-age), 0 to 3600. 0: not kept.
A signed-in user's answer is never kept (private, no-store).

Default: 60.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
PublicCacheTTL=60
*/ ?>

RateLimit #

Requests of one address within RateWindow seconds; more are answered 429 with Retry-After. 0: no limit.

Default: 60.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
RateLimit=60
*/ ?>

RateWindow #

Default: 60.

<?php /* #?ini charset="utf-8"?
# settings/override/site.ini.append.php
[SiteSearchSuggestSettings]
RateWindow=60
*/ ?>

Related #

• All blocks of site.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/site.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.