WordPress.org
Get WordPress

Make WordPress Core

Changeset 30608


Ignore:
Timestamp:
11/28/2014 11:09:32 AM (12 years ago)
Author:
DrewAPicture
Message:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Section, WP_Customize_Section, and WP_Customize_Sidebar_Section classes.

See #30469.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-customize-section.php

    r30329 r30608  
    120120
    121121        /**
    122          * Callback.
     122         * Active callback.
    123123         *
    124124         * @since 4.1.0
    … …  
    128128         *
    129129         * @var callable Callback is called with one argument, the instance of
    130          *               WP_Customize_Section, and returns bool to indicate whether
    131          *               the section is active (such as it relates to the URL
     130         *               {@see WP_Customize_Section}, and returns bool to indicate
     131         *               whether the section is active (such as it relates to the URL
    132132         *               currently being previewed).
    133133         */
    … …  
    179179
    180180                /**
    181                  * Filter response of WP_Customize_Section::active().
     181                 * Filter response of {@see WP_Customize_Section::active()}.
    182182                 *
    183183                 * @since 4.1.0
    184184                 *
    185185                 * @param bool                 $active  Whether the Customizer section is active.
    186                  * @param WP_Customize_Section $section WP_Customize_Section instance.
     186                 * @param WP_Customize_Section $section {@see WP_Customize_Section} instance.
    187187                 */
    188188                $active = apply_filters( 'customize_section_active', $active, $section );
    … …  
    192192
    193193        /**
    194          * Default callback used when invoking WP_Customize_Section::active().
    195          *
    196          * Subclasses can override this with their specific logic, or they may
    197          * provide an 'active_callback' argument to the constructor.
     194         * Default callback used when invoking {@see WP_Customize_Section::active()}.
     195         *
     196         * Subclasses can override this with their specific logic, or they may provide
     197         * an 'active_callback' argument to the constructor.
    198198         *
    199199         * @since 4.1.0
    … …  
    211211         * @since 4.1.0
    212212         *
    213          * @return array The array to be exported to the client as JSON
     213         * @return array The array to be exported to the client as JSON.
    214214         */
    215215        public function json() {
    … …  
    246246         * @since 4.1.0
    247247         *
    248          * @return string
     248         * @return string Contents of the section.
    249249         */
    250250        public final function get_content() {
    … …  
    317317 * @package WordPress
    318318 * @subpackage Customize
     319 *
    319320 * @since 4.1.0
     321 *
     322 * @see WP_Customize_Section
    320323 */
    321324class WP_Customize_Sidebar_Section extends WP_Customize_Section {
    … …  
    342345         * @since 4.1.0
    343346         *
    344          * @return array The array to be exported to the client as JSON
     347         * @return array The array to be exported to the client as JSON.
    345348         */
    346349        public function json() {
Note: See TracChangeset for help on using the changeset viewer.