“Function Reference/unregister sidebar”的版本间的差异

来自WordPress中文文档
跳转至: 导航搜索
(1个修订)
(1个版本)
 
(未显示另一用户的1个中间版本)
第1行: 第1行:
 
== Description ==
 
== Description ==
  
De-registers a previously registered sidebar.
+
De-registers a previously registered [[Sidebars|sidebar]].
  
 
== Usage ==
 
== Usage ==
  
%%% ?php unregister_sidebar( $name ); ? %%%
+
%%% <?php unregister_sidebar( $id ); ?> %%%
  
 
== Parameters ==
 
== Parameters ==
  
{{Parameter|$name|string|The ID of the sidebar when it was added.}}
+
{{Parameter|$id|string|The ID of the sidebar when it was added.}}
 +
 
 +
== Example ==
 +
 
 +
If added to a child theme's functions.php file, this will remove the footer sidebars registered by the TwentyTen theme.
 +
 
 +
<pre>
 +
function remove_some_widgets(){
 +
 
 +
// Unregister some of the TwentyTen sidebars
 +
unregister_sidebar( 'first-footer-widget-area' );
 +
unregister_sidebar( 'second-footer-widget-area' );
 +
unregister_sidebar( 'third-footer-widget-area' );
 +
unregister_sidebar( 'fourth-footer-widget-area' );
 +
}
 +
add_action( 'widgets_init', 'remove_some_widgets', 11 );
 +
</pre>
 +
 
 +
== Notes ==
 +
 
 +
In the example, note that we assign a priority of 11 when registering the widgets_init hook. This is because a child theme's functions.php file is called before the parent theme's, which means that our call to unregister_sidebar() would accomplish nothing since the sidebar has not yet been registered.
 +
 
 +
By lowering the priority of our action, we ensure that it is called after the parent theme's functions.php file is loaded.
  
 
== Change Log ==
 
== Change Log ==
第17行: 第39行:
 
== Source File ==
 
== Source File ==
  
ttunregister_sidebar()/tt is located in {{Trac|wp-includes/widgets.php}}.
+
<tt>unregister_sidebar()</tt> is located in {{Trac|wp-includes/widgets.php}}.
  
 
== Related ==
 
== Related ==
  
{{Widget Tags}}
+
{{Sidebar Tags}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}

2013年8月2日 (五) 04:21的最新版本

Description

De-registers a previously registered sidebar.

Usage

%%% <?php unregister_sidebar( $id ); ?> %%%

Parameters

tt$id/tt
(string) (required) The ID of the sidebar when it was added.
Default: Nonenoinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

Example

If added to a child theme's functions.php file, this will remove the footer sidebars registered by the TwentyTen theme.

function remove_some_widgets(){

	// Unregister some of the TwentyTen sidebars
	unregister_sidebar( 'first-footer-widget-area' );
	unregister_sidebar( 'second-footer-widget-area' );
	unregister_sidebar( 'third-footer-widget-area' );
	unregister_sidebar( 'fourth-footer-widget-area' );
}
add_action( 'widgets_init', 'remove_some_widgets', 11 );

Notes

In the example, note that we assign a priority of 11 when registering the widgets_init hook. This is because a child theme's functions.php file is called before the parent theme's, which means that our call to unregister_sidebar() would accomplish nothing since the sidebar has not yet been registered.

By lowering the priority of our action, we ensure that it is called after the parent theme's functions.php file is loaded.

Change Log

Since: 2.2.0

Source File

unregister_sidebar() is located in onlyincludecodewp-includes/widgets.php/code/onlyinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Template Description

Link to the source code on http://core.trac.wordpress.org/browser/.

Parameters

  1. filename
  2. (option) path to codetag/code (version) or codetrunk/code. This option is only used for a new function.br /Default: codetrunk/code -- trunk is the latest bleeding edge development version of WordPress.

Usage

Link to the stable version: pre检查到模板循环:模板:Trac/pre

Link to trunk: pre检查到模板循环:模板:Trac/pre

/div

wordpress.org.cn.

Related

模板:Sidebar Tags

includeonlydiv style=clear:both; background-color:#F7F7F7; border:1px solid #CCCCCC; color:#000000; padding:7px; margin:0.5em auto 0.5em auto; vertical-align:middle;See also index of Function Reference and index of Template Tags./div/includeonlynoinclude

Description

This Template is used by Codex:Template Messages.

Usage

pre 检查到模板循环:模板:Message /pre

Result

检查到模板循环:模板:Message

/noinclude