R/update-wp-post.R

In wordpressr: An API Wrapper for WordPress Site APIs

#' @title Update a WordPress Post
#'
#' @description Updates an existing WordPress post with new values.
#'
#' @param root_url The domain on which you wish to create the post.
#' @param user The username to be passed into the API call to create the post.
#' @param pass The password to be used in the API call to create the post.
#' To get this value, you must have the Application Passwords plugin
#' installed, and must create an application using that plugin via your WordPress admin panel;
#' there you will get the password needed.
#' @param title_val The title of the page you are creating.
#' @param excerpt_val The excerpt to be shown where your WordPress features excerpts of post.
#' @param content_val The content of the post.
#' @param fifu_val If the Featured Image From URL plugin is installed, users can specify a
#' remotely hosted image file to use as the featured image for the post.
#' This field defaults to a value of NULL.
#' @param status_val The status of the post. Can be one of 'draft','publish','pending','future',
#' 'private'.
#' @param post_id The ID of the post to be updated.
#' @param author_val The user ID of the author creating the post.
#' @param format_val The WordPress format to use. Defaults to 'standard'.
#' @param categories_val The category IDs the post is to be associated with;
#' comma separate in a character string if more than one.
#' @param tag_val The tag IDs the post is to be associated with; comma separate in a category
#' string if more than one.
#'
#' @return A list containing the status code of the API call. A status code of 200 indicates
#' the call was a success.
#'
#' @examples
#' \dontrun{
#'create_wp_post(root_url = 'https://domain.com',user = Sys.getenv('username'),
#'pass = Sys.getenv('password'),
#'title_val = 'post title',excerpt_val = 'post excerpt',
#'content_val = 'the post content as a string, with wordpress-accepted
#'<strong>html</strong> (or bbcode!)',
#'fifu_val = 'https://domain.com/image.png',
#'status_val = 'draft',post_id = 123,format_val = 'standard',categories_val = 1, tag_val = 1)
#'}
#'
#' @export update_wp_post
#' @import tibble
#' @import httr
#' @import dplyr

update_wp_post <- function(root_url,user,pass,title_val,excerpt_val ='',content_val,
                           fifu_val = NULL,status_val,post_id,author_val,
                           format_val = 'standard',categories_val, tag_val = '') {

  pb <- list(title = title_val,
             excerpt = excerpt_val,
             content = content_val,
             fifu = fifu_val,
             status = status_val,
             author=author_val,
             format=format_val,
             categories=categories_val,
             tags = tag_val)
  pb <- ifelse(is.null(fifu_val),within(pb, rm(fifu)),pb)
  ch = httr::POST(paste0(root_url,"/wp-json/wp/v2/posts/",post_id),
            httr::authenticate(user,pass),
            body = pb,
            encode = "json")
  return(ch)
}