/**
* Sets an author on a post, with a specified role.
*
* This can be used to edit an existing coauthor - for example, changing the role
* of an author already attached to a post - but it is not guaranteed to
* preserve order. If the sorted order of authors needs to be preserved, call
* `update_coauthors_on_post()` and pass the full list of coauthors to update,
* sorted.
*
* @param int|object $post_id Post to set author as "coauthor" on
* @param object|string $author user_nicename of Author to add on post (or WP_User object)
* @param object|string $author_role Term or slug of contributor role to set. Defaults to "byline" if empty
* @return bool True on success, false on failure (if any of the inputs are not acceptable).
*/
function set_author_on_post($post_id, $author, $author_role = false)
{
global $coauthors_plus;
if (is_object($post_id) && isset($post_id->ID)) {
$post_id = $post_id->ID;
}
$post_id = intval($post_id);
if (is_string($author)) {
$author = $coauthors_plus->get_coauthor_by('user_nicename', $author);
}
if (!isset($author->user_nicename)) {
return false;
}
// Only create the byline term if the contributor role is:
// - one of the byline roles, as set in register_author_role(), or
// - unset, meaning they should default to primary author role.
if (!$author_role || in_array($author_role, byline_roles())) {
$coauthors_plus->add_coauthors($post_id, array($author->user_nicename), true);
}
if (!$post_id || !$author) {
return false;
}
foreach (get_post_meta($post_id) as $key => $values) {
if (strpos($key, 'cap-') === 0 && in_array($author->user_nicename, $values)) {
delete_post_meta($post_id, $key, $author->user_nicename);
}
}
if (!is_object($author_role)) {
$author_role = get_author_role($author_role);
}
if (!$author_role) {
return false;
}
add_post_meta($post_id, 'cap-' . $author_role->slug, $author->user_nicename);
}
/**
* Get all coauthors on a post, and their roles.
*
* A lot of copypasta from get_coauthors() in Co-Authors Plus, with additional options.
*
* @param int $post_ID ID of post to check. Defaults to the current post.
* @param arr $args Query options. Available options are:
* author_role array of roles to query in
* @return arr Array of authors
*/
function get_coauthors($post_id = 0, $args = array())
{
global $post, $post_ID, $coauthors_plus, $wpdb;
// Merge default query args with parameters
$args = wp_parse_args($args, array('author_role' => 'byline'));
$coauthors = array();
// Default to current post if $post_id is not set.
$post_id = (int) $post_id;
if (!$post_id && $post_ID) {
$post_id = $post_ID;
}
if (!$post_id && $post) {
$post_id = $post->ID;
}
if (!$post_id) {
return;
}
// Querying for "bylines" (the default) should return the same results as in CAP
if ($args['author_role'] === 'byline') {
/*
* This query is the same as the one from Co-Authors Plus, because any co-authors
* added in byline roles should have an author term set.
*/
$coauthor_terms = get_the_terms($post_id, $coauthors_plus->coauthor_taxonomy);
if (is_array($coauthor_terms) && !empty($coauthor_terms)) {
foreach ($coauthor_terms as $coauthor) {
$coauthor_slug = preg_replace('#^cap\\-#', '', $coauthor->slug);
$post_author = $coauthors_plus->get_coauthor_by('user_nicename', $coauthor_slug);
// In case the user has been deleted while plugin was deactivated
if (!empty($post_author)) {
$post_author->author_role = 'byline';
$coauthors[] = $post_author;
}
}
} else {
if (!$coauthors_plus->force_guest_authors) {
if ($post && $post_id == $post->ID) {
$post_author = get_userdata($post->post_author);
} else {
$post_author = get_userdata($wpdb->get_var($wpdb->prepare("SELECT post_author FROM {$wpdb->posts} WHERE ID = %d", $post_id)));
}
if (!empty($post_author)) {
$coauthors[] = $post_author;
}
}
}
// the empty else case is because if we force guest authors, we don't ever care what value wp_posts.post_author has.
} else {
/*
* Any other queries need to be performed using postmeta fields.
*
* Passing the string 'any' or false to 'author_role' should get anyone, regardless of role.
* Passing a string or array of strings should get all roles with those slugs.
*/
if ($args['author_role'] === 'any' || !$args['author_role']) {
$author_roles = wp_list_pluck(get_author_roles(), 'slug');
} else {
if (is_string($args['author_role'])) {
$author_roles = array($args['author_role']);
} else {
$author_roles = $args['author_role'];
}
}
// Get the terms as stored in post meta: look up all the author roles passed in by function
// arguments (to whitelist arguments), and return the slug for each as would be used in post meta keys.
$roles_meta_keys = array_map(function ($term) {
return 'cap-' . $term;
}, array_filter($author_roles, 'CoAuthorsPlusRoles\\get_author_role'));
// Get all coauthors on this post, from post meta values
$coauthor_nicenames = array();
foreach (get_post_meta($post_id) as $key => $values) {
if (in_array($key, $roles_meta_keys)) {
foreach ($values as $author_name) {
$author = $coauthors_plus->get_coauthor_by('user_nicename', $author_name);
if ($role = get_author_role(substr($key, 4))) {
$author->author_role = $role->slug;
}
$coauthors[] = $author;
}
}
}
if ($args['author_role'] === 'any' || !$args['author_role'] || is_array($args['author_role']) && in_array('byline', $args['author_role'])) {
// Now, get the author terms, in case of bylines or coauthors who were entered with CAP.
$coauthor_terms = get_the_terms($post_id, $coauthors_plus->coauthor_taxonomy);
$byline_coauthors = array();
if (is_array($coauthor_terms) && !empty($coauthor_terms)) {
foreach ($coauthor_terms as $coauthor) {
$coauthor_slug = preg_replace('#^cap\\-#', '', $coauthor->slug);
// Since some authors may have also been added through postmeta, skip them here
// so as not to include duplicate authors in results.
if (in_array($coauthor_slug, wp_list_pluck($coauthors, 'user_nicename'))) {
continue;
}
$post_author = $coauthors_plus->get_coauthor_by('user_nicename', $coauthor_slug);
/*
* The special case where `author_role` is empty should be handled separately.
* An empty role means that its treated as a "byline". We give it a name here for display purposes,
* but this name is never saved.
*/
$post_author->author_role = esc_html__('byline', 'co-authors-plus-roles');
// In case the user has been deleted while plugin was deactivated
if (!empty($post_author)) {
$byline_coauthors[] = $post_author;
}
}
}
$coauthors = array_merge($byline_coauthors, $coauthors);
}
}
return $coauthors;
}
/**
* Respond to a selected coauthor in modal window.
*
* Output the HTML markup for an <li> to add to the sortable list in the
* Co-Authors meta box.
*/
function ajax_template_coauthor_sortable()
{
check_ajax_referer('coauthor-select', '_ajax_coauthor_template_nonce');
global $coauthors_plus;
$coauthor = $coauthors_plus->get_coauthor_by('user_nicename', sanitize_text_field($_REQUEST['authorNicename']));
$role = get_author_role(sanitize_text_field($_REQUEST['authorRole']));
if (!$coauthor) {
wp_send_json_error('Missing required information.');
}
if (is_object($role)) {
$role = $role->slug;
}
ob_start();
template_coauthor_sortable($coauthor, $role);
$sortable_markup = ob_get_clean();
wp_send_json_success($sortable_markup);
}