<!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>[10794] sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/watchlist.php: Handbooks, Watchlist: Play nicer with o2 to avoid error_log messages when creating a watch/unwatch action link</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/10794">10794</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/10794","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-03-07 20:41:31 +0000 (Sun, 07 Mar 2021)</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'>Handbooks, Watchlist: Play nicer with o2 to avoid error_log messages when creating a watch/unwatch action link
* Call `o2_register_post_action_states()` when function exists to register config for the two watch states
* Introduce `get_default_post_action_info()` as getter for config info for each watch state
* Configure more action attributes expected by o2 (e.g. initialState, genericon, rel, shortText)
* Prevent "no post action states have been registered for action watch" error_log message</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookincwatchlistphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/watchlist.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginshandbookincwatchlistphp"></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/handbook/inc/watchlist.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/handbook/inc/watchlist.php 2021-03-07 20:40:12 UTC (rev 10793)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/watchlist.php 2021-03-07 20:41:31 UTC (rev 10794)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +27,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function on_init() {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$post_types = WPorg_Handbook_Init::get_post_types();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::o2_register_default_post_action_states();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'p2_action_links', [ __CLASS__, 'display_action_link' ], 100 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'o2_filter_post_actions', [ __CLASS__, 'add_o2_action_link' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'o2_filter_post_action_html', [ __CLASS__, 'get_o2_action_link' ], 10, 2 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,6 +35,54 @@
</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">+ * Returns default post action info.
+ *
+ * @param string $type The post action type. Either 'watch' or 'unwatch'.
+ * @return array
+ */
+ protected static function get_default_post_action_info( $type ) {
+ $info = [];
+
+ if ( ! in_array( $type, [ 'unwatch', 'watch' ] ) ) {
+ return $info;
+ }
+
+ if ( 'watch' === $type ) {
+ $info = [
+ 'shortText' => __( 'Watch', 'wporg' ),
+ 'title' => __( 'Get notified about changes to this page', 'wporg' ),
+ 'genericon' => 'genericon-subscribe',
+ 'classes' => [ 'genericon', 'genericon-subscribe' ],
+ 'rel' => false,
+ ];
+ } else {
+ $info = [
+ 'shortText' => __( 'Unwatch', 'wporg' ),
+ 'title' => __( 'Stop getting notified about changes to this page', 'wporg' ),
+ 'genericon' => 'genericon-unsubscribe',
+ 'classes' => [ 'genericon', 'genericon-unsubscribe' ],
+ 'rel' => false,
+ ];
+ }
+
+ return $info;
+ }
+
+ /**
+ * Registers default post action states.
+ */
+ public static function o2_register_default_post_action_states() {
+ if( ! function_exists( 'o2_register_post_action_states' ) ) {
+ return;
+ }
+
+ o2_register_post_action_states( 'watch', [
+ 'unwatch' => self::get_default_post_action_info( 'unwatch' ),
+ 'watch' => self::get_default_post_action_info( 'watch' ),
+ ] );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Adds a 'Watch' action link to O2.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $actions Array of O2 actions.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,21 +102,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $watchlist = get_post_meta( $post->ID, '_wporg_watchlist', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $watchlist && in_array( get_current_user_id(), $watchlist ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actions[35] = [
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actions[35] = wp_parse_args( [
</ins><span class="cx" style="display: block; padding: 0 10px"> 'action' => 'watch',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'text' => __( 'Unwatch', 'wporg' ),
</del><span class="cx" style="display: block; padding: 0 10px"> 'href' => wp_nonce_url( admin_url( 'admin-post.php?action=wporg_watchlist&post_id=' . $post->ID ), 'unwatch-' . $post->ID ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => __( 'Stop getting notified about changes to this page', 'wporg' ),
- 'classes' => [ 'genericon', 'genericon-unsubscribe' ],
- ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'initialState' => 'unwatch',
+ ], self::get_default_post_action_info( 'unwatch' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actions[35] = [
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actions[35] = wp_parse_args( [
</ins><span class="cx" style="display: block; padding: 0 10px"> 'action' => 'watch',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'text' => __( 'Watch', 'wporg' ),
</del><span class="cx" style="display: block; padding: 0 10px"> 'href' => wp_nonce_url( admin_url( 'admin-post.php?action=wporg_watchlist&watch=1&post_id=' . $post->ID ), 'watch-' . $post->ID ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => __( 'Get notified about changes to this page', 'wporg' ),
- 'classes' => [ 'genericon', 'genericon-subscribe' ],
- ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'initialState' => 'watch',
+ ], self::get_default_post_action_info( 'watch' ) );
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,7 +133,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $action['href'],
</span><span class="cx" style="display: block; padding: 0 10px"> $action['title'],
</span><span class="cx" style="display: block; padding: 0 10px"> implode( ' ', $action['classes'] ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $action['text']
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $action['shortText']
</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>