(JavaScript) WordPress Media Upload

See more WordPress Examples

For more information, see https://developer.wordpress.org/rest-api/reference/media/#create-a-media-item

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var http = new CkHttp();

// This example will use WordPress username / Application password authentication using the "Applications Password" plugin.
// See https://wordpress.org/plugins/application-passwords/

// Use your WordPress login, such as "admin", not the application name.
http.Login = "wp_username";
// Use the application password, such as "Nths RwVH eDJ4 weNZ orMN jabq"
http.Password = "app_password";
http.BasicAuth = true;

var req = new CkHttpRequest();
req.HttpVerb = "POST";

// Use the Content-Type that corresponds to the type of file you are uploading.

// WordPress supports uploading the following file types:

// Images
// 
//     .jpg  (image/jpg)
//     .jpeg  (image/jpeg)
//     .png  (image/png)
//     .gif  (image/gif)
//     .ico (image/x-icon)
// 
// Documents
// 
//     .pdf (applicatin/pdf)
//     .doc, .docx (application/msword)
//     .ppt, .pptx, .pps, .ppsx (application/mspowerpoint)
//     .odt 
//     .xls, .xlsx (application/msexcel)
//     .psd (??? image/vnd.adobe.photoshop,application/x-photoshop,application/photoshop,application/psd,image/psd)
// 
// Audio
// 
//     .mp3 (audio/mpeg)
//     .m4a
//     .ogg
//     .wav (audio/wav)
// 
// Video
// 
//     .mp4, .m4v (video/mp4)
//     .mov (video/quicktime)
//     .wmv (video/x-ms-wmv)
//     .avi (video/avi)
//     .mpg (video/mpeg)
//     .ogv 
//     .3gp 
//     .3g2 

req.ContentType = "image/jpg";
req.Path = "/wp-json/wp/v2/media";

success = req.LoadBodyFromFile("qa_data/jpg/starfish.jpg");
if (success == false) {
    console.log(req.LastErrorText);
    return;
}

req.AddHeader("Content-Disposition","attachment; filename=starfish.jpg");

req.AddHeader("Expect","100-continue");

