You are here

Home » API reference » Facet API 7 » facetapi.module

function facetapi_set_facet_disabled in Facet API 7

Same name and namespace in other branches
  1. 6.3 facetapi.module \facetapi_set_facet_disabled()
  2. 7.2 facetapi.module \facetapi_set_facet_disabled()

Disables a facet for this page load only.

Parameters

string $searcher: The machine readable name of the searcher.

string $realm_name: The machine readable name of the realm, pass NULL for all realms.

string $facet_name: The machine readable name of the facet.

bool $batch_process: A boolean flagging whether batch processing is being performed.

See also

facetapi_set_facet_status()

1 call to facetapi_set_facet_disabled()
FacetapiApiFunctions::testSetFacetStatus in tests/facetapi.test
Tests facetapi_set_facet_status() API functions.

File

./facetapi.module, line 1134
An abstracted facet API that can be used by various search backends.

Code

function facetapi_set_facet_disabled($searcher, $realm_name, $facet_name, $batch_process = FALSE) {
  return facetapi_set_facet_status($searcher, $realm_name, $facet_name, FALSE, $batch_process);
}