Task-oriented walkthrough: Use Template Functions in Your Theme.

All functions are global, loaded on every request. Source: src/Frontend/TemplateFunctions.php (all signatures verified against source). The short huxx_api* names are the recommended forms; the long huxx_connect_* originals are permanent equivalents.

huxx_api()#

huxx_api( string $api_id, string $endpoint_id, array $args = array() )

The return type is mixed (documented; the source declares no return type).

Executes a configured endpoint and returns the response.

Parameters#

$args keys#

All optional. Runtime values merge over the saved endpoint configuration; runtime wins.

The response format (decoded array vs. JSON string vs. raw body) is controlled by the endpoint’s Results Format setting, not by a runtime argument. (The source docblock for huxx_connect_api() advertises a results_format runtime argument, but the executor never reads it — the endpoint setting is the only control.)

Return value#

mixed:

• Decoded array (Results Format PHP Array), string (JSON String / Raw), extracted value(s) when keys is set.
• HuxxConnectCoreErrorResponse on failure. With debug => true, failures of the actual HTTP request are returned as the error array instead; lookup/configuration failures always return the ErrorResponse object.
• false when $api_id or $endpoint_id is an empty string (no lookup is attempted).

Example#

<?php
$titles = huxx_api( 'demo_api', 'get_products', array(
    'query_variables' => array( 'limit' => 2 ),
    'keys'            => 'products.[].title',
) );
print_r( $titles );

Output:

Array
(
    [0] => Essence Mascara Lash Princess
    [1] => Eyeshadow Palette with Mirror
)

huxx_api_is_error()#

huxx_api_is_error( $response ): bool

The $response parameter accepts any value (mixed, documented; the source declares no parameter type).

Returns true when $response is a failure — either an ErrorResponse object or an array whose _huxx_connect_error key is true. Returns false for everything else, including false itself.

Example#

<?php
$data = huxx_api( 'demo_api', 'get_products' );
var_dump( huxx_api_is_error( $data ) );

Output on success:

bool(false)

huxx_api_get_error()#

huxx_api_get_error( $response ): ?array

The $response parameter accepts any value (mixed, documented; the source declares no parameter type).

Returns the error details as an array, or null when $response is not an error.

Error array shape#

Matches HuxxConnectCoreErrorResponse::to_array():

Example#

<?php
$data = huxx_api( 'demo_api', 'no_such_endpoint' );
$error = huxx_api_get_error( $data );
echo esc_html( $error['message'] );

Output:

Endpoint "no_such_endpoint" not found for API "demo_api".

Long-form equivalents#

Identical behavior, kept permanently for backward compatibility:

huxx_connect_api( string $api_id, string $endpoint_id, array $args = array() )
huxx_connect_is_error( $response ): bool
huxx_connect_get_error( $response ): ?array

Notes#

• Calls made through these functions are tagged php_function in the request log unless trigger_type overrides it.
• Deactivated APIs return an ErrorResponse (API "…" is currently deactivated.) without making a request.
• To observe or modify the outgoing request, use the request-lifecycle hooks: huxx_connect/request/before, huxx_connect/request/args, huxx_connect/request/after.