Skip to content

Commit 2dc09c2

Browse files
Docs: Synchronize WP_REST_Server::check_authentication() docs with the filter.
Follow-up to [34928], [55693]. See #63166. git-svn-id: https://develop.svn.wordpress.org/trunk@61141 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 7c3e145 commit 2dc09c2

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ public function __construct() {
166166
*
167167
* @since 4.4.0
168168
*
169-
* @return WP_Error|null|true WP_Error indicates unsuccessful login, null indicates successful
170-
* or no authentication provided.
169+
* @return WP_Error|null|true WP_Error if authentication error occurred, null if authentication
170+
* method wasn't used, true if authentication succeeded.
171171
*/
172172
public function check_authentication() {
173173
/**
@@ -191,7 +191,7 @@ public function check_authentication() {
191191
*
192192
* @since 4.4.0
193193
*
194-
* @param WP_Error|null|true $errors WP_Error if authentication error, null if authentication
194+
* @param WP_Error|null|true $errors WP_Error if authentication error occurred, null if authentication
195195
* method wasn't used, true if authentication succeeded.
196196
*/
197197
return apply_filters( 'rest_authentication_errors', null );

0 commit comments

Comments
 (0)