Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-27 06:42:56 +02:00
Code Issues Projects Releases Wiki Activity

Inline documentation cleanup for 4.0 audit.

Browse Source 
phpDoc tweaks for methods, properties, and filters added in [29051]:
* `WP_Customize_Control->$active_callback` property
* `WP_Customize_Control::active()` method
* `WP_Customize_Control::active_callback()` method
* `WP_Widget_Area_Customize_Control::active_callback()` method
* `WP_Widget_Form_Customize_Control::active_callback()` method
* 'customize_control_active' filter

Added in [28930]:
* `WP_Customize_Control::input_attrs()` method

See #27993 and #28885.

Built from https://develop.svn.wordpress.org/trunk@29156


git-svn-id: http://core.svn.wordpress.org/trunk@28940 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-07-14 00:32:16 +00:00
parent f5e5bc8934
commit 7b85adf989
1 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
wp-includes/class-wp-customize-control.php
View File

@ -86,16 +86,17 @@ class WP_Customize_Control {
public $type = 'text'; public $type = 'text';
/** /**
* Callback * Callback.
* *
* @since 4.0.0 * @since 4.0.0
*
* @access public * @access public
*
* @see WP_Customize_Control::active() * @see WP_Customize_Control::active()
* @var callable Callback is called with one argument, the instance of *
* WP_Customize_Control, and returns bool to indicate whether * @var callable Callback is called with one argument, the instance of
* the control is active (such as it relates to the URL * WP_Customize_Control, and returns bool to indicate whether
* currently being previewed). * the control is active (such as it relates to the URL
* currently being previewed).
*/ */
public $active_callback = ''; public $active_callback = '';
@ -154,8 +155,9 @@ class WP_Customize_Control {
* Check whether control is active to current customizer preview. * Check whether control is active to current customizer preview.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @return bool * @return bool Whether the control is active to the current preview.
*/ */
public final function active() { public final function active() {
$control = $this; $control = $this;
@ -166,8 +168,8 @@ class WP_Customize_Control {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param bool $active * @param bool $active Whether the Customizer control is active.
* @param WP_Customize_Control $control * @param WP_Customize_Control $control WP_Customize_Control instance.
*/ */
$active = apply_filters( 'customize_control_active', $active, $control ); $active = apply_filters( 'customize_control_active', $active, $control );
@ -180,7 +182,10 @@ class WP_Customize_Control {
* Subclasses can override this with their specific logic, or they may * Subclasses can override this with their specific logic, or they may
* provide an 'active_callback' argument to the constructor. * provide an 'active_callback' argument to the constructor.
* *
* @return bool * @since 4.0.0
* @access public
*
* @return bool Always true.
*/ */
public function active_callback() { public function active_callback() {
return true; return true;
@ -315,6 +320,7 @@ class WP_Customize_Control {
* Render the custom attributes for the control's input element. * Render the custom attributes for the control's input element.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
*/ */
public function input_attrs() { public function input_attrs() {
foreach( $this->input_attrs as $attr => $value ) { foreach( $this->input_attrs as $attr => $value ) {
@ -1052,9 +1058,14 @@ class WP_Widget_Area_Customize_Control extends WP_Customize_Control {
} }
/** /**
* @return bool * Whether the current sidebar is rendered on the page.
*
* @since 4.0.0
* @access public
*
* @return bool Whether sidebar is rendered.
*/ */
function active_callback() { public function active_callback() {
return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id ); return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
} }
} }
@ -1099,7 +1110,12 @@ class WP_Widget_Form_Customize_Control extends WP_Customize_Control {
} }
/** /**
* @return bool * Whether the current widget is rendered on the page.
*
* @since 4.0.0
* @access public
*
* @return bool Whether the widget is rendered.
*/ */
function active_callback() { function active_callback() {
return $this->manager->widgets->is_widget_rendered( $this->widget_id ); return $this->manager->widgets->is_widget_rendered( $this->widget_id );