Codex

Function Reference/wp register sidebar widget

Contents

Description

Register widget for use in sidebars.

Usage

 <?php wp_register_sidebar_widget( $id, $name, $output_callback, $options, $params, ... ); ?> 

Parameters

$id
(int/string) (required) Widget ID.
Default: None
$name
(string) (required) Widget display title.
Default: None
$output_callback
(callback) (required) Run when widget is called.
Default: None
$options
(array/string) (optional) Widget Options.
Default: None
$params,...
(mixed) (optional) Widget parameters to add to widget.
Default: None

Output Callback Function Parameters Format

function my_output_callback_function( $args, $params ){ ... }

$args
(array) (required) Various values merged into an array
Default: None
$params
(array) (required) The extra $params given to wp_register_sidebar_widget, as an array
Default: None

$args array contains:

The 'dynamic_sidebar_params' filter is applied to the parameters (as an array), before your output function is called back.

Example

The following code will create a widget called "Your Widget" which will become available in the WordPress Administrative Panels. The widget can then be dragged to an available sidebar for display. 

<?php

function your_widget_display() {
    // print some HTML for the widget to display here
    echo "Your Widget Test";
}

wp_register_sidebar_widget(
    'your_widget_1',        // your unique widget id
    'Your Widget',          // widget name
    'your_widget_display',  // callback function
    array(                  // options
        'description' => 'Description of what your widget does'
    )
);

?>

Change Log

Since: 2.2.0

Source File

wp_register_sidebar_widget() is located in wp-includes/widgets.php.

Related

Sidebars: is_active_sidebar(), register_sidebars(), register_sidebar(), unregister_sidebar(), is_dynamic_sidebar(), dynamic_sidebar(), wp_register_sidebar_widget(), wp_unregister_sidebar_widget(), wp_get_sidebars_widgets(), wp_set_sidebars_widgets()

Widgets: is_active_widget(), the_widget(), register_widget(), unregister_widget(), wp_register_widget_control(), wp_unregister_widget_control(), wp_convert_widget_settings(), wp_get_widget_defaults(), wp_widget_description()

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/wp_register_sidebar_widget"

Codex Resources