Make WordPress Core

Changeset 37505


Ignore:
Timestamp:
05/22/2016 06:31:20 PM (10 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in wp-includes/media.php 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-includes/media.php

    r37034 r37505  
    9696
    9797        /**
    98          * Filter the maximum image size dimensions for the editor.
     98         * Filters the maximum image size dimensions for the editor.
    9999         *
    100100         * @since 2.5.0
     
    169169
    170170        /**
    171          * Filter whether to preempt the output of image_downsize().
     171         * Filters whether to preempt the output of image_downsize().
    172172         *
    173173         * Passing a truthy value to the filter will effectively short-circuit
     
    340340
    341341        /**
    342          * Filter the value of the attachment's image tag class attribute.
     342         * Filters the value of the attachment's image tag class attribute.
    343343         *
    344344         * @since 2.6.0
     
    355355
    356356        /**
    357          * Filter the HTML content for the image tag.
     357         * Filters the HTML content for the image tag.
    358358         *
    359359         * @since 2.6.0
     
    432432
    433433        /**
    434          * Filter dimensions to constrain down-sampled images to.
     434         * Filters dimensions to constrain down-sampled images to.
    435435         *
    436436         * @since 4.1.0
     
    478478
    479479        /**
    480          * Filter whether to preempt calculating the image resize dimensions.
     480         * Filters whether to preempt calculating the image resize dimensions.
    481481         *
    482482         * Passing a non-null value to the filter will effectively short-circuit
     
    690690
    691691        /**
    692          * Filter the output of image_get_intermediate_size()
     692         * Filters the output of image_get_intermediate_size()
    693693         *
    694694         * @since 4.4.0
     
    721721
    722722        /**
    723          * Filter the list of intermediate image sizes.
     723         * Filters the list of intermediate image sizes.
    724724         *
    725725         * @since 2.5.0
     
    768768        }
    769769        /**
    770          * Filter the image src result.
     770         * Filters the image src result.
    771771         *
    772772         * @since 4.3.0
     
    841841
    842842                /**
    843                  * Filter the list of attachment image attributes.
     843                 * Filters the list of attachment image attributes.
    844844                 *
    845845                 * @since 2.8.0
     
    10441044
    10451045        /**
    1046          * Filter the maximum image width to be included in a 'srcset' attribute.
     1046         * Filters the maximum image width to be included in a 'srcset' attribute.
    10471047         *
    10481048         * @since 4.4.0
     
    10861086
    10871087                /*
    1088                  * Filter out images that are wider than '$max_srcset_image_width' unless
     1088                 * Filters out images that are wider than '$max_srcset_image_width' unless
    10891089                 * that file is in the 'src' attribute.
    10901090                 */
     
    11251125
    11261126        /**
    1127          * Filter an image's 'srcset' sources.
     1127         * Filters an image's 'srcset' sources.
    11281128         *
    11291129         * @since 4.4.0
     
    12331233
    12341234        /**
    1235          * Filter the output of 'wp_calculate_image_sizes()'.
     1235         * Filters the output of 'wp_calculate_image_sizes()'.
    12361236         *
    12371237         * @since 4.4.0
     
    14681468
    14691469        /**
    1470          * Filter the default caption shortcode output.
     1470         * Filters the default caption shortcode output.
    14711471         *
    14721472         * If the filtered output isn't empty, it will be used instead of generating
     
    15071507
    15081508        /**
    1509          * Filter the width of an image's caption.
     1509         * Filters the width of an image's caption.
    15101510         *
    15111511         * By default, the caption is 10 pixels greater than the width of the image,
     
    15901590
    15911591        /**
    1592          * Filter the default gallery shortcode output.
     1592         * Filters the default gallery shortcode output.
    15931593         *
    15941594         * If the filtered output isn't empty, it will be used instead of generating
     
    16741674
    16751675        /**
    1676          * Filter whether to print default gallery styles.
     1676         * Filters whether to print default gallery styles.
    16771677         *
    16781678         * @since 3.1.0
     
    17081708
    17091709        /**
    1710          * Filter the default gallery shortcode CSS styles.
     1710         * Filters the default gallery shortcode CSS styles.
    17111711         *
    17121712         * @since 2.5.0
     
    18761876
    18771877        /**
    1878          * Filter the playlist output.
     1878         * Filters the playlist output.
    18791879         *
    18801880         * Passing a non-empty value to the filter will short-circuit generation
     
    20822082function wp_mediaelement_fallback( $url ) {
    20832083        /**
    2084          * Filter the Mediaelement fallback output for no-JS.
     2084         * Filters the Mediaelement fallback output for no-JS.
    20852085         *
    20862086         * @since 3.6.0
     
    21012101function wp_get_audio_extensions() {
    21022102        /**
    2103          * Filter the list of supported audio formats.
     2103         * Filters the list of supported audio formats.
    21042104         *
    21052105         * @since 3.6.0
     
    21362136
    21372137        /**
    2138          * Filter the editable list of keys to look up data from an attachment's metadata.
     2138         * Filters the editable list of keys to look up data from an attachment's metadata.
    21392139         *
    21402140         * @since 3.9.0
     
    21762176
    21772177        /**
    2178          * Filter the default audio shortcode output.
     2178         * Filters the default audio shortcode output.
    21792179         *
    21802180         * If the filtered output isn't empty, it will be used instead of generating the default audio template.
     
    22442244
    22452245        /**
    2246          * Filter the media library used for the audio shortcode.
     2246         * Filters the media library used for the audio shortcode.
    22472247         *
    22482248         * @since 3.6.0
     
    22572257
    22582258        /**
    2259          * Filter the class attribute for the audio shortcode output container.
     2259         * Filters the class attribute for the audio shortcode output container.
    22602260         *
    22612261         * @since 3.6.0
     
    23112311
    23122312        /**
    2313          * Filter the audio shortcode output.
     2313         * Filters the audio shortcode output.
    23142314         *
    23152315         * @since 3.6.0
     
    23342334function wp_get_video_extensions() {
    23352335        /**
    2336          * Filter the list of supported video formats.
     2336         * Filters the list of supported video formats.
    23372337         *
    23382338         * @since 3.6.0
     
    23802380
    23812381        /**
    2382          * Filter the default video shortcode output.
     2382         * Filters the default video shortcode output.
    23832383         *
    23842384         * If the filtered output isn't empty, it will be used instead of generating
     
    24812481
    24822482        /**
    2483          * Filter the media library used for the video shortcode.
     2483         * Filters the media library used for the video shortcode.
    24842484         *
    24852485         * @since 3.6.0
     
    24942494
    24952495        /**
    2496          * Filter the class attribute for the video shortcode output container.
     2496         * Filters the class attribute for the video shortcode output container.
    24972497         *
    24982498         * @since 3.6.0
     
    25692569
    25702570        /**
    2571          * Filter the output of the video shortcode.
     2571         * Filters the output of the video shortcode.
    25722572         *
    25732573         * @since 3.6.0
     
    26522652
    26532653        /**
    2654          * Filter the adjacent image link.
     2654         * Filters the adjacent image link.
    26552655         *
    26562656         * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
     
    28112811
    28122812        /**
    2813          * Filter the maximum upload size allowed in php.ini.
     2813         * Filters the maximum upload size allowed in php.ini.
    28142814         *
    28152815         * @since 2.5.0
     
    28892889
    28902890        /**
    2891          * Filter the list of image editing library classes.
     2891         * Filters the list of image editing library classes.
    28922892         *
    28932893         * @since 3.5.0
     
    29542954
    29552955        /**
    2956          * Filter the Plupload default settings.
     2956         * Filters the Plupload default settings.
    29572957         *
    29582958         * @since 3.4.0
     
    29672967
    29682968        /**
    2969          * Filter the Plupload default parameters.
     2969         * Filters the Plupload default parameters.
    29702970         *
    29712971         * @since 3.4.0
     
    31853185
    31863186        /**
    3187          * Filter the attachment data prepared for JavaScript.
     3187         * Filters the attachment data prepared for JavaScript.
    31883188         *
    31893189         * @since 3.5.0
     
    34563456
    34573457        /**
    3458          * Filter the media view settings.
     3458         * Filters the media view settings.
    34593459         *
    34603460         * @since 3.5.0
     
    34663466
    34673467        /**
    3468          * Filter the media view strings.
     3468         * Filters the media view strings.
    34693469         *
    34703470         * @since 3.5.0
     
    35273527
    35283528        /**
    3529          * Filter arguments used to retrieve media attached to the given post.
     3529         * Filters arguments used to retrieve media attached to the given post.
    35303530         *
    35313531         * @since 3.6.0
     
    35403540
    35413541        /**
    3542          * Filter the list of media attached to the given post.
     3542         * Filters the list of media attached to the given post.
    35433543         *
    35443544         * @since 3.6.0
     
    35643564
    35653565        /**
    3566          * Filter the embedded media types that are allowed to be returned from the content blob.
     3566         * Filters the embedded media types that are allowed to be returned from the content blob.
    35673567         *
    35683568         * @since 4.2.0
     
    36343634
    36353635        /**
    3636          * Filter the list of all found galleries in the given post.
     3636         * Filters the list of all found galleries in the given post.
    36373637         *
    36383638         * @since 3.6.0
     
    36583658
    36593659        /**
    3660          * Filter the first-found post gallery.
     3660         * Filters the first-found post gallery.
    36613661         *
    36623662         * @since 3.6.0
     
    37603760
    37613761        /**
    3762          * Filter an attachment id found by URL.
     3762         * Filters an attachment id found by URL.
    37633763         *
    37643764         * @since 4.2.0
Note: See TracChangeset for help on using the changeset viewer.