Changeset 8787 for trunk/src/bp-core/bp-core-classes.php

Timestamp:

08/11/2014 03:13:23 PM (12 years ago)

Author:

r-a-y

Message:

Add ability to query activity items by date.

This commit:

• Introduces the BP_Date_Query class. This class extends WP_Date_Query, which will enable us to easily add support to query various BuddyPress items by date.
• Adds a new 'date_query' parameter to BP_Activity_Activity::get(). This parameter utilizes the new BP_Date_Query class and is an example of how to use the class in BuddyPress. (Will add support for the Groups component in a later commit.)
• Adds unit tests.

Due to the dependency on the WP_Date_Query class, this functionality is
only available in WordPress 3.7+.

Fixes #5803.

File:

• trunk/src/bp-core/bp-core-classes.php (modified) (1 diff)

trunk/src/bp-core/bp-core-classes.php

@@ -1508 +1508 @@
 }
 
+if ( class_exists( 'WP_Date_Query' ) ) :
+/**
+ * BuddyPress date query class.
+ *
+ * Extends the {@link WP_Date_Query} class for use with BuddyPress.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $date_query {
+ *     Date query arguments.  See first parameter of {@link WP_Date_Query::__construct()}.
+ * }
+ * @param string $column The DB column to query against.
+ */
+class BP_Date_Query extends WP_Date_Query {
+    /**
+     * The column to query against. Can be changed via the query arguments.
+     *
+     * @var string
+     */
+    public $column;
+
+    /**
+     * Constructor.
+     *
+     * @see WP_Date_Query::__construct()
+     */
+    public function __construct( $date_query, $column = '' ) {
+        if ( ! empty( $column ) ) {
+            $this->column = $column;
+            add_filter( 'date_query_valid_columns', array( $this, 'register_date_column' ) );
+        }
+
+        parent::__construct( $date_query, $column );
+    }
+
+    /**
+     * Destructor.
+     */
+    public function __destruct() {
+        remove_filter( 'date_query_valid_columns', array( $this, 'register_date_column' ) );    
+    }
+
+    /**
+     * Registers our date column with WP Date Query to pass validation.
+     *
+     * @param array $retval Current DB columns
+     * @return array
+     */
+    public function register_date_column( $retval = array() ) {
+        $retval[] = $this->column;
+        return $retval;
+    }
+}
+endif;
 
 /**