Changeset 13303

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

Location:

trunk/src

Files:

• bp-blogs/bp-blogs-template.php (modified) (4 diffs)
• bp-core/deprecated/11.0.php (modified) (1 diff)
• bp-templates/bp-nouveau/includes/blogs/functions.php (modified) (1 diff)
• bp-templates/bp-nouveau/includes/blogs/template-tags.php (modified) (1 diff)
• class-buddypress.php (modified) (1 diff)

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 );
     }
 

trunk/src/bp-core/deprecated/11.0.php

@@ -57 +57 @@
     return array();
 }
+
+/**
+ * Catch the arguments for buttons
+ *
+ * @since 3.0.0
+ * @deprecated 11.0.0
+ *
+ * @param array $buttons The arguments of the button that BuddyPress is about to create.
+ *
+ * @return array An empty array to stop the button creation process.
+ */
+function bp_nouveau_blogs_catch_button_args( $button = array() ) {
+    _deprecated_function( __FUNCTION__, '11.0.0' );
+
+    // Globalize the arguments so that we can use it  in bp_nouveau_get_blogs_buttons().
+    bp_nouveau()->blogs->button_args = $button;
+
+    // return an empty array to stop the button creation process
+    return array();
+}

trunk/src/bp-templates/bp-nouveau/includes/blogs/functions.php

@@ -117 +117 @@
 
 /**
- * Catch the arguments for buttons
- *
- * @since 3.0.0
- *
- * @param array $buttons The arguments of the button that BuddyPress is about to create.
- *
- * @return array An empty array to stop the button creation process.
- */
-function bp_nouveau_blogs_catch_button_args( $button = array() ) {
-    // Globalize the arguments so that we can use it  in bp_nouveau_get_blogs_buttons().
-    bp_nouveau()->blogs->button_args = $button;
-
-    // return an empty array to stop the button creation process
-    return array();
-}
-
-/**
  * Add settings to the customizer for the blogs component.
  *

trunk/src/bp-templates/bp-nouveau/includes/blogs/template-tags.php

@@ -200 +200 @@
         }
 
-        /*
-         * This filter workaround is waiting for a core adaptation
-         * so that we can directly get the groups button arguments
-         * instead of the button.
-         *
-         * See https://buddypress.trac.wordpress.org/ticket/7126
-         */
-        add_filter( 'bp_get_blogs_visit_blog_button', 'bp_nouveau_blogs_catch_button_args', 100, 1 );
-
-        bp_get_blogs_visit_blog_button();
-
-        remove_filter( 'bp_get_blogs_visit_blog_button', 'bp_nouveau_blogs_catch_button_args', 100, 1 );
-
-        if ( isset( bp_nouveau()->blogs->button_args ) && bp_nouveau()->blogs->button_args ) {
-            $button_args = bp_nouveau()->blogs->button_args ;
-
-            // If we pass through parent classes add them to $button array
-            $parent_class = '';
-            if ( ! empty( $args['parent_attr']['class'] ) ) {
-                $parent_class = $args['parent_attr']['class'];
-            }
-
-            // Set defaults if not set.
-            $button_args = array_merge( array(
-                'wrapper_id' => '',
-                'link_id'    => '',
-                'link_rel'   => ''
-            ), $button_args );
-
-            $buttons['visit_blog'] = array(
-                'id'                => 'visit_blog',
-                'position'          => 5,
-                'component'         => $button_args['component'],
-                'must_be_logged_in' => $button_args['must_be_logged_in'],
-                'block_self'        => $button_args['block_self'],
-                'parent_element'    => $parent_element,
-                'button_element'    => $button_element,
-                'link_text'         => $button_args['link_text'],
-                'parent_attr'       => array(
-                    'id'              => $button_args['wrapper_id'],
-                    'class'           => $parent_class,
-                ),
-                'button_attr'       => array(
-                    'href'             => $button_args['link_href'],
-                    'id'               => $button_args['link_id'],
-                    'class'            => $button_args['link_class'] . ' button',
-                    'rel'              => $button_args['link_rel'],
-                    'title'            => '',
-                ),
-            );
-
-            unset( bp_nouveau()->blogs->button_args );
-        }
+        $button_args = bp_get_blogs_visit_blog_button_args();
+
+        // If we pass through parent classes add them to $button array
+        $parent_class = '';
+        if ( ! empty( $args['parent_attr']['class'] ) ) {
+            $parent_class = $args['parent_attr']['class'];
+        }
+
+        // Set defaults if not set.
+        $button_args = array_merge( array(
+            'wrapper_id' => '',
+            'link_id'    => '',
+            'link_rel'   => ''
+        ), $button_args );
+
+        $buttons['visit_blog'] = array(
+            'id'                => 'visit_blog',
+            'position'          => 5,
+            'component'         => $button_args['component'],
+            'must_be_logged_in' => $button_args['must_be_logged_in'],
+            'block_self'        => $button_args['block_self'],
+            'parent_element'    => $parent_element,
+            'button_element'    => $button_element,
+            'link_text'         => $button_args['link_text'],
+            'link_title'        => $button_args['link_title'],
+            'parent_attr'       => array(
+                'id'              => $button_args['wrapper_id'],
+                'class'           => $parent_class,
+            ),
+            'button_attr'       => array(
+                'href'             => $button_args['link_href'],
+                'id'               => $button_args['link_id'],
+                'class'            => $button_args['link_class'] . ' button',
+                'rel'              => $button_args['link_rel'],
+                'title'            => '',
+            ),
+        );
 
         /**

trunk/src/class-buddypress.php

@@ -560 +560 @@
             require $this->plugin_dir . 'bp-core/deprecated/9.0.php';
             require $this->plugin_dir . 'bp-core/deprecated/10.0.php';
+            require $this->plugin_dir . 'bp-core/deprecated/11.0.php';
         }