<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13300] trunk/src: Introduce a function to only get the Private Message button arguments</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13300">13300</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13300","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-07-22 09:32:13 +0000 (Fri, 22 Jul 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/7126">#7126</a>
See <a href="http://buddypress.trac.wordpress.org/ticket/8722">#8722</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagestemplatephp">trunk/src/bp-messages/bp-messages-template.php</a></li>
<li><a href="#trunksrcbptemplatesbpnouveauincludesmemberstemplatetagsphp">trunk/src/bp-templates/bp-nouveau/includes/members/template-tags.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagestemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-template.php 2022-07-22 09:00:42 UTC (rev 13299)
+++ trunk/src/bp-messages/bp-messages-template.php 2022-07-22 09:32:13 UTC (rev 13300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1504,35 +1504,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0 Added `$args` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array|string $args See {@link bp_get_send_message_button()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see bp_get_send_message_button_args() for description of parameters.
+ *
+ * @param array|string $args See {@link bp_get_send_message_button_args()}.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_send_message_button( $args = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo bp_get_send_message_button( $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Generate the 'Private Message' button for member profile headers.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get the arguments for the private message button.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 1.2.0
- * @since 3.0.0 Added `$args` parameter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 11.0.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array The arguments for the public message button.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function bp_get_send_message_button( $args = '' ) {
-
- $r = bp_parse_args(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function bp_get_send_message_button_args( $args = '' ) {
+ $button_args = bp_parse_args(
</ins><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => 'private_message',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1542,23 +1544,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wrapper_id' => 'send-private-message',
</span><span class="cx" style="display: block; padding: 0 10px"> 'link_href' => bp_get_send_private_message_link(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'link_text' => __( 'Private Message', 'buddypress' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'link_title' => __( 'Send a private message to this member.', 'buddypress' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'link_class' => 'send-message',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * 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 ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ return $button;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcbptemplatesbpnouveauincludesmemberstemplatetagsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-templates/bp-nouveau/includes/members/template-tags.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-templates/bp-nouveau/includes/members/template-tags.php 2022-07-22 09:00:42 UTC (rev 13299)
+++ trunk/src/bp-templates/bp-nouveau/includes/members/template-tags.php 2022-07-22 09:32:13 UTC (rev 13300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -401,49 +401,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_active( 'messages' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * This filter workaround is waiting for a core adaptation
- * so that we can directly get the private messages button arguments
- * instead of the button.
- * @see https://buddypress.trac.wordpress.org/ticket/7126
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $button_args = bp_get_send_message_button_args();
+
+ /*
+ * This button should remain as an anchor link.
+ * Hardcode the use of anchor elements if button arg passed in for other elements.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'bp_get_send_message_button_args', 'bp_nouveau_members_catch_button_args', 100, 1 );
-
- bp_get_send_message_button();
-
- remove_filter( 'bp_get_send_message_button_args', 'bp_nouveau_members_catch_button_args', 100, 1 );
-
- if ( isset( bp_nouveau()->members->button_args ) && bp_nouveau()->members->button_args ) {
- $button_args = bp_nouveau()->members->button_args;
-
- /*
- * This button should remain as an anchor link.
- * Hardcode the use of anchor elements if button arg passed in for other elements.
- */
- $buttons['private_message'] = array(
- 'id' => $button_args['id'],
- 'position' => 25,
- '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' => 'a',
- 'link_text' => $button_args['link_text'],
- 'parent_attr' => array(
- 'id' => $button_args['wrapper_id'],
- 'class' => $parent_class,
- ),
- 'button_attr' => array(
- 'href' => bp_get_send_private_message_link(),
- 'id' => false,
- 'class' => $button_args['link_class'],
- 'rel' => '',
- 'title' => '',
- ),
- );
-
- unset( bp_nouveau()->members->button_args );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $buttons['private_message'] = array(
+ 'id' => $button_args['id'],
+ 'position' => 25,
+ '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' => 'a',
+ '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' => bp_get_send_private_message_link(),
+ 'id' => false,
+ 'class' => $button_args['link_class'],
+ 'rel' => '',
+ 'title' => '',
+ ),
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>