# storeengine/2.2.0/includes/api/logs.php

StoreEngine — Complete eCommerce Solution with Memberships, Licensing, Affiliates & More, version 2.2.0. 294 lines.

- Page: https://pluginprobe.com/plugins/storeengine/2.2.0/code/includes/api/logs.php
- Raw: https://pluginprobe.com/plugins/storeengine/2.2.0/raw/includes/api/logs.php
- Modified: 2026-05-26T15:51:46+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/storeengine/2.2.0/code/includes/api/logs.php#L10-L20`.

```php
<?php
namespace StoreEngine\API;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

use WP_REST_Controller;
use WP_REST_Request;
use WP_REST_Server;
use WP_Error;
use StoreEngine\Utils\Helper;
use StoreEngine\Classes\LogItem;
use StoreEngine\Classes\LogItemCollection;

class Logs extends WP_REST_Controller {

	/**
	 * Constructor.
	 */
	public function __construct() {
		$this->namespace = STOREENGINE_PLUGIN_SLUG . '/v1';
		$this->rest_base = 'logs';
	}

	/**
	 * Init the API class.
	 */
	public static function init() {
		$self = new self();
		add_action( 'rest_api_init',[ $self, 'register_routes' ] );
	}

	/**
	 * Register the routes for the objects of the controller.
	 */
	public function register_routes() {
		// Route to fetch and delete logs.
		register_rest_route( $this->namespace, '/' . $this->rest_base, [
			[
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => [ $this, 'get_items' ],
				// 'permission_callback' =>[ $this, 'permissions_check' ],
				'permission_callback' => '__return_true',
				'args'                => $this->get_collection_params(),
			],
			[
				'methods'             => WP_REST_Server::DELETABLE,
				'callback'            => [ $this, 'delete_items' ],
				'permission_callback' => [ $this, 'permissions_check' ],
				'args'                => [
					'ids' => [
						'required' => true,
						'type'     => 'array',
						'items'    => [
							'type' => 'integer',
						],
					],
				],
			],
		] );

		// Route to get and save log cleanup settings.
		register_rest_route( $this->namespace, '/' . $this->rest_base . '/settings', [
			[
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => [ $this, 'get_settings' ],
				'permission_callback' => [ $this, 'permissions_check' ],
			],
			[
				'methods'             => WP_REST_Server::CREATABLE,
				'callback'            => [ $this, 'save_settings' ],
				'permission_callback' => [ $this, 'permissions_check' ],
				'args'                => $this->get_settings_params(),
			],
		] );
	}

	/**
	 * Get a collection of logs.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 * @return \WP_REST_Response|\WP_Error
	 */
	public function get_items( $request ) {
		$args =[
			'page'     => (int) $request->get_param( 'page' ),
			'per_page' => (int) $request->get_param( 'per_page' ),
			'where'    => []
		];

		if ( $status = $request->get_param( 'status' ) ) {
			$args['where'][] =[ 'key' => 'status', 'value' => $status ];
		}

		if ( $module = $request->get_param( 'module' ) ) {
			$args['where'][] =[ 'key' => 'module', 'value' => $module ];
		}

		if ( $search = $request->get_param( 'search' ) ) {
			$args['where'][] =[ 'key' => 'title', 'value' => $search, 'compare' => 'LIKE' ];
		}

		// Best-effort entity filters: the storeengine_logs.content column holds a
		// JSON blob (when Logger::log was called with an array). Most relevant
		// modules — checkout, gateways, abandoned-cart-email — pass order_id /
		// customer_id / abandoned_cart_id keys. Match via LIKE so per-entity
		// detail pages can surface "anything we logged about this order/customer/cart"
		// without us migrating every Logger call site to write structured columns.
		// Brittle if log writers stop including these keys, but acceptable as a
		// best-effort view (the canonical audit still lives in storeengine_email_log).
		if ( $order_id = (int) $request->get_param( 'order_id' ) ) {
			$args['where'][] = [
				'key'     => 'content',
				'value'   => '%"order_id":' . $order_id . '%',
				'compare' => 'LIKE',
			];
		}

		if ( $customer_id = (int) $request->get_param( 'customer_id' ) ) {
			$args['where'][] = [
				'key'     => 'content',
				'value'   => '%"customer_id":' . $customer_id . '%',
				'compare' => 'LIKE',
			];
		}

		if ( $abc_id = (int) $request->get_param( 'abandoned_cart_id' ) ) {
			$args['where'][] = [
				'key'     => 'content',
				'value'   => '%"abandoned_cart":' . $abc_id . '%',
				'compare' => 'LIKE',
			];
		}

		$collection = new LogItemCollection( $args );

		$results = $collection->get_results();
		$data    =[];

		foreach ( $results as $log ) {
			$data[] = $log->get_data();
		}

		$response = rest_ensure_response( $data );
		$response->header( 'X-WP-Total', (string) $collection->get_found_results() );
		$response->header( 'X-WP-TotalPages', (string) $collection->get_max_num_pages() );

		return $response;
	}

	/**
	 * Delete single or multiple logs.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 * @return \WP_REST_Response|\WP_Error
	 */
	public function delete_items( $request ) {
		$ids = $request->get_param( 'ids' );

		if ( empty( $ids ) || ! is_array( $ids ) ) {
			return new WP_Error( 'invalid_log_ids', __( 'Invalid or empty IDs provided.', 'storeengine' ), [ 'status' => 400 ] );
		}

		$query = new LogItemCollection( [
			'per_page' => - 1,
			'where'    => [
				'key'     => 'id',
				'value'   => array_filter( array_unique( array_map( 'absint', $ids ) ) ),
				'compare' => 'IN',
			]
		] );

		$deleted = [];

		while ( $query->have_results() ) {
			$query->the_result();
			global $log;

			try {
				$id = $log->get_id();
				$log->delete( true );
				$deleted[] = $id;
			} catch ( \Throwable $e ) {
				// No op.
			}
		}

		$deleted_count = count( $deleted );

		return rest_ensure_response( [
			'message' => sprintf(
			// translators: %d is the number of deleted logs.
				_n( '%d log deleted successfully.', '%d logs deleted successfully.', $deleted_count, 'storeengine' ),
				$deleted_count
			),
			'deleted' => $deleted,
		] );
	}

	/**
	 * Retrieve log cleanup settings from the database.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 * @return \WP_REST_Response|\WP_Error
	 */
	public function get_settings( $request ) {
		$settings = get_option( 'storeengine_log_settings',[
			'retention_days'   => 30,
			'cleanup_statuses' => [ 'success' ]
		] );

		return rest_ensure_response( $settings );
	}

	/**
	 * Save log cleanup settings to the database.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 * @return \WP_REST_Response|\WP_Error
	 */
	public function save_settings( $request ) {
		$retention_days   = (int) $request->get_param( 'retention_days' );
		$cleanup_statuses = $request->get_param( 'cleanup_statuses' );

		// Security check: Fallback to an empty array if not a valid array.
		if ( ! is_array( $cleanup_statuses ) ) {
			$cleanup_statuses = [];
		}

		$settings =[
			'retention_days'   => $retention_days,
			'cleanup_statuses' => array_map( 'sanitize_text_field', $cleanup_statuses )
		];

		update_option( 'storeengine_log_settings', $settings );

		return rest_ensure_response([
			'message'  => __( 'Log settings saved successfully.', 'storeengine' ),
			'settings' => $settings
		] );
	}

	/**
	 * Check if a given request has access to the logs.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 * @return bool|\WP_Error
	 */
	public function permissions_check( $request ) {
		return Helper::check_rest_user_cap( 'manage_options' );
	}

	/**
	 * Get the query params for collections.
	 *
	 * @return array
	 */
	public function get_collection_params(): array {
		return [
			'page'              => [ 'default' => 1, 'sanitize_callback' => 'absint' ],
			'per_page'          => [ 'default' => 20, 'sanitize_callback' => 'absint' ],
			'status'            => [ 'sanitize_callback' => 'sanitize_text_field' ],
			'module'            => [ 'sanitize_callback' => 'sanitize_text_field' ],
			'search'            => [ 'sanitize_callback' => 'sanitize_text_field' ],
			'order_id'          => [ 'sanitize_callback' => 'absint' ],
			'customer_id'       => [ 'sanitize_callback' => 'absint' ],
			'abandoned_cart_id' => [ 'sanitize_callback' => 'absint' ],
		];
	}

	/**
	 * Get the validation parameters for saving settings.
	 *
	 * @return array
	 */
	public function get_settings_params(): array {
		return [
			'retention_days' =>[
				'required'          => true,
				'type'              => 'integer',
				'sanitize_callback' => 'absint'
			],
			'cleanup_statuses' =>[
				'required'          => true,
				'type'              => 'array',
				'items'             =>[
					'type' => 'string'
				]
			]
		];
	}
}

```