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.

Get the base URL of the shop.

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.

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.

Register a new widget in the widget manager.

Update properties of an existing widget.

Remove a widget from the widget manager.

Emit an event to trigger registered subscribers.

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.

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

Update the schedule of an existing cronjob.

Remove a scheduled job 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.

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.

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.

Browse files and folders in media directory.

Create a folder in media directory.

Delete a file from media directory.

Upload files to media directory.

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.

Validate customer address data.

Add custom validation rule for customer addresses.

Cancel an order and restock inventory.

Update order payment status.

Update order shipment status.