WordPress.org

Make WordPress Core

Changeset 29156


Ignore:
Timestamp:
07/14/2014 12:31:22 AM (6 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-customize-control.php

    r29051 r29156  
    8787
    8888    /**
    89      * Callback
     89     * Callback.
    9090     *
    9191     * @since 4.0.0
    92      *
    93      * @access public
     92     * @access public
     93     *
    9494     * @see WP_Customize_Control::active()
    95      * @var callable  Callback is called with one argument, the instance of
    96      *                WP_Customize_Control, and returns bool to indicate whether
    97      *                the control is active (such as it relates to the URL
    98      *                currently being previewed).
     95     *
     96     * @var callable Callback is called with one argument, the instance of
     97     *               WP_Customize_Control, and returns bool to indicate whether
     98     *               the control is active (such as it relates to the URL
     99     *               currently being previewed).
    99100     */
    100101    public $active_callback = '';
     
    155156     *
    156157     * @since 4.0.0
    157      *
    158      * @return bool
     158     * @access public
     159     *
     160     * @return bool Whether the control is active to the current preview.
    159161     */
    160162    public final function active() {
     
    167169         * @since 4.0.0
    168170         *
    169          * @param bool $active
    170          * @param WP_Customize_Control $control
     171         * @param bool                 $active  Whether the Customizer control is active.
     172         * @param WP_Customize_Control $control WP_Customize_Control instance.
    171173         */
    172174        $active = apply_filters( 'customize_control_active', $active, $control );
     
    181183     * provide an 'active_callback' argument to the constructor.
    182184     *
    183      * @return bool
     185     * @since 4.0.0
     186     * @access public
     187     *
     188     * @return bool Always true.
    184189     */
    185190    public function active_callback() {
     
    316321     *
    317322     * @since 4.0.0
     323     * @access public
    318324     */
    319325    public function input_attrs() {
     
    10531059
    10541060    /**
    1055      * @return bool
    1056      */
    1057     function active_callback() {
     1061     * Whether the current sidebar is rendered on the page.
     1062     *
     1063     * @since 4.0.0
     1064     * @access public
     1065     *
     1066     * @return bool Whether sidebar is rendered.
     1067     */
     1068    public function active_callback() {
    10581069        return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
    10591070    }
     
    11001111
    11011112    /**
    1102      * @return bool
     1113     * Whether the current widget is rendered on the page.
     1114     *
     1115     * @since 4.0.0
     1116     * @access public
     1117     *
     1118     * @return bool Whether the widget is rendered.
    11031119     */
    11041120    function active_callback() {
Note: See TracChangeset for help on using the changeset viewer.