| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650 |
- <?php
- /**
- * Core Widgets API
- *
- * This API is used for creating dynamic sidebar without hardcoding functionality into
- * themes
- *
- * Includes both internal WordPress routines and theme-use routines.
- *
- * This functionality was found in a plugin before the WordPress 2.2 release, which
- * included it in the core from that point on.
- *
- * @link https://codex.wordpress.org/Plugins/WordPress_Widgets WordPress Widgets
- * @link https://codex.wordpress.org/Plugins/WordPress_Widgets_Api Widgets API
- *
- * @package WordPress
- * @subpackage Widgets
- * @since 2.2.0
- */
- //
- // Global Variables
- //
- /** @ignore */
- 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
- * @since 2.2.0
- */
- $wp_registered_sidebars = array();
- /**
- * Stores the registered widgets.
- *
- * @global array $wp_registered_widgets
- * @since 2.2.0
- */
- $wp_registered_widgets = array();
- /**
- * Stores the registered widget control (options).
- *
- * @global array $wp_registered_widget_controls
- * @since 2.2.0
- */
- $wp_registered_widget_controls = array();
- /**
- * @global array $wp_registered_widget_updates
- */
- $wp_registered_widget_updates = array();
- /**
- * Private
- *
- * @global array $_wp_sidebars_widgets
- */
- $_wp_sidebars_widgets = array();
- /**
- * Private
- *
- * @global array $_wp_deprecated_widgets_callbacks
- */
- $GLOBALS['_wp_deprecated_widgets_callbacks'] = array(
- 'wp_widget_pages',
- 'wp_widget_pages_control',
- 'wp_widget_calendar',
- 'wp_widget_calendar_control',
- 'wp_widget_archives',
- 'wp_widget_archives_control',
- 'wp_widget_links',
- 'wp_widget_meta',
- 'wp_widget_meta_control',
- 'wp_widget_search',
- 'wp_widget_recent_entries',
- 'wp_widget_recent_entries_control',
- 'wp_widget_tag_cloud',
- 'wp_widget_tag_cloud_control',
- 'wp_widget_categories',
- 'wp_widget_categories_control',
- 'wp_widget_text',
- 'wp_widget_text_control',
- 'wp_widget_rss',
- 'wp_widget_rss_control',
- 'wp_widget_recent_comments',
- 'wp_widget_recent_comments_control'
- );
- //
- // Template tags & API functions
- //
- /**
- * Register a widget
- *
- * Registers a WP_Widget widget
- *
- * @since 2.8.0
- * @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object
- * instead of simply a `WP_Widget` subclass name.
- *
- * @see WP_Widget
- *
- * @global WP_Widget_Factory $wp_widget_factory
- *
- * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
- */
- function register_widget( $widget ) {
- global $wp_widget_factory;
- $wp_widget_factory->register( $widget );
- }
- /**
- * Unregisters a widget.
- *
- * Unregisters a WP_Widget widget. Useful for un-registering default widgets.
- * Run within a function hooked to the {@see 'widgets_init'} action.
- *
- * @since 2.8.0
- * @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object
- * instead of simply a `WP_Widget` subclass name.
- *
- * @see WP_Widget
- *
- * @global WP_Widget_Factory $wp_widget_factory
- *
- * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
- */
- function unregister_widget( $widget ) {
- global $wp_widget_factory;
- $wp_widget_factory->unregister( $widget );
- }
- /**
- * Creates multiple sidebars.
- *
- * If you wanted to quickly create multiple sidebars for a theme or internally.
- * This function will allow you to do so. If you don't pass the 'name' and/or
- * 'id' in `$args`, then they will be built for you.
- *
- * @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
- *
- * @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.
- *
- * @type string $id The base string of the unique identifier for each sidebar. If provided, and multiple
- * sidebars are being defined, the id will have "-2" appended, and so on.
- * Default 'sidebar-' followed by the number the sidebar creation is currently at.
- * @type string $name The name or title for the sidebars displayed in the admin dashboard. If registering
- * more than one sidebar, include '%d' in the string as a placeholder for the uniquely
- * assigned number for each sidebar.
- * Default 'Sidebar' for the first sidebar, otherwise 'Sidebar %d'.
- * }
- */
- function register_sidebars( $number = 1, $args = array() ) {
- global $wp_registered_sidebars;
- $number = (int) $number;
- if ( is_string($args) )
- parse_str($args, $args);
- for ( $i = 1; $i <= $number; $i++ ) {
- $_args = $args;
- if ( $number > 1 )
- $_args['name'] = isset($args['name']) ? sprintf($args['name'], $i) : sprintf(__('Sidebar %d'), $i);
- else
- $_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']) ) {
- $_args['id'] = $args['id'];
- $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);
- }
- }
- /**
- * Builds the definition for a single sidebar and returns the ID.
- *
- * Accepts either a string or an array and then parses that against a set
- * of default arguments for the new sidebar. WordPress will automatically
- * generate a sidebar ID and name based on the current number of registered
- * sidebars if those arguments are not included.
- *
- * When allowing for automatic generation of the name and ID parameters, keep
- * in mind that the incrementor for your sidebar can change over time depending
- * on what other plugins and themes are installed.
- *
- * If theme support for 'widgets' has not yet been added when this function is
- * called, it will be automatically enabled through the use of add_theme_support()
- *
- * @since 2.2.0
- *
- * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
- *
- * @param array|string $args {
- * Optional. Array or string of arguments for the sidebar being registered.
- *
- * @type string $name The name or title of the sidebar displayed in the Widgets
- * interface. Default 'Sidebar $instance'.
- * @type string $id The unique identifier by which the sidebar will be called.
- * Default 'sidebar-$instance'.
- * @type string $description Description of the sidebar, displayed in the Widgets interface.
- * Default empty string.
- * @type string $class Extra CSS class to assign to the sidebar in the Widgets interface.
- * Default empty.
- * @type string $before_widget HTML content to prepend to each widget's HTML output when
- * assigned to this sidebar. Default is an opening list item element.
- * @type string $after_widget HTML content to append to each widget's HTML output when
- * assigned to this sidebar. Default is a closing list item element.
- * @type string $before_title HTML content to prepend to the sidebar title when displayed.
- * Default is an opening h2 element.
- * @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()) {
- global $wp_registered_sidebars;
- $i = count($wp_registered_sidebars) + 1;
- $id_is_empty = empty( $args['id'] );
- $defaults = array(
- 'name' => sprintf(__('Sidebar %d'), $i ),
- 'id' => "sidebar-$i",
- 'description' => '',
- 'class' => '',
- 'before_widget' => '<li id="%1$s" class="widget %2$s">',
- 'after_widget' => "</li>\n",
- 'before_title' => '<h2 class="widgettitle">',
- '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;
- add_theme_support('widgets');
- /**
- * Fires once a sidebar has been registered.
- *
- * @since 3.0.0
- *
- * @param array $sidebar Parsed arguments for the registered sidebar.
- */
- do_action( 'register_sidebar', $sidebar );
- return $sidebar['id'];
- }
- /**
- * 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.
- *
- * @param string|int $sidebar_id The ID of the sidebar when it was registered.
- */
- function unregister_sidebar( $sidebar_id ) {
- global $wp_registered_sidebars;
- unset( $wp_registered_sidebars[ $sidebar_id ] );
- }
- /**
- * Checks if a sidebar is registered.
- *
- * @since 4.4.0
- *
- * @global array $wp_registered_sidebars Registered sidebars.
- *
- * @param string|int $sidebar_id The ID of the sidebar when it was registered.
- * @return bool True if the sidebar is registered, false otherwise.
- */
- function is_registered_sidebar( $sidebar_id ) {
- global $wp_registered_sidebars;
- return isset( $wp_registered_sidebars[ $sidebar_id ] );
- }
- /**
- * Register an instance of a widget.
- *
- * The default widget option is 'classname' that can be overridden.
- *
- * The function can also be used to un-register widgets when `$output_callback`
- * parameter is an empty string.
- *
- * @since 2.2.0
- *
- * @global array $wp_registered_widgets Uses stored registered widgets.
- * @global array $wp_registered_widget_controls Stores the registered widget controls (options).
- * @global array $wp_registered_widget_updates
- * @global array $_wp_deprecated_widgets_callbacks
- *
- * @param int|string $id Widget ID.
- * @param string $name Widget display title.
- * @param callable $output_callback Run when widget is called.
- * @param array $options {
- * Optional. An array of supplementary widget options for the instance.
- *
- * @type string $classname Class name for the widget's HTML container. Default is a shortened
- * version of the output callback name.
- * @type string $description Widget description for display in the widget administration
- * panel and/or theme.
- * }
- */
- 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);
- if ( empty($output_callback) ) {
- unset($wp_registered_widgets[$id]);
- return;
- }
- $id_base = _get_widget_id_base($id);
- 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);
- $options = wp_parse_args($options, $defaults);
- $widget = array(
- 'name' => $name,
- 'id' => $id,
- 'callback' => $output_callback,
- 'params' => array_slice(func_get_args(), 4)
- );
- $widget = array_merge($widget, $options);
- 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;
- }
- }
- /**
- * Retrieve description for widget.
- *
- * When registering widgets, the options can also include 'description' that
- * describes the widget for display on the widget administration panel or
- * in the theme.
- *
- * @since 2.5.0
- *
- * @global array $wp_registered_widgets
- *
- * @param int|string $id Widget ID.
- * @return string|void Widget description, if available.
- */
- function wp_widget_description( $id ) {
- if ( !is_scalar($id) )
- return;
- global $wp_registered_widgets;
- if ( isset($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
- *
- * @param string $id sidebar ID.
- * @return string|void Sidebar description, if available.
- */
- function wp_sidebar_description( $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' );
- }
- }
- /**
- * Remove widget from sidebar.
- *
- * @since 2.2.0
- *
- * @param int|string $id 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_unregister_widget_control($id);
- }
- /**
- * Registers widget control callback for customizing options.
- *
- * @since 2.2.0
- *
- * @todo `$params` parameter?
- *
- * @global array $wp_registered_widget_controls
- * @global array $wp_registered_widget_updates
- * @global array $wp_registered_widgets
- * @global array $_wp_deprecated_widgets_callbacks
- *
- * @param int|string $id Sidebar ID.
- * @param string $name Sidebar display name.
- * @param callable $control_callback Run when sidebar is displayed.
- * @param array $options {
- * Optional. Array or string of control options. Default empty array.
- *
- * @type int $height Never used. Default 200.
- * @type int $width Width of the fully expanded control form (but try hard to use the default width).
- * Default 250.
- * @type int|string $id_base Required for multi-widgets, i.e widgets that allow multiple instances such as the
- * text widget. The widget id will end up looking like `{$id_base}-{$unique_number}`.
- * }
- */
- 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_base = _get_widget_id_base($id);
- if ( empty($control_callback) ) {
- unset($wp_registered_widget_controls[$id]);
- unset($wp_registered_widget_updates[$id_base]);
- return;
- }
- 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' ) )
- return;
- $defaults = array('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,
- 'id' => $id,
- 'callback' => $control_callback,
- 'params' => array_slice(func_get_args(), 4)
- );
- $widget = array_merge($widget, $options);
- $wp_registered_widget_controls[$id] = $widget;
- if ( isset($wp_registered_widget_updates[$id_base]) )
- return;
- 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;
- }
- /**
- * Registers the update callback for a widget.
- *
- * @since 2.8.0
- *
- * @global array $wp_registered_widget_updates
- *
- * @param string $id_base The base ID of a widget created by extending WP_Widget.
- * @param callable $update_callback Update callback method for the widget.
- * @param array $options Optional. Widget control options. See wp_register_widget_control().
- * 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 ( empty($update_callback) )
- unset($wp_registered_widget_updates[$id_base]);
- return;
- }
- $widget = array(
- 'callback' => $update_callback,
- 'params' => array_slice(func_get_args(), 3)
- );
- $widget = array_merge($widget, $options);
- $wp_registered_widget_updates[$id_base] = $widget;
- }
- /**
- * Registers the form callback for a widget.
- *
- * @since 2.8.0
- *
- * @global array $wp_registered_widget_controls
- *
- * @param int|string $id Widget ID.
- * @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()) {
- global $wp_registered_widget_controls;
- $id = strtolower($id);
- if ( empty($form_callback) ) {
- unset($wp_registered_widget_controls[$id]);
- return;
- }
- if ( isset($wp_registered_widget_controls[$id]) && !did_action( 'widgets_init' ) )
- return;
- $defaults = array('width' => 250, 'height' => 200 );
- $options = wp_parse_args($options, $defaults);
- $options['width'] = (int) $options['width'];
- $options['height'] = (int) $options['height'];
- $widget = array(
- 'name' => $name,
- 'id' => $id,
- 'callback' => $form_callback,
- 'params' => array_slice(func_get_args(), 4)
- );
- $widget = array_merge($widget, $options);
- $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) {
- wp_register_widget_control( $id, '', '' );
- }
- /**
- * Display dynamic sidebar.
- *
- * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
- * '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_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.
- */
- function dynamic_sidebar( $index = 1 ) {
- global $wp_registered_sidebars, $wp_registered_widgets;
- if ( is_int( $index ) ) {
- $index = "sidebar-$index";
- } else {
- $index = sanitize_title( $index );
- foreach ( (array) $wp_registered_sidebars as $key => $value ) {
- if ( sanitize_title( $value['name'] ) == $index ) {
- $index = $key;
- break;
- }
- }
- }
- $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 );
- /** This filter is documented in wp-includes/widget.php */
- return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
- }
- /**
- * Fires before widgets are rendered in a dynamic sidebar.
- *
- * Note: The action also fires for empty sidebars, and on both the front end
- * and back end, including the Inactive Widgets sidebar on the Widgets screen.
- *
- * @since 3.9.0
- *
- * @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];
- $did_one = false;
- foreach ( (array) $sidebars_widgets[$index] as $id ) {
- 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) $wp_registered_widgets[$id]['params']
- );
- // Substitute HTML id and class attributes into before_widget
- $classname_ = '';
- foreach ( (array) $wp_registered_widgets[$id]['classname'] as $cn ) {
- if ( is_string($cn) )
- $classname_ .= '_' . $cn;
- elseif ( is_object($cn) )
- $classname_ .= '_' . get_class($cn);
- }
- $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,
- * including for the Inactive Widgets sidebar on the Widgets screen.
- *
- * @since 2.5.0
- *
- * @see register_sidebar()
- *
- * @param array $params {
- * @type array $args {
- * An array of widget display arguments.
- *
- * @type string $name Name of the sidebar the widget is assigned to.
- * @type string $id ID of the sidebar the widget is assigned to.
- * @type string $description The sidebar description.
- * @type string $class CSS class applied to the sidebar container.
- * @type string $before_widget HTML markup to prepend to each widget in the sidebar.
- * @type string $after_widget HTML markup to append to each widget in the sidebar.
- * @type string $before_title HTML markup to prepend to the widget title when displayed.
- * @type string $after_title HTML markup to append to the widget title when displayed.
- * @type string $widget_id ID of the widget.
- * @type string $widget_name Name of the widget.
- * }
- * @type array $widget_args {
- * An array of multi-widget arguments.
- *
- * @type int $number Number increment used for multiples of the same widget.
- * }
- * }
- */
- $params = apply_filters( 'dynamic_sidebar_params', $params );
- $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
- * for widgets in the Inactive Widgets sidebar on the Widgets screen.
- *
- * The action is not fired for empty sidebars.
- *
- * @since 3.0.0
- *
- * @param array $widget_id {
- * An associative array of widget arguments.
- *
- * @type string $name Name of the widget.
- * @type string $id Widget ID.
- * @type array|callable $callback When the hook is fired on the front end, $callback is an array
- * containing the widget object. Fired on the back end, $callback
- * is 'wp_widget_control', see $_callback.
- * @type array $params An associative array of multi-widget arguments.
- * @type string $classname CSS class applied to the widget container.
- * @type string $description The widget description.
- * @type array $_callback When the hook is fired on the back end, $_callback is populated
- * with an array containing the widget object, see $callback.
- * }
- */
- do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] );
- if ( is_callable($callback) ) {
- call_user_func_array($callback, $params);
- $did_one = true;
- }
- }
- /**
- * Fires after widgets are rendered in a dynamic sidebar.
- *
- * Note: The action also fires for empty sidebars, and on both the front end
- * and back end, including the Inactive Widgets sidebar on the Widgets screen.
- *
- * @since 3.9.0
- *
- * @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_after', $index, true );
- /**
- * Filters whether a sidebar has widgets.
- *
- * Note: The filter is also evaluated for empty sidebars, and on both the front end
- * and back end, including the Inactive Widgets sidebar on the Widgets screen.
- *
- * @since 3.9.0
- *
- * @param bool $did_one Whether at least one widget was rendered in the sidebar.
- * Default false.
- * @param int|string $index Index, name, or ID of the dynamic sidebar.
- */
- return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
- }
- /**
- * Whether 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.
- * With the $widget_id parameter, returns the ID of the sidebar where
- * 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.
- *
- * @since 2.2.0
- *
- * @global array $wp_registered_widgets
- *
- * @param string|false $callback Optional, Widget callback to check. Default false.
- * @param int|false $widget_id Optional. Widget ID. Optional, but needed for checking. Default false.
- * @param string|false $id_base Optional. The base ID of a widget created by extending WP_Widget. Default false.
- * @param bool $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. Default true.
- * @return string|false False if widget is not active or id of sidebar in which the widget is active.
- */
- 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) ) {
- foreach ( $sidebars_widgets as $sidebar => $widgets ) {
- if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
- continue;
- }
- 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 ( !$widget_id || $widget_id == $wp_registered_widgets[$widget]['id'] )
- return $sidebar;
- }
- }
- }
- }
- }
- return false;
- }
- /**
- * Whether the dynamic sidebar is enabled and used by theme.
- *
- * @since 2.2.0
- *
- * @global array $wp_registered_widgets
- * @global array $wp_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');
- foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) {
- if ( ! empty( $sidebars_widgets[ $index ] ) ) {
- foreach ( (array) $sidebars_widgets[$index] as $widget )
- if ( array_key_exists($widget, $wp_registered_widgets) )
- return true;
- }
- }
- return false;
- }
- /**
- * Whether a sidebar is in use.
- *
- * @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);
- $sidebars_widgets = wp_get_sidebars_widgets();
- $is_active_sidebar = ! empty( $sidebars_widgets[$index] );
- /**
- * Filters whether a dynamic sidebar is considered "active".
- *
- * @since 3.9.0
- *
- * @param bool $is_active_sidebar Whether or not the sidebar should be considered "active".
- * In other words, whether the sidebar contains any widgets.
- * @param int|string $index Index, name, or ID of the dynamic sidebar.
- */
- return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index );
- }
- //
- // Internal Functions
- //
- /**
- * Retrieve full list of sidebars and their widget instance IDs.
- *
- * Will upgrade sidebar widget list, if needed. Will also save updated list, if
- * needed.
- *
- * @since 2.2.0
- * @access private
- *
- * @global array $_wp_sidebars_widgets
- * @global array $sidebars_widgets
- *
- * @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 )
- _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 ( empty($_wp_sidebars_widgets) )
- $_wp_sidebars_widgets = get_option('sidebars_widgets', array());
- $sidebars_widgets = $_wp_sidebars_widgets;
- } else {
- $sidebars_widgets = get_option('sidebars_widgets', array());
- }
- if ( is_array( $sidebars_widgets ) && isset($sidebars_widgets['array_version']) )
- unset($sidebars_widgets['array_version']);
- /**
- * Filters the list of sidebars and their widgets.
- *
- * @since 2.7.0
- *
- * @param array $sidebars_widgets An associative array of sidebars and their widgets.
- */
- return apply_filters( 'sidebars_widgets', $sidebars_widgets );
- }
- /**
- * Set the sidebar widget option to update sidebars.
- *
- * @since 2.2.0
- * @access private
- *
- * @global array $_wp_sidebars_widgets
- * @param array $sidebars_widgets Sidebar widgets and their settings.
- */
- function wp_set_sidebars_widgets( $sidebars_widgets ) {
- global $_wp_sidebars_widgets;
- // Clear cached value used in wp_get_sidebars_widgets().
- $_wp_sidebars_widgets = null;
- if ( ! isset( $sidebars_widgets['array_version'] ) ) {
- $sidebars_widgets['array_version'] = 3;
- }
- update_option( 'sidebars_widgets', $sidebars_widgets );
- }
- /**
- * Retrieve default registered sidebars list.
- *
- * @since 2.2.0
- * @access private
- *
- * @global array $wp_registered_sidebars
- *
- * @return array
- */
- function wp_get_widget_defaults() {
- global $wp_registered_sidebars;
- $defaults = array();
- foreach ( (array) $wp_registered_sidebars as $index => $sidebar )
- $defaults[$index] = array();
- return $defaults;
- }
- /**
- * Convert the widget settings from single to multi-widget format.
- *
- * @since 2.8.0
- *
- * @global array $_wp_sidebars_widgets
- *
- * @param string $base_name
- * @param string $option_name
- * @param array $settings
- * @return array
- */
- function wp_convert_widget_settings($base_name, $option_name, $settings) {
- // This test may need expanding.
- $single = $changed = false;
- if ( empty($settings) ) {
- $single = true;
- } else {
- foreach ( array_keys($settings) as $number ) {
- if ( 'number' == $number )
- continue;
- 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');
- } else {
- if ( empty($GLOBALS['_wp_sidebars_widgets']) )
- $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) ) {
- foreach ( $sidebar as $i => $name ) {
- if ( $base_name == $name ) {
- $sidebars_widgets[$index][$i] = "$name-2";
- $changed = true;
- break 2;
- }
- }
- }
- }
- if ( is_admin() && $changed )
- update_option('sidebars_widgets', $sidebars_widgets);
- }
- $settings['_multiwidget'] = 1;
- if ( is_admin() )
- update_option( $option_name, $settings );
- return $settings;
- }
- /**
- * Output an arbitrary widget as a template tag.
- *
- * @since 2.8.0
- *
- * @global WP_Widget_Factory $wp_widget_factory
- *
- * @param string $widget The widget's PHP class name (see class-wp-widget.php).
- * @param array $instance Optional. The widget's instance settings. Default empty array.
- * @param array $args {
- * Optional. Array of arguments to configure the display of the widget.
- *
- * @type string $before_widget HTML content that will be prepended to the widget's HTML output.
- * Default `<div class="widget %s">`, where `%s` is the widget's class name.
- * @type string $after_widget HTML content that will be appended to the widget's HTML output.
- * Default `</div>`.
- * @type string $before_title HTML content that will be prepended to the widget's title when displayed.
- * Default `<h2 class="widgettitle">`.
- * @type string $after_title HTML content that will be appended to the widget's title when displayed.
- * Default `</h2>`.
- * }
- */
- function the_widget( $widget, $instance = array(), $args = array() ) {
- global $wp_widget_factory;
- if ( ! isset( $wp_widget_factory->widgets[ $widget ] ) ) {
- /* 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];
- if ( ! ( $widget_obj instanceof WP_Widget ) ) {
- return;
- }
- $default_args = array(
- 'before_widget' => '<div class="widget %s">',
- 'after_widget' => "</div>",
- 'before_title' => '<h2 class="widgettitle">',
- 'after_title' => '</h2>',
- );
- $args = wp_parse_args( $args, $default_args );
- $args['before_widget'] = sprintf( $args['before_widget'], $widget_obj->widget_options['classname'] );
- $instance = wp_parse_args($instance);
- /**
- * Fires before rendering the requested widget.
- *
- * @since 3.0.0
- *
- * @param string $widget The widget's class name.
- * @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->widget($args, $instance);
- }
- /**
- * Retrieves the widget ID base value.
- *
- * @since 2.8.0
- *
- * @param string $id Widget ID.
- * @return string Widget ID base.
- */
- function _get_widget_id_base( $id ) {
- return preg_replace( '/-[0-9]+$/', '', $id );
- }
- /**
- * Handle sidebars config after theme change
- *
- * @access private
- * @since 3.3.0
- *
- * @global array $sidebars_widgets
- */
- function _wp_sidebars_changed() {
- global $sidebars_widgets;
- if ( ! is_array( $sidebars_widgets ) )
- $sidebars_widgets = wp_get_sidebars_widgets();
- 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 $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.
- * @return array Updated sidebars widgets.
- */
- function retrieve_widgets( $theme_changed = false ) {
- 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 ( empty( $sidebars_widgets ) ) {
- return array();
- }
- unset( $sidebars_widgets['array_version'] );
- $sidebars_widgets_keys = array_keys( $sidebars_widgets );
- sort( $sidebars_widgets_keys );
- sort( $registered_sidebars_keys );
- if ( $sidebars_widgets_keys === $registered_sidebars_keys ) {
- $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids );
- return $sidebars_widgets;
- }
- }
- // Discard invalid, theme-specific widgets from sidebars.
- $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids );
- $sidebars_widgets = wp_map_sidebars_widgets( $sidebars_widgets );
- // Find hidden/lost multi-widget instances.
- $shown_widgets = call_user_func_array( 'array_merge', $sidebars_widgets );
- $lost_widgets = array_diff( $registered_widgets_ids, $shown_widgets );
- foreach ( $lost_widgets as $key => $widget_id ) {
- $number = preg_replace( '/.+?-([0-9]+)$/', '$1', $widget_id );
- // Only keep active and default widgets.
- if ( is_numeric( $number ) && (int) $number < 2 ) {
- unset( $lost_widgets[ $key ] );
- }
- }
- $sidebars_widgets['wp_inactive_widgets'] = array_merge( $lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets'] );
- if ( 'customize' !== $theme_changed ) {
- wp_set_sidebars_widgets( $sidebars_widgets );
- }
- return $sidebars_widgets;
- }
- /**
- * Compares a list of sidebars with their widgets against a whitelist.
- *
- * @since 4.9.0
- * @since 4.9.2 Always tries to restore widget assignments from previous data, not just if sidebars needed mapping.
- *
- * @param array $existing_sidebars_widgets List of sidebars and their widget instance IDs.
- * @return array Mapped sidebars widgets.
- */
- function wp_map_sidebars_widgets( $existing_sidebars_widgets ) {
- global $wp_registered_sidebars;
- $new_sidebars_widgets = array(
- 'wp_inactive_widgets' => array(),
- );
- // Short-circuit if there are no sidebars to map.
- if ( ! is_array( $existing_sidebars_widgets ) || empty( $existing_sidebars_widgets ) ) {
- return $new_sidebars_widgets;
- }
- foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) {
- if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
- $new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], (array) $widgets );
- unset( $existing_sidebars_widgets[ $sidebar ] );
- }
- }
- // If old and new theme have just one sidebar, map it and we're done.
- if ( 1 === count( $existing_sidebars_widgets ) && 1 === count( $wp_registered_sidebars ) ) {
- $new_sidebars_widgets[ key( $wp_registered_sidebars ) ] = array_pop( $existing_sidebars_widgets );
- return $new_sidebars_widgets;
- }
- // Map locations with the same slug.
- $existing_sidebars = array_keys( $existing_sidebars_widgets );
- 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 ) ) {
- $new_sidebars_widgets[ $sidebar ] = array();
- }
- }
- // If there are more sidebars, try to map them.
- if ( ! empty( $existing_sidebars_widgets ) ) {
- /*
- * If old and new theme both have sidebars that contain phrases
- * from within the same group, make an educated guess and map it.
- */
- $common_slug_groups = array(
- array( 'sidebar', 'primary', 'main', 'right' ),
- array( 'second', 'left' ),
- array( 'sidebar-2', 'footer', 'bottom' ),
- array( 'header', 'top' ),
- );
- // Go through each group...
- foreach ( $common_slug_groups as $slug_group ) {
- // ...and see if any of these slugs...
- foreach ( $slug_group as $slug ) {
- // ...and any of the new sidebars...
- foreach ( $wp_registered_sidebars as $new_sidebar => $args ) {
- // ...actually match!
- if ( false === stripos( $new_sidebar, $slug ) && false === stripos( $slug, $new_sidebar ) ) {
- continue;
- }
- // Then see if any of the existing sidebars...
- foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) {
- // ...and any slug in the same group...
- foreach ( $slug_group as $slug ) {
- // ... have a match as well.
- if ( false === stripos( $sidebar, $slug ) && false === stripos( $slug, $sidebar ) ) {
- continue;
- }
- // Make sure this sidebar wasn't mapped and removed previously.
- if ( ! empty( $existing_sidebars_widgets[ $sidebar ] ) ) {
- // We have a match that can be mapped!
- $new_sidebars_widgets[ $new_sidebar ] = array_merge( $new_sidebars_widgets[ $new_sidebar ], $existing_sidebars_widgets[ $sidebar ] );
- // Remove the mapped sidebar so it can't be mapped again.
- unset( $existing_sidebars_widgets[ $sidebar ] );
- // Go back and check the next new sidebar.
- continue 3;
- }
- } // endforeach ( $slug_group as $slug )
- } // endforeach ( $existing_sidebars_widgets as $sidebar => $widgets )
- } // endforeach foreach ( $wp_registered_sidebars as $new_sidebar => $args )
- } // endforeach ( $slug_group as $slug )
- } // endforeach ( $common_slug_groups as $slug_group )
- }
- // Move any left over widgets to inactive sidebar.
- foreach ( $existing_sidebars_widgets as $widgets ) {
- if ( is_array( $widgets ) && ! empty( $widgets ) ) {
- $new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], $widgets );
- }
- }
- // Sidebars_widgets settings from when this theme was previously active.
- $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' );
- $old_sidebars_widgets = isset( $old_sidebars_widgets['data'] ) ? $old_sidebars_widgets['data'] : false;
- if ( is_array( $old_sidebars_widgets ) ) {
- // Remove empty sidebars, no need to map those.
- $old_sidebars_widgets = array_filter( $old_sidebars_widgets );
- // Only check sidebars that are empty or have not been mapped to yet.
- foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ) {
- if ( array_key_exists( $new_sidebar, $old_sidebars_widgets ) && ! empty( $new_widgets ) ) {
- unset( $old_sidebars_widgets[ $new_sidebar ] );
- }
- }
- // Remove orphaned widgets, we're only interested in previously active sidebars.
- foreach ( $old_sidebars_widgets as $sidebar => $widgets ) {
- if ( 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
- unset( $old_sidebars_widgets[ $sidebar ] );
- }
- }
- $old_sidebars_widgets = _wp_remove_unregistered_widgets( $old_sidebars_widgets );
- if ( ! empty( $old_sidebars_widgets ) ) {
- // Go through each remaining sidebar...
- foreach ( $old_sidebars_widgets as $old_sidebar => $old_widgets ) {
- // ...and check every new sidebar...
- foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ) {
- // ...for every widget we're trying to revive.
- foreach ( $old_widgets as $key => $widget_id ) {
- $active_key = array_search( $widget_id, $new_widgets, true );
- // If the widget is used elsewhere...
- if ( false !== $active_key ) {
- // ...and that elsewhere is inactive widgets...
- if ( 'wp_inactive_widgets' === $new_sidebar ) {
- // ...remove it from there and keep the active version...
- unset( $new_sidebars_widgets['wp_inactive_widgets'][ $active_key ] );
- } else {
- // ...otherwise remove it from the old sidebar and keep it in the new one.
- unset( $old_sidebars_widgets[ $old_sidebar ][ $key ] );
- }
- } // endif ( $active_key )
- } // 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;
- }
- /**
- * Compares a list of sidebars with their widgets against a whitelist.
- *
- * @since 4.9.0
- *
- * @param array $sidebars_widgets List of sidebars and their widget instance IDs.
- * @param array $whitelist Optional. List of widget IDs to compare against. Default: Registered widgets.
- * @return array Sidebars with whitelisted widgets.
- */
- function _wp_remove_unregistered_widgets( $sidebars_widgets, $whitelist = array() ) {
- if ( empty( $whitelist ) ) {
- $whitelist = array_keys( $GLOBALS['wp_registered_widgets'] );
- }
- foreach ( $sidebars_widgets as $sidebar => $widgets ) {
- if ( is_array( $widgets ) ) {
- $sidebars_widgets[ $sidebar ] = array_intersect( $widgets, $whitelist );
- }
- }
- 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><strong>' . __( 'RSS Error:' ) . '</strong> ' . $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, ' […]' ) );
- $summary = '';
- if ( $show_summary ) {
- $summary = $desc;
- // Change existing [...] to […].
- if ( '[...]' == substr( $summary, -5 ) ) {
- $summary = substr( $summary, 0, -5 ) . '[…]';
- }
- $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>' . __( '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>
- <?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' );
- }
- /**
- * Registers all of the default WordPress widgets on startup.
- *
- * Calls {@see '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_Media_Audio' );
- register_widget( 'WP_Widget_Media_Image' );
- register_widget( 'WP_Widget_Media_Gallery' );
- register_widget( 'WP_Widget_Media_Video' );
- 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' );
- register_widget( 'WP_Widget_Custom_HTML' );
- /**
- * Fires after all default WordPress widgets have been registered.
- *
- * @since 2.2.0
- */
- do_action( 'widgets_init' );
- }
|