Changeset 33843 for trunk/src/wp-includes/widget-functions.php

Timestamp:

09/01/2015 01:49:00 PM (10 years ago)

Author:

wonderboymusic

Message:

Move widget classes to their own files in wp-includes/widgets:

• default-widgets.php now requires all of the individual classes
• Move the functions scattered about this file to widget-functions.php, which loads before default-widgets.php, which only conditionally loads anyway in wp_maybe_load_widgets(), which is hooked on plugins_loaded

See #33413, #23012.

File:

• trunk/src/wp-includes/widget-functions.php (modified) (1 diff)

trunk/src/wp-includes/widget-functions.php

@@ -1096 +1096 @@
     return $sidebars_widgets;
 }
+
+/**
+ * Display the RSS entries in a list.
+ *
+ * @since 2.5.0
+ *
+ * @param string|array|object $rss RSS url.
+ * @param array $args Widget arguments.
+ */
+function wp_widget_rss_output( $rss, $args = array() ) {
+    if ( is_string( $rss ) ) {
+        $rss = fetch_feed($rss);
+    } elseif ( is_array($rss) && isset($rss['url']) ) {
+        $args = $rss;
+        $rss = fetch_feed($rss['url']);
+    } elseif ( !is_object($rss) ) {
+        return;
+    }
+
+    if ( is_wp_error($rss) ) {
+        if ( is_admin() || current_user_can('manage_options') )
+            echo '<p>' . sprintf( __('<strong>RSS Error</strong>: %s'), $rss->get_error_message() ) . '</p>';
+        return;
+    }
+
+    $default_args = array( 'show_author' => 0, 'show_date' => 0, 'show_summary' => 0, 'items' => 0 );
+    $args = wp_parse_args( $args, $default_args );
+
+    $items = (int) $args['items'];
+    if ( $items < 1 || 20 < $items )
+        $items = 10;
+    $show_summary  = (int) $args['show_summary'];
+    $show_author   = (int) $args['show_author'];
+    $show_date     = (int) $args['show_date'];
+
+    if ( !$rss->get_item_quantity() ) {
+        echo '<ul><li>' . __( 'An error has occurred, which probably means the feed is down. Try again later.' ) . '</li></ul>';
+        $rss->__destruct();
+        unset($rss);
+        return;
+    }
+
+    echo '<ul>';
+    foreach ( $rss->get_items( 0, $items ) as $item ) {
+        $link = $item->get_link();
+        while ( stristr( $link, 'http' ) != $link ) {
+            $link = substr( $link, 1 );
+        }
+        $link = esc_url( strip_tags( $link ) );
+
+        $title = esc_html( trim( strip_tags( $item->get_title() ) ) );
+        if ( empty( $title ) ) {
+            $title = __( 'Untitled' );
+        }
+
+        $desc = @html_entity_decode( $item->get_description(), ENT_QUOTES, get_option( 'blog_charset' ) );
+        $desc = esc_attr( wp_trim_words( $desc, 55, ' [&hellip;]' ) );
+
+        $summary = '';
+        if ( $show_summary ) {
+            $summary = $desc;
+
+            // Change existing [...] to [&hellip;].
+            if ( '[...]' == substr( $summary, -5 ) ) {
+                $summary = substr( $summary, 0, -5 ) . '[&hellip;]';
+            }
+
+            $summary = '<div class="rssSummary">' . esc_html( $summary ) . '</div>';
+        }
+
+        $date = '';
+        if ( $show_date ) {
+            $date = $item->get_date( 'U' );
+
+            if ( $date ) {
+                $date = ' <span class="rss-date">' . date_i18n( get_option( 'date_format' ), $date ) . '</span>';
+            }
+        }
+
+        $author = '';
+        if ( $show_author ) {
+            $author = $item->get_author();
+            if ( is_object($author) ) {
+                $author = $author->get_name();
+                $author = ' <cite>' . esc_html( strip_tags( $author ) ) . '</cite>';
+            }
+        }
+
+        if ( $link == '' ) {
+            echo "<li>$title{$date}{$summary}{$author}</li>";
+        } elseif ( $show_summary ) {
+            echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$summary}{$author}</li>";
+        } else {
+            echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$author}</li>";
+        }
+    }
+    echo '</ul>';
+    $rss->__destruct();
+    unset($rss);
+}
+
+/**
+ * Display RSS widget options form.
+ *
+ * The options for what fields are displayed for the RSS form are all booleans
+ * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author',
+ * 'show_date'.
+ *
+ * @since 2.5.0
+ *
+ * @param array|string $args Values for input fields.
+ * @param array $inputs Override default display options.
+ */
+function wp_widget_rss_form( $args, $inputs = null ) {
+    $default_inputs = array( 'url' => true, 'title' => true, 'items' => true, 'show_summary' => true, 'show_author' => true, 'show_date' => true );
+    $inputs = wp_parse_args( $inputs, $default_inputs );
+
+    $args['title'] = isset( $args['title'] ) ? $args['title'] : '';
+    $args['url'] = isset( $args['url'] ) ? $args['url'] : '';
+    $args['items'] = isset( $args['items'] ) ? (int) $args['items'] : 0;
+
+    if ( $args['items'] < 1 || 20 < $args['items'] ) {
+        $args['items'] = 10;
+    }
+
+    $args['show_summary']   = isset( $args['show_summary'] ) ? (int) $args['show_summary'] : (int) $inputs['show_summary'];
+    $args['show_author']    = isset( $args['show_author'] ) ? (int) $args['show_author'] : (int) $inputs['show_author'];
+    $args['show_date']      = isset( $args['show_date'] ) ? (int) $args['show_date'] : (int) $inputs['show_date'];
+
+    if ( ! empty( $args['error'] ) ) {
+        echo '<p class="widget-error"><strong>' . sprintf( __( 'RSS Error: %s' ), $args['error'] ) . '</strong></p>';
+    }
+
+    $esc_number = esc_attr( $args['number'] );
+    if ( $inputs['url'] ) :
+?>
+    <p><label for="rss-url-<?php echo $esc_number; ?>"><?php _e( 'Enter the RSS feed URL here:' ); ?></label>
+    <input class="widefat" id="rss-url-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][url]" type="text" value="<?php echo esc_url( $args['url'] ); ?>" /></p>
+<?php endif; if ( $inputs['title'] ) : ?>
+    <p><label for="rss-title-<?php echo $esc_number; ?>"><?php _e( 'Give the feed a title (optional):' ); ?></label>
+    <input class="widefat" id="rss-title-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][title]" type="text" value="<?php echo esc_attr( $args['title'] ); ?>" /></p>
+<?php endif; if ( $inputs['items'] ) : ?>
+    <p><label for="rss-items-<?php echo $esc_number; ?>"><?php _e( 'How many items would you like to display?' ); ?></label>
+    <select id="rss-items-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][items]">
+    <?php
+    for ( $i = 1; $i <= 20; ++$i ) {
+        echo "<option value='$i' " . selected( $args['items'], $i, false ) . ">$i</option>";
+    }
+    ?>
+    </select></p>
+<?php endif; if ( $inputs['show_summary'] ) : ?>
+    <p><input id="rss-show-summary-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_summary]" type="checkbox" value="1" <?php checked( $args['show_summary'] ); ?> />
+    <label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label></p>
+<?php endif; if ( $inputs['show_author'] ) : ?>
+    <p><input id="rss-show-author-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_author]" type="checkbox" value="1" <?php checked( $args['show_author'] ); ?> />
+    <label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label></p>
+<?php endif; if ( $inputs['show_date'] ) : ?>
+    <p><input id="rss-show-date-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_date]" type="checkbox" value="1" <?php checked( $args['show_date'] ); ?>/>
+    <label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label></p>
+<?php
+    endif;
+    foreach ( array_keys($default_inputs) as $input ) :
+        if ( 'hidden' === $inputs[$input] ) :
+            $id = str_replace( '_', '-', $input );
+?>
+    <input type="hidden" id="rss-<?php echo esc_attr( $id ); ?>-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][<?php echo esc_attr( $input ); ?>]" value="<?php echo esc_attr( $args[ $input ] ); ?>" />
+<?php
+        endif;
+    endforeach;
+}
+
+/**
+ * Process RSS feed widget data and optionally retrieve feed items.
+ *
+ * The feed widget can not have more than 20 items or it will reset back to the
+ * default, which is 10.
+ *
+ * The resulting array has the feed title, feed url, feed link (from channel),
+ * feed items, error (if any), and whether to show summary, author, and date.
+ * All respectively in the order of the array elements.
+ *
+ * @since 2.5.0
+ *
+ * @param array $widget_rss RSS widget feed data. Expects unescaped data.
+ * @param bool $check_feed Optional, default is true. Whether to check feed for errors.
+ * @return array
+ */
+function wp_widget_rss_process( $widget_rss, $check_feed = true ) {
+    $items = (int) $widget_rss['items'];
+    if ( $items < 1 || 20 < $items )
+        $items = 10;
+    $url           = esc_url_raw( strip_tags( $widget_rss['url'] ) );
+    $title         = isset( $widget_rss['title'] ) ? trim( strip_tags( $widget_rss['title'] ) ) : '';
+    $show_summary  = isset( $widget_rss['show_summary'] ) ? (int) $widget_rss['show_summary'] : 0;
+    $show_author   = isset( $widget_rss['show_author'] ) ? (int) $widget_rss['show_author'] :0;
+    $show_date     = isset( $widget_rss['show_date'] ) ? (int) $widget_rss['show_date'] : 0;
+
+    if ( $check_feed ) {
+        $rss = fetch_feed($url);
+        $error = false;
+        $link = '';
+        if ( is_wp_error($rss) ) {
+            $error = $rss->get_error_message();
+        } else {
+            $link = esc_url(strip_tags($rss->get_permalink()));
+            while ( stristr($link, 'http') != $link )
+                $link = substr($link, 1);
+
+            $rss->__destruct();
+            unset($rss);
+        }
+    }
+
+    return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' );
+}
+
+/**
+ * Register all of the default WordPress widgets on startup.
+ *
+ * Calls 'widgets_init' action after all of the WordPress widgets have been
+ * registered.
+ *
+ * @since 2.2.0
+ */
+function wp_widgets_init() {
+    if ( !is_blog_installed() )
+        return;
+
+    register_widget('WP_Widget_Pages');
+
+    register_widget('WP_Widget_Calendar');
+
+    register_widget('WP_Widget_Archives');
+
+    if ( get_option( 'link_manager_enabled' ) )
+        register_widget('WP_Widget_Links');
+
+    register_widget('WP_Widget_Meta');
+
+    register_widget('WP_Widget_Search');
+
+    register_widget('WP_Widget_Text');
+
+    register_widget('WP_Widget_Categories');
+
+    register_widget('WP_Widget_Recent_Posts');
+
+    register_widget('WP_Widget_Recent_Comments');
+
+    register_widget('WP_Widget_RSS');
+
+    register_widget('WP_Widget_Tag_Cloud');
+
+    register_widget('WP_Nav_Menu_Widget');
+
+    /**
+     * Fires after all default WordPress widgets have been registered.
+     *
+     * @since 2.2.0
+     */
+    do_action( 'widgets_init' );
+}