enmi-conf.org: comparison wp/wp-includes/rest-api/class-wp-rest-request.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 * 2 (`POST`) not 1 (`GET`). For more precision between request methods, use
 * WP_REST_Request::get_body_params(), WP_REST_Request::get_url_params(), etc.
 *
 * @since 4.4.0
 *
-* @see ArrayAccess
+* @link https://www.php.net/manual/en/class.arrayaccess.php
 */
 class WP_REST_Request implements ArrayAccess {
 	/**
 	 * HTTP method.
 	/**
 	 * Retrieves the content-type of the request.
 	 *
 	 * @since 4.4.0
 	 *
-	 * @return array Map containing 'value' and 'parameters' keys.
+	 * @return array|null Map containing 'value' and 'parameters' keys
+	 *                    or null when no valid content-type header was
+	 *                    available.
 	 */
 	public function get_content_type() {
 		$value = $this->get_header( 'content-type' );
 		if ( empty( $value ) ) {
 			return null;
 		if ( strpos( $value, ';' ) ) {
 			list( $value, $parameters ) = explode( ';', $value, 2 );
 		}
 		$value = strtolower( $value );
-		if ( strpos( $value, '/' ) === false ) {
+		if ( false === strpos( $value, '/' ) ) {
 			return null;
 		}
 		// Parse type and subtype out.
 		list( $type, $subtype ) = explode( '/', $value, 2 );
 	 *
 	 * Used when checking parameters in get_param().
 	 *
 	 * @since 4.4.0
 	 *
-	 * @return array List of types to check, in order of priority.
+	 * @return string[] Array of types to check, in order of priority.
 	 */
 	protected function get_parameter_order() {
 		$order = array();
 		$content_type = $this->get_content_type();
-		if ( $content_type['value'] === 'application/json' ) {
+		if ( isset( $content_type['value'] ) && 'application/json' === $content_type['value'] ) {
 			$order[] = 'JSON';
 		}
 		$this->parse_json_params();
 		if ( 'POST' !== $this->method && ! empty( $body ) ) {
 			$this->parse_body_params();
 		}
 		$accepts_body_data = array( 'POST', 'PUT', 'PATCH', 'DELETE' );
-		if ( in_array( $this->method, $accepts_body_data ) ) {
+		if ( in_array( $this->method, $accepts_body_data, true ) ) {
 			$order[] = 'POST';
 		}
 		$order[] = 'GET';
 		$order[] = 'URL';
 		 * The order affects which parameters are checked when using get_param() and family.
 		 * This acts similarly to PHP's `request_order` setting.
 		 *
 		 * @since 4.4.0
 		 *
-		 * @param array           $order {
+		 * @param string[]        $order Array of types to check, in order of priority.
-		 *    An array of types to check, in order of priority.
+		 * @param WP_REST_Request $this  The request object.
-		 *
-		 * @param string $type The type to check.
-		 * }
-		 * @param WP_REST_Request $this The request object.
 		 */
 		return apply_filters( 'rest_request_parameter_order', $order, $this );
 	}
 	/**
 		return null;
 	}
 	/**
+	 * Checks if a parameter exists in the request.
+	 *
+	 * This allows distinguishing between an omitted parameter,
+	 * and a parameter specifically set to null.
+	 *
+	 * @since 5.3.0
+	 *
+	 * @param string $key Parameter name.
+	 * @return bool True if a param exists for the given key.
+	 */
+	public function has_param( $key ) {
+		$order = $this->get_parameter_order();
+		foreach ( $order as $type ) {
+			if ( is_array( $this->params[ $type ] ) && array_key_exists( $key, $this->params[ $type ] ) ) {
+				return true;
+			}
+		}
+		return false;
+	}
+	/**
 	 * Sets a parameter on the request.
+	 *
+	 * If the given parameter key exists in any parameter type an update will take place,
+	 * otherwise a new param will be created in the first parameter type (respecting
+	 * get_parameter_order()).
 	 *
 	 * @since 4.4.0
 	 *
 	 * @param string $key   Parameter name.
 	 * @param mixed  $value Parameter value.
 	 */
 	public function set_param( $key, $value ) {
-		$order                             = $this->get_parameter_order();
+		$order     = $this->get_parameter_order();
-		$this->params[ $order[0] ][ $key ] = $value;
+		$found_key = false;
+		foreach ( $order as $type ) {
+			if ( 'defaults' !== $type && is_array( $this->params[ $type ] ) && array_key_exists( $key, $this->params[ $type ] ) ) {
+				$this->params[ $type ][ $key ] = $value;
+				$found_key                     = true;
+			}
+		}
+		if ( ! $found_key ) {
+			$this->params[ $order[0] ][ $key ] = $value;
+		}
 	}
 	/**
 	 * Retrieves merged parameters from the request.
 	 *
 		$order = $this->get_parameter_order();
 		$order = array_reverse( $order, true );
 		$params = array();
 		foreach ( $order as $type ) {
-			// array_merge / the "+" operator will mess up
+			// array_merge() / the "+" operator will mess up
 			// numeric keys, so instead do a manual foreach.
 			foreach ( (array) $this->params[ $type ] as $key => $value ) {
 				$params[ $key ] = $value;
 			}
 		}
 		$params = json_decode( $body, true );
 		/*
 		 * Check for a parsing error.
-		 *
-		 * Note that due to WP's JSON compatibility functions, json_last_error
-		 * might not be defined: https://core.trac.wordpress.org/ticket/27799
 		 */
-		if ( null === $params && ( ! function_exists( 'json_last_error' ) || JSON_ERROR_NONE !== json_last_error() ) ) {
+		if ( null === $params && JSON_ERROR_NONE !== json_last_error() ) {
 			// Ensure subsequent calls receive error instance.
 			$this->parsed_json = false;
 			$error_data = array(
-				'status' => WP_Http::BAD_REQUEST,
+				'status'             => WP_Http::BAD_REQUEST,
+				'json_error_code'    => json_last_error(),
+				'json_error_message' => json_last_error_msg(),
 			);
-			if ( function_exists( 'json_last_error' ) ) {
-				$error_data['json_error_code']    = json_last_error();
-				$error_data['json_error_message'] = json_last_error_msg();
-			}
 			return new WP_Error( 'rest_invalid_json', __( 'Invalid JSON body passed.' ), $error_data );
 		}
 		$this->params['JSON'] = $params;
 		return true;
 	}
 	/**
 	 * Parses the request body parameters.
 		}
 		parse_str( $this->get_body(), $params );
 		/*
-		 * Amazingly, parse_str follows magic quote rules. Sigh.
-		 *
-		 * NOTE: Do not refactor to use `wp_unslash`.
-		 */
-		if ( get_magic_quotes_gpc() ) {
-			$params = stripslashes_deep( $params );
-		}
-		/*
 		 * Add to the POST parameters stored internally. If a user has already
 		 * set these manually (via `set_body_params`), don't override them.
 		 */
 		$this->params['POST'] = array_merge( $params, $this->params['POST'] );
 	}
 		foreach ( $order as $type ) {
 			if ( empty( $this->params[ $type ] ) ) {
 				continue;
 			}
 			foreach ( $this->params[ $type ] as $key => $value ) {
 				if ( ! isset( $attributes['args'][ $key ] ) ) {
 					continue;
 				}
 				$param_args = $attributes['args'][ $key ];
 				// If the arg has a type but no sanitize_callback attribute, default to rest_parse_request_arg.
 				if ( ! array_key_exists( 'sanitize_callback', $param_args ) && ! empty( $param_args['type'] ) ) {
 					$param_args['sanitize_callback'] = 'rest_parse_request_arg';
 		}
 		if ( $invalid_params ) {
 			return new WP_Error(
 				'rest_invalid_param',
+				/* translators: %s: List of invalid parameters. */
 				sprintf( __( 'Invalid parameter(s): %s' ), implode( ', ', array_keys( $invalid_params ) ) ),
 				array(
 					'status' => 400,
 					'params' => $invalid_params,
 				)
 		}
 		if ( ! empty( $required ) ) {
 			return new WP_Error(
 				'rest_missing_callback_param',
+				/* translators: %s: List of required parameters. */
 				sprintf( __( 'Missing parameter(s): %s' ), implode( ', ', $required ) ),
 				array(
 					'status' => 400,
 					'params' => $required,
 				)
 		}
 		if ( $invalid_params ) {
 			return new WP_Error(
 				'rest_invalid_param',
+				/* translators: %s: List of invalid parameters. */
 				sprintf( __( 'Invalid parameter(s): %s' ), implode( ', ', array_keys( $invalid_params ) ) ),
 				array(
 					'status' => 400,
 					'params' => $invalid_params,
 				)
 		if ( get_option( 'permalink_structure' ) && 0 === strpos( $url, $api_root ) ) {
 			// Pretty permalinks on, and URL is under the API root.
 			$api_url_part = substr( $url, strlen( untrailingslashit( $api_root ) ) );
 			$route        = parse_url( $api_url_part, PHP_URL_PATH );
 		} elseif ( ! empty( $query_params['rest_route'] ) ) {
-			// ?rest_route=... set directly
+			// ?rest_route=... set directly.
 			$route = $query_params['rest_route'];
 			unset( $query_params['rest_route'] );
 		}
 		$request = false;

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a