- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「関数リファレンス/register sidebar widget」の版間の差分
(2.8: 非推奨(廃止予定)) |
細 (廃止の追加) |
||
1行目: | 1行目: | ||
{{非推奨|wp_register_sidebar_widget|2.8|関数|関数リファレンス}} | {{非推奨|wp_register_sidebar_widget|2.8|関数|関数リファレンス}} | ||
− | == | + | == 説明 == |
Register widget for sidebar with backwards compatibility. | Register widget for sidebar with backwards compatibility. | ||
17行目: | 17行目: | ||
When you register a widget you may pass a custom HTML class to replace <code>callback</code>. This is most useful for object-oriented widgets whose callbacks are passed as arrays. | When you register a widget you may pass a custom HTML class to replace <code>callback</code>. This is most useful for object-oriented widgets whose callbacks are passed as arrays. | ||
− | == | + | == 使い方 == |
<?php register_sidebar_widget( $name, $output_callback, $classname ); ?> | <?php register_sidebar_widget( $name, $output_callback, $classname ); ?> | ||
− | == | + | == パラメータ == |
{{Parameter|$name|string/int|Widget ID.}} | {{Parameter|$name|string/int|Widget ID.}} | ||
27行目: | 27行目: | ||
{{Parameter|$classname|string|Classname widget.|optional}} | {{Parameter|$classname|string|Classname widget.|optional}} | ||
− | == | + | ==用例== |
<pre><?php | <pre><?php | ||
49行目: | 49行目: | ||
?></pre> | ?></pre> | ||
− | == | + | == 更新履歴 == |
− | + | * 導入: [[Version 2.2|2.2.0]] | |
+ | * 廃止: [[Version 2.8|2.8.0]] 今後はこちらをお使いください [[関数リファレンス/wp_register_sidebar_widget|wp_register_sidebar_widget()]] [[:en:Function_Reference/wp_register_sidebar_widget|en]] | ||
− | == | + | == ソースファイル == |
− | <tt>register_sidebar_widget()</tt> | + | <tt>register_sidebar_widget()</tt> は {{Trac|wp-includes/widgets.php}}にありました。 |
{{原文|Function Reference/register_sidebar_widget|75256}}<!-- 23:55, 3 July 2009 Ramiy 版 --> | {{原文|Function Reference/register_sidebar_widget|75256}}<!-- 23:55, 3 July 2009 Ramiy 版 --> | ||
− | == | + | == 関連 == |
{{Widget Tags}} | {{Widget Tags}} |
2015年5月15日 (金) 12:47時点における最新版
この関数は WordPress 2.8 から非推奨となりました。後継となる新しい関数が作られたか、動作対象外となり、WordPress の将来のバージョンで削除される見込みです。
この関数を使っていた場合は、後継の wp_register_sidebar_widget
に切り替えてください。
説明
Register widget for sidebar with backwards compatibility.
Provides backwards compatability to wp_register_sidebar_widget()/en. Registers callback as a widget output function with unique index name. This causes a draggable object containing name to appear in the admin interface.
A basic widget is simply a function that prints some HTML. To get a widget included in the widgets palette, you must register it via this function.
It is possible for theme authors to define replacement widgets within functions.php. Replace an existing widget by registering its name with a new callback. An empty callback will unregister a widget.
Because each widget has a unique name and a non-unique callback, the default markup before a widget looks like this:
<li id="{name}" class="{callback}">{callback output}</li>
When you register a widget you may pass a custom HTML class to replace callback
. This is most useful for object-oriented widgets whose callbacks are passed as arrays.
使い方
<?php register_sidebar_widget( $name, $output_callback, $classname ); ?>
パラメータ
- $name
- (string/int) (必須) Widget ID.
- 初期値: なし
- $output_callback
- (callback) (必須) Run when widget is called.
- 初期値: なし
- $classname
- (string) (optional) Classname widget.
- 初期値: なし
用例
<?php function my_widget { // print some HTML for the widget to display here. } register_sidebar_widget("my_widget", "my_widget"); ?>
Given a class my_widget
whose method that prints the widget HTML is called display
, you would use the following code:
<?php class my_widget { function display() { // print some HTML for the widget to display here. } } register_sidebar_widget('My Widget', array('my_widget', 'display')); // callback is mywidget::display ?>
更新履歴
- 導入: 2.2.0
- 廃止: 2.8.0 今後はこちらをお使いください wp_register_sidebar_widget() en
ソースファイル
register_sidebar_widget() は wp-includes/widgets.php
にありました。
最新英語版: WordPress Codex » Function Reference/register_sidebar_widget (最新版との差分)
関連
ウィジェット API: is_active_widget(), the_widget(), register_widget(), unregister_widget() / en, wp_register_widget_control() / en, wp_unregister_widget_control() / en, wp_convert_widget_settings() / en, wp_get_widget_defaults() / en, wp_widget_description() / en