<!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][11237] trunk/src/bp-blogs: Adds PHPDocs to missed filters in the blogs component.</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 { 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/11237">11237</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/11237","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-05 00:13:46 +0000 (Sat, 05 Nov 2016)</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'>Adds PHPDocs to missed filters in the blogs component.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpblogsbpblogsactivityphp">trunk/src/bp-blogs/bp-blogs-activity.php</a></li>
<li><a href="#trunksrcbpblogsbpblogsfunctionsphp">trunk/src/bp-blogs/bp-blogs-functions.php</a></li>
<li><a href="#trunksrcbpblogsbpblogstemplatephp">trunk/src/bp-blogs/bp-blogs-template.php</a></li>
<li><a href="#trunksrcbpblogsclassesclassbpblogsblogphp">trunk/src/bp-blogs/classes/class-bp-blogs-blog.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpblogsbpblogsactivityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/bp-blogs-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/bp-blogs-activity.php 2016-11-04 18:23:40 UTC (rev 11236)
+++ trunk/src/bp-blogs/bp-blogs-activity.php 2016-11-05 00:13:46 UTC (rev 11237)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -624,6 +624,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $is_private && ! $no_activity && bp_blogs_is_blog_trackable( $recorded_blog->blog_id, $recorded_blog->user_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_blogs_record_activity( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => $recorded_blog->user_id,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the activity created blog primary link.
+ *
+ * @since 1.1.0
+ *
+ * @param string $value Blog primary link.
+ * @param int $value Blog ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> 'primary_link' => apply_filters( 'bp_blogs_activity_created_blog_primary_link', bp_blogs_get_blogmeta( $recorded_blog->blog_id, 'url' ), $recorded_blog->blog_id ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'new_blog',
</span><span class="cx" style="display: block; padding: 0 10px"> 'item_id' => $recorded_blog->blog_id
</span></span></pre></div>
<a id="trunksrcbpblogsbpblogsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/bp-blogs-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/bp-blogs-functions.php 2016-11-04 18:23:40 UTC (rev 11236)
+++ trunk/src/bp-blogs/bp-blogs-functions.php 2016-11-05 00:13:46 UTC (rev 11237)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,7 +65,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $r['include_blog_ids']
</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">- // Filter and return.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters a set of blogs.
+ *
+ * @since 1.2.0
+ *
+ * @param array $blogs Array of blog data.
+ * @param array $r Parsed query arguments.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_blogs_get_blogs', $blogs, $r );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -246,9 +253,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_blogs_is_blog_recordable( $blog_id, $user_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not a blog is globally activity stream recordable.
+ *
+ * @since 1.7.0
+ *
+ * @param bool $value Whether or not recordable. Default true.
+ * @param int $blog_id Current blog ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $recordable_globally = apply_filters( 'bp_blogs_is_blog_recordable', true, $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $user_id ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not a blog is globally activity stream recordable for user.
+ *
+ * @since 1.7.0
+ *
+ * @param bool $recordable_globally Whether or not recordable.
+ * @param int $blog_id Current blog ID.
+ * @param int $user_id Current user ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $recordable_for_user = apply_filters( 'bp_blogs_is_blog_recordable_for_user', $recordable_globally, $blog_id, $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $recordable_for_user = $recordable_globally;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,9 +299,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_blogs_is_blog_trackable( $blog_id, $user_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not a blog is globally trackable.
+ *
+ * @since 1.7.0
+ *
+ * @param bool $value Whether or not trackable.
+ * @param int $blog_id Current blog ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $trackable_globally = apply_filters( 'bp_blogs_is_blog_trackable', bp_blogs_is_blog_recordable( $blog_id, $user_id ), $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $user_id ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters whether or not a blog is globally trackable for user.
+ *
+ * @since 1.7.0
+ *
+ * @param bool $value Whether or not trackable.
+ * @param int $blog_id Current blog ID.
+ * @param int $user_id Current user ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $trackable_for_user = apply_filters( 'bp_blogs_is_blog_trackable_for_user', $trackable_globally, $blog_id, $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $trackable_for_user = $trackable_globally;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -344,6 +386,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_blogs_update_blogmeta( $recorded_blog->blog_id, 'thread_comments_depth', $thread_depth );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $is_private = !empty( $_POST['blog_public'] ) && (int) $_POST['blog_public'] ? false : true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters whether or not a new blog is public.
+ *
+ * @since 1.5.0
+ *
+ * @param bool $is_private Whether or not blog is public.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $is_private = !apply_filters( 'bp_is_new_blog_public', !$is_private );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -844,6 +894,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_blogs_get_allowed_roles() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the allowed roles a member must have to be recorded into bp_user_blogs pointer table.
+ *
+ * @since 2.1.0
+ *
+ * @param array $value Array of potential roles user needs.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_blogs_get_allowed_roles', array( 'contributor', 'author', 'editor', 'administrator' ) );
</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="trunksrcbpblogsbpblogstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/bp-blogs-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/bp-blogs-template.php 2016-11-04 18:23:40 UTC (rev 11236)
+++ trunk/src/bp-blogs/bp-blogs-template.php 2016-11-05 00:13:46 UTC (rev 11237)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -645,7 +645,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the last active date of the current blog in the loop.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 1.2.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $last_activity Last active date.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $r Array of parsed args used to determine formatting.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1401,6 +1401,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $output = '<li id="blog-create-nav">' . $create_blog_button . '</li>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the Create A Site nav item output.
+ *
+ * @since 2.2.0
+ *
+ * @param string $output Nav item output.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_blog_create_nav_item', $output );
</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="trunksrcbpblogsclassesclassbpblogsblogphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/classes/class-bp-blogs-blog.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/classes/class-bp-blogs-blog.php 2016-11-04 18:23:40 UTC (rev 11236)
+++ trunk/src/bp-blogs/classes/class-bp-blogs-blog.php 2016-11-05 00:13:46 UTC (rev 11237)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +75,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function save() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the blog user ID before save.
+ *
+ * @since 1.0.0
+ *
+ * @param int $value User ID.
+ * @param int $value Site ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->user_id = apply_filters( 'bp_blogs_blog_user_id_before_save', $this->user_id, $this->id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the blog blog ID before save.
+ *
+ * @since 1.0.0
+ *
+ * @param int $value Blog ID.
+ * @param int $value Site ID.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->blog_id = apply_filters( 'bp_blogs_blog_id_before_save', $this->blog_id, $this->id );
</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>