var resp = new CkHttpResponse();
success = http.HttpSReq("www.yourserver.com",443,true,req,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

console.log("HTTP response status: " + resp.StatusCode);

var jsonResponse = new CkJsonObject();
jsonResponse.Load(resp.BodyStr);

jsonResponse.EmitCompact = false;
console.log(jsonResponse.Emit());

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": 1915,
//   "date": "2021-01-19T18:25:01",
//   "date_gmt": "2021-01-20T01:25:01",
//   "guid": {
//     "rendered": "http:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg",
//     "raw": "http:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg"
//   },
//   "modified": "2021-01-19T18:25:01",
//   "modified_gmt": "2021-01-20T01:25:01",
//   "slug": "starfish",
//   "status": "inherit",
//   "type": "attachment",
//   "link": "https:\/\/cknotes.com\/starfish\/",
//   "title": {
//     "raw": "starfish",
//     "rendered": "starfish"
//   },
//   "author": 1,
//   "comment_status": "closed",
//   "ping_status": "closed",
//   "template": "",
//   "meta": [
//   ],
//   "permalink_template": "https:\/\/cknotes.com\/?attachment_id=1915",
//   "generated_slug": "starfish",
//   "description": {
//     "raw": "",
//     "rendered": "<p class=\"attachment\"><a href='https:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg'><img width=\"120\" height=\"120\" src=\"https:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg\" class=\"attachment-medium size-medium\" alt=\"\" loading=\"lazy\" srcset=\"http:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg 120w, http:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish-100x100.jpg 100w\" sizes=\"(max-width: 120px) 100vw, 120px\" \/><\/a><\/p>\n"
//   },
//   "caption": {
//     "raw": "",
//     "rendered": ""
//   },
//   "alt_text": "",
//   "media_type": "image",
//   "mime_type": "image\/jpeg",
//   "media_details": {
//     "width": 120,
//     "height": 120,
//     "file": "2021\/01\/starfish.jpg",
//     "sizes": {
//       "woocommerce_gallery_thumbnail": {
//         "file": "starfish-100x100.jpg",
//         "width": 100,
//         "height": 100,
//         "mime_type": "image\/jpeg",
//         "source_url": "https:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish-100x100.jpg"
//       },
//       "shop_thumbnail": {
//         "file": "starfish-100x100.jpg",
//         "width": 100,
//         "height": 100,
//         "mime_type": "image\/jpeg",
//         "source_url": "https:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish-100x100.jpg"
//       },
//       "full": {
//         "file": "starfish.jpg",
//         "width": 120,
//         "height": 120,
//         "mime_type": "image\/jpeg",
//         "source_url": "https:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg"
//       }
//     },
//     "image_meta": {
//       "aperture": "0",
//       "credit": "",
//       "camera": "",
//       "caption": "",
//       "created_timestamp": "0",
//       "copyright": "",
//       "focal_length": "0",
//       "iso": "0",
//       "shutter_speed": "0",
//       "title": "",
//       "orientation": "0",
//       "keywords": [
//       ]
//     }
//   },
//   "post": null,
//   "source_url": "https:\/\/cknotes.com\/wp-content\/uploads\/2021\/01\/starfish.jpg",
//   "missing_image_sizes": [
//   ],
//   "_links": {
//     "self": [
//       {
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/media\/1915"
//       }
//     ],
//     "collection": [
//       {
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/media"
//       }
//     ],
//     "about": [
//       {
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/types\/attachment"
//       }
//     ],
//     "author": [
//       {
//         "embeddable": true,
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/users\/1"
//       }
//     ],
//     "replies": [
//       {
//         "embeddable": true,
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/comments?post=1915"
//       }
//     ],
//     "wp:action-unfiltered-html": [
//       {
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/media\/1915"
//       }
//     ],
//     "wp:action-assign-author": [
//       {
//         "href": "https:\/\/cknotes.com\/wp-json\/wp\/v2\/media\/1915"
//       }
//     ],
//     "curies": [
//       {
//         "name": "wp",
//         "href": "https:\/\/api.w.org\/{rel}",
//         "templated": true
//       }
//     ]
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

var date_gmt = new CkDtObj();
var href;
var embeddable;
var name;
var templated;

var id = jsonResponse.IntOf("id");
var date = jsonResponse.StringOf("date");
jsonResponse.DtOf("date_gmt",false,date_gmt);
var guidRendered = jsonResponse.StringOf("guid.rendered");
var guidRaw = jsonResponse.StringOf("guid.raw");
var modified = jsonResponse.StringOf("modified");
var modified_gmt = jsonResponse.StringOf("modified_gmt");
var slug = jsonResponse.StringOf("slug");
var status = jsonResponse.StringOf("status");
var v_type = jsonResponse.StringOf("type");
var link = jsonResponse.StringOf("link");
var titleRaw = jsonResponse.StringOf("title.raw");
var titleRendered = jsonResponse.StringOf("title.rendered");
var author = jsonResponse.IntOf("author");
var comment_status = jsonResponse.StringOf("comment_status");
var ping_status = jsonResponse.StringOf("ping_status");
var template = jsonResponse.StringOf("template");
var permalink_template = jsonResponse.StringOf("permalink_template");
var generated_slug = jsonResponse.StringOf("generated_slug");
var descriptionRaw = jsonResponse.StringOf("description.raw");
var descriptionRendered = jsonResponse.StringOf("description.rendered");
var captionRaw = jsonResponse.StringOf("caption.raw");
var captionRendered = jsonResponse.StringOf("caption.rendered");
var alt_text = jsonResponse.StringOf("alt_text");
var media_type = jsonResponse.StringOf("media_type");
var mime_type = jsonResponse.StringOf("mime_type");
var media_detailsWidth = jsonResponse.IntOf("media_details.width");
var media_detailsHeight = jsonResponse.IntOf("media_details.height");
var media_detailsFile = jsonResponse.StringOf("media_details.file");
var media_detailsSizesWoocommerce_gallery_thumbnailFile = jsonResponse.StringOf("media_details.sizes.woocommerce_gallery_thumbnail.file");
var media_detailsSizesWoocommerce_gallery_thumbnailWidth = jsonResponse.IntOf("media_details.sizes.woocommerce_gallery_thumbnail.width");
var media_detailsSizesWoocommerce_gallery_thumbnailHeight = jsonResponse.IntOf("media_details.sizes.woocommerce_gallery_thumbnail.height");
var media_detailsSizesWoocommerce_gallery_thumbnailMime_type = jsonResponse.StringOf("media_details.sizes.woocommerce_gallery_thumbnail.mime_type");
var media_detailsSizesWoocommerce_gallery_thumbnailSource_url = jsonResponse.StringOf("media_details.sizes.woocommerce_gallery_thumbnail.source_url");
var media_detailsSizesShop_thumbnailFile = jsonResponse.StringOf("media_details.sizes.shop_thumbnail.file");
var media_detailsSizesShop_thumbnailWidth = jsonResponse.IntOf("media_details.sizes.shop_thumbnail.width");
var media_detailsSizesShop_thumbnailHeight = jsonResponse.IntOf("media_details.sizes.shop_thumbnail.height");
var media_detailsSizesShop_thumbnailMime_type = jsonResponse.StringOf("media_details.sizes.shop_thumbnail.mime_type");
var media_detailsSizesShop_thumbnailSource_url = jsonResponse.StringOf("media_details.sizes.shop_thumbnail.source_url");
var media_detailsSizesFullFile = jsonResponse.StringOf("media_details.sizes.full.file");
var media_detailsSizesFullWidth = jsonResponse.IntOf("media_details.sizes.full.width");
var media_detailsSizesFullHeight = jsonResponse.IntOf("media_details.sizes.full.height");
var media_detailsSizesFullMime_type = jsonResponse.StringOf("media_details.sizes.full.mime_type");
var media_detailsSizesFullSource_url = jsonResponse.StringOf("media_details.sizes.full.source_url");
var media_detailsImage_metaAperture = jsonResponse.StringOf("media_details.image_meta.aperture");
var media_detailsImage_metaCredit = jsonResponse.StringOf("media_details.image_meta.credit");
var media_detailsImage_metaCamera = jsonResponse.StringOf("media_details.image_meta.camera");
var media_detailsImage_metaCaption = jsonResponse.StringOf("media_details.image_meta.caption");
var media_detailsImage_metaCreated_timestamp = jsonResponse.StringOf("media_details.image_meta.created_timestamp");
var media_detailsImage_metaCopyright = jsonResponse.StringOf("media_details.image_meta.copyright");
var media_detailsImage_metaFocal_length = jsonResponse.StringOf("media_details.image_meta.focal_length");
var media_detailsImage_metaIso = jsonResponse.StringOf("media_details.image_meta.iso");
var media_detailsImage_metaShutter_speed = jsonResponse.StringOf("media_details.image_meta.shutter_speed");
var media_detailsImage_metaTitle = jsonResponse.StringOf("media_details.image_meta.title");
var media_detailsImage_metaOrientation = jsonResponse.StringOf("media_details.image_meta.orientation");
var post = jsonResponse.StringOf("post");
var source_url = jsonResponse.StringOf("source_url");
var i = 0;
var count_i = jsonResponse.SizeOfArray("meta");
while (i < count_i) {
    jsonResponse.I = i;
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("media_details.image_meta.keywords");
while (i < count_i) {
    jsonResponse.I = i;
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("missing_image_sizes");
while (i < count_i) {
    jsonResponse.I = i;
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.self");
while (i < count_i) {
    jsonResponse.I = i;
    href = jsonResponse.StringOf("_links.self[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.collection");
while (i < count_i) {
    jsonResponse.I = i;
    href = jsonResponse.StringOf("_links.collection[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.about");
while (i < count_i) {
    jsonResponse.I = i;
    href = jsonResponse.StringOf("_links.about[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.author");
while (i < count_i) {
    jsonResponse.I = i;
    embeddable = jsonResponse.BoolOf("_links.author[i].embeddable");
    href = jsonResponse.StringOf("_links.author[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.replies");
while (i < count_i) {
    jsonResponse.I = i;
    embeddable = jsonResponse.BoolOf("_links.replies[i].embeddable");
    href = jsonResponse.StringOf("_links.replies[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.wp:action-unfiltered-html");
while (i < count_i) {
    jsonResponse.I = i;
    href = jsonResponse.StringOf("_links.wp:action-unfiltered-html[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.wp:action-assign-author");
while (i < count_i) {
    jsonResponse.I = i;
    href = jsonResponse.StringOf("_links.wp:action-assign-author[i].href");
    i = i+1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("_links.curies");
while (i < count_i) {
    jsonResponse.I = i;
    name = jsonResponse.StringOf("_links.curies[i].name");
    href = jsonResponse.StringOf("_links.curies[i].href");
    templated = jsonResponse.BoolOf("_links.curies[i].templated");
    i = i+1;
}