Changeset 29156

Timestamp:

07/14/2014 12:31:22 AM (10 years ago)

Author:

DrewAPicture

Message:

Inline documentation cleanup for 4.0 audit.

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.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (7 diffs)

trunk/src/wp-includes/class-wp-customize-control.php

@@ -87 +87 @@
 
     /**
-     * Callback
+     * Callback.
      *
      * @since 4.0.0
-     *
-     * @access public
+     * @access public
+     *
      * @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
-     *                the control is active (such as it relates to the URL
-     *                currently being previewed).
+     *
+     * @var callable Callback is called with one argument, the instance of
+     *               WP_Customize_Control, and returns bool to indicate whether
+     *               the control is active (such as it relates to the URL
+     *               currently being previewed).
      */
     public $active_callback = '';
@@ -155 +156 @@
      *
      * @since 4.0.0
-     *
-     * @return bool
+     * @access public
+     *
+     * @return bool Whether the control is active to the current preview.
      */
     public final function active() {
@@ -167 +169 @@
          * @since 4.0.0
          *
-         * @param bool $active
-         * @param WP_Customize_Control $control
+         * @param bool                 $active  Whether the Customizer control is active.
+         * @param WP_Customize_Control $control WP_Customize_Control instance.
          */
         $active = apply_filters( 'customize_control_active', $active, $control );
@@ -181 +183 @@
      * provide an 'active_callback' argument to the constructor.
      *
-     * @return bool
+     * @since 4.0.0
+     * @access public
+     *
+     * @return bool Always true.
      */
     public function active_callback() {
@@ -316 +321 @@
      *
      * @since 4.0.0
+     * @access public
      */
     public function input_attrs() {
@@ -1053 +1059 @@
 
     /**
-     * @return bool
-     */
-    function active_callback() {
+     * Whether the current sidebar is rendered on the page.
+     *
+     * @since 4.0.0
+     * @access public
+     *
+     * @return bool Whether sidebar is rendered.
+     */
+    public function active_callback() {
         return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
     }
@@ -1100 +1111 @@
 
     /**
-     * @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() {