BP_REST_Topics_Endpoint::update_item( WP_REST_Request $request )
Update/Edit a topic.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-forums/classes/class-bp-rest-topics-endpoint.php
public function update_item( $request ) { $request->set_param( 'context', 'edit' ); $topic_new = $this->prepare_topic_for_database( $request ); // Define local variable(s). $revisions_removed = false; $topic = 0; $topic_id = 0; $topic_author = 0; $forum_id = 0; $topic_title = ''; $topic_content = ''; $topic_edit_reason = ''; $anonymous_data = array(); // Topic id was not passed. if ( empty( $topic_new->bbp_topic_id ) ) { new WP_Error( 'bp_rest_topic_invalid_id', __( 'Invalid topic ID.', 'buddyboss' ), array( 'status' => 404, ) ); // Topic id was passed. } elseif ( is_numeric( $topic_new->bbp_topic_id ) ) { $topic_id = (int) $topic_new->bbp_topic_id; $topic = bbp_get_topic( $topic_id ); } // Topic does not exist. if ( empty( $topic ) ) { new WP_Error( 'bp_rest_bbp_edit_topic_not_found', __( 'Sorry, The discussion you want to edit was not found.', 'buddyboss' ), array( 'status' => 404, ) ); } // Topic exists. // Check users ability to create new topic. if ( ! bbp_is_topic_anonymous( $topic_id ) ) { // User cannot edit this topic. if ( ! current_user_can( 'edit_topic', $topic_id ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_permissions', __( 'Sorry, You do not have permission to edit that discussion.', 'buddyboss' ), array( 'status' => 403, ) ); } // Set topic author. $topic_author = bbp_get_topic_author_id( $topic_id ); // It is an anonymous post. } else { $anonymous_args = array( 'bbp_anonymous_name' => ! empty( $request['anonymous_name'] ) ? sanitize_text_field( $request['anonymous_name'] ) : '', 'bbp_anonymous_email' => ! empty( $request['anonymous_email'] ) ? sanitize_email( $request['anonymous_email'] ) : '', 'bbp_anonymous_website' => ! empty( $request['anonymous_website'] ) ? sanitize_text_field( $request['anonymous_website'] ) : '', ); // Filter anonymous data. $anonymous_data = bbp_filter_anonymous_post_data( $anonymous_args ); } // Remove kses filters from title and content for capable users. if ( current_user_can( 'unfiltered_html' ) ) { remove_filter( 'bbp_edit_topic_pre_title', 'wp_filter_kses' ); remove_filter( 'bbp_edit_topic_pre_content', 'bbp_encode_bad', 10 ); remove_filter( 'bbp_edit_topic_pre_content', 'bbp_filter_kses', 30 ); } /** Topic Forum */ // Forum id was not passed. if ( empty( $topic_new->bbp_forum_id ) ) { return new WP_Error( 'bp_rest_bbp_topic_forum_id', __( 'Sorry, Forum ID is missing.', 'buddyboss' ), array( 'status' => 400, ) ); // Forum id was passed. } elseif ( is_numeric( $topic_new->bbp_forum_id ) ) { $forum_id = (int) $topic_new->bbp_forum_id; } // Current forum this topic is in. $current_forum_id = bbp_get_topic_forum_id( $topic_id ); // Forum exists. if ( ! empty( $forum_id ) && ( $forum_id !== $current_forum_id ) ) { // Forum is a category. if ( bbp_is_forum_category( $forum_id ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_forum_category', __( 'Sorry, This forum is a category. No discussions can be created in this forum.', 'buddyboss' ), array( 'status' => 400, ) ); // Forum is not a category. } else { // Forum is closed and user cannot access. if ( bbp_is_forum_closed( $forum_id ) && ! current_user_can( 'edit_forum', $forum_id ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_forum_closed', __( 'Sorry, This forum has been closed to new discussions.', 'buddyboss' ), array( 'status' => 400, ) ); } /** * Added logic for group forum * Current user is part of that group or not. * We need to check manually because bbpress updating that caps only on group forum page and * in API those conditional tag will not work. */ $is_member = false; $group_ids = array(); if ( function_exists( 'bbp_get_forum_group_ids' ) ) { $group_ids = bbp_get_forum_group_ids( $forum_id ); if ( ! empty( $group_ids ) ) { foreach ( $group_ids as $group_id ) { if ( groups_is_user_member( $topic_author, $group_id ) ) { $is_member = true; break; } } } } // Forum is private and user cannot access. if ( bbp_is_forum_private( $forum_id ) && ! bbp_is_user_keymaster() ) { if ( ( empty( $group_ids ) && ! current_user_can( 'read_private_forums' ) ) || ( ! empty( $group_ids ) && ! $is_member ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_forum_private', __( 'Sorry, This forum is private and you do not have the capability to read or create new discussions in it.', 'buddyboss' ), array( 'status' => 400, ) ); } // Forum is hidden and user cannot access. } elseif ( bbp_is_forum_hidden( $forum_id ) && ! bbp_is_user_keymaster() ) { if ( ( empty( $group_ids ) && ! current_user_can( 'read_hidden_forums' ) ) || ( ! empty( $group_ids ) && ! $is_member ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_forum_hidden', __( 'Sorry, This forum is hidden and you do not have the capability to read or create new discussions in it.', 'buddyboss' ), array( 'status' => 400, ) ); } } } } /** Discussion Title */ if ( ! empty( $topic_new->bbp_topic_title ) ) { $topic_title = esc_attr( wp_strip_all_tags( $topic_new->bbp_topic_title ) ); } // Filter and sanitize. $topic_title = apply_filters( 'bbp_edit_topic_pre_title', $topic_title, $topic_id ); // No topic title. if ( empty( $topic_title ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_title', __( 'Sorry, Your discussion needs a title.', 'buddyboss' ), array( 'status' => 400, ) ); } /** Topic Content */ if ( ! empty( $topic_new->bbp_topic_content ) ) { $topic_content = $topic_new->bbp_topic_content; } // Filter and sanitize. $topic_content = apply_filters( 'bbp_edit_topic_pre_content', $topic_content, $topic_id ); // No topic content. if ( empty( $topic_content ) ) { return new WP_Error( 'bp_rest_bbp_edit_topic_content', __( 'Sorry, Your discussion cannot be empty.', 'buddyboss' ), array( 'status' => 400, ) ); } /** Topic Blacklist */ if ( ! bbp_check_for_blacklist( $anonymous_data, $topic_author, $topic_title, $topic_content ) ) { return new WP_Error( 'bp_rest_bbp_topic_blacklist', __( 'Sorry, Your discussion cannot be edited at this time.', 'buddyboss' ), array( 'status' => 400, ) ); } /** Topic Status */ // Maybe put into moderation. if ( ! bbp_check_for_moderation( $anonymous_data, $topic_author, $topic_title, $topic_content ) ) { // Set post status to pending if public or closed. if ( in_array( $topic->post_status, array( bbp_get_public_status_id(), bbp_get_closed_status_id(), ), true ) ) { $topic_status = bbp_get_pending_status_id(); } // Check a whitelist of possible topic status ID's. } elseif ( ! empty( $topic_new->bbp_topic_status ) && in_array( $topic_new->bbp_topic_status, array_keys( bbp_get_topic_statuses() ), true ) ) { $topic_status = $topic_new->bbp_topic_status; // Use existing post_status. } else { $topic_status = $topic->post_status; } /** Topic Tags */ // Either replace terms. if ( bbp_allow_topic_tags() && current_user_can( 'assign_topic_tags' ) && ! empty( $topic_new->bbp_topic_tags ) ) { // Escape tag input. $terms = esc_attr( wp_strip_all_tags( $topic_new->bbp_topic_tags ) ); // Explode by comma. if ( strstr( $terms, ',' ) ) { $terms = explode( ',', $terms ); } // Add topic tag ID as main key. $terms = array( bbp_get_topic_tag_tax_id() => $terms ); // ...or remove them. } elseif ( isset( $topic_new->bbp_topic_tags ) ) { $terms = array( bbp_get_topic_tag_tax_id() => array() ); // Existing terms. } else { $terms = array( bbp_get_topic_tag_tax_id() => explode( ',', bbp_get_topic_tag_names( $topic_id, ',' ) ) ); } /** Additional Actions (Before Save) */ do_action( 'bbp_edit_topic_pre_extras', $topic_id ); // Add the content of the form to $topic_data as an array. // Just in time manipulation of topic data before being edited. $topic_data = apply_filters( 'bbp_edit_topic_pre_insert', array( 'ID' => $topic_id, 'post_title' => $topic_title, 'post_content' => $topic_content, 'post_status' => $topic_status, 'post_parent' => $forum_id, 'post_author' => $topic_author, 'post_type' => bbp_get_topic_post_type(), 'tax_input' => $terms, ) ); // Toggle revisions to avoid duplicates. if ( post_type_supports( bbp_get_topic_post_type(), 'revisions' ) ) { $revisions_removed = true; remove_post_type_support( bbp_get_topic_post_type(), 'revisions' ); } // Insert topic. $topic_id = wp_update_post( $topic_data ); // Toggle revisions back on. if ( true === $revisions_removed ) { $revisions_removed = false; add_post_type_support( bbp_get_topic_post_type(), 'revisions' ); } if ( empty( $topic_id ) || is_wp_error( $topic_id ) ) { $append_error = ( ( is_wp_error( $topic_id ) && $topic_id->get_error_message() ) ? __( 'The following problem(s) have been found with your topic: ', 'buddyboss' ) . $topic_id->get_error_message() . __( 'Please try again.', 'buddyboss' ) : __( 'We are facing a problem to update a topic.', 'buddyboss' ) ); return new WP_Error( 'bp_rest_bbp_topic_error', $append_error, array( 'status' => 400, ) ); } // Update counts, etc... do_action( 'bbp_edit_topic', $topic_id, $forum_id, $anonymous_data, $topic_author, true /* Is edit */ ); /** Revisions */ // Revision Reason. if ( ! empty( $topic_new->bbp_topic_edit_reason ) ) { $topic_edit_reason = esc_attr( wp_strip_all_tags( $topic_new->bbp_topic_edit_reason ) ); } // Update revision log. if ( ! empty( $topic_new->bbp_log_topic_edit ) && ( true === $topic_new->bbp_log_topic_edit ) ) { $revision_id = wp_save_post_revision( $topic_id ); if ( ! empty( $revision_id ) ) { bbp_update_topic_revision_log( array( 'topic_id' => $topic_id, 'revision_id' => $revision_id, 'author_id' => bbp_get_current_user_id(), 'reason' => $topic_edit_reason, ) ); } } /** Move Topic */ // If the new forum id is not equal to the old forum id, run the. // bbp_move_topic action and pass the topic's forum id as the. // first arg and topic id as the second to update counts. if ( $forum_id !== $topic->post_parent ) { bbp_move_topic_handler( $topic_id, $topic->post_parent, $forum_id ); } /** Stickies */ if ( ! empty( $topic_new->bbp_stick_topic ) && in_array( $topic_new->bbp_stick_topic, array_keys( bbp_get_topic_types() ), true ) ) { // What's the caps? if ( current_user_can( 'moderate' ) ) { // What's the haps? switch ( $topic_new->bbp_stick_topic ) { // Sticky in forum. case 'stick': bbp_stick_topic( $topic_id ); break; // Sticky in all forums. case 'super': bbp_stick_topic( $topic_id, true ); break; // Normal. case 'unstick': default: bbp_unstick_topic( $topic_id ); break; } } } // Handle Subscription Checkbox. if ( bbp_is_subscriptions_active() ) { $author_id = bbp_get_user_id( 0, true, true ); // Check if subscribed. $subscribed = bbp_is_user_subscribed( $author_id, $topic_id ); // Subscribed and unsubscribing. if ( true === $subscribed && empty( $topic_new->bbp_topic_subscription ) ) { bbp_remove_user_subscription( $author_id, $topic_id ); // Not subscribed and subscribing. } elseif ( false === $subscribed && ! empty( $topic_new->bbp_topic_subscription ) ) { bbp_add_user_subscription( $author_id, $topic_id ); } } /** Additional Actions (After Save) */ do_action( 'bbp_edit_topic_post_extras', $topic_id ); $topic = get_post( $topic_id ); $fields_update = $this->update_additional_fields_for_object( $topic, $request ); if ( is_wp_error( $fields_update ) ) { return $fields_update; } $retval = $this->prepare_response_for_collection( $this->prepare_item_for_response( $topic, $request ) ); $response = rest_ensure_response( $retval ); /** * Fires after a topic is updated and fetched via the REST API. * * @param array $topic Updated topic. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ do_action( 'bp_rest_topic_update_item', $topic, $response, $request ); return $response; }
Changelog
Version | Description |
---|---|
0.1.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.