]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-content/themes/twentyfourteen/inc/featured-content.php
WordPress 4.6.3
[autoinstalls/wordpress.git] / wp-content / themes / twentyfourteen / inc / featured-content.php
index 64858745718562866c177e6f26b895729552f7fd..ffeb993db81ff4bc80403d9664712f6e55d2c24e 100644 (file)
@@ -8,7 +8,7 @@
  * For maximum compatibility with different methods of posting users
  * will designate a featured post tag to associate posts with. Since
  * this tag now has special meaning beyond that of a normal tags, users
  * For maximum compatibility with different methods of posting users
  * will designate a featured post tag to associate posts with. Since
  * this tag now has special meaning beyond that of a normal tags, users
- * will have the ability to hide it from the front-end of their site.
+ * will have the ability to hide it from the front end of their site.
  */
 class Featured_Content {
 
  */
 class Featured_Content {
 
@@ -86,6 +86,7 @@ class Featured_Content {
                add_filter( $filter,                              array( __CLASS__, 'get_featured_posts' )    );
                add_action( 'customize_register',                 array( __CLASS__, 'customize_register' ), 9 );
                add_action( 'admin_init',                         array( __CLASS__, 'register_setting'   )    );
                add_filter( $filter,                              array( __CLASS__, 'get_featured_posts' )    );
                add_action( 'customize_register',                 array( __CLASS__, 'customize_register' ), 9 );
                add_action( 'admin_init',                         array( __CLASS__, 'register_setting'   )    );
+               add_action( 'switch_theme',                       array( __CLASS__, 'delete_transient'   )    );
                add_action( 'save_post',                          array( __CLASS__, 'delete_transient'   )    );
                add_action( 'delete_post_tag',                    array( __CLASS__, 'delete_post_tag'    )    );
                add_action( 'customize_controls_enqueue_scripts', array( __CLASS__, 'enqueue_scripts'    )    );
                add_action( 'save_post',                          array( __CLASS__, 'delete_transient'   )    );
                add_action( 'delete_post_tag',                    array( __CLASS__, 'delete_post_tag'    )    );
                add_action( 'customize_controls_enqueue_scripts', array( __CLASS__, 'enqueue_scripts'    )    );
@@ -94,9 +95,9 @@ class Featured_Content {
        }
 
        /**
        }
 
        /**
-        * Hide "featured" tag from the front-end.
+        * Hide "featured" tag from the front end.
         *
         *
-        * Has to run on wp_loaded so that the preview filters of the customizer
+        * Has to run on wp_loaded so that the preview filters of the Customizer
         * have a chance to alter the value.
         *
         * @static
         * have a chance to alter the value.
         *
         * @static
@@ -105,7 +106,7 @@ class Featured_Content {
         */
        public static function wp_loaded() {
                if ( self::get_setting( 'hide-tag' ) ) {
         */
        public static function wp_loaded() {
                if ( self::get_setting( 'hide-tag' ) ) {
-                       add_filter( 'get_terms',     array( __CLASS__, 'hide_featured_term'     ), 10, 2 );
+                       add_filter( 'get_terms',     array( __CLASS__, 'hide_featured_term'     ), 10, 3 );
                        add_filter( 'get_the_terms', array( __CLASS__, 'hide_the_featured_term' ), 10, 3 );
                }
        }
                        add_filter( 'get_the_terms', array( __CLASS__, 'hide_the_featured_term' ), 10, 3 );
                }
        }
@@ -150,46 +151,39 @@ class Featured_Content {
         * @return array Array of post IDs.
         */
        public static function get_featured_post_ids() {
         * @return array Array of post IDs.
         */
        public static function get_featured_post_ids() {
-               // Return array of cached results if they exist.
+               // Get array of cached results if they exist.
                $featured_ids = get_transient( 'featured_content_ids' );
                $featured_ids = get_transient( 'featured_content_ids' );
-               if ( ! empty( $featured_ids ) ) {
-                       return array_map( 'absint', (array) $featured_ids );
-               }
 
 
-               $settings = self::get_setting();
+               if ( false === $featured_ids ) {
+                       $settings = self::get_setting();
+                       $term     = get_term_by( 'name', $settings['tag-name'], 'post_tag' );
 
 
-               // Return sticky post ids if no tag name is set.
-               $term = get_term_by( 'name', $settings['tag-name'], 'post_tag' );
-               if ( $term ) {
-                       $tag = $term->term_id;
-               } else {
-                       return self::get_sticky_posts();
-               }
+                       if ( $term ) {
+                               // Query for featured posts.
+                               $featured_ids = get_posts( array(
+                                       'fields'           => 'ids',
+                                       'numberposts'      => self::$max_posts,
+                                       'suppress_filters' => false,
+                                       'tax_query'        => array(
+                                               array(
+                                                       'field'    => 'term_id',
+                                                       'taxonomy' => 'post_tag',
+                                                       'terms'    => $term->term_id,
+                                               ),
+                                       ),
+                               ) );
+                       }
 
 
-               // Query for featured posts.
-               $featured = get_posts( array(
-                       'numberposts' => $settings['quantity'],
-                       'tax_query'   => array(
-                               array(
-                                       'field'    => 'term_id',
-                                       'taxonomy' => 'post_tag',
-                                       'terms'    => $tag,
-                               ),
-                       ),
-               ) );
+                       // Get sticky posts if no Featured Content exists.
+                       if ( ! $featured_ids ) {
+                               $featured_ids = self::get_sticky_posts();
+                       }
 
 
-               // Return array with sticky posts if no Featured Content exists.
-               if ( ! $featured ) {
-                       return self::get_sticky_posts();
+                       set_transient( 'featured_content_ids', $featured_ids );
                }
 
                }
 
-               // Ensure correct format before save/return.
-               $featured_ids = wp_list_pluck( (array) $featured, 'ID' );
-               $featured_ids = array_map( 'absint', $featured_ids );
-
-               set_transient( 'featured_content_ids', $featured_ids );
-
-               return $featured_ids;
+               // Ensure correct format before return.
+               return array_map( 'absint', $featured_ids );
        }
 
        /**
        }
 
        /**
@@ -202,8 +196,7 @@ class Featured_Content {
         * @return array Array of sticky posts.
         */
        public static function get_sticky_posts() {
         * @return array Array of sticky posts.
         */
        public static function get_sticky_posts() {
-               $settings = self::get_setting();
-               return array_slice( get_option( 'sticky_posts', array() ), 0, $settings['quantity'] );
+               return array_slice( get_option( 'sticky_posts', array() ), 0, self::$max_posts );
        }
 
        /**
        }
 
        /**
@@ -242,10 +235,8 @@ class Featured_Content {
                        return;
                }
 
                        return;
                }
 
-               $page_on_front = get_option( 'page_on_front' );
-
                // Bail if the blog page is not the front page.
                // Bail if the blog page is not the front page.
-               if ( ! empty( $page_on_front ) ) {
+               if ( 'posts' !== get_option( 'show_on_front' ) ) {
                        return;
                }
 
                        return;
                }
 
@@ -283,7 +274,6 @@ class Featured_Content {
         * @since Twenty Fourteen 1.0
         *
         * @param int $tag_id The term_id of the tag that has been deleted.
         * @since Twenty Fourteen 1.0
         *
         * @param int $tag_id The term_id of the tag that has been deleted.
-        * @return void
         */
        public static function delete_post_tag( $tag_id ) {
                $settings = self::get_setting();
         */
        public static function delete_post_tag( $tag_id ) {
                $settings = self::get_setting();
@@ -298,7 +288,7 @@ class Featured_Content {
        }
 
        /**
        }
 
        /**
-        * Hide featured tag from displaying when global terms are queried from the front-end.
+        * Hide featured tag from displaying when global terms are queried from the front end.
         *
         * Hooks into the "get_terms" filter.
         *
         *
         * Hooks into the "get_terms" filter.
         *
@@ -312,9 +302,9 @@ class Featured_Content {
         *
         * @uses Featured_Content::get_setting()
         */
         *
         * @uses Featured_Content::get_setting()
         */
-       public static function hide_featured_term( $terms, $taxonomies ) {
+       public static function hide_featured_term( $terms, $taxonomies, $args ) {
 
 
-               // This filter is only appropriate on the front-end.
+               // This filter is only appropriate on the front end.
                if ( is_admin() ) {
                        return $terms;
                }
                if ( is_admin() ) {
                        return $terms;
                }
@@ -329,8 +319,14 @@ class Featured_Content {
                        return $terms;
                }
 
                        return $terms;
                }
 
-               foreach( $terms as $order => $term ) {
-                       if ( self::get_setting( 'tag-id' ) == $term->term_id && 'post_tag' == $term->taxonomy ) {
+               // Bail if term objects are unavailable.
+               if ( 'all' != $args['fields'] ) {
+                       return $terms;
+               }
+
+               $settings = self::get_setting();
+               foreach ( $terms as $order => $term ) {
+                       if ( ( $settings['tag-id'] === $term->term_id || $settings['tag-name'] === $term->name ) && 'post_tag' === $term->taxonomy ) {
                                unset( $terms[ $order ] );
                        }
                }
                                unset( $terms[ $order ] );
                        }
                }
@@ -340,7 +336,7 @@ class Featured_Content {
 
        /**
         * Hide featured tag from display when terms associated with a post object
 
        /**
         * Hide featured tag from display when terms associated with a post object
-        * are queried from the front-end.
+        * are queried from the front end.
         *
         * Hooks into the "get_the_terms" filter.
         *
         *
         * Hooks into the "get_the_terms" filter.
         *
@@ -357,7 +353,7 @@ class Featured_Content {
         */
        public static function hide_the_featured_term( $terms, $id, $taxonomy ) {
 
         */
        public static function hide_the_featured_term( $terms, $id, $taxonomy ) {
 
-               // This filter is only appropriate on the front-end.
+               // This filter is only appropriate on the front end.
                if ( is_admin() ) {
                        return $terms;
                }
                if ( is_admin() ) {
                        return $terms;
                }
@@ -372,8 +368,9 @@ class Featured_Content {
                        return $terms;
                }
 
                        return $terms;
                }
 
-               foreach( $terms as $order => $term ) {
-                       if ( self::get_setting( 'tag-id' ) == $term->term_id ) {
+               $settings = self::get_setting();
+               foreach ( $terms as $order => $term ) {
+                       if ( ( $settings['tag-id'] === $term->term_id || $settings['tag-name'] === $term->name ) && 'post_tag' === $term->taxonomy ) {
                                unset( $terms[ $term->term_id ] );
                        }
                }
                                unset( $terms[ $term->term_id ] );
                        }
                }
@@ -387,8 +384,6 @@ class Featured_Content {
         * @static
         * @access public
         * @since Twenty Fourteen 1.0
         * @static
         * @access public
         * @since Twenty Fourteen 1.0
-        *
-        * @return void
         */
        public static function register_setting() {
                register_setting( 'featured-content', 'featured-content', array( __CLASS__, 'validate_settings' ) );
         */
        public static function register_setting() {
                register_setting( 'featured-content', 'featured-content', array( __CLASS__, 'validate_settings' ) );
@@ -401,19 +396,22 @@ class Featured_Content {
         * @access public
         * @since Twenty Fourteen 1.0
         *
         * @access public
         * @since Twenty Fourteen 1.0
         *
-        * @param WP_Customize_Manager $wp_customize Theme Customizer object.
+        * @param WP_Customize_Manager $wp_customize Customizer object.
         */
        public static function customize_register( $wp_customize ) {
                $wp_customize->add_section( 'featured_content', array(
                        'title'          => __( 'Featured Content', 'twentyfourteen' ),
         */
        public static function customize_register( $wp_customize ) {
                $wp_customize->add_section( 'featured_content', array(
                        'title'          => __( 'Featured Content', 'twentyfourteen' ),
-                       'description'    => sprintf( __( 'Use the <a href="%1$s">"featured" tag</a> to feature your posts. You can change this to a tag of your choice; if no posts match the tag, <a href="%2$s">sticky posts</a> will be displayed instead.', 'twentyfourteen' ), admin_url( '/edit.php?tag=featured' ), admin_url( '/edit.php?show_sticky=1' ) ),
+                       'description'    => sprintf( __( 'Use a <a href="%1$s">tag</a> to feature your posts. If no posts match the tag, <a href="%2$s">sticky posts</a> will be displayed instead.', 'twentyfourteen' ),
+                               esc_url( add_query_arg( 'tag', _x( 'featured', 'featured content default tag slug', 'twentyfourteen' ), admin_url( 'edit.php' ) ) ),
+                               admin_url( 'edit.php?show_sticky=1' )
+                       ),
                        'priority'       => 130,
                        'theme_supports' => 'featured-content',
                ) );
 
                // Add Featured Content settings.
                $wp_customize->add_setting( 'featured-content[tag-name]', array(
                        'priority'       => 130,
                        'theme_supports' => 'featured-content',
                ) );
 
                // Add Featured Content settings.
                $wp_customize->add_setting( 'featured-content[tag-name]', array(
-                       'default'              => 'featured',
+                       'default'              => _x( 'featured', 'featured content default tag slug', 'twentyfourteen' ),
                        'type'                 => 'option',
                        'sanitize_js_callback' => array( __CLASS__, 'delete_transient' ),
                ) );
                        'type'                 => 'option',
                        'sanitize_js_callback' => array( __CLASS__, 'delete_transient' ),
                ) );
@@ -472,14 +470,12 @@ class Featured_Content {
 
                $defaults = array(
                        'hide-tag' => 1,
 
                $defaults = array(
                        'hide-tag' => 1,
-                       'quantity' => 6,
                        'tag-id'   => 0,
                        'tag-id'   => 0,
-                       'tag-name' => 'featured',
+                       'tag-name' => _x( 'featured', 'featured content default tag slug', 'twentyfourteen' ),
                );
 
                $options = wp_parse_args( $saved, $defaults );
                $options = array_intersect_key( $options, $defaults );
                );
 
                $options = wp_parse_args( $saved, $defaults );
                $options = array_intersect_key( $options, $defaults );
-               $options['quantity'] = self::sanitize_quantity( $options['quantity'] );
 
                if ( 'all' != $key ) {
                        return isset( $options[ $key ] ) ? $options[ $key ] : false;
 
                if ( 'all' != $key ) {
                        return isset( $options[ $key ] ) ? $options[ $key ] : false;
@@ -523,10 +519,6 @@ class Featured_Content {
                        $output['tag-name'] = $input['tag-name'];
                }
 
                        $output['tag-name'] = $input['tag-name'];
                }
 
-               if ( isset( $input['quantity'] ) ) {
-                       $output['quantity'] = self::sanitize_quantity( $input['quantity'] );
-               }
-
                $output['hide-tag'] = isset( $input['hide-tag'] ) && $input['hide-tag'] ? 1 : 0;
 
                // Delete the featured post ids transient.
                $output['hide-tag'] = isset( $input['hide-tag'] ) && $input['hide-tag'] ? 1 : 0;
 
                // Delete the featured post ids transient.
@@ -534,29 +526,6 @@ class Featured_Content {
 
                return $output;
        }
 
                return $output;
        }
-
-       /**
-        * Sanitize quantity of featured posts.
-        *
-        * @static
-        * @access public
-        * @since Twenty Fourteen 1.0
-        *
-        * @param int $input The value to sanitize.
-        * @return int A number between 1 and FeaturedContent::$max_posts.
-        */
-       public static function sanitize_quantity( $input ) {
-               $quantity = absint( $input );
-
-               if ( $quantity > self::$max_posts ) {
-                       $quantity = self::$max_posts;
-               } else if ( 1 > $quantity ) {
-                       $quantity = 1;
-               }
-
-               return $quantity;
-       }
-
 } // Featured_Content
 
 Featured_Content::setup();
 } // Featured_Content
 
 Featured_Content::setup();