Overview

This filter lets you modify the final output array, before it’s converted to JSON and returned to the client (via AJAX).

Parameters

  • $output | array | An associative array of output data (see below)
  • $params | array | An associative array of input parameters (see below)
$output = [
    'facets' => [
        'the_facet_name' => 'HTML output',
        'another_facet' => 'HTML output',
    ],
    'template' => 'HTML string',
    'settings' => [
        'the_facet_name' => [
            'setting1' => 'value'
        ]
    ],
    'pager' => 'HTML output',
    'sort' => 'HTML output',
];

$params contains the data (selected values, etc.) passed in client-side from AJAX.

$params = [
    'facets' => [
        [
            'facet_name' => 'the_facet_name',
            'selected_values' => [ 1, 2, 3 ],
        ],
        [
            'facet_name' => 'another_facet',
            'selected_values' => [ 4, 5 ],
        ],
    ),
    'template' => 'my_template',
    'http_params' => [
        'uri' => 'the/page/url'
    ],
    'extras' => [
        'sort' => 'default',
        'pager' => true,
    ],
    'paged' => 1
];

Usage

In this example, we will modify the “start” setting for a slider facet. On first load, the slider will only show items with a price between 500 and 1000.

add_filter( 'facetwp_render_output', function( $output, $params ) {
    $output['settings']['price']['start'] = [ 500, 1000 ];
    return $output;
}, 10, 2 );

More examples