Changeset 13300 for trunk/src/bp-messages/bp-messages-template.php

Timestamp:

07/22/2022 09:32:13 AM (2 years ago)

Author:

imath

Message:

Introduce a function to only get the Private Message button arguments

bp_get_send_message_button_args() eases the process of getting these arguments and removes the need for BP Nouveau's workaround.

Props hnla

See #7126
See #8722

File:

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

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

@@ -1505 +1505 @@
  * @since 3.0.0 Added `$args` parameter.
  *
- * @param array|string $args See {@link bp_get_send_message_button()}.
+ * @see bp_get_send_message_button_args() for description of parameters.
+ *
+ * @param array|string $args See {@link bp_get_send_message_button_args()}.
  */
 function bp_send_message_button( $args = '' ) {
     echo bp_get_send_message_button( $args );
 }
-    /**
-     * Generate the 'Private Message' button for member profile headers.
-     *
-     * @since 1.2.0
-     * @since 3.0.0 Added `$args` parameter.
+
+    /**
+     * Get the arguments for the private message button.
+     *
+     * @since 11.0.0
      *
      * @param array|string $args {
-     *     All arguments are optional. See {@link BP_Button} for complete
-     *     descriptions.
-     *     @type string $id                Default: 'private_message'.
-     *     @type string $component         Default: 'messages'.
-     *     @type bool   $must_be_logged_in Default: true.
-     *     @type bool   $block_self        Default: true.
-     *     @type string $wrapper_id        Default: 'send-private-message'.
-     *     @type string $link_href         Default: the private message link for
-     *                                     the current member in the loop.
-     *     @type string $link_text         Default: 'Private Message'.
-     *     @type string $link_class        Default: 'send-message'.
+     *    All arguments are optional. See {@link BP_Button} for complete
+     *    descriptions.
+     *    @type string $id                Default: 'private_message'.
+     *    @type string $component         Default: 'messages'.
+     *    @type bool   $must_be_logged_in Default: true.
+     *    @type bool   $block_self        Default: true.
+     *    @type string $wrapper_id        Default: 'send-private-message'.
+     *    @type string $link_href         Default: the private message link for
+     *                                    the current member in the loop.
+     *    @type string $link_title        Default: 'Send a private message to this member.'.
+     *    @type string $link_text         Default: 'Private Message'.
+     *    @type string $link_class        Default: 'send-message'.
      * }
-     * @return string
-     */
-    function bp_get_send_message_button( $args = '' ) {
-
-        $r = bp_parse_args(
+     * @return array The arguments for the public message button.
+     */
+    function bp_get_send_message_button_args( $args = '' ) {
+        $button_args = bp_parse_args(
             $args,
             array(
@@ -1543 +1545 @@
                 'link_href'         => bp_get_send_private_message_link(),
                 'link_text'         => __( 'Private Message', 'buddypress' ),
+                'link_title'        => __( 'Send a private message to this member.', 'buddypress' ),
                 'link_class'        => 'send-message',
             )
         );
 
-        // Note: 'bp_get_send_message_button' is a legacy filter. Use
-        // 'bp_get_send_message_button_args' instead. See #4536.
-        return apply_filters( 'bp_get_send_message_button',
-
-            /**
-             * Filters the "Private Message" button for member profile headers.
-             *
-             * @since 1.8.0
-             *
-             * @param array $value See {@link BP_Button}.
-             */
-            bp_get_button( apply_filters( 'bp_get_send_message_button_args', $r ) )
+        /**
+         * Filters the "Private Message" button for member profile headers.
+         *
+         * @since 1.8.0
+         *
+         * @param array $button_args See {@link BP_Button}.
+         */
+        return apply_filters( 'bp_get_send_message_button_args', $button_args );
+    }
+
+    /**
+     * Generate the 'Private Message' button for member profile headers.
+     *
+     * @since 1.2.0
+     * @since 3.0.0 Added `$args` parameter.
+     * @since 11.0.0 uses `bp_get_send_message_button_args()`.
+     *
+     * @see bp_get_send_message_button_args() for description of parameters.
+     *
+     * @param array|string $args See {@link bp_get_send_message_button_args()}.
+     * @return string
+     */
+    function bp_get_send_message_button( $args = '' ) {
+        $button_args = bp_get_send_message_button_args( $args );
+
+        if ( ! array_filter( $button_args ) ) {
+            return '';
+        }
+
+        /** This filter is documented in wp-includes/deprecated.php */
+        $button = apply_filters_deprecated(
+            'bp_get_send_message_button',
+            array( bp_get_button( $button_args ) ),
+            '1.8.0',
+            'bp_get_send_message_button_args'
         );
+
+        return $button;
     }