Changeset 10906

Timestamp:

06/27/2016 05:50:09 PM (9 years ago)

Author:

imath

Message:

Blogs: introduce a function to return the blogs pagination

Unlike other components, the blogs component was not including a function to only return the pagination content, but only a function to display it.
bp_get_blogs_pagination_count() will now do this job and the bp_blogs_pagination_count() is using it to display the pagination.

Fixes #7118

File:

• trunk/src/bp-blogs/bp-blogs-template.php (modified) (2 diffs)

trunk/src/bp-blogs/bp-blogs-template.php

@@ -221 +221 @@
  * Output the blogs pagination count.
  *
+ * @since 1.0.0
+ */
+function bp_blogs_pagination_count() {
+    echo bp_get_blogs_pagination_count();
+}
+
+/**
+ * Get the blogs pagination count.
+ *
+ * @since 2.7.0
+ *
  * @global object $blogs_template {@link BP_Blogs_Template}
  */
-function bp_blogs_pagination_count() {
+function bp_get_blogs_pagination_count() {
     global $blogs_template;
 
@@ -237 +248 @@
     }
 
-    echo $message;
+    /**
+     * Filters the "Viewing x-y of z blogs" pagination message.
+     *
+     * @since 2.7.0
+     *
+     * @param string $message  "Viewing x-y of z blogs" text.
+     * @param string $from_num Total amount for the low value in the range.
+     * @param string $to_num   Total amount for the high value in the range.
+     * @param string $total    Total amount of blogs found.
+     */
+    return apply_filters( 'bp_get_blogs_pagination_count', $message, $from_num, $to_num, $total );
 }