Function Reference

Learn how to use the helpers module to access system paths and constants in EverShop.

Read configuration values from the application configuration files.

Read environment variable values with optional default values.

Wrap a function to make it hookable, allowing hooks to run before or after execution.

Get values from the registry asynchronously with optional processing and validation.

Register a callback to run before a hookable function executes.

Get values from the registry synchronously with optional processing and validation.

Register a callback to run after a hookable function executes.

Register processors to transform registry values.

Register a final processor that always executes last in the processor pipeline.

Get the base URL of the shop.

Template translation function with variable interpolation.

Server-side translation function with CSV file support.

Build a URL from a route ID and parameters.

Build an absolute URL from a route ID (server-side only).

Format and round price values.

Get a value from GraphQL context by key.

Set a value in GraphQL context at request or application level.

Get all context values merged from application and request levels.

Check if a context key exists at request or application level.

Get a setting value from the database.

Convert an object's keys from snake_case or kebab-case to camelCase.

Hash, compare, and validate passwords using bcrypt.

Register sources of sitemap URLs and generate the sitemap set.

Build, parse and register stable cross-module entity identifiers.

Define, validate, shape and provision custom metafields on core entities.

Wrap a function to make it hookable, allowing hooks to run before or after execution.

Learn how to use the Event Emitter to emit and subscribe to events asynchronously in EverShop.

Emit an event to trigger registered subscribers.

Create a type-safe event subscriber with automatic data typing.

Register a new widget in the widget manager.

Update properties of an existing widget.

Remove a widget from the widget manager.

Retrieve registered widgets from the widget manager.

Resolve stored widget link URNs to current URLs, batched per request.

PostgreSQL connection pool instance.

Get a dedicated PostgreSQL database connection from the pool.

Create a SELECT query using the query builder.

Insert a new record into the database.

Update existing records in the database.

Start a database transaction.

Commit a database transaction.

Rollback a database transaction.

Delete records from the database.

Insert a row or update it if a conflict occurs on the specified columns.

Register a new payment method, with optional capture, void and refund handlers, in the EverShop checkout system.

Get cart by session ID or customer ID.

Create a new shopping cart.

Get cart by UUID.

Get available payment methods for checkout.

Save cart to database.

Format and round price values.

Create an order from a cart.

Add shipping address to cart.

Removes an item from the cart by its UUID. A hookable checkout service.

Adds an item to the cart, merging quantities when the same SKU is already there. A hookable checkout service.

Register shipping providers and resolve shipping quotes at checkout.

Register a scheduled job (cronjob) in the job manager.

Update the schedule of an existing cronjob.

Remove a scheduled job from the job manager.

Retrieve registered cron jobs from the job manager.

Log debug messages.

Log error messages.

Log warning messages.

Log informational messages.

Log success messages.

Login an admin user with email and password.

Logout the currently logged-in admin user.

Check if an admin user is currently logged in.

Get the currently logged-in admin user data.

Login a customer with email and password.

Logout the currently logged-in customer.

Check if a customer is currently logged in.

Get the currently logged-in customer data.

Hash, compare, and validate passwords using bcrypt.

Get base query for categories with description joined.

Get base query for collections.

Get base query for products with descriptions, inventory, and images joined.

Get base query for products filtered by category with optional subcategories.

Get base query for products filtered by collection.

Create a new product with inventory, attributes, and images.

Update an existing product.

Delete a product.

Create a new category.

Update an existing category.

Delete a category.

Create a new collection.

Update an existing collection.

Delete a collection.

Create a new product attribute.

Update an existing product attribute.

Delete a product attribute.

Define, validate, shape and provision custom metafields on core entities.

Browse files and folders at a storage path.

Create a folder in the store's file storage.

Delete a file from the store's file storage.

Upload files to the store's file storage.

Get base query for customers table.

Create a new customer with validation and password hashing.

Update customer profile information.

Delete a customer account.

Update customer password with validation and hashing.

Create a new customer address with validation.

Update an existing customer address with validation.

Delete a customer address.

Create a new coupon with discount rules and conditions.

Update an existing coupon.

Delete a coupon.

Create, update, delete and duplicate promotion landing pages.

Create a new CMS page.

Update an existing CMS page.

Delete a CMS page.

Validate an address against its country's address schema.

Add a custom validation rule that runs after the schema checks.

Change a country's address format record from an extension.

Provide the selectable regions (states, cities, wards) of a country.

Add an extra address field without a migration.

Resolve the address form of a country: fields, labels, requiredness, patterns.

Print an address as display lines in the layout of its country.

Map a stored address to the consumer-neutral shape payment and carrier integrations build their payloads from.

Create a shipment for an order.

Cancel an order, release an uncaptured authorization and restock inventory.

Update order payment status.

Update the status of a single shipment.

Register a custom payment status in the OMS system.

Register a custom shipment status in the OMS system.

Register a custom order status with allowed transitions.

Register a mapping from payment+shipment status to order status.

Retrieve registered order, payment, and shipment status lists.

Add an activity log entry to an order.

Load order data with items and addresses.

Record a payment transaction for an order.

Read shipments, compute the order shipment rollup, and integrate carriers.

Capture the authorized payment of an order through its payment method's capture handler.

Refund a captured payment, in full or in part, through the order's payment method's refund handler.

Record a refund that already happened at the payment provider, set the payment status and emit order_refunded.

Store a write-once value on the request for sharing data between middleware.

Retrieve a delegate value set by an earlier middleware in the request pipeline.

Check if a delegate value exists on the request.

Register a custom email service provider for sending emails.

Send an email using the registered email service.

Retrieve and refresh store settings.

Read merchant-configured store settings, synchronously or asynchronously.