Documentation

falcon_link_functions.php

Table of Contents

Functions

falcon_link_publish()  : array<string|int, mixed>
Publish resources in the array to falcon.io
falcon_link_archive()  : array<string|int, mixed>
Archive resources in falcon.io

Functions

Publish resources in the array to falcon.io

falcon_link_publish(array<string|int, mixed> $resources, string $template_text, string $template_tags) : array<string|int, mixed>
Parameters
$resources : array<string|int, mixed>

Array of resources to publish. Must include named "ref" key with resource ID as value as per search results

$template_text : string

Text to use for template description. If not passed will use value from configured $falcon_link_text_field

$template_tags : string

Comma separated list of tags to add to Falcon template. If not passed will use values from configured $falcon_link_tag_fields

Return values
array<string|int, mixed>

"success" => Overall outcome of publish action "errors" => Array of error messages "results" => Array of resource IDs and associated status messages

Archive resources in falcon.io

falcon_link_archive(array<string|int, mixed> $resources) : array<string|int, mixed>
Parameters
$resources : array<string|int, mixed>

Array of resources to archive. Must include named "ref" key with resource ID as value as per search results

Return values
array<string|int, mixed>

"success" => Overall outcome of archive action "errors" => Array of error messages "results" => Array of resource IDs and associated status messages

On this page

Search results