NoteActionForbiddenException.php — WooCommerce 10.9.1

woocommerce / src / Internal / Admin / Notes / NoteActionForbiddenException.php

woocommerce / src / Internal / Admin / Notes Last commit date

NoteActionForbiddenException.php

37 lines

1	<?php
2	/**
3	* Note Action Forbidden Exception.
4	*/
5
6	declare( strict_types=1 );
7
8	namespace Automattic\WooCommerce\Internal\Admin\Notes;
9
10	defined( 'ABSPATH' ) \|\| exit;
11
12	/**
13	* Thrown by internal WooCommerce handlers on the `woocommerce_note_action[_*]`
14	* hooks to signal that the current user lacks the per-action capability the
15	* handler enforces.
16	*
17	* `Automattic\WooCommerce\Admin\API\NoteActions::trigger_note_action()` catches
18	* this exception and converts it to a 403 REST response. Any other exception
19	* type bubbles uncaught so genuine server faults are not masked as auth errors.
20	*
21	* Hook abort behavior: when a handler throws, `WP_Hook::do_action()` does not
22	* catch the exception, so any lower-priority callbacks registered on the same
23	* `woocommerce_note_action_<name>` hook are silently skipped, and
24	* `Notes::trigger_note_action()` does not run its post-hook
25	* `$note->set_status()`/`$note->save()` step — keeping the note actionable in
26	* the inbox.
27	*
28	* This is an internal contract used by first-party note-action handlers in the
29	* `Internal\\Admin\\Notes\\` namespace. Third-party extensions hooking into
30	* `woocommerce_note_action[_*]` should not rely on this class — its API and
31	* existence may change.
32	*
33	* @internal
34	* @since 10.9.0
35	*/
36	class NoteActionForbiddenException extends \Exception {}
37