WordPress.org

Make WordPress Core

Changeset 36820


Ignore:
Timestamp:
03/03/2016 07:03:23 AM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Use third-person singular verbs in DocBlock summaries for the WP_Site_Logo class, introduced in [36698].

Also minorly improves various inline docs.

See #33755. See #35986.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-site-logo.php

    r36709 r36820  
    2828
    2929    /**
    30      * Hide header text on front end if necessary.
     30     * Hides header text on the front end if necessary.
    3131     *
    3232     * @since 4.5.0
     
    3939        }
    4040
    41         // Is Display Header Text unchecked? If so, we need to hide our header text.
     41        // Is Display Header Text unchecked? If so, hide the header text.
    4242        ?>
    4343        <!-- Site Logo: hide header text -->
     
    5252
    5353    /**
    54      * Reset the site logo if the current logo is deleted in the media manager.
     54     * Resets the site logo if the current logo is deleted in the media manager.
    5555     *
    5656     * @since 4.5.0
    5757     * @access public
    5858     *
    59      * @param int $post_id
     59     * @param int $post_id Post ID.
    6060     */
    6161    public function delete_attachment_data( $post_id ) {
     
    6868
    6969    /**
    70      * Make custom image sizes available to the media manager.
     70     * Makes custom image sizes available to the media manager.
    7171     *
    7272     * @since 4.5.0
     
    8181        $intermediate = get_intermediate_image_sizes();
    8282
    83         // Have we got anything fun to work with?
     83        // Is there anything fun to work with?
    8484        if ( is_array( $intermediate ) && ! empty( $intermediate ) ) {
    8585            foreach ( $intermediate as $key => $size ) {
     
    9696
    9797    /**
    98      * Get header text classes. If not defined in add_theme_support(), defaults from Underscores will be used.
     98     * Retrieves the header text classes.
     99     *
     100     * If not defined in add_theme_support(), defaults from Underscores will be used.
    99101     *
    100102     * @since 4.5.0
    101103     * @access protected
    102104     *
    103      * @return string String of classes to hide
     105     * @return string String of classes to hide.
    104106     */
    105107    protected function header_text_classes() {
     
    117119        }
    118120
    119         // If we've got an array, reduce them to a string for output.
     121        // If there's an array of classes, reduce them to a string for output.
    120122        if ( is_array( $classes ) ) {
    121123            $classes = array_map( 'sanitize_html_class', $classes );
Note: See TracChangeset for help on using the changeset viewer.