[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/rest-api/endpoints/ -> class-wp-rest-attachments-controller.php (summary)

REST API: WP_REST_Attachments_Controller class

File Size: 824 lines (26 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_REST_Attachments_Controller:: (13 methods):
  prepare_items_query()
  create_item_permissions_check()
  create_item()
  update_item()
  prepare_item_for_database()
  prepare_item_for_response()
  get_item_schema()
  upload_from_data()
  get_filename_from_disposition()
  get_collection_params()
  upload_from_file()
  get_media_types()
  check_upload_size()


Class: WP_REST_Attachments_Controller  - X-Ref

Core controller used to access attachments via the REST API.

prepare_items_query( $prepared_args = array()   X-Ref
Determines the allowed query_vars for a get_items() response and
prepares for WP_Query.

return: array Array of query arguments.
since: 4.7.0
param: array           $prepared_args Optional. Array of prepared arguments. Default empty array.
param: WP_REST_Request $request       Optional. Request to prepare items for.

create_item_permissions_check( $request )   X-Ref
Checks if a given request has access to create an attachment.

return: WP_Error|true Boolean true if the attachment may be created, or a WP_Error if not.
since: 4.7.0
param: WP_REST_Request $request Full details about the request.

create_item( $request )   X-Ref
Creates a single attachment.

return: WP_Error|WP_REST_Response Response object on success, WP_Error object on failure.
since: 4.7.0
param: WP_REST_Request $request Full details about the request.

update_item( $request )   X-Ref
Updates a single attachment.

return: WP_Error|WP_REST_Response Response object on success, WP_Error object on failure.
since: 4.7.0
param: WP_REST_Request $request Full details about the request.

prepare_item_for_database( $request )   X-Ref
Prepares a single attachment for create or update.

return: WP_Error|stdClass $prepared_attachment Post object.
since: 4.7.0
param: WP_REST_Request $request Request object.

prepare_item_for_response( $post, $request )   X-Ref
Prepares a single attachment output for response.

return: WP_REST_Response Response object.
since: 4.7.0
param: WP_Post         $post    Attachment object.
param: WP_REST_Request $request Request object.

get_item_schema()   X-Ref
Retrieves the attachment's schema, conforming to JSON Schema.

return: array Item schema as an array.
since: 4.7.0

upload_from_data( $data, $headers )   X-Ref
Handles an upload via raw POST data.

return: array|WP_Error Data from wp_handle_sideload().
since: 4.7.0
param: array $data    Supplied file data.
param: array $headers HTTP headers from the request.

get_filename_from_disposition( $disposition_header )   X-Ref
Parses filename from a Content-Disposition header value.

As per RFC6266:

content-disposition = "Content-Disposition" ":"
disposition-type *( ";" disposition-parm )

disposition-type    = "inline" | "attachment" | disp-ext-type
; case-insensitive
disp-ext-type       = token

disposition-parm    = filename-parm | disp-ext-parm

filename-parm       = "filename" "=" value
| "filename*" "=" ext-value

disp-ext-parm       = token "=" value
| ext-token "=" ext-value
ext-token           = <the characters in token, followed by "*">

return: string|null Filename if available, or null if not found.
since: 4.7.0
param: string[] $disposition_header List of Content-Disposition header values.

get_collection_params()   X-Ref
Retrieves the query params for collections of attachments.

return: array Query parameters for the attachment collection as an array.
since: 4.7.0

upload_from_file( $files, $headers )   X-Ref
Handles an upload via multipart/form-data ($_FILES).

return: array|WP_Error Data from wp_handle_upload().
since: 4.7.0
param: array $files   Data from the `$_FILES` superglobal.
param: array $headers HTTP headers from the request.

get_media_types()   X-Ref
Retrieves the supported media types.

Media types are considered the MIME type category.

return: array Array of supported media types.
since: 4.7.0

check_upload_size( $file )   X-Ref
Determine if uploaded file exceeds space quota on multisite.

Replicates check_upload_size().

return: true|WP_Error True if can upload, error for errors.
since: 4.9.8
param: array $file $_FILES array for a given file.



Generated: Wed Sep 18 01:00:03 2019 Cross-referenced by PHPXref 0.7.1