Egenverk Lagom · Documentation

Reference

Admin addresses

tools.php?page=egenverk-lagom and tools.php?page=lagom lead to the overview.

Address parameters

Constants in wp-config.php

define( 'EGENVERK_LAGOM_PSI_KEY', 'your-api-key' );
define( 'EGENVERK_LAGOM_RULES_OFF', true );

The egenverk_lagom_order_search filter

Another plugin with an order index of its own can answer Lagom's fast order search, so the site does not need two indexes. The filter runs once per search term, only when Fast order search is on and someone searches the order list.

apply_filters( 'egenverk_lagom_order_search', null, array $query );

• Return a list of order ids, newest first, to answer. Lagom removes duplicates and keeps at most 500.
• An empty list means no orders match.
• Return null to let Lagom look the term up itself. Do so also when your index cannot answer the whole term, so you never leave a partial list.

$query holds:

Each entry in lookups has type and value:

An example for a plugin with a table of its own, my_orders:

add_filter(
	'egenverk_lagom_order_search',
	function ( $ids, array $query ) {
		if ( null !== $ids ) {
			return $ids; // Someone already answered.
		}
		global $wpdb;
		$found = array();
		foreach ( $query['lookups'] as $lookup ) {
			if ( 'phone' !== $lookup['type'] ) {
				return null; // Let Lagom handle the whole term.
			}
			$found = array_merge(
				$found,
				$wpdb->get_col( $wpdb->prepare( "SELECT order_id FROM {$wpdb->prefix}my_orders WHERE phone_e164 = %s ORDER BY order_id DESC LIMIT %d", $lookup['value'], $query['limit'] ) )
			);
		}
		return $found;
	},
	10,
	2
);

REST routes

The coverage tool uses three routes under egenverk-lagom/v1. Every call needs a valid run key from the Advanced tab.

Scheduled jobs

Lagom's WP-Cron and Action Scheduler jobs are listed in Data and privacy. The Action Scheduler jobs sit in the egenverk-lagom group.