<!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>[1583] sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-organizer-nags/wordcamp-organizer-nags.php: WordCamp Organizer Nags: Migrate admin notices to a dashboard widget.</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/1583">1583</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/1583","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>2015-05-15 19:02:58 +0000 (Fri, 15 May 2015)</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'>WordCamp Organizer Nags: Migrate admin notices to a dashboard widget.
Admin notices should only be used for relatively urgent messages, not day-to-day tasks, and they should only appear on screens that are relevant. Global, non-dismissable notices with mundane content are counter-productive in the long run, because they train people to ignore all notices.
A dashboard widget is a much more appropriate and sustainable medium for this type of communication.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcamporganizernagswordcamporganizernagsphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-organizer-nags/wordcamp-organizer-nags.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcamporganizernagswordcamporganizernagsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-organizer-nags/wordcamp-organizer-nags.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-organizer-nags/wordcamp-organizer-nags.php 2015-05-15 18:47:02 UTC (rev 1582)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-organizer-nags/wordcamp-organizer-nags.php 2015-05-15 19:02:58 UTC (rev 1583)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,25 +8,45 @@
</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"> class WordCampOrganizerNags {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected $notices;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $need_central_about_info, $needed_pages;
</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"> * Constructor
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->notices = array( 'updated' => array(), 'error' => array() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'admin_print_styles-index.php', array( $this, 'print_styles' ) );
+ add_action( 'wp_dashboard_setup', array( $this, 'create_dashboard_widgets' ) );
</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_action( 'wp_dashboard_setup', array( $this, 'create_dashboard_widgets' ) );
- add_action( 'admin_notices', array( $this, 'print_admin_notices' ) );
- add_action( 'admin_init', array( $this, 'central_about_info' ) );
- add_action( 'admin_init', array( $this, 'published_attendees_schedule_pages' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // todo align
</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">+ * Print wp-admin styles
+ */
+ public function print_styles() {
+ ?>
+
+ <style type="text/css">
+ #wordcamp_reminders ul {
+ margin-left: 12px;
+ list-style-type: disc;
+ }
+ </style>
+
+ <?php
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Create dashboard widgets
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_dashboard_widgets() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_meta_boxes;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->show_wordcamp_reminders() ) {
+ wp_add_dashboard_widget(
+ 'wordcamp_reminders',
+ 'WordCamp Reminders',
+ array( $this, 'render_wordcamp_reminders' )
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The survey expires 2015-05-23 at 11:45pm EST
</span><span class="cx" style="display: block; padding: 0 10px"> if ( time() < 1432350000 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,86 +55,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'WordCamp Organizer Survey',
</span><span class="cx" style="display: block; padding: 0 10px"> array( $this, 'improving_tools_survey' )
</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">- // Move it to the top of the side column, so it'll be seen better
- $wp_meta_boxes['dashboard']['side']['core'] = array_merge(
- array( 'improving_tools_survey' => $wp_meta_boxes['dashboard']['normal']['core']['improving_tools_survey'] ),
- $wp_meta_boxes['dashboard']['side']['core']
- );
- unset( $wp_meta_boxes['dashboard']['normal']['core']['improving_tools_survey'] );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->prioritize_wordcamp_widgets();
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Render the content for the WordCamp Organizer Survey dashboard widget
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determine if we need to show the WordCamp Reminders widget
+ *
+ * @return bool
</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 improving_tools_survey() {
- ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function show_wordcamp_reminders() {
+ $this->need_central_about_info = $this->check_central_about_info();
+ $this->needed_pages = $this->check_needed_pages();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <p>We need feedback from WordCamp organizers to drive some decisions about improving WordCamp.org tools.</p>
-
- <p>
- Please <a href="https://make.wordpress.org/community/2015/05/05/wordcamp-organizer-survey/">take the survey</a>
- so we can learn from your experiences.
- </p>
-
- <?php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $this->need_central_about_info || $this->needed_pages;
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Prints all of the notices and errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Check if the organizers have given us their "About" text and banner image for their central.wordcamp.org page
+ *
+ * @return bool
</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 print_admin_notices() {
- $this->notices = apply_filters( 'wcon_notices', $this->notices );
-
- foreach( array( 'updated', 'error' ) as $type ) :
- if ( $this->notices[ $type ] ) : ?>
-
- <div class="<?php echo $type; ?>">
- <?php foreach( $this->notices[ $type ] as $nag ) : ?>
- <p><?php echo $nag; ?></p>
- <?php endforeach; ?>
- </div>
-
- <?php endif;
- endforeach;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function check_central_about_info() {
+ $transient_key = 'wcorg_need_central_info';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Check if the organizers have given us their "About" text and banner image for their central.wordcamp.org page
- */
- public function central_about_info() {
- $site_url = parse_url( site_url() );
- switch_to_blog( BLOG_ID_CURRENT_SITE ); // central.wordcamp.org
-
- $wordcamp = get_posts( array(
- 'post_type' => 'wordcamp',
- 'posts_per_page' => 1,
- 'meta_query' => array(
- array(
- 'key' => 'URL',
- 'value' => $site_url['host'],
- 'compare' => 'LIKE',
- )
- )
- ) );
-
- if ( isset( $wordcamp[0]->ID ) ) {
- if ( ! has_post_thumbnail( $wordcamp[0]->ID ) || empty( $wordcamp[0]->post_content ) ) {
- $this->notices['updated'][] = 'Please send us the <a href="http://plan.wordcamp.org/first-steps/web-presence/your-page-on-central-wordcamp-org/">"about" text and banner image</a> for your central.wordcamp.org page.</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $need_info = get_transient( $transient_key ) ) {
+ return 'yes' == $need_info;
+ }
+
+ $need_info = 'yes';
+ $wordcamp = get_wordcamp_post();
+
+ if ( isset( $wordcamp->ID ) ) {
+ switch_to_blog( BLOG_ID_CURRENT_SITE ); // central.wordcamp.org
+
+ if ( has_post_thumbnail( $wordcamp->ID ) && $wordcamp->post_content ) {
+ $need_info = 'no';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ restore_current_blog();
</ins><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">- restore_current_blog();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ set_transient( $transient_key, $need_info, HOUR_IN_SECONDS );
+
+ return 'yes' == $need_info;
</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"> * Checks if Attendees and Schedule pages have been published along with the Ticket Registration page
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @todo When publishing an attendee or schedule page, delete the transient to trigger a refresh
+ *
+ * @return array
</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 published_attendees_schedule_pages() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function check_needed_pages() {
+ $transient_key = 'wcorg_needed_pages';
+ $needed_pages = get_transient( $transient_key );
+
+ if ( false !== $needed_pages ) {
+ return $needed_pages;
+ }
+
+ $needed_pages = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> $found_registration = $found_attendees = $found_schedule = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $published_pages = get_posts( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_type' => 'page',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post_status' => 'publish',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'posts_per_page' => -1
</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">@@ -137,13 +144,85 @@
</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 ( $found_registration && ! $found_attendees ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->notices['updated'][] = 'Tickets are on sale now! Don’t forget to <a href="http://plan.wordcamp.org/using-camptix/#attendees-list">publish an Attendees page</a>, so everyone can see what amazing people are coming to your WordCamp.';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $needed_pages[] = 'attendees';
</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"> if ( $found_registration && ! $found_schedule ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->notices['updated'][] = 'Tickets sell a lot faster when people can see who\'s speaking at your WordCamp. How about <a href="http://plan.wordcamp.org/first-steps/web-presence/working-with-speakers-sessions-and-sponsors/#schedule">publishing a schedule</a> today?';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $needed_pages[] = 'schedule';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ set_transient( $transient_key, $needed_pages, HOUR_IN_SECONDS );
+
+ return $needed_pages;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Make our custom dashboard widgets more visible
+ */
+ protected function prioritize_wordcamp_widgets() {
+ global $wp_meta_boxes;
+
+ // Move WordCamp Reminders to the top of the primary column
+ if ( isset( $wp_meta_boxes['dashboard']['normal']['core']['wordcamp_reminders'] ) ) {
+ $reminders_temp = $wp_meta_boxes['dashboard']['normal']['core']['wordcamp_reminders'];
+ unset( $wp_meta_boxes['dashboard']['normal']['core']['wordcamp_reminders'] );
+
+ $wp_meta_boxes['dashboard']['normal']['core'] = array_merge(
+ array( 'wordcamp_reminders' => $reminders_temp ),
+ $wp_meta_boxes['dashboard']['normal']['core']
+ );
+ }
+
+ // Move WordCamp Organizer Survey to the top of the side column
+ if ( isset( $wp_meta_boxes['dashboard']['normal']['core']['improving_tools_survey'] ) ) {
+ $wp_meta_boxes['dashboard']['side']['core'] = array_merge(
+ array( 'improving_tools_survey' => $wp_meta_boxes['dashboard']['normal']['core']['improving_tools_survey'] ),
+ $wp_meta_boxes['dashboard']['side']['core']
+ );
+
+ unset( $wp_meta_boxes['dashboard']['normal']['core']['improving_tools_survey'] );
+ }
+ }
+
+ /**
+ * Render the content for the WordCamp Reminders dashboard widget
+ */
+ public function render_wordcamp_reminders() {
+ ?>
+
+ <ul>
+ <?php if ( $this->need_central_about_info ) : ?>
+ <li>Please send us <a href="http://plan.wordcamp.org/first-steps/web-presence/your-page-on-central-wordcamp-org/">the "about" text and banner image</a> for your central.wordcamp.org page.</a></li>
+ <?php endif; ?>
+
+ <?php if ( in_array( 'attendees', $this->needed_pages ) ) : ?>
+ <li>Tickets are on sale now! Don’t forget to <a href="http://plan.wordcamp.org/using-camptix/#attendees-list">publish an Attendees page</a>, so everyone can see what amazing people are coming to your WordCamp.</li>
+ <?php endif; ?>
+
+ <?php if ( in_array( 'schedule', $this->needed_pages ) ) : ?>
+ <li>Tickets sell a lot faster when people can see who's speaking at your WordCamp. How about <a href="http://plan.wordcamp.org/first-steps/web-presence/working-with-speakers-sessions-and-sponsors/#schedule">publishing a schedule</a> today?</li>
+ <?php endif; ?>
+ </ul>
+
+ <?php
+ }
+
+ /**
+ * Render the content for the WordCamp Organizer Survey dashboard widget
+ */
+ public function improving_tools_survey() {
+ // todo rename to render_tools_survey() for consistency
+ ?>
+
+ <p>We need feedback from WordCamp organizers to drive some decisions about improving WordCamp.org tools.</p>
+
+ <p>
+ Please <a href="https://make.wordpress.org/community/2015/05/05/wordcamp-organizer-survey/">take the survey</a>
+ so we can learn from your experiences.
+ </p>
+
+ <?php
+ }
</ins><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">-$GLOBALS['WordCampOrganizerNags'] = new WordCampOrganizerNags();
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$GLOBALS['WordCampOrganizerNags'] = new WordCampOrganizerNags();
</ins></span></pre>
</div>
</div>
</body>
</html>