WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/22/2016 06:00:23 PM (5 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize hook docs in wp-admin/* to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/media.php

    r37484 r37488  
    2323
    2424    /**
    25      * Filter the available tabs in the legacy (pre-3.5.0) media popup.
     25     * Filters the available tabs in the legacy (pre-3.5.0) media popup.
    2626     *
    2727     * @since 2.5.0
     
    136136
    137137    /**
    138      * Filter the image HTML markup to send to the editor.
     138     * Filters the image HTML markup to send to the editor.
    139139     *
    140140     * @since 2.5.0
     
    173173
    174174    /**
    175      * Filter the caption text.
     175     * Filters the caption text.
    176176     *
    177177     * Note: If the caption text is empty, the caption shortcode will not be appended
     
    179179     *
    180180     * Passing an empty value also prevents the {@see 'image_add_caption_shortcode'}
    181      * filter from being evaluated at the end of image_add_caption().
     181     * Filters from being evaluated at the end of image_add_caption().
    182182     *
    183183     * @since 4.1.0
     
    189189
    190190    /**
    191      * Filter whether to disable captions.
     191     * Filters whether to disable captions.
    192192     *
    193193     * Prevents image captions from being appended to image HTML when inserted into the editor.
     
    221221
    222222    /**
    223      * Filter the image HTML markup including the caption shortcode.
     223     * Filters the image HTML markup including the caption shortcode.
    224224     *
    225225     * @since 2.6.0
     
    569569    );
    570570    /**
    571      * Filter the legacy (pre-3.5.0) media buttons.
     571     * Filters the legacy (pre-3.5.0) media buttons.
    572572     *
    573573     * @since 2.5.0
     
    609609
    610610    /**
    611      * Filter the upload iframe source URL for a specific media type.
     611     * Filters the upload iframe source URL for a specific media type.
    612612     *
    613613     * The dynamic portion of the hook name, `$type`, refers to the type
     
    661661
    662662        /**
    663          * Filter the attachment fields to be saved.
     663         * Filters the attachment fields to be saved.
    664664         *
    665665         * @since 2.5.0
     
    717717
    718718        /**
    719          * Filter the HTML markup for a media item sent to the editor.
     719         * Filters the HTML markup for a media item sent to the editor.
    720720         *
    721721         * @since 2.5.0
     
    775775
    776776            /**
    777              * Filter the URL sent to the editor for a specific media type.
     777             * Filters the URL sent to the editor for a specific media type.
    778778             *
    779779             * The dynamic portion of the hook name, `$type`, refers to the type
     
    798798
    799799            /**
    800              * Filter the image URL sent to the editor.
     800             * Filters the image URL sent to the editor.
    801801             *
    802802             * @since 2.8.0
     
    979979function image_size_input_fields( $post, $check = '' ) {
    980980    /**
    981      * Filter the names and labels of the default image sizes.
     981     * Filters the names and labels of the default image sizes.
    982982     *
    983983     * @since 3.3.0
     
    11301130
    11311131/**
    1132  * Filters input from media_upload_form_handler() and assigns a default
     1132 * Filterss input from media_upload_form_handler() and assigns a default
    11331133 * post_title from the file name if none supplied.
    11341134 *
     
    12861286
    12871287    /**
    1288      * Filter the attachment fields to edit.
     1288     * Filters the attachment fields to edit.
    12891289     *
    12901290     * @since 2.5.0
     
    13701370
    13711371    /**
    1372      * Filter the arguments used to retrieve an image for the edit image form.
     1372     * Filters the arguments used to retrieve an image for the edit image form.
    13731373     *
    13741374     * @since 3.1.0
     
    14281428
    14291429    /**
    1430      * Filter the media metadata.
     1430     * Filters the media metadata.
    14311431     *
    14321432     * @since 2.5.0
     
    18461846
    18471847/**
    1848  * Filter the media upload post parameters.
     1848 * Filters the media upload post parameters.
    18491849 *
    18501850 * @since 3.1.0 As 'swfupload_post_params'
     
    18791879
    18801880/**
    1881  * Filter the default Plupload settings.
     1881 * Filters the default Plupload settings.
    18821882 *
    18831883 * @since 3.3.0
     
    19861986
    19871987    /**
    1988      * Filter the media upload form action URL.
     1988     * Filters the media upload form action URL.
    19891989     *
    19901990     * @since 2.6.0
     
    21662166<?php
    21672167/**
    2168  * Filter the insert media from URL form HTML.
     2168 * Filters the insert media from URL form HTML.
    21692169 *
    21702170 * @since 3.3.0
     
    24192419}
    24202420/**
    2421  * Filter the media upload mime type list items.
     2421 * Filters the media upload mime type list items.
    24222422 *
    24232423 * Returned values should begin with an `<li>` tag.
     
    28662866
    28672867        /**
    2868          * Filter the audio and video metadata fields to be shown in the publish meta box.
     2868         * Filters the audio and video metadata fields to be shown in the publish meta box.
    28692869         *
    28702870         * The key for each item in the array should correspond to an attachment
     
    29042904
    29052905        /**
    2906          * Filter the audio attachment metadata fields to be shown in the publish meta box.
     2906         * Filters the audio attachment metadata fields to be shown in the publish meta box.
    29072907         *
    29082908         * The key for each item in the array should correspond to an attachment
Note: See TracChangeset for help on using the changeset viewer.