wp_register_sidebar_widget

函数
wp_register_sidebar_widget ( $id, $name, $output_callback, $options = array(), $params )
参数
  • (int|string) $id Widget ID.
    Required:
  • (string) $name Widget display title.
    Required:
  • (callable) $output_callback Run when widget is called.
    Required:
  • (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. @type bool $show_instance_in_rest Whether to show the widget's instance settings in the REST API. Only available for WP_Widget based widgets. }
    Required:
    Default: array()
  • (mixed) $params Optional additional parameters to pass to the callback function when it's called.
    Required:
定义位置
相关方法
wp_unregister_sidebar_widgetregister_sidebar_widgetunregister_sidebar_widgetwp_get_sidebars_widgetswp_set_sidebars_widgets
引入
2.2.0
弃用
-

wp_register_sidebar_widget: 这个函数用来注册一个小工具,以便在侧边栏显示。它接受几个参数,包括小工具的名称、ID、描述和回调函数。

注册一个 widget 的实例。

默认的widget选项是’classname’,可以被重写。

当`$output_callback’参数为空字符串时,该函数也可用于取消注册小工具。

function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array(), ...$params ) {
	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'   => $params,
	);
	$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;
	}
}

常见问题

FAQs
查看更多 >