function hook_facetapi_realm_info in Facet API 6

Same name and namespace in other branches

1. 6.3 facetapi.api.php \hook_facetapi_realm_info()
2. 7.2 facetapi.api.php \hook_facetapi_realm_info()
3. 7 facetapi.api.php \hook_facetapi_realm_info()

Defines realms that facets can be built in.

A facet realm is a group of facets that are displayed in a similar fashion and built through the same function. For example, facets in the "block" realm are built via the facetapi_realm_block_build() function. This architecture allows us to define a single facet but display it in different ways.

Return value

An associative array containing:

• name: The machine readable name of the realm.
  • title: Human readable name of the realm, i.e. label.
  • description: The realm description.
  • weight: The default weight of the realm, defaults to 0.
  • sortable: Whether or not the facet weights can be set in the Facet API user interface.
  • widget requirements: An array of requirements applied to all facets in the realm.
  • ui: A boolean that flags whether the realm should have a user interface.

1 function implements hook_facetapi_realm_info()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

facetapi_facetapi_realm_info in ./facetapi.module

Implementation of hook_facetapi_realm_info().

1 invocation of hook_facetapi_realm_info()

facetapi_realms_get in ./facetapi.module

Invokes hook_facetapi_realm_info(), returns realm definitions.

File

./facetapi.api.inc, line 65

Defines and gives example implementations of all Facet API hooks.

Code

function hook_facetapi_realm_info() {
}