is_enabled_on_forum( bbp_get_topic_forum_id( $topic_id ) ) ) {
return $title;
}
// Don't run when viewing a single topic, a topic edit page, or a reply edit page.
if ( bbp_is_single_topic() || bbp_is_topic_edit() || bbp_is_reply_edit() ) {
return $title;
}
// Don't run when displaying a title attribute via bbp_get_reply_title_fallback(), hooked to 'the_title'.
if ( doing_filter( 'the_title' ) ) {
return $title;
}
if ( 'yes' == $this->get_topic_resolution( array( 'id' => $topic_id ) ) ) {
$title = sprintf(
'',
esc_attr__( 'Resolved', 'wporg-forums' ),
esc_attr__( 'Topic is resolved.', 'wporg-forums' )
) . $title;
}
return $title;
}
/**
* Outputs resolved topic indicator.
*/
public function single_topic_resolved_indicator() {
$topic_id = bbp_get_topic_id();
if (
// Must be single topic view
! bbp_is_single_topic()
||
// Must be enabled on the forum
! $this->is_enabled_on_forum( bbp_get_topic_forum_id( $topic_id ) )
||
// Must be a resolved topic
'yes' !== $this->get_topic_resolution( array( 'id' => $topic_id ) )
) {
return;
}
echo '' . __( 'Resolved', 'wporg-forums' ) . '';
}
/**
* Output topic resolution selection dropdown.
*/
public function form_topic_resolution_dropdown() {
// Only display on forums where this is enabled
if ( ! $this->is_enabled_on_forum() ) {
return;
}
// Only display on topic edit.
if ( ! bbp_is_topic_edit() ) {
return;
}
$resolutions = $this->get_topic_resolutions();
// Post value passed
if ( bbp_is_topic_form_post_request() && isset( $_POST[ self::META_KEY ] ) ) {
$resolution = $this->sanitize_topic_resolution( $_POST[ self::META_KEY ] );
// No post value passed
} else if ( bbp_is_single_topic() || bbp_is_topic_edit() ) {
$resolution = $this->get_topic_resolution( array( 'id' => bbp_get_topic_id() ) );
}
if ( empty( $resolution ) ) {
$resolution = $this->get_default_topic_resolution();
}
?>
is_enabled_on_forum() ) {
return;
}
// Only display on new topics
if ( bbp_is_topic_edit() ) {
return;
}
?>
is_enabled_on_forum( bbp_get_topic_forum_id( $topic_id ) ) ) {
return;
}
$resolution = $this->get_default_topic_resolution();
if ( isset( $_POST[ self::META_KEY ] ) ) {
$resolution = $this->sanitize_topic_resolution( $_POST[ self::META_KEY ] );
}
$this->set_topic_resolution( array(
'id' => $topic_id,
'resolution' => $resolution,
) );
}
/**
* Output topic resolution as a string or a selection dropdown.
*/
public function get_topic_resolution_form() {
// Only display on forums where this is enabled
if ( ! $this->is_enabled_on_forum() ) {
return;
}
// Only display on single topic.
if ( ! bbp_is_single_topic() && ! bbp_is_topic_edit() ) {
return;
}
// Get topic and user data.
$topic_id = intval( bbp_get_topic_id() );
$topic = bbp_get_topic( $topic_id );
if ( ! $topic_id || ! $topic ) {
return;
}
// Get the current resolution of this topic.
$resolution = $this->get_topic_resolution( array( 'id' => bbp_get_topic_id() ) );
if ( empty( $resolution ) ) {
$resolution = $this->get_default_topic_resolution();
}
$resolutions = $this->get_topic_resolutions();
// Display the current topic resolution if the user can't update it.
$user_id = get_current_user_id();
if ( bbp_is_topic_edit() || ! $this->user_can_resolve( $user_id, $topic_id ) ) {
printf( esc_html__( 'Status: %s', 'wporg-forums' ), $resolutions[ $resolution ] );
// Display the form to update the topic resolution.
} else {
?>
is_enabled_on_forum() ) {
return false;
}
// Bail if the action isn't meant for this function.
if ( $action != 'wporg_bbp_topic_resolution' ) {
return;
}
// Bail if no topic id or resolution is passed.
if ( empty( $_POST['topic_id'] ) || empty( $_POST[ self::META_KEY ] ) ) {
return;
}
// Get required data.
$topic_id = intval( $_POST['topic_id'] );
$topic = bbp_get_topic( $topic_id );
$user_id = get_current_user_id();
$resolution = $_POST[ self::META_KEY ];
// Check for empty topic id.
if ( empty( $topic_id ) || ! $topic ) {
bbp_add_error( 'wporg_bbp_topic_resolution_topic_id', __( 'Error: No topic was found!', 'wporg-forums' ) );
// Check valid resolution.
} elseif ( ! $this->is_valid_topic_resolution( $resolution ) ) {
bbp_add_error( 'wporg_bbp_topic_resolution_invalid', __( 'Error: That is not a valid topic resolution!', 'wporg-forums' ) );
// Check user permissions.
} elseif ( ! $this->user_can_resolve( $user_id, $topic->ID ) ) {
bbp_add_error( 'wporg_bbp_topic_resolution_permissions', __( 'Error: You don\'t have permission to do this!', 'wporg-forums' ) );
// Check nonce.
} elseif ( ! bbp_verify_nonce_request( 'toggle-topic-resolution_' . $topic->ID ) ) {
bbp_add_error( 'wporg_bbp_topic_resolution_nonce', __( 'Error: Are you sure you wanted to do that?', 'wporg-forums' ) );
}
if ( bbp_has_errors() ) {
return;
}
// Update the topic resolution.
$this->set_topic_resolution( array(
'id' => $topic->ID,
'resolution' => $resolution,
) );
bbp_redirect( get_permalink( $topic->ID ) );
}
/**
* Register resolution state views.
*/
public function register_views() {
// Not a support topic.
bbp_register_view(
'support-forum-mu',
__( 'Non-support topics', 'wporg-forums' ),
apply_filters( 'wporg_bbp_topic_resolution_view_non_support', array(
'meta_key' => 'topic_resolved',
'meta_type' => 'CHAR',
'meta_value' => 'mu',
'meta_compare' => '=',
'orderby' => '',
'show_stickies' => false,
) )
);
// Resolved.
bbp_register_view(
'support-forum-yes',
__( 'Resolved topics', 'wporg-forums' ),
apply_filters( 'wporg_bbp_topic_resolution_view_resolved', array(
'meta_key' => 'topic_resolved',
'meta_type' => 'CHAR',
'meta_value' => 'yes',
'meta_compare' => '=',
'orderby' => '',
'show_stickies' => false,
) )
);
// Unresolved.
bbp_register_view(
'support-forum-no',
__( 'Unresolved topics', 'wporg-forums' ),
apply_filters( 'wporg_bbp_topic_resolution_view_unresolved', array(
// Note: Do not merge into the below meta_query, this needs to use the `meta_key` property.
'meta_key' => 'topic_resolved',
'meta_type' => 'CHAR',
'meta_value' => 'no',
'meta_compare' => '=',
// Only query for posts that haven't been auto-closed after 6mths from last reply.
'meta_query' => [
'key' => '_bbp_last_active_time',
'compare' => '>',
'value' => gmdate( 'Y-m-d H:i:s', time() - 6*MONTH_IN_SECONDS ),
],
'orderby' => '',
'show_stickies' => false,
// Only query for topics that are not closed
'post_status' => 'publish',
) )
);
}
public function add_forum_topic_resolution_column( $columns ) {
return array_merge( $columns, array(
'bbp_topic_resolution' => __( 'Support', 'wporg-forums' ),
) );
}
public function add_forum_topic_resolution_value( $column, $forum_id ) {
if ( $column === 'bbp_topic_resolution' && $this->is_enabled_on_forum( $forum_id ) ) {
?>
is_enabled_on_forum( $forum_id ) ) {
$enabled = $this->get_enabled_forums();
$enabled[] = $forum_id;
update_option( '_bbp_topic_resolution_enabled', array_values( $enabled ) );
}
}
public function disable_on_forum( $forum_id = 0 ) {
$forum = bbp_get_forum( $forum_id );
if ( empty( $forum ) ) {
return;
}
if ( $this->is_enabled_on_forum( $forum_id ) ) {
$enabled = $this->get_enabled_forums();
$enabled = array_diff( $enabled, array( $forum_id ) );
update_option( '_bbp_topic_resolution_enabled', array_values( $enabled ) );
}
}
public function get_topic_resolution( $args = array() ) {
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'id' => 0,
), 'get_topic_resolution' );
$topic = bbp_get_topic( $r['id'] );
if ( empty( $topic ) ) {
return;
}
// Only return a value on forums where this is enabled
if ( ! $this->is_enabled_on_forum( bbp_get_topic_forum_id( $topic->ID ) ) ) {
return;
}
$retval = get_post_meta( $topic->ID, self::META_KEY, true );
return apply_filters( 'wporg_bbp_get_topic_resolution', $retval, $r, $args );
}
public function set_topic_resolution( $args = array() ) {
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'id' => 0,
'resolution' => '',
), 'set_topic_resolution' );
$topic = bbp_get_topic( $r['id'] );
if ( empty( $topic ) ) {
return;
}
// Only run this on forums where this is enabled
if ( ! $this->is_enabled_on_forum( bbp_get_topic_forum_id( $topic->ID ) ) ) {
return;
}
$resolution = $this->sanitize_topic_resolution( $r['resolution'] );
update_post_meta( $topic->ID, self::META_KEY, $resolution );
wp_cache_delete( $topic->ID, 'post_meta' );
}
public function get_topic_resolutions() {
return apply_filters( 'wporg_bbp_get_topic_resolutions', array(
'no' => __( 'not resolved', 'wporg-forums' ),
'yes' => __( 'resolved', 'wporg-forums' ),
'mu' => __( 'not a support question', 'wporg-forums' ),
) );
}
/**
* Is a topic resolution string in the array of possible resolutions?
*
* @param string $resolution The resolution to check
* @return bool True if in the array, false if not
*/
public function is_valid_topic_resolution( $resolution ) {
$resolutions = $this->get_topic_resolutions();
$retval = in_array( $resolution, array_keys( $resolutions ) );
return apply_filters( 'wporg_bbp_is_valid_topic_resolution', $retval, $resolution );
}
public function get_default_topic_resolution() {
$retval = get_option( '_bbp_default_topic_resolution' );
if ( false == $retval ) {
$retval = 'no';
}
return apply_filters( 'wporg_bbp_default_topic_resolution', $retval );
}
public function sanitize_topic_resolution( $resolution ) {
if ( array_key_exists( $resolution, $this->get_topic_resolutions() ) ) {
$retval = $resolution;
} else {
$retval = $this->get_default_topic_resolution();
}
return apply_filters( 'wporg_bbp_sanitize_topic_resolution', $retval );
}
/**
* Is a given user is allowed to update the resolution of a topic?
*
* @param int $user_id The user id
* @param int $topic_id The topic id
* @return bool True if allowed, false if not
*/
public function user_can_resolve( $user_id, $topic_id ) {
$post = false;
$topic_id = bbp_get_topic_id();
if ( $topic_id ) {
$post = get_post( $topic_id );
}
if ( $user_id && $post && ( user_can( $user_id, 'moderate', $topic_id ) || $user_id == $post->post_author ) ) {
$retval = true;
} else {
$retval = false;
}
return apply_filters( 'wporg_bbp_user_can_resolve', $retval, $user_id, $topic_id );
}
}