API / Minn / RestError

RestError final class

Minn\RestError · public/minn/src/Minn/RestError.php · 60 lines · implements Stringable, Throwable · extends RuntimeException

A WordPress-shaped error, thrown from anywhere and rendered once by the kernel: {"code": ..., "message": ..., "data": {"status": ...}}.

Used by 65 (show)

Admin\EditorController Admin\LanguageController Admin\OverviewController Admin\PackagesController Admin\PreferencesController Admin\RenderController Admin\SessionsController Admin\SystemController Admin\ThemesController Admin\Translations Admin\UpdatesController Cli\AssetUpdate Cli\DirectorySearch Cli\PackageInstaller Engine Http\Envelope Http\Kernel Http\Router Media\Upload Ops\Archive Ops\CoreStatus Ops\Directory Ops\Logs Ops\Packages Ops\Updates Ops\UpgraderRun Rest\Api Rest\ApplicationPasswordsController Rest\ArgCheck Rest\BatchController Rest\BlockRendererController Rest\BlockTypesController Rest\BlocksController Rest\Caller Rest\CommentsController Rest\Embed Rest\ExistingPost Rest\GlobalStylesController Rest\InstalledThemesController Rest\LiveSettings Rest\MediaController Rest\MenusController Rest\PluginsController Rest\PolicyGate Rest\PostsController Rest\PostsWriteController Rest\RegisteredFields Rest\Reply Rest\RestMeta Rest\RevisionsController Rest\RuntimeEnvelope Rest\RuntimeRoutes Rest\SearchController Rest\SettingsController Rest\SidebarsController Rest\StatusesController Rest\TemplatesController Rest\TermsController Rest\UsersController Rest\WidgetsController Runtime\CommentEvents Runtime\MenuEvents Runtime\PostSave Runtime\TermEvents Runtime\UserEvents

Constants and properties

prop	`readonly string $errorCode`	Promoted from the constructor.
prop	`readonly int $status`	Promoted from the constructor.
prop	`readonly array $extra`	Promoted from the constructor.
prop	`readonly array $topLevel`	Promoted from the constructor.
private	`readonly bool $bare`	Promoted from the constructor.

Public

new

__construct(string $errorCode, string $message, int $status, array $extra = array ( ), array $topLevel = array ( ), bool $bare = false)

`$extra`	`array<string, mixed>`	keys added beside status inside data (the whole of data when it names status)
`$topLevel`	`array<string, mixed>`	keys added beside code/message/data

static

noRoute(): self#

The reference's 404 for a route nothing answers.

static

missingParams(array $params): self#

The reference's 400 for required parameters that did not arrive.

$params list<string>

static

invalidParam(string $param, string $message, string $code = 'rest_not_in_enum', mixed $data = NULL): self#

The reference's 400 for one parameter its schema refuses: the message under params, and under details with the refusal's code and data, as WP_REST_Request::has_valid_params reports it.

static

bare(string $code, string $message): self#

A statusless core error as REST serves it: HTTP 500 with data null.

method

payload(): array#

The error as the reference's JSON body: code, message, data.