enmi-conf.org: comparison wp/wp-includes/widgets.php

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
 global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
 /**
 * Stores the sidebars, since many themes can have more than one.
 *
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars Registered sidebars.
 * @since 2.2.0
 */
 $wp_registered_sidebars = array();
 /**
 	'wp_widget_text',
 	'wp_widget_text_control',
 	'wp_widget_rss',
 	'wp_widget_rss_control',
 	'wp_widget_recent_comments',
-	'wp_widget_recent_comments_control'
+	'wp_widget_recent_comments_control',
 );
 //
 // Template tags & API functions
 //
 *
 * @since 2.2.0
 *
 * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here.
 *
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars The new sidebars are stored in this array by sidebar ID.
 *
 * @param int          $number Optional. Number of sidebars to create. Default 1.
 * @param array|string $args {
 *     Optional. Array or string of arguments for building a sidebar.
 *
 */
 function register_sidebars( $number = 1, $args = array() ) {
 	global $wp_registered_sidebars;
 	$number = (int) $number;
-	if ( is_string($args) )
+	if ( is_string( $args ) ) {
-		parse_str($args, $args);
+		parse_str( $args, $args );
+	}
 	for ( $i = 1; $i <= $number; $i++ ) {
 		$_args = $args;
-		if ( $number > 1 )
+		if ( $number > 1 ) {
-			$_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i);
+			$_args['name'] = isset( $args['name'] ) ? sprintf( $args['name'], $i ) : sprintf( __( 'Sidebar %d' ), $i );
-		else
+		} else {
-			$_args['name'] = isset($args['name']) ? $args['name'] : __('Sidebar');
+			$_args['name'] = isset( $args['name'] ) ? $args['name'] : __( 'Sidebar' );
+		}
 		// Custom specified ID's are suffixed if they exist already.
 		// Automatically generated sidebar names need to be suffixed regardless starting at -0
-		if ( isset($args['id']) ) {
+		if ( isset( $args['id'] ) ) {
 			$_args['id'] = $args['id'];
-			$n = 2; // Start at -2 for conflicting custom ID's
+			$n           = 2; // Start at -2 for conflicting custom ID's
 			while ( is_registered_sidebar( $_args['id'] ) ) {
 				$_args['id'] = $args['id'] . '-' . $n++;
 			}
 		} else {
 			$n = count( $wp_registered_sidebars );
 			do {
 				$_args['id'] = 'sidebar-' . ++$n;
 			} while ( is_registered_sidebar( $_args['id'] ) );
 		}
-		register_sidebar($_args);
+		register_sidebar( $_args );
 	}
 }
 /**
 * Builds the definition for a single sidebar and returns the ID.
 *     @type string $after_title   HTML content to append to the sidebar title when displayed.
 *                                 Default is a closing h2 element.
 * }
 * @return string Sidebar ID added to $wp_registered_sidebars global.
 */
-function register_sidebar($args = array()) {
+function register_sidebar( $args = array() ) {
 	global $wp_registered_sidebars;
-	$i = count($wp_registered_sidebars) + 1;
+	$i = count( $wp_registered_sidebars ) + 1;
 	$id_is_empty = empty( $args['id'] );
 	$defaults = array(
-		'name' => sprintf(__('Sidebar %d'), $i ),
+		'name'          => sprintf( __( 'Sidebar %d' ), $i ),
-		'id' => "sidebar-$i",
+		'id'            => "sidebar-$i",
-		'description' => '',
+		'description'   => '',
-		'class' => '',
+		'class'         => '',
 		'before_widget' => '<li id="%1$s" class="widget %2$s">',
-		'after_widget' => "</li>\n",
+		'after_widget'  => "</li>\n",
-		'before_title' => '<h2 class="widgettitle">',
+		'before_title'  => '<h2 class="widgettitle">',
-		'after_title' => "</h2>\n",
+		'after_title'   => "</h2>\n",
 	);
 	$sidebar = wp_parse_args( $args, $defaults );
 	if ( $id_is_empty ) {
 		/* translators: 1: the id argument, 2: sidebar name, 3: recommended id value */
 		_doing_it_wrong( __FUNCTION__, sprintf( __( 'No %1$s was set in the arguments array for the "%2$s" sidebar. Defaulting to "%3$s". Manually set the %1$s to "%3$s" to silence this notice and keep existing sidebar content.' ), '<code>id</code>', $sidebar['name'], $sidebar['id'] ), '4.2.0' );
 	}
-	$wp_registered_sidebars[$sidebar['id']] = $sidebar;
+	$wp_registered_sidebars[ $sidebar['id'] ] = $sidebar;
-	add_theme_support('widgets');
+	add_theme_support( 'widgets' );
 	/**
 	 * Fires once a sidebar has been registered.
 	 *
 	 * @since 3.0.0
 /**
 * Removes a sidebar from the list.
 *
 * @since 2.2.0
 *
-* @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
+* @global array $wp_registered_sidebars Removes the sidebar from this array by sidebar ID.
 *
 * @param string|int $sidebar_id The ID of the sidebar when it was registered.
 */
 function unregister_sidebar( $sidebar_id ) {
 	global $wp_registered_sidebars;
 * }
 */
 function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array() ) {
 	global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;
-	$id = strtolower($id);
+	$id = strtolower( $id );
-	if ( empty($output_callback) ) {
+	if ( empty( $output_callback ) ) {
-		unset($wp_registered_widgets[$id]);
+		unset( $wp_registered_widgets[ $id ] );
 		return;
 	}
-	$id_base = _get_widget_id_base($id);
+	$id_base = _get_widget_id_base( $id );
-	if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) {
+	if ( in_array( $output_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $output_callback ) ) {
 		unset( $wp_registered_widget_controls[ $id ] );
 		unset( $wp_registered_widget_updates[ $id_base ] );
 		return;
 	}
-	$defaults = array('classname' => $output_callback);
+	$defaults = array( 'classname' => $output_callback );
-	$options = wp_parse_args($options, $defaults);
+	$options  = wp_parse_args( $options, $defaults );
-	$widget = array(
+	$widget   = array(
-		'name' => $name,
+		'name'     => $name,
-		'id' => $id,
+		'id'       => $id,
 		'callback' => $output_callback,
-		'params' => array_slice(func_get_args(), 4)
+		'params'   => array_slice( func_get_args(), 4 ),
 	);
-	$widget = array_merge($widget, $options);
+	$widget   = array_merge( $widget, $options );
-	if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) ) {
+	if ( is_callable( $output_callback ) && ( ! isset( $wp_registered_widgets[ $id ] ) || did_action( 'widgets_init' ) ) ) {
 		/**
 		 * Fires once for each registered widget.
 		 *
 		 * @since 3.0.0
 		 *
 		 * @param array $widget An array of default widget arguments.
 		 */
 		do_action( 'wp_register_sidebar_widget', $widget );
-		$wp_registered_widgets[$id] = $widget;
+		$wp_registered_widgets[ $id ] = $widget;
 	}
 }
 /**
 * Retrieve description for widget.
 *
 * @param int|string $id Widget ID.
 * @return string|void Widget description, if available.
 */
 function wp_widget_description( $id ) {
-	if ( !is_scalar($id) )
+	if ( ! is_scalar( $id ) ) {
 		return;
+	}
 	global $wp_registered_widgets;
-	if ( isset($wp_registered_widgets[$id]['description']) )
+	if ( isset( $wp_registered_widgets[ $id ]['description'] ) ) {
-		return esc_html( $wp_registered_widgets[$id]['description'] );
+		return esc_html( $wp_registered_widgets[ $id ]['description'] );
+	}
 }
 /**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars Registered sidebars.
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
 function wp_sidebar_description( $id ) {
-	if ( !is_scalar($id) )
+	if ( ! is_scalar( $id ) ) {
 		return;
+	}
 	global $wp_registered_sidebars;
 	if ( isset( $wp_registered_sidebars[ $id ]['description'] ) ) {
 		return wp_kses( $wp_registered_sidebars[ $id ]['description'], 'sidebar_description' );
 *
 * @since 2.2.0
 *
 * @param int|string $id Widget ID.
 */
-function wp_unregister_sidebar_widget($id) {
+function wp_unregister_sidebar_widget( $id ) {
 	/**
 	 * Fires just before a widget is removed from a sidebar.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param int $id The widget ID.
 	 */
 	do_action( 'wp_unregister_sidebar_widget', $id );
-	wp_register_sidebar_widget($id, '', '');
+	wp_register_sidebar_widget( $id, '', '' );
-	wp_unregister_widget_control($id);
+	wp_unregister_widget_control( $id );
 }
 /**
 * Registers widget control callback for customizing options.
 *
 * }
 */
 function wp_register_widget_control( $id, $name, $control_callback, $options = array() ) {
 	global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;
-	$id = strtolower($id);
+	$id      = strtolower( $id );
-	$id_base = _get_widget_id_base($id);
+	$id_base = _get_widget_id_base( $id );
-	if ( empty($control_callback) ) {
+	if ( empty( $control_callback ) ) {
-		unset($wp_registered_widget_controls[$id]);
+		unset( $wp_registered_widget_controls[ $id ] );
-		unset($wp_registered_widget_updates[$id_base]);
+		unset( $wp_registered_widget_updates[ $id_base ] );
 		return;
 	}
-	if ( in_array($control_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($control_callback) ) {
+	if ( in_array( $control_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $control_callback ) ) {
 		unset( $wp_registered_widgets[ $id ] );
 		return;
 	}
-	if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
+	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {
 		return;
+	}
-	$defaults = array('width' => 250, 'height' => 200 ); // height is never used
-	$options = wp_parse_args($options, $defaults);
+	$defaults          = array(
-	$options['width'] = (int) $options['width'];
+		'width'  => 250,
+		'height' => 200,
+	); // height is never used
+	$options           = wp_parse_args( $options, $defaults );
+	$options['width']  = (int) $options['width'];
 	$options['height'] = (int) $options['height'];
 	$widget = array(
-		'name' => $name,
+		'name'     => $name,
-		'id' => $id,
+		'id'       => $id,
 		'callback' => $control_callback,
-		'params' => array_slice(func_get_args(), 4)
+		'params'   => array_slice( func_get_args(), 4 ),
 	);
-	$widget = array_merge($widget, $options);
+	$widget = array_merge( $widget, $options );
-	$wp_registered_widget_controls[$id] = $widget;
+	$wp_registered_widget_controls[ $id ] = $widget;
-	if ( isset($wp_registered_widget_updates[$id_base]) )
+	if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {
 		return;
+	}
-	if ( isset($widget['params'][0]['number']) )
+	if ( isset( $widget['params'][0]['number'] ) ) {
 		$widget['params'][0]['number'] = -1;
+	}
-	unset($widget['width'], $widget['height'], $widget['name'], $widget['id']);
-	$wp_registered_widget_updates[$id_base] = $widget;
+	unset( $widget['width'], $widget['height'], $widget['name'], $widget['id'] );
+	$wp_registered_widget_updates[ $id_base ] = $widget;
 }
 /**
 * Registers the update callback for a widget.
 *
 *                                  Default empty array.
 */
 function _register_widget_update_callback( $id_base, $update_callback, $options = array() ) {
 	global $wp_registered_widget_updates;
-	if ( isset($wp_registered_widget_updates[$id_base]) ) {
+	if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {
-		if ( empty($update_callback) )
+		if ( empty( $update_callback ) ) {
-			unset($wp_registered_widget_updates[$id_base]);
+			unset( $wp_registered_widget_updates[ $id_base ] );
+		}
 		return;
 	}
 	$widget = array(
 		'callback' => $update_callback,
-		'params' => array_slice(func_get_args(), 3)
+		'params'   => array_slice( func_get_args(), 3 ),
 	);
-	$widget = array_merge($widget, $options);
+	$widget                                   = array_merge( $widget, $options );
-	$wp_registered_widget_updates[$id_base] = $widget;
+	$wp_registered_widget_updates[ $id_base ] = $widget;
 }
 /**
 * Registers the form callback for a widget.
 *
 * @param string     $name          Name attribute for the widget.
 * @param callable   $form_callback Form callback.
 * @param array      $options       Optional. Widget control options. See wp_register_widget_control().
 *                                  Default empty array.
 */
-function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
+function _register_widget_form_callback( $id, $name, $form_callback, $options = array() ) {
 	global $wp_registered_widget_controls;
-	$id = strtolower($id);
+	$id = strtolower( $id );
-	if ( empty($form_callback) ) {
+	if ( empty( $form_callback ) ) {
-		unset($wp_registered_widget_controls[$id]);
+		unset( $wp_registered_widget_controls[ $id ] );
 		return;
 	}
-	if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
+	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {
 		return;
+	}
-	$defaults = array('width' => 250, 'height' => 200 );
-	$options = wp_parse_args($options, $defaults);
+	$defaults          = array(
-	$options['width'] = (int) $options['width'];
+		'width'  => 250,
+		'height' => 200,
+	);
+	$options           = wp_parse_args( $options, $defaults );
+	$options['width']  = (int) $options['width'];
 	$options['height'] = (int) $options['height'];
 	$widget = array(
-		'name' => $name,
+		'name'     => $name,
-		'id' => $id,
+		'id'       => $id,
 		'callback' => $form_callback,
-		'params' => array_slice(func_get_args(), 4)
+		'params'   => array_slice( func_get_args(), 4 ),
 	);
-	$widget = array_merge($widget, $options);
+	$widget = array_merge( $widget, $options );
-	$wp_registered_widget_controls[$id] = $widget;
+	$wp_registered_widget_controls[ $id ] = $widget;
 }
 /**
 * Remove control callback for widget.
 *
 * @since 2.2.0
 *
 * @param int|string $id Widget ID.
 */
-function wp_unregister_widget_control($id) {
+function wp_unregister_widget_control( $id ) {
 	wp_register_widget_control( $id, '', '' );
 }
 /**
 * Display dynamic sidebar.
 * 'name' parameter for its registered sidebars you can pass an id or name as the $index parameter.
 * Otherwise, you can pass in a numerical index to display the sidebar at that index.
 *
 * @since 2.2.0
 *
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars Registered sidebars.
 * @global array $wp_registered_widgets
 *
 * @param int|string $index Optional, default is 1. Index, name or ID of dynamic sidebar.
 * @return bool True, if widget sidebar was found and called. False if not found or not called.
 */
 	$sidebars_widgets = wp_get_sidebars_widgets();
 	if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
 		/** This action is documented in wp-includes/widget.php */
 		do_action( 'dynamic_sidebar_before', $index, false );
 		/** This action is documented in wp-includes/widget.php */
-		do_action( 'dynamic_sidebar_after',  $index, false );
+		do_action( 'dynamic_sidebar_after', $index, false );
 		/** This filter is documented in wp-includes/widget.php */
 		return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
 	}
 	/**
 	 * @param int|string $index       Index, name, or ID of the dynamic sidebar.
 	 * @param bool       $has_widgets Whether the sidebar is populated with widgets.
 	 *                                Default true.
 	 */
 	do_action( 'dynamic_sidebar_before', $index, true );
-	$sidebar = $wp_registered_sidebars[$index];
+	$sidebar = $wp_registered_sidebars[ $index ];
 	$did_one = false;
-	foreach ( (array) $sidebars_widgets[$index] as $id ) {
+	foreach ( (array) $sidebars_widgets[ $index ] as $id ) {
-		if ( !isset($wp_registered_widgets[$id]) ) continue;
+		if ( ! isset( $wp_registered_widgets[ $id ] ) ) {
+			continue;
+		}
 		$params = array_merge(
-			array( array_merge( $sidebar, array('widget_id' => $id, 'widget_name' => $wp_registered_widgets[$id]['name']) ) ),
+			array(
-			(array) $wp_registered_widgets[$id]['params']
+				array_merge(
+					$sidebar,
+					array(
+						'widget_id'   => $id,
+						'widget_name' => $wp_registered_widgets[ $id ]['name'],
+					)
+				),
+			),
+			(array) $wp_registered_widgets[ $id ]['params']
 		);
 		// Substitute HTML id and class attributes into before_widget
 		$classname_ = '';
-		foreach ( (array) $wp_registered_widgets[$id]['classname'] as $cn ) {
+		foreach ( (array) $wp_registered_widgets[ $id ]['classname'] as $cn ) {
-			if ( is_string($cn) )
+			if ( is_string( $cn ) ) {
 				$classname_ .= '_' . $cn;
-			elseif ( is_object($cn) )
+			} elseif ( is_object( $cn ) ) {
-				$classname_ .= '_' . get_class($cn);
+				$classname_ .= '_' . get_class( $cn );
-		}
+			}
-		$classname_ = ltrim($classname_, '_');
+		}
-		$params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_);
+		$classname_                 = ltrim( $classname_, '_' );
+		$params[0]['before_widget'] = sprintf( $params[0]['before_widget'], $id, $classname_ );
 		/**
 		 * Filters the parameters passed to a widget's display callback.
 		 *
 		 * Note: The filter is evaluated on both the front end and back end,
 		 *     }
 		 * }
 		 */
 		$params = apply_filters( 'dynamic_sidebar_params', $params );
-		$callback = $wp_registered_widgets[$id]['callback'];
+		$callback = $wp_registered_widgets[ $id ]['callback'];
 		/**
 		 * Fires before a widget's display callback is called.
 		 *
 		 * Note: The action fires on both the front end and back end, including
 		 *                                       with an array containing the widget object, see $callback.
 		 * }
 		 */
 		do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] );
-		if ( is_callable($callback) ) {
+		if ( is_callable( $callback ) ) {
-			call_user_func_array($callback, $params);
+			call_user_func_array( $callback, $params );
 			$did_one = true;
 		}
 	}
 	/**
 	 */
 	return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
 }
 /**
-* Whether widget is displayed on the front end.
+* Determines whether a given widget is displayed on the front end.
 *
 * Either $callback or $id_base can be used
 * $id_base is the first argument when extending WP_Widget class
 * Without the optional $widget_id parameter, returns the ID of the first sidebar
 * in which the first instance of the widget with the given callback or $id_base is found.
 * the widget with that callback/$id_base AND that ID is found.
 *
 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective
 * this function has to run after widgets have initialized, at action {@see 'init'} or later.
 *
+* For more information on this and similar theme functions, check out
+* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+* Conditional Tags} article in the Theme Developer Handbook.
+*
 * @since 2.2.0
 *
 * @global array $wp_registered_widgets
 *
 * @param string|false $callback      Optional, Widget callback to check. Default false.
 function is_active_widget( $callback = false, $widget_id = false, $id_base = false, $skip_inactive = true ) {
 	global $wp_registered_widgets;
 	$sidebars_widgets = wp_get_sidebars_widgets();
-	if ( is_array($sidebars_widgets) ) {
+	if ( is_array( $sidebars_widgets ) ) {
 		foreach ( $sidebars_widgets as $sidebar => $widgets ) {
 			if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
 				continue;
 			}
-			if ( is_array($widgets) ) {
+			if ( is_array( $widgets ) ) {
 				foreach ( $widgets as $widget ) {
-					if ( ( $callback && isset($wp_registered_widgets[$widget]['callback']) && $wp_registered_widgets[$widget]['callback'] == $callback ) || ( $id_base && _get_widget_id_base($widget) == $id_base ) ) {
+					if ( ( $callback && isset( $wp_registered_widgets[ $widget ]['callback'] ) && $wp_registered_widgets[ $widget ]['callback'] == $callback ) || ( $id_base && _get_widget_id_base( $widget ) == $id_base ) ) {
-						if ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
+						if ( ! $widget_id || $widget_id == $wp_registered_widgets[ $widget ]['id'] ) {
 							return $sidebar;
+						}
 					}
 				}
 			}
 		}
 	}
 	return false;
 }
 /**
-* Whether the dynamic sidebar is enabled and used by theme.
+* Determines whether the dynamic sidebar is enabled and used by the theme.
+*
+* For more information on this and similar theme functions, check out
+* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+* Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 2.2.0
 *
 * @global array $wp_registered_widgets
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars Registered sidebars.
 *
 * @return bool True, if using widgets. False, if not using widgets.
 */
 function is_dynamic_sidebar() {
 	global $wp_registered_widgets, $wp_registered_sidebars;
-	$sidebars_widgets = get_option('sidebars_widgets');
+	$sidebars_widgets = get_option( 'sidebars_widgets' );
 	foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
 		if ( ! empty( $sidebars_widgets[ $index ] ) ) {
-			foreach ( (array) $sidebars_widgets[$index] as $widget )
+			foreach ( (array) $sidebars_widgets[ $index ] as $widget ) {
-				if ( array_key_exists($widget, $wp_registered_widgets) )
+				if ( array_key_exists( $widget, $wp_registered_widgets ) ) {
 					return true;
+				}
+			}
 		}
 	}
 	return false;
 }
 /**
-* Whether a sidebar is in use.
+* Determines whether a sidebar is in use.
+*
+* For more information on this and similar theme functions, check out
+* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+* Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 2.8.0
 *
 * @param string|int $index Sidebar name, id or number to check.
 * @return bool true if the sidebar is in use, false otherwise.
 */
 function is_active_sidebar( $index ) {
-	$index = ( is_int($index) ) ? "sidebar-$index" : sanitize_title($index);
+	$index             = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index );
-	$sidebars_widgets = wp_get_sidebars_widgets();
+	$sidebars_widgets  = wp_get_sidebars_widgets();
-	$is_active_sidebar = ! empty( $sidebars_widgets[$index] );
+	$is_active_sidebar = ! empty( $sidebars_widgets[ $index ] );
 	/**
 	 * Filters whether a dynamic sidebar is considered "active".
 	 *
 	 * @since 3.9.0
 *
 * @param bool $deprecated Not used (argument deprecated).
 * @return array Upgraded list of widgets to version 3 array format when called from the admin.
 */
 function wp_get_sidebars_widgets( $deprecated = true ) {
-	if ( $deprecated !== true )
+	if ( $deprecated !== true ) {
 		_deprecated_argument( __FUNCTION__, '2.8.1' );
+	}
 	global $_wp_sidebars_widgets, $sidebars_widgets;
 	// If loading from front page, consult $_wp_sidebars_widgets rather than options
 	// to see if wp_convert_widget_settings() has made manipulations in memory.
-	if ( !is_admin() ) {
+	if ( ! is_admin() ) {
-		if ( empty($_wp_sidebars_widgets) )
+		if ( empty( $_wp_sidebars_widgets ) ) {
-			$_wp_sidebars_widgets = get_option('sidebars_widgets', array());
+			$_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() );
+		}
 		$sidebars_widgets = $_wp_sidebars_widgets;
 	} else {
-		$sidebars_widgets = get_option('sidebars_widgets', array());
+		$sidebars_widgets = get_option( 'sidebars_widgets', array() );
 	}
-	if ( is_array( $sidebars_widgets ) && isset($sidebars_widgets['array_version']) )
+	if ( is_array( $sidebars_widgets ) && isset( $sidebars_widgets['array_version'] ) ) {
-		unset($sidebars_widgets['array_version']);
+		unset( $sidebars_widgets['array_version'] );
+	}
 	/**
 	 * Filters the list of sidebars and their widgets.
 	 *
 	 * @since 2.7.0
 * Retrieve default registered sidebars list.
 *
 * @since 2.2.0
 * @access private
 *
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars Registered sidebars.
 *
 * @return array
 */
 function wp_get_widget_defaults() {
 	global $wp_registered_sidebars;
 	$defaults = array();
-	foreach ( (array) $wp_registered_sidebars as $index => $sidebar )
+	foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
-		$defaults[$index] = array();
+		$defaults[ $index ] = array();
+	}
 	return $defaults;
 }
 /**
 * @param string $base_name
 * @param string $option_name
 * @param array  $settings
 * @return array
 */
-function wp_convert_widget_settings($base_name, $option_name, $settings) {
+function wp_convert_widget_settings( $base_name, $option_name, $settings ) {
 	// This test may need expanding.
 	$single = $changed = false;
-	if ( empty($settings) ) {
+	if ( empty( $settings ) ) {
 		$single = true;
 	} else {
-		foreach ( array_keys($settings) as $number ) {
+		foreach ( array_keys( $settings ) as $number ) {
-			if ( 'number' == $number )
+			if ( 'number' == $number ) {
 				continue;
-			if ( !is_numeric($number) ) {
+			}
+			if ( ! is_numeric( $number ) ) {
 				$single = true;
 				break;
 			}
 		}
 	}
 	if ( $single ) {
 		$settings = array( 2 => $settings );
 		// If loading from the front page, update sidebar in memory but don't save to options
 		if ( is_admin() ) {
-			$sidebars_widgets = get_option('sidebars_widgets');
+			$sidebars_widgets = get_option( 'sidebars_widgets' );
 		} else {
-			if ( empty($GLOBALS['_wp_sidebars_widgets']) )
+			if ( empty( $GLOBALS['_wp_sidebars_widgets'] ) ) {
-				$GLOBALS['_wp_sidebars_widgets'] = get_option('sidebars_widgets', array());
+				$GLOBALS['_wp_sidebars_widgets'] = get_option( 'sidebars_widgets', array() );
+			}
 			$sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets'];
 		}
 		foreach ( (array) $sidebars_widgets as $index => $sidebar ) {
-			if ( is_array($sidebar) ) {
+			if ( is_array( $sidebar ) ) {
 				foreach ( $sidebar as $i => $name ) {
 					if ( $base_name == $name ) {
-						$sidebars_widgets[$index][$i] = "$name-2";
+						$sidebars_widgets[ $index ][ $i ] = "$name-2";
-						$changed = true;
+						$changed                          = true;
 						break 2;
 					}
 				}
 			}
 		}
-		if ( is_admin() && $changed )
+		if ( is_admin() && $changed ) {
-			update_option('sidebars_widgets', $sidebars_widgets);
+			update_option( 'sidebars_widgets', $sidebars_widgets );
+		}
 	}
 	$settings['_multiwidget'] = 1;
-	if ( is_admin() )
+	if ( is_admin() ) {
 		update_option( $option_name, $settings );
+	}
 	return $settings;
 }
 /**
 		/* translators: %s: register_widget() */
 		_doing_it_wrong( __FUNCTION__, sprintf( __( 'Widgets need to be registered using %s, before they can be displayed.' ), '<code>register_widget()</code>' ), '4.9.0' );
 		return;
 	}
-	$widget_obj = $wp_widget_factory->widgets[$widget];
+	$widget_obj = $wp_widget_factory->widgets[ $widget ];
 	if ( ! ( $widget_obj instanceof WP_Widget ) ) {
 		return;
 	}
-	$default_args = array(
+	$default_args          = array(
 		'before_widget' => '<div class="widget %s">',
-		'after_widget'  => "</div>",
+		'after_widget'  => '</div>',
 		'before_title'  => '<h2 class="widgettitle">',
 		'after_title'   => '</h2>',
 	);
-	$args = wp_parse_args( $args, $default_args );
+	$args                  = wp_parse_args( $args, $default_args );
 	$args['before_widget'] = sprintf( $args['before_widget'], $widget_obj->widget_options['classname'] );
-	$instance = wp_parse_args($instance);
+	$instance = wp_parse_args( $instance );
 	/**
 	 * Fires before rendering the requested widget.
 	 *
 	 * @since 3.0.0
 	 * @param array  $instance The current widget instance's settings.
 	 * @param array  $args     An array of the widget's sidebar arguments.
 	 */
 	do_action( 'the_widget', $widget, $instance, $args );
-	$widget_obj->_set(-1);
+	$widget_obj->_set( -1 );
-	$widget_obj->widget($args, $instance);
+	$widget_obj->widget( $args, $instance );
 }
 /**
 * Retrieves the widget ID base value.
 *
 * @global array $sidebars_widgets
 */
 function _wp_sidebars_changed() {
 	global $sidebars_widgets;
-	if ( ! is_array( $sidebars_widgets ) )
+	if ( ! is_array( $sidebars_widgets ) ) {
 		$sidebars_widgets = wp_get_sidebars_widgets();
+	}
-	retrieve_widgets(true);
+	retrieve_widgets( true );
 }
 /**
 * Look for "lost" widgets, this has to run at least on each theme change.
 *
 * @since 2.8.0
 *
-* @global array $wp_registered_sidebars
+* @global array $wp_registered_sidebars Registered sidebars.
 * @global array $sidebars_widgets
 * @global array $wp_registered_widgets
 *
 * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
 *                                   of 'customize' defers updates for the Customizer.
 	global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
 	$registered_sidebars_keys = array_keys( $wp_registered_sidebars );
 	$registered_widgets_ids   = array_keys( $wp_registered_widgets );
-	if ( ! is_array( get_theme_mod( 'sidebars_widgets' ) ) )  {
+	if ( ! is_array( get_theme_mod( 'sidebars_widgets' ) ) ) {
 		if ( empty( $sidebars_widgets ) ) {
 			return array();
 		}
 		unset( $sidebars_widgets['array_version'] );
 	foreach ( $wp_registered_sidebars as $sidebar => $name ) {
 		if ( in_array( $sidebar, $existing_sidebars, true ) ) {
 			$new_sidebars_widgets[ $sidebar ] = $existing_sidebars_widgets[ $sidebar ];
 			unset( $existing_sidebars_widgets[ $sidebar ] );
-		} else if ( ! array_key_exists( $sidebar, $new_sidebars_widgets ) ) {
+		} elseif ( ! array_key_exists( $sidebar, $new_sidebars_widgets ) ) {
 			$new_sidebars_widgets[ $sidebar ] = array();
 		}
 	}
 	// If there are more sidebars, try to map them.
 					} // endforeach ( $old_widgets as $key => $widget_id )
 				} // endforeach ( $new_sidebars_widgets as $new_sidebar => $new_widgets )
 			} // endforeach ( $old_sidebars_widgets as $old_sidebar => $old_widgets )
 		} // endif ( ! empty( $old_sidebars_widgets ) )
 		// Restore widget settings from when theme was previously active.
 		$new_sidebars_widgets = array_merge( $new_sidebars_widgets, $old_sidebars_widgets );
 	}
 	return $new_sidebars_widgets;
 * @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);
+		$rss = fetch_feed( $rss );
-	} elseif ( is_array($rss) && isset($rss['url']) ) {
+	} elseif ( is_array( $rss ) && isset( $rss['url'] ) ) {
 		$args = $rss;
-		$rss = fetch_feed($rss['url']);
+		$rss  = fetch_feed( $rss['url'] );
-	} elseif ( !is_object($rss) ) {
+	} elseif ( ! is_object( $rss ) ) {
 		return;
 	}
-	if ( is_wp_error($rss) ) {
+	if ( is_wp_error( $rss ) ) {
-		if ( is_admin() || current_user_can('manage_options') )
+		if ( is_admin() || current_user_can( 'manage_options' ) ) {
 			echo '<p><strong>' . __( 'RSS Error:' ) . '</strong> ' . $rss->get_error_message() . '</p>';
+		}
 		return;
 	}
-	$default_args = array( 'show_author' => 0, 'show_date' => 0, 'show_summary' => 0, 'items' => 0 );
+	$default_args = array(
-	$args = wp_parse_args( $args, $default_args );
+		'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 )
+	if ( $items < 1 || 20 < $items ) {
 		$items = 10;
-	$show_summary  = (int) $args['show_summary'];
+	}
-	$show_author   = (int) $args['show_author'];
+	$show_summary = (int) $args['show_summary'];
-	$show_date     = (int) $args['show_date'];
+	$show_author  = (int) $args['show_author'];
+	$show_date    = (int) $args['show_date'];
-	if ( !$rss->get_item_quantity() ) {
+	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);
+		unset( $rss );
 		return;
 	}
 	echo '<ul>';
 	foreach ( $rss->get_items( 0, $items ) as $item ) {
 		}
 		$author = '';
 		if ( $show_author ) {
 			$author = $item->get_author();
-			if ( is_object($author) ) {
+			if ( is_object( $author ) ) {
 				$author = $author->get_name();
 				$author = ' <cite>' . esc_html( strip_tags( $author ) ) . '</cite>';
 			}
 		}
 			echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$author}</li>";
 		}
 	}
 	echo '</ul>';
 	$rss->__destruct();
-	unset($rss);
+	unset( $rss );
 }
 /**
 * Display RSS widget options form.
 *
 *
 * @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 );
+	$default_inputs = array(
-	$inputs = wp_parse_args( $inputs, $default_inputs );
+		'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['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_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_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'];
+	$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>' . __( 'RSS Error:' ) . '</strong> ' . $args['error'] . '</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>
 	<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
+	<?php
 	endif;
-	foreach ( array_keys($default_inputs) as $input ) :
+foreach ( array_keys( $default_inputs ) as $input ) :
-		if ( 'hidden' === $inputs[$input] ) :
+	if ( 'hidden' === $inputs[ $input ] ) :
-			$id = str_replace( '_', '-', $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 ] ); ?>" />
+<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
+		<?php
-		endif;
+	endif;
 	endforeach;
 }
 /**
 * Process RSS feed widget data and optionally retrieve feed items.
 * @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 )
+	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'] ) ) : '';
+	$url          = esc_url_raw( strip_tags( $widget_rss['url'] ) );
-	$show_summary  = isset( $widget_rss['show_summary'] ) ? (int) $widget_rss['show_summary'] : 0;
+	$title        = isset( $widget_rss['title'] ) ? trim( strip_tags( $widget_rss['title'] ) ) : '';
-	$show_author   = isset( $widget_rss['show_author'] ) ? (int) $widget_rss['show_author'] :0;
+	$show_summary = isset( $widget_rss['show_summary'] ) ? (int) $widget_rss['show_summary'] : 0;
-	$show_date     = isset( $widget_rss['show_date'] ) ? (int) $widget_rss['show_date'] : 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);
+		$rss   = fetch_feed( $url );
 		$error = false;
-		$link = '';
+		$link  = '';
-		if ( is_wp_error($rss) ) {
+		if ( is_wp_error( $rss ) ) {
 			$error = $rss->get_error_message();
 		} else {
-			$link = esc_url(strip_tags($rss->get_permalink()));
+			$link = esc_url( strip_tags( $rss->get_permalink() ) );
-			while ( stristr($link, 'http') != $link )
+			while ( stristr( $link, 'http' ) != $link ) {
-				$link = substr($link, 1);
+				$link = substr( $link, 1 );
+			}
 			$rss->__destruct();
-			unset($rss);
+			unset( $rss );
 		}
 	}
 	return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' );
 }

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4