Changeset 6026 for trunk/src/includes/forums/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/forums/functions.php (modified) (3 diffs)

trunk/src/includes/forums/functions.php

@@ -1791 +1791 @@
  * @since 2.4.0 bbPress (r5059)
  *
+ * @param int $forum_id   Optional. Forum id.
+ *
  * @return array
  */
-function bbp_get_forum_statuses() {
+function bbp_get_forum_statuses( $forum_id = 0 ) {
     return apply_filters( 'bbp_get_forum_statuses', array(
         'open'   => _x( 'Open',    'Open the forum',  'bbpress' ),
         'closed' => _x( 'Closed',  'Close the forum', 'bbpress' )
-    ) );
+    ), $forum_id );
 }
 
@@ -1805 +1807 @@
  * @since 2.4.0 bbPress (r5059)
  *
+ * @param int $forum_id   Optional. Forum id.
+ *
  * @return array
  */
-function bbp_get_forum_types() {
+function bbp_get_forum_types( $forum_id = 0 ) {
     return apply_filters( 'bbp_get_forum_types', array(
         'forum'    => _x( 'Forum',    'Forum accepts new topics', 'bbpress' ),
         'category' => _x( 'Category', 'Forum is a category',      'bbpress' )
-    ) );
+    ), $forum_id );
 }
 
@@ -1819 +1823 @@
  * @since 2.4.0 bbPress (r5059)
  *
+ * @param int $forum_id   Optional. Forum id.
+ *
  * @return array
  */
-function bbp_get_forum_visibilities() {
+function bbp_get_forum_visibilities( $forum_id = 0) {
     return apply_filters( 'bbp_get_forum_visibilities', array(
         bbp_get_public_status_id()  => _x( 'Public',  'Make forum public',  'bbpress' ),
         bbp_get_private_status_id() => _x( 'Private', 'Make forum private', 'bbpress' ),
         bbp_get_hidden_status_id()  => _x( 'Hidden',  'Make forum hidden',  'bbpress' )
-    ) );
+    ), $forum_id );
 }