<!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>[5659] sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php: Support Forums, User Notes: Cache notes output to a static variable, following the idea from the original patch, to avoid repeated template function calls.</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://meta.trac.wordpress.org/changeset/5659">5659</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/5659","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-07-12 14:53:16 +0000 (Wed, 12 Jul 2017)</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'>Support Forums, User Notes: Cache notes output to a static variable, following the idea from the original patch, to avoid repeated template function calls.
See <a href="http://meta.trac.wordpress.org/ticket/2272">#2272</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassusernotesphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassusernotesphp"></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/support-forums/inc/class-user-notes.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/support-forums/inc/class-user-notes.php 2017-07-12 04:10:28 UTC (rev 5658)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php 2017-07-12 14:53:16 UTC (rev 5659)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,8 +22,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bbp_post_request', array( $this, 'add_user_note' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bbp_get_request', array( $this, 'delete_user_note' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'bbp_theme_after_topic_author_details', array( $this, 'add_user_notes_toggle_link' ) );
- add_action( 'bbp_theme_after_reply_author_details', array( $this, 'add_user_notes_toggle_link' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'bbp_theme_after_topic_author_details', array( $this, 'display_user_notes_toggle_link' ) );
+ add_action( 'bbp_theme_after_reply_author_details', array( $this, 'display_user_notes_toggle_link' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bbp_theme_before_topic_content', array( $this, 'display_user_notes_in_content' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bbp_theme_before_reply_content', array( $this, 'display_user_notes_in_content' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -171,7 +171,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves all notes for a particular user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID. Defaults to the current post author.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of user notes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array {
+ * Array of user notes.
+ *
+ * @type int $count User notes count.
+ * @type array $raw Array of raw user notes data.
+ * @type string $html User notes output.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_user_notes( $user_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $user_id ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -188,95 +194,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user_notes = array();
</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->user_notes[ $user_id ] = $user_notes;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $note_id = isset( $_GET['note_id'] ) ? (int) $_GET['note_id'] : 0;
+ $edit_note = isset( $user_notes[ $note_id ] );
</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 $user_notes;
- }
-
- /**
- * Adds toggle link for notes to the author area of a post.
- */
- public function add_user_notes_toggle_link() {
- if ( ! current_user_can( 'moderate' ) ) {
- return;
- }
-
- $user_id = get_the_author_meta( 'ID' );
- $post_id = get_the_ID();
-
- // Only keymasters can see notes on moderators.
- if ( user_can( $user_id, 'moderate' ) && ! current_user_can( 'keep_gate' ) ) {
- return;
- }
-
- printf( '<div class="wporg-bbp-user-notes-toggle"><a href="#" data-post-id="%d">%s</a></div>',
- esc_attr( $post_id ),
- esc_html(
- /* translators: %d: user notes count */
- sprintf( __( 'User Notes (%d)', 'wporg-forums' ),
- count( $this->get_user_notes( $user_id ) )
- )
- )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->user_notes[ $user_id ] = (object) array(
+ 'count' => count( $user_notes ),
+ 'raw' => $user_notes,
+ 'html' => '',
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Retrieves permalink to the post associated with a note.
- *
- * If the note is not associated with a particular post, returns a link
- * to user profile.
- *
- * @param int $post_id Post ID. Default 0.
- * @param int $user_id User ID. Default 0.
- * @param int $site_id Site ID. Default 0.
- * @return string Post permalink or user profile URL.
- */
- public function get_user_note_post_permalink( $post_id = 0, $user_id = 0, $site_id = 0 ) {
- switch_to_blog( $site_id );
-
- $post_type = $post_id ? get_post_type( $post_id ) : '';
-
- if ( 'topic' === $post_type ) {
- $permalink = bbp_get_topic_permalink( $post_id ) . '#post-' . (int) $post_id;
- $permalink = add_query_arg( array(
- 'view' => 'all',
- 'show_user_notes' => $post_id,
- ), $permalink );
- } elseif ( 'reply' === $post_type ) {
- $permalink = bbp_get_reply_url( $post_id );
- $permalink = add_query_arg( array(
- 'view' => 'all',
- 'show_user_notes' => $post_id,
- ), $permalink );
- } else {
- $permalink = bbp_get_user_profile_url( $user_id ) . '#user-notes';
- }
-
- restore_current_blog();
-
- return $permalink;
- }
-
- /**
- * Displays notes for a particular user and a form for adding a new note.
- *
- * @param int $user_id User ID. Defaults to the current post author.
- */
- public function display_user_notes( $user_id = 0 ) {
- $note_id = isset( $_GET['note_id'] ) ? (int) $_GET['note_id'] : 0;
- $user_notes = $this->get_user_notes( $user_id );
- $edit_note = isset( $user_notes[ $note_id ] );
-
- $current_post_type = get_post_type();
-
</del><span class="cx" style="display: block; padding: 0 10px"> foreach ( $user_notes as $key => $note ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_site_id = isset( $note->site_id ) ? (int) $note->site_id : get_current_blog_id();
</span><span class="cx" style="display: block; padding: 0 10px"> $post_permalink = $this->get_user_note_post_permalink( $note->post_id, $user_id, $post_site_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_on_delete = $this->get_user_note_post_permalink( get_the_ID(), $user_id, get_current_blog_id() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $note_meta = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: user note author's display name, 2: link to post, 3: date, 4: time */
- 'author' => sprintf( __( 'By %1$s on <a href="%2$s">%3$s at %4$s</a>', 'wporg-forums' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'author' => sprintf(
+ /* translators: 1: user note author's display name, 2: link to post, 3: date, 4: time */
+ __( 'By %1$s on <a href="%2$s">%3$s at %4$s</a>', 'wporg-forums' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> sprintf( '<a href="%s">%s</a>',
</span><span class="cx" style="display: block; padding: 0 10px"> esc_url( get_home_url( $post_site_id, "/users/{$note->moderator}/" ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> $note->moderator
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -322,7 +257,8 @@
</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">- printf( '<div class="bbp-template-notice warning"><p>%s</p> %s</div>' . "\n",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->user_notes[ $user_id ]->html .= sprintf(
+ '<div class="bbp-template-notice warning"><p>%s</p> %s</div>' . "\n",
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_kses( $note->text, array( 'a' => array( 'href' => true ) ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf( '<p class="wporg-bbp-user-note-meta">%s</p>' . "\n",
</span><span class="cx" style="display: block; padding: 0 10px"> implode( ' | ', $note_meta )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -330,22 +266,66 @@
</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 ( $edit_note && $key == $note_id ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ob_start();
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->display_note_form( $user_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->user_notes[ $user_id ]->html .= ob_get_clean();
</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 class="cx" style="display: block; padding: 0 10px"> if ( ! $user_notes ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- printf( '<div class="bbp-template-notice info"><p>%s</p></div>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->user_notes[ $user_id ]->html .= sprintf(
+ '<div class="bbp-template-notice info"><p>%s</p></div>',
</ins><span class="cx" style="display: block; padding: 0 10px"> esc_html__( 'No notes have been added for this user.', 'wporg-forums' )
</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><span class="cx" style="display: block; padding: 0 10px"> if ( ! $edit_note ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ob_start();
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->display_note_form( $user_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->user_notes[ $user_id ]->html .= ob_get_clean();
</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 $this->user_notes[ $user_id ];
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves permalink to the post associated with a note.
+ *
+ * If the note is not associated with a particular post, returns a link
+ * to user profile.
+ *
+ * @param int $post_id Post ID. Default 0.
+ * @param int $user_id User ID. Default 0.
+ * @param int $site_id Site ID. Default 0.
+ * @return string Post permalink or user profile URL.
+ */
+ public function get_user_note_post_permalink( $post_id = 0, $user_id = 0, $site_id = 0 ) {
+ switch_to_blog( $site_id );
+
+ $post_type = $post_id ? get_post_type( $post_id ) : '';
+
+ if ( 'topic' === $post_type ) {
+ $permalink = bbp_get_topic_permalink( $post_id ) . '#post-' . (int) $post_id;
+ $permalink = add_query_arg( array(
+ 'view' => 'all',
+ 'show_user_notes' => $post_id,
+ ), $permalink );
+ } elseif ( 'reply' === $post_type ) {
+ $permalink = bbp_get_reply_url( $post_id );
+ $permalink = add_query_arg( array(
+ 'view' => 'all',
+ 'show_user_notes' => $post_id,
+ ), $permalink );
+ } else {
+ $permalink = bbp_get_user_profile_url( $user_id ) . '#user-notes';
+ }
+
+ restore_current_blog();
+
+ return $permalink;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Displays the form for adding a new note or editing an existing note.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID. Defaults to the current post author.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -362,7 +342,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"> $note_id = isset( $_GET['note_id'] ) ? (int) $_GET['note_id'] : 0;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_notes = $this->get_user_notes( $user_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_notes = $this->get_user_notes( $user_id )->raw;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $user_notes[ $note_id ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $edit_note = true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -394,6 +374,33 @@
</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">+ * Displays toggle link for notes to the author area of a post.
+ */
+ public function display_user_notes_toggle_link() {
+ if ( ! current_user_can( 'moderate' ) ) {
+ return;
+ }
+
+ $user_id = get_the_author_meta( 'ID' );
+ $post_id = get_the_ID();
+
+ // Only keymasters can see notes on moderators.
+ if ( user_can( $user_id, 'moderate' ) && ! current_user_can( 'keep_gate' ) ) {
+ return;
+ }
+
+ printf( '<div class="wporg-bbp-user-notes-toggle"><a href="#" data-post-id="%d">%s</a></div>',
+ esc_attr( $post_id ),
+ esc_html(
+ /* translators: %d: user notes count */
+ sprintf( __( 'User Notes (%d)', 'wporg-forums' ),
+ $this->get_user_notes( $user_id )->count
+ )
+ )
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Displays existing notes and the form for adding a new note before post content
</span><span class="cx" style="display: block; padding: 0 10px"> * in topics or replies.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -418,7 +425,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"> <div class="<?php echo esc_attr( $class ); ?>" id="wporg-bbp-user-notes-<?php echo esc_attr( $post_id ); ?>">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php $this->display_user_notes( $user_id ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php echo $this->get_user_notes( $user_id )->html; ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -441,7 +448,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wporg-bbp-user-notes">
</span><span class="cx" style="display: block; padding: 0 10px"> <h2 id="user-notes" class="entry-title"><?php esc_html_e( 'User Notes', 'wporg-forums' ); ?></h2>
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="bbp-user-section">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php $this->display_user_notes( $user_id ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php echo $this->get_user_notes( $user_id )->html; ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span></span></pre>
</div>
</div>
</body>
</html>