<!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>[12017] sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier: Profiles: Notify of activity when handbooks are updated.</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://meta.trac.wordpress.org/changeset/12017">12017</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/12017","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-08-12 21:13:41 +0000 (Fri, 12 Aug 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'>Profiles: Notify of activity when handbooks are updated.
See https://github.com/WordPress/five-for-the-future/issues/193</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgprofileswpactivitynotifiertestse2ephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/tests/e2e.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgprofileswpactivitynotifierwporgprofileswpactivitynotifierphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/wporg-profiles-wp-activity-notifier.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgprofileswpactivitynotifiertestse2ephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/tests/e2e.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/tests/e2e.php 2022-08-12 21:13:14 UTC (rev 12016)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/tests/e2e.php 2022-08-12 21:13:41 UTC (rev 12017)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,7 +8,7 @@
</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"> namespace WordPressdotorg\Activity_Notifier\Tests;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-use WPOrg_WP_Activity_Notifier;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use WPOrg_WP_Activity_Notifier, WP_User;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> ini_set( 'display_errors', 'On' ); // won't do anything if fatal errors
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,7 +51,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $plugins;
</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">-function test_post( WPOrg_WP_Activity_Notifier $notifier ) : void {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function test_new_post( WPOrg_WP_Activity_Notifier $notifier ) : void {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'IS_WORDCAMP_NETWORK' ) && IS_WORDCAMP_NETWORK ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $notifier->maybe_notify_new_published_post( 'publish', 'draft', get_post( 1 ) ); // post
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,6 +68,25 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function test_update_handbook( WPOrg_WP_Activity_Notifier $notifier, WP_User $user ) : void {
+ // WordCamp.org doesn't use the Handbook plugin.
+ if ( defined( 'IS_WORDCAMP_NETWORK' ) && IS_WORDCAMP_NETWORK ) {
+ return;
+ }
+
+ wp_set_current_user( $user->ID );
+
+ // This should notify
+ $handbook = get_post( 1849 );
+ $notifier->maybe_notify_updated_post( $handbook->ID, $handbook, $handbook );
+
+ sleep( 1 ); // buddypress doesn't show activity that happens at the exact same time
+
+ // This should not notify
+ $regular_post = get_post( 1879 ); // `post` post type.
+ $notifier->maybe_notify_updated_post( $regular_post->ID, $regular_post, $regular_post );
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_comment( WPOrg_WP_Activity_Notifier $notifier ) : void {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'IS_WORDCAMP_NETWORK' ) && IS_WORDCAMP_NETWORK ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_id = 1;
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgprofileswpactivitynotifierwporgprofileswpactivitynotifierphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/wporg-profiles-wp-activity-notifier.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/wporg-profiles-wp-activity-notifier.php 2022-08-12 21:13:14 UTC (rev 12016)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-profiles-wp-activity-notifier/wporg-profiles-wp-activity-notifier.php 2022-08-12 21:13:41 UTC (rev 12017)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,6 +51,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function init() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'transition_post_status', array( $this, 'maybe_notify_new_published_post' ), 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'post_updated', array( $this, 'maybe_notify_updated_post' ), 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'transition_comment_status', array( $this, 'maybe_notify_new_approved_comment' ), 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_insert_comment', array( $this, 'insert_comment' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,16 +80,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Indicates whether it is permitted to notify about a post or not.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The post
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $action 'publish' for new posts, 'update' for existing posts, 'comment' for new comments.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return boolean True == the post can be notified about.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function is_post_notifiable( $post ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function is_post_notifiable( $post, $action ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $post || ! is_a( $post, 'WP_Post' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // wp-parser-* post types belong to developer.wordpress.org
- $notifiable_post_types = array( 'post', 'handbook', 'wporg_workshop', 'lesson-plan', 'course', 'wp-parser-hook', 'wp-parser-function', 'wp-parser-method', 'wp-parser-class' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // All actions can notify about handbooks.
+ $notifiable_post_types = array( 'handbook' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // There's a large number of custom handbooks, and more will be created in the future.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( str_contains( $post->post_type, '-handbook' ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,6 +97,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $notifiable_post_types[] = $post->post_type;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'publish' === $action || 'comment' === $action ) {
+ $notifiable_post_types = array_merge(
+ $notifiable_post_types,
+ array( 'post', 'handbook', 'wporg_workshop', 'lesson-plan', 'course' )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_plugin_active( 'subscribers-only.php' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $notifiable = false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,24 +152,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- if ( ! $this->is_post_notifiable( $post ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_post_notifiable( $post, 'publish' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- $this->notify_new_blog_post( $post );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->notify_blog_post( $post, 'new' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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><span class="cx" style="display: block; padding: 0 10px"> * Sends activity notification for new blog post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The published post
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $type 'new' for new posts, 'update' for existing ones.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function notify_new_blog_post( $post ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function notify_blog_post( $post, $type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- $author = get_user_by( 'id', $post->post_author );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_id = 'new' === $type ? $post->post_author : get_current_user_id();
+ $user = get_user_by( 'id', $user_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $content = wp_trim_words(
</span><span class="cx" style="display: block; padding: 0 10px"> strip_shortcodes( has_excerpt( $post ) ? $post->post_excerpt : $post->post_content ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,8 +181,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => 'wporg_handle_activity',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => $type,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'source' => 'wordpress',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user' => $author->user_login,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user' => $user->user_login,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'post_id' => $post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'blog' => get_bloginfo( 'name' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'blog_url' => site_url(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,6 +197,21 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Send an activity notification if the post being updated matches certain criteria.
+ */
+ public function maybe_notify_updated_post( int $post_id, WP_Post $before, WP_Post $after ) : void {
+ if ( 'publish' !== $before->post_status || 'publish' !== $after->post_status ) {
+ return;
+ }
+
+ if ( ! $this->is_post_notifiable( $after, 'update' ) ) {
+ return;
+ }
+
+ $this->notify_blog_post( $after, 'update' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Handler for comment creation.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $id Comment ID
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -209,7 +237,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post( $comment->comment_post_ID );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $this->is_post_notifiable( $post ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_post_notifiable( $post, 'comment' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</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>