Make WordPress Core

Changeset 37504


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

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

    r37487 r37504  
    198198
    199199        /**
    200          * Filter the attached file based on the given ID.
     200         * Filters the attached file based on the given ID.
    201201         *
    202202         * @since 2.1.0
     
    225225
    226226        /**
    227          * Filter the path to the attached file to update.
     227         * Filters the path to the attached file to update.
    228228         *
    229229         * @since 2.1.0
     
    260260
    261261        /**
    262          * Filter the relative path to an uploaded file.
     262         * Filters the relative path to an uploaded file.
    263263         *
    264264         * @since 2.9.0
     
    578578
    579579        /**
    580          * Filter the post status.
     580         * Filters the post status.
    581581         *
    582582         * @since 4.4.0
     
    10071007
    10081008        /**
    1009          * Filter the arguments for registering a post type.
     1009         * Filters the arguments for registering a post type.
    10101010         *
    10111011         * @since 4.4.0
     
    14761476
    14771477        /**
    1478          * Filter the labels of a specific post type.
     1478         * Filters the labels of a specific post type.
    14791479         *
    14801480         * The dynamic portion of the hook name, `$post_type`, refers to
     
    20392039
    20402040                        /**
    2041                          * Filter the value of a specific post field to edit.
     2041                         * Filters the value of a specific post field to edit.
    20422042                         *
    20432043                         * The dynamic portion of the hook name, `$field`, refers to the post
     
    20522052
    20532053                        /**
    2054                          * Filter the value of a specific post field to edit.
     2054                         * Filters the value of a specific post field to edit.
    20552055                         *
    20562056                         * The dynamic portion of the hook name, `$field_no_prefix`, refers to
     
    20792079
    20802080                        /**
    2081                          * Filter the value of a specific post field before saving.
     2081                         * Filters the value of a specific post field before saving.
    20822082                         *
    20832083                         * The dynamic portion of the hook name, `$field`, refers to the post
     
    20912091
    20922092                        /**
    2093                          * Filter the value of a specific field before saving.
     2093                         * Filters the value of a specific field before saving.
    20942094                         *
    20952095                         * The dynamic portion of the hook name, `$field_no_prefix`, refers
     
    21052105
    21062106                        /**
    2107                          * Filter the value of a specific post field before saving.
     2107                         * Filters the value of a specific post field before saving.
    21082108                         *
    21092109                         * The dynamic portion of the hook name, `$field`, refers to the post
     
    21222122
    21232123                        /**
    2124                          * Filter the value of a specific post field for display.
     2124                         * Filters the value of a specific post field for display.
    21252125                         *
    21262126                         * The dynamic portion of the hook name, `$field`, refers to the post
     
    23422342
    23432343        /**
    2344          * Filter the default list of post mime types.
     2344         * Filters the default list of post mime types.
    23452345         *
    23462346         * @since 2.5.0
     
    24872487
    24882488        /**
    2489          * Filter whether a post deletion should take place.
     2489         * Filters whether a post deletion should take place.
    24902490         *
    24912491         * @since 4.4.0
     
    30873087
    30883088        /**
    3089          * Filter whether the post should be considered "empty".
     3089         * Filters whether the post should be considered "empty".
    30903090         *
    30913091         * The post is considered "empty" if both:
     
    32553255
    32563256        /**
    3257          * Filter the post parent -- used to check for and prevent hierarchy loops.
     3257         * Filters the post parent -- used to check for and prevent hierarchy loops.
    32583258         *
    32593259         * @since 3.1.0
     
    33093309        if ( 'attachment' === $post_type ) {
    33103310                /**
    3311                  * Filter attachment post data before it is updated in or added to the database.
     3311                 * Filters attachment post data before it is updated in or added to the database.
    33123312                 *
    33133313                 * @since 3.9.0
     
    33193319        } else {
    33203320                /**
    3321                  * Filter slashed post data just before it is inserted into the database.
     3321                 * Filters slashed post data just before it is inserted into the database.
    33223322                 *
    33233323                 * @since 2.7.0
     
    37093709
    37103710                /**
    3711                  * Filter whether the post slug would make a bad attachment slug.
     3711                 * Filters whether the post slug would make a bad attachment slug.
    37123712                 *
    37133713                 * @since 3.1.0
     
    37373737
    37383738                /**
    3739                  * Filter whether the post slug would make a bad hierarchical post slug.
     3739                 * Filters whether the post slug would make a bad hierarchical post slug.
    37403740                 *
    37413741                 * @since 3.1.0
     
    37833783
    37843784                /**
    3785                  * Filter whether the post slug would be bad as a flat slug.
     3785                 * Filters whether the post slug would be bad as a flat slug.
    37863786                 *
    37873787                 * @since 3.1.0
     
    38033803
    38043804        /**
    3805          * Filter the unique post slug.
     3805         * Filters the unique post slug.
    38063806         *
    38073807         * @since 3.3.0
     
    40444044
    40454045        /**
    4046          * Filter the new ping URL to add for the given post.
     4046         * Filters the new ping URL to add for the given post.
    40474047         *
    40484048         * @since 2.0.0
     
    40814081
    40824082        /**
    4083          * Filter the list of enclosures already enclosed for the given post.
     4083         * Filters the list of enclosures already enclosed for the given post.
    40844084         *
    40854085         * @since 2.0.0
     
    41084108
    41094109        /**
    4110          * Filter the list of already-pinged URLs for the given post.
     4110         * Filters the list of already-pinged URLs for the given post.
    41114111         *
    41124112         * @since 2.0.0
     
    41344134
    41354135        /**
    4136          * Filter the list of URLs yet to ping for the given post.
     4136         * Filters the list of URLs yet to ping for the given post.
    41374137         *
    41384138         * @since 2.0.0
     
    44724472
    44734473        /**
    4474          * Filter the URI for a page.
     4474         * Filters the URI for a page.
    44754475         *
    44764476         * @since 4.4.0
     
    47674767
    47684768        /**
    4769          * Filter the retrieved list of pages.
     4769         * Filters the retrieved list of pages.
    47704770         *
    47714771         * @since 2.1.0
     
    49784978
    49794979        /**
    4980          * Filter the attachment meta data.
     4980         * Filters the attachment meta data.
    49814981         *
    49824982         * @since 2.1.0
     
    50045004
    50055005        /**
    5006          * Filter the updated attachment meta data.
     5006         * Filters the updated attachment meta data.
    50075007         *
    50085008         * @since 2.1.0
     
    50685068
    50695069        /**
    5070          * Filter the attachment URL.
     5070         * Filters the attachment URL.
    50715071         *
    50725072         * @since 2.1.0
     
    51025102        if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) ) {
    51035103                /**
    5104                  * Filter the attachment thumbnail file path.
     5104                 * Filters the attachment thumbnail file path.
    51055105                 *
    51065106                 * @since 2.1.0
     
    51395139
    51405140        /**
    5141          * Filter the attachment thumbnail URL.
     5141         * Filters the attachment thumbnail URL.
    51425142         *
    51435143         * @since 2.1.0
     
    52505250                if ( !is_array($icon_files) ) {
    52515251                        /**
    5252                          * Filter the icon directory path.
     5252                         * Filters the icon directory path.
    52535253                         *
    52545254                         * @since 2.0.0
     
    52595259
    52605260                        /**
    5261                          * Filter the icon directory URI.
     5261                         * Filters the icon directory URI.
    52625262                         *
    52635263                         * @since 2.0.0
     
    52685268
    52695269                        /**
    5270                          * Filter the list of icon directory URIs.
     5270                         * Filters the list of icon directory URIs.
    52715271                         *
    52725272                         * @since 2.5.0
     
    53285328
    53295329        /**
    5330          * Filter the mime type icon.
     5330         * Filters the mime type icon.
    53315331         *
    53325332         * @since 2.1.0
     
    54355435
    54365436                /**
    5437                  * Filter the capability to read private posts for a custom post type
     5437                 * Filters the capability to read private posts for a custom post type
    54385438                 * when generating SQL for getting posts by author.
    54395439                 *
     
    55045504function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) {
    55055505        /**
    5506          * Filter the date the last post was published.
     5506         * Filters the date the last post was published.
    55075507         *
    55085508         * @since 2.3.0
     
    55565556
    55575557        /**
    5558          * Filter the date the last post was modified.
     5558         * Filters the date the last post was modified.
    55595559         *
    55605560         * @since 2.3.0
Note: See TracChangeset for help on using the changeset viewer.