Changeset 61141

Timestamp:

11/05/2025 10:10:07 AM (10 months ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize WP_REST_Server::check_authentication() docs with the filter.

Follow-up to [34928], [55693].

See #63166.

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-server.php (modified) (2 diffs)

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

@@ -167 +167 @@
          * @since 4.4.0
          *
-         * @return WP_Error|null|true WP_Error indicates unsuccessful login, null indicates successful
-         *                            or no authentication provided.
+         * @return WP_Error|null|true WP_Error if authentication error occurred, null if authentication
+         *                            method wasn't used, true if authentication succeeded.
          */
         public function check_authentication() {
@@ -192 +192 @@
                  * @since 4.4.0
                  *
-                 * @param WP_Error|null|true $errors WP_Error if authentication error, null if authentication
+                 * @param WP_Error|null|true $errors WP_Error if authentication error occurred, null if authentication
                  *                                   method wasn't used, true if authentication succeeded.
                  */