Changeset 36636 for trunk/src/wp-includes/rest-api/class-wp-rest-request.php

Timestamp:

02/23/2016 04:56:28 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Improve documentation for WP_REST_Request to highlight a caveat of ArrayAccess when it comes to passing similar arguments for multiple request methods.

Props danielbachhuber, DrewAPicture.
Fixes #35799.

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-request.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/class-wp-rest-request.php

@@ -16 +16 @@
  * used in that manner. It does not use ArrayObject (as we cannot rely on SPL),
  * so be aware it may have non-array behaviour in some cases.
+ *
+ * Note: When using features provided by ArrayAccess, be aware that WordPress deliberately
+ * does not distinguish between arguments of the same name for different request methods.
+ * For instance, in a request with `GET id=1` and `POST id=2`, `$request['id']` will equal
+ * 2 (`POST`) not 1 (`GET`). For more precision between request methods, use
+ * {@see WP_REST_Request::get_body_params()}, {@see WP_REST_Request::get_url_params()},
+ * etc.
  *
  * @since 4.4.0