Changeset 1371

Timestamp:

03/03/2015 11:51:49 PM (11 years ago)

Author:

iandunn

Message:

WordCamp Post Types: Make get_{speakers|sessions|organizers}_permalink DRY.

They were exactly the same except the for the shortcode value, so a single DRY method that handles all three cases is easier to maintain and less prone to errors.

Location:

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types

Files:

• inc/widgets.php (modified) (3 diffs)
• wc-post-types.php (modified) (4 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/inc/widgets.php

@@ -149 +149 @@
         echo $widget_content;
 
-        $speakers_permalink = $wcpt_plugin->get_speakers_permalink();
+        $speakers_permalink = $wcpt_plugin->get_wcpt_permalink( 'speakers' );
         if ( ! empty( $speakers_permalink ) )
             printf( '<a class="wcpt-speakers-link" href="%s">%s</a>', esc_url( $speakers_permalink ), esc_html( __( 'View all speakers &rarr;', 'wordcamporg' ) ) );
@@ -255 +255 @@
         echo $widget_content;
 
-        $sessions_permalink = $wcpt_plugin->get_sessions_permalink();
+        $sessions_permalink = $wcpt_plugin->get_wcpt_permalink( 'sessions' );
         if ( ! empty( $sessions_permalink ) )
             printf( '<a class="wcpt-sessions-link" href="%s">%s</a>', esc_url( $sessions_permalink ), esc_html( __( 'View all sessions &rarr;', 'wordcamporg' ) ) );
@@ -356 +356 @@
         echo $widget_content;
 
-        $organizers_permalink = $wcpt_plugin->get_organizers_permalink();
+        $organizers_permalink = $wcpt_plugin->get_wcpt_permalink( 'organizers' );
         if ( ! empty( $organizers_permalink ) )
             printf( '<a class="wcpt-organizers-link" href="%s">%s</a>', esc_url( $organizers_permalink ), esc_html( __( 'Organizing team &rarr;', 'wordcamporg' ) ) );

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/wc-post-types.php

@@ -8 +8 @@
 
 class WordCamp_Post_Types_Plugin {
+    protected $wcpt_permalinks;
 
     /**
@@ -13 +14 @@
      */
     function __construct() {
+        $this->wcpt_permalinks = array();
+
         add_action( 'init', array( $this, 'register_post_types' ) );
         add_action( 'init', array( $this, 'register_taxonomies' ) );
@@ -748 +751 @@
         switch( $post->post_type ) {
             case 'wcb_speaker':
-                $permalink = $this->get_speakers_permalink();
+                $permalink = $this->get_wcpt_permalink( 'speakers' );
                 $anchor_id = $post->post_name;
                 break;
 
             case 'wcb_session':
-                $permalink = $this->get_sessions_permalink();
+                $permalink = $this->get_wcpt_permalink( 'sessions' );
                 $anchor_id = $post->ID;
                 break;
@@ -775 +778 @@
 
     /**
-     * Returns the speakers page permalink
-     *
-     * Fetches for a post or page with the [speakers] shortcode and
+     * Returns the page permalink for speakers, sessions or organizers
+     *
+     * Fetches for a post or page with the [speakers | sessions | organizers] shortcode and
      * returns the permalink of whichever comes first.
-     */
-    function get_speakers_permalink() {
-        // todo combine this, get_sessions_permalink, and get_organizers_permalink into a DRY function
-        
-        if ( isset( $this->speakers_permalink ) )
-            return $this->speakers_permalink;
-
-        $this->speakers_permalink = false;
-
-        $speakers_post = get_posts( array(
-            'post_type' => array( 'post', 'page' ),
-            'post_status' => 'publish',
-            's' => '[speakers',
+     *
+     * @param string $type
+     *
+     * @return false | string
+     */
+    function get_wcpt_permalink( $type ) {
+        if ( ! in_array( $type, array( 'speakers', 'sessions', 'organizers' ) ) ) {
+            return false;
+        }
+
+        /*
+         * The [schedule] shortcode can call this for each session and speaker, so cache the result to avoid
+         * dozens of SQL queries.
+         */
+        if ( isset( $this->wcpt_permalinks[ $type ] ) ) {
+            return $this->wcpt_permalinks[ $type ];
+        }
+
+        $this->wcpt_permalinks[ $type ] = false;
+
+        $wcpt_post = get_posts( array(
+            'post_type'      => array( 'post', 'page' ),
+            'post_status'    => 'publish',
+            's'              => '[' . $type,
             'posts_per_page' => 1,
         ) );
 
-        if ( ! empty( $speakers_post ) )
-            $this->speakers_permalink = get_permalink( $speakers_post[0] );
-
-        return $this->speakers_permalink;
-    }
-
-    /**
-     * Returns the sessions page permalink
-     */
-    function get_sessions_permalink() {
-        if ( isset( $this->sessions_permalink ) )
-            return $this->sessions_permalink;
-
-        $this->sessions_permalink = false;
-
-        $sessions_post = get_posts( array(
-            'post_type' => array( 'post', 'page' ),
-            'post_status' => 'publish',
-            's' => '[sessions',
-            'posts_per_page' => 1,
-        ) );
-
-        if ( ! empty( $sessions_post ) )
-            $this->sessions_permalink = get_permalink( $sessions_post[0] );
-
-        return $this->sessions_permalink;
-    }
-
-    /**
-     * Returns the organizers page permalink
-     */
-    function get_organizers_permalink() {
-        if ( isset( $this->organizers_permalink ) )
-            return $this->organizers_permalink;
-
-        $this->organizers_permalink = false;
-
-        $organizers_post = get_posts( array(
-            'post_type' => array( 'post', 'page' ),
-            'post_status' => 'publish',
-            's' => '[organizers',
-            'posts_per_page' => 1,
-        ) );
-
-        if ( ! empty( $organizers_post ) )
-            $this->organizers_permalink = get_permalink( $organizers_post[0] );
-
-        return $this->organizers_permalink;
+        if ( ! empty( $wcpt_post ) ) {
+            $this->wcpt_permalinks[ $type ] = get_permalink( $wcpt_post[0] );
+        }
+
+        return $this->wcpt_permalinks[ $type ];
     }