WordPress/wp-includes/widgets/class-wp-widget-rss.php
Drew Jaynes 5cd5252964 Docs: Add a file header to wp-includes/widgets/class-wp-widget-rss.php, introduced in [33746].
Also clarifies the class DocBlock summary and tags for `WP_Widget_RSS`.

See #33413. See #33701.

Built from https://develop.svn.wordpress.org/trunk@34437


git-svn-id: http://core.svn.wordpress.org/trunk@34401 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-22 14:57:26 +00:00

103 lines
2.9 KiB
PHP

<?php
/**
* Widget API: WP_Widget_RSS class
*
* @package WordPress
* @subpackage Widgets
* @since 4.4.0
*/
/**
* Core class used to implement a RSS widget.
*
* @since 2.8.0
*
* @see WP_Widget
*/
class WP_Widget_RSS extends WP_Widget {
public function __construct() {
$widget_ops = array( 'description' => __('Entries from any RSS or Atom feed.') );
$control_ops = array( 'width' => 400, 'height' => 200 );
parent::__construct( 'rss', __('RSS'), $widget_ops, $control_ops );
}
/**
* @param array $args
* @param array $instance
*/
public function widget( $args, $instance ) {
if ( isset($instance['error']) && $instance['error'] )
return;
$url = ! empty( $instance['url'] ) ? $instance['url'] : '';
while ( stristr($url, 'http') != $url )
$url = substr($url, 1);
if ( empty($url) )
return;
// self-url destruction sequence
if ( in_array( untrailingslashit( $url ), array( site_url(), home_url() ) ) )
return;
$rss = fetch_feed($url);
$title = $instance['title'];
$desc = '';
$link = '';
if ( ! is_wp_error($rss) ) {
$desc = esc_attr(strip_tags(@html_entity_decode($rss->get_description(), ENT_QUOTES, get_option('blog_charset'))));
if ( empty($title) )
$title = strip_tags( $rss->get_title() );
$link = strip_tags( $rss->get_permalink() );
while ( stristr($link, 'http') != $link )
$link = substr($link, 1);
}
if ( empty($title) )
$title = empty($desc) ? __('Unknown Feed') : $desc;
/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
$url = strip_tags( $url );
$icon = includes_url( 'images/rss.png' );
if ( $title )
$title = '<a class="rsswidget" href="' . esc_url( $url ) . '"><img style="border:0" width="14" height="14" src="' . esc_url( $icon ) . '" alt="RSS" /></a> <a class="rsswidget" href="' . esc_url( $link ) . '">"'. esc_html( $title ) .'"</a>';
echo $args['before_widget'];
if ( $title ) {
echo $args['before_title'] . $title . $args['after_title'];
}
wp_widget_rss_output( $rss, $instance );
echo $args['after_widget'];
if ( ! is_wp_error($rss) )
$rss->__destruct();
unset($rss);
}
/**
* @param array $new_instance
* @param array $old_instance
* @return array
*/
public function update( $new_instance, $old_instance ) {
$testurl = ( isset( $new_instance['url'] ) && ( !isset( $old_instance['url'] ) || ( $new_instance['url'] != $old_instance['url'] ) ) );
return wp_widget_rss_process( $new_instance, $testurl );
}
/**
* @param array $instance
*/
public function form( $instance ) {
if ( empty( $instance ) ) {
$instance = array( 'title' => '', 'url' => '', 'items' => 10, 'error' => false, 'show_summary' => 0, 'show_author' => 0, 'show_date' => 0 );
}
$instance['number'] = $this->number;
wp_widget_rss_form( $instance );
}
}