Changeset 6026 for trunk/src/includes/topics/functions.php

Timestamp:

05/19/2016 07:35:41 PM (9 years ago)

Author:

johnjamesjacoby

Message:

Statuses, Types, Visibilities: Pass the forum, topic, or reply ID into helper functions.

These ID's pass additional context into respective filters, useful for fine-grained control over UI elements.

This commit normalizes the way these functions work across all of bbPress where applicable, by ensuring all similar functions accept an ID and assume 0 by default. Note that there are currently 2 locations where no ID exists to pass context into, which is by design.

Fixes #2954.

File:

• trunk/src/includes/topics/functions.php (modified) (7 diffs)

trunk/src/includes/topics/functions.php

@@ -284 +284 @@
     /** Topic Status **********************************************************/
 
+    // Get available topic statuses
+    $topic_statuses = bbp_get_topic_statuses();
+
     // Maybe put into moderation
     if ( ! bbp_check_for_moderation( $anonymous_data, $topic_author, $topic_title, $topic_content ) ) {
@@ -289 +292 @@
 
     // Check a whitelist of possible topic status ID's
-    } elseif ( ! empty( $_POST['bbp_topic_status'] ) && in_array( $_POST['bbp_topic_status'], array_keys( bbp_get_topic_statuses() ) ) ) {
+    } elseif ( ! empty( $_POST['bbp_topic_status'] ) && in_array( $_POST['bbp_topic_status'], array_keys( $topic_statuses ) ) ) {
         $topic_status = sanitize_key( $_POST['bbp_topic_status'] );
 
@@ -628 +631 @@
     /** Topic Status **********************************************************/
 
+    // Get available topic statuses
+    $topic_statuses = bbp_get_topic_statuses( $topic_id );
+
     // Maybe put into moderation
     if ( ! bbp_check_for_moderation( $anonymous_data, $topic_author, $topic_title, $topic_content ) ) {
@@ -637 +643 @@
 
     // Check a whitelist of possible topic status ID's
-    } elseif ( ! empty( $_POST['bbp_topic_status'] ) && in_array( $_POST['bbp_topic_status'], array_keys( bbp_get_topic_statuses() ) ) ) {
+    } elseif ( ! empty( $_POST['bbp_topic_status'] ) && in_array( $_POST['bbp_topic_status'], array_keys( $topic_statuses ) ) ) {
         $topic_status = sanitize_key( $_POST['bbp_topic_status'] );
 
@@ -2008 +2014 @@
  * @since 2.4.0 bbPress (r5059)
  *
+ * @param int $topic_id   Optional. Topic id.
+ *
  * @return array
  */
-function bbp_get_topic_statuses() {
+function bbp_get_topic_statuses( $topic_id = 0 ) {
     return apply_filters( 'bbp_get_topic_statuses', array(
         bbp_get_public_status_id()  => _x( 'Open',    'Open the topic',        'bbpress' ),
@@ -2017 +2025 @@
         bbp_get_trash_status_id()   => _x( 'Trash',   'Trash the topic',       'bbpress' ),
         bbp_get_pending_status_id() => _x( 'Pending', 'Mark topic as pending', 'bbpress' ),
-    ) );
+    ), $topic_id );
 }
 
@@ -2025 +2033 @@
  * @since 2.4.0 bbPress (r5059)
  *
+ * @param int $topic_id   Optional. Topic id.
+ *
  * @return array
  */
-function bbp_get_topic_types() {
+function bbp_get_topic_types( $topic_id = 0 ) {
     return apply_filters( 'bbp_get_topic_types', array(
         'unstick' => _x( 'Normal',       'Unstick a topic',         'bbpress' ),
         'stick'   => _x( 'Sticky',       'Make topic sticky',       'bbpress' ),
         'super'   => _x( 'Super Sticky', 'Make topic super sticky', 'bbpress' )
-    ) );
+    ), $topic_id );
 }