1 | <?php |
||
11 | class WPCOM_REST_API_V2_Endpoint_Admin_Menu extends WP_REST_Controller { |
||
12 | /** |
||
13 | * Whether this is a wpcom-specific endpoint. |
||
14 | * |
||
15 | * @var bool |
||
16 | */ |
||
17 | public $wpcom_is_wpcom_only_endpoint = true; |
||
18 | |||
19 | /** |
||
20 | * Whether this is a site-specific endpoint. |
||
21 | * |
||
22 | * @var bool |
||
23 | */ |
||
24 | public $wpcom_is_site_specific_endpoint = true; |
||
25 | |||
26 | /** |
||
27 | * Namespace prefix. |
||
28 | * |
||
29 | * @var string |
||
30 | */ |
||
31 | public $namespace = 'wpcom/v2'; |
||
32 | |||
33 | /** |
||
34 | * Endpoint base route. |
||
35 | * |
||
36 | * @var string |
||
37 | */ |
||
38 | public $rest_base = 'admin-menu'; |
||
39 | |||
40 | /** |
||
41 | * WPCOM_REST_API_V2_Endpoint_Admin_Menu constructor. |
||
42 | */ |
||
43 | public function __construct() { |
||
46 | |||
47 | /** |
||
48 | * Register routes. |
||
49 | */ |
||
50 | public function register_routes() { |
||
62 | |||
63 | /** |
||
64 | * Checks if a given request has access to get a specific item. |
||
65 | * |
||
66 | * @param WP_REST_Request $request Full details about the request. |
||
67 | * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise. |
||
68 | */ |
||
69 | public function get_item_permissions_check( $request ) { // phpcs:ignore |
||
72 | |||
73 | /** |
||
74 | * Retrieves one item from the collection. |
||
75 | * |
||
76 | * @param WP_REST_Request $request Full details about the request. |
||
77 | * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
||
78 | */ |
||
79 | public function get_item( $request ) { |
||
87 | |||
88 | /** |
||
89 | * Prepares the item for the REST response. |
||
90 | * |
||
91 | * @param array $menu Admin menu. |
||
92 | * @param WP_REST_Request $request Request object. |
||
93 | * @return array Admin menu |
||
94 | */ |
||
95 | public function prepare_item_for_response( $menu, $request ) { // phpcs:ignore |
||
117 | |||
118 | /** |
||
119 | * Sets up a menu item for consumption by Calypso. |
||
120 | * |
||
121 | * @param array $menu_item Menu item. |
||
122 | * @return array Prepared menu item. |
||
123 | */ |
||
124 | private function prepare_menu_item( $menu_item ) { |
||
151 | |||
152 | /** |
||
153 | * Sets up a submenu item for consumption by Calypso. |
||
154 | * |
||
155 | * @param array $submenu_item Submenu item. |
||
156 | * @param array $menu_item Menu item. |
||
157 | * @return array Prepared submenu item. |
||
158 | */ |
||
159 | private function prepare_submenu_item( $submenu_item, $menu_item ) { |
||
174 | |||
175 | /** |
||
176 | * Prepares a menu icon for consumption by Calypso. |
||
177 | * |
||
178 | * @param string $icon Menu icon. |
||
179 | * @return string |
||
180 | */ |
||
181 | private function prepare_menu_item_icon( $icon ) { |
||
198 | |||
199 | /** |
||
200 | * Prepares a menu icon for consumption by Calypso. |
||
201 | * |
||
202 | * @param string $url Menu slug. |
||
203 | * @param string $parent_slug Parent menu item slug. |
||
|
|||
204 | * @return string |
||
205 | */ |
||
206 | private function prepare_menu_item_url( $url, $parent_slug = null ) { |
||
233 | } |
||
234 | |||
236 |
This check looks for
@param
annotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.