Changeset 13303 for trunk/src/bp-blogs/bp-blogs-template.php

Timestamp:

07/22/2022 12:54:40 PM (2 years ago)

Author:

imath

Message:

Introduce a function to only get the "Visit blog" button args

bp_get_blogs_visit_blog_button_args() eases the process of getting these arguments and removes the need for BP Nouveau's workaround.
Deprecate the bp_nouveau_blogs_catch_button_args() as no more needed.

Props hnla

Fixes #7126
See #8722

File:

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

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

@@ -1543 +1543 @@
  * Output button for visiting a blog in a loop.
  *
- * @see bp_get_blogs_visit_blog_button() for description of arguments.
- *
- * @param array|string $args See {@link bp_get_blogs_visit_blog_button()}.
+ * @see bp_get_blogs_visit_blog_button_args() for description of arguments.
+ *
+ * @param array|string $args See {@link bp_get_blogs_visit_blog_button_args()}.
  */
 function bp_blogs_visit_blog_button( $args = '' ) {
     echo bp_get_blogs_visit_blog_button( $args );
 }
-    /**
-     * Return button for visiting a blog in a loop.
+
+    /**
+     * Return the arguments of the button for visiting a blog in a loop.
      *
      * @see BP_Button for a complete description of arguments and return
      *      value.
+     *
+     * @since 11.0.0
      *
      * @param array|string $args {
@@ -1567 +1570 @@
      *     @type string $link_class        Default: 'blog-button visit'.
      *     @type string $link_text         Default: 'Visit Site'.
+     *     @type string $link_title        Default: 'Visit Site'.
      * }
-     * @return string The HTML for the Visit button.
-     */
-    function bp_get_blogs_visit_blog_button( $args = '' ) {
-        $button = bp_parse_args(
+     * @return array Thhe arguments of the button for visiting a blog in a loop.
+     */
+    function bp_get_blogs_visit_blog_button_args( $args = '' ) {
+        $button_args = bp_parse_args(
             $args,
             array(
@@ -1582 +1586 @@
                 'link_class'        => 'blog-button visit',
                 'link_text'         => __( 'Visit Site', 'buddypress' ),
+                'link_title'        => __( 'Visit Site', 'buddypress' ),
             )
         );
@@ -1590 +1595 @@
          * @since 1.2.10
          *
-         * @param array $button Array of arguments to be used for the button to visit a blog.
-         */
-        return bp_get_button( apply_filters( 'bp_get_blogs_visit_blog_button', $button ) );
+         * @param array $button_args Array of arguments to be used for the button to visit a blog.
+         */
+        return apply_filters( 'bp_get_blogs_visit_blog_button', $button_args );
+    }
+
+    /**
+     * Return button for visiting a blog in a loop.
+     *
+     * @see BP_Button for a complete description of arguments and return
+     *      value.
+     *
+     * @see bp_get_blogs_visit_blog_button_args() for description of arguments.
+     *
+     * @param array|string $args See {@link bp_get_blogs_visit_blog_button_args()}.
+     * @return string The HTML for the Visit button.
+     */
+    function bp_get_blogs_visit_blog_button( $args = '' ) {
+        $button_args = bp_get_blogs_visit_blog_button_args( $args );
+
+        if ( ! array_filter( $button_args ) ) {
+            return '';
+        }
+
+        return bp_get_button( $button_args );
     }