IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Increase the specificity of various docblock parameter types and return types.

Browse Source 
See #48303
Built from https://develop.svn.wordpress.org/trunk@46823


git-svn-id: http://core.svn.wordpress.org/trunk@46623 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
2019-12-06 22:43:04 +00:00
parent 15a566edef
commit f93ee2ca76
27 changed files with 79 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/rest-api/endpoints/class-wp-rest-blocks-controller.php
View File

@@ -24,7 +24,7 @@ class WP_REST_Blocks_Controller extends WP_REST_Posts_Controller {
*
* @since 5.0.0
*
* @param object $post Post object that backs the block.
* @param WP_Post $post Post object that backs the block.
* @return bool Whether the block can be read.
*/
public function check_read_permission( $post ) {

2
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
View File

@@ -1664,7 +1664,7 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $comment Comment object.
* @param WP_Comment $comment Comment object.
* @return bool Whether the comment can be edited or deleted.
*/
protected function check_edit_permission( $comment ) {

6
wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php
View File

@@ -227,9 +227,9 @@ class WP_REST_Post_Types_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Response $response The response object.
* @param object $item The original post type object.
* @param WP_REST_Request $request Request used to generate the response.
* @param WP_REST_Response $response The response object.
* @param WP_Post_Type $post_type The original post type object.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( 'rest_prepare_post_type', $response, $post_type, $request );
}

16
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
View File

@@ -869,7 +869,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $post The deleted or trashed post.
* @param WP_Post $post The deleted or trashed post.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
*/
@@ -1145,8 +1145,8 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param string $post_status Post status.
* @param object $post_type Post type.
* @param string $post_status Post status.
* @param WP_Post_Type $post_type Post type.
* @return string|WP_Error Post status or WP_Error if lacking the proper permission.
*/
protected function handle_status_param( $post_status, $post_type ) {
@@ -1321,7 +1321,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object|string $post_type Post type name or object.
* @param WP_Post_Type|string $post_type Post type name or object.
* @return bool Whether the post type is allowed in REST.
*/
protected function check_is_post_type_allowed( $post_type ) {
@@ -1343,7 +1343,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $post Post object.
* @param WP_Post $post Post object.
* @return bool Whether the post can be read.
*/
public function check_read_permission( $post ) {
@@ -1386,7 +1386,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $post Post object.
* @param WP_Post $post Post object.
* @return bool Whether the post can be edited.
*/
protected function check_update_permission( $post ) {
@@ -1404,7 +1404,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $post Post object.
* @param WP_Post $post Post object.
* @return bool Whether the post can be created.
*/
protected function check_create_permission( $post ) {
@@ -1422,7 +1422,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $post Post object.
* @param WP_Post $post Post object.
* @return bool Whether the post can be deleted.
*/
protected function check_delete_permission( $post ) {

4
wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php
View File

@@ -781,7 +781,7 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
* @since 4.7.0
*
* @param WP_REST_Response $response The response object.
* @param object $item The original term object.
* @param WP_Term $item The original term object.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $item, $request );
@@ -792,7 +792,7 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* @since 4.7.0
*
* @param object $term Term object.
* @param WP_Term $term Term object.
* @return array Links for the given term.
*/
protected function prepare_links( $term ) {

2
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php
View File

@@ -961,7 +961,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* @since 4.7.0
*
* @param WP_REST_Response $response The response object.
* @param object $user User object used to create response.
* @param WP_User $user User object used to create response.
* @param WP_REST_Request $request Request object.
*/
return apply_filters( 'rest_prepare_user', $response, $user, $request );