Make WordPress Core

Changeset 37492


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

Docs: Standardize filter docs in core classes in wp-includes/* to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

Location:
trunk/src/wp-includes
Files:
21 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-comment-query.php

    r37482 r37492  
    415415                if ( $comment_ids && $this->query_vars['number'] && ! $this->query_vars['no_found_rows'] ) {
    416416                        /**
    417                          * Filter the query used to retrieve found comment count.
     417                         * Filters the query used to retrieve found comment count.
    418418                         *
    419419                         * @since 4.4.0
    … …  
    454454
    455455                /**
    456                  * Filter the comment query results.
     456                 * Filters the comment query results.
    457457                 *
    458458                 * @since 3.1.0
    … …  
    851851                $pieces = array( 'fields', 'join', 'where', 'orderby', 'limits', 'groupby' );
    852852                /**
    853                  * Filter the comment query clauses.
     853                 * Filters the comment query clauses.
    854854                 *
    855855                 * @since 3.1.0
  • trunk/src/wp-includes/class-wp-editor.php

    r37441 r37492  
    6767
    6868                /**
    69                  * Filter the wp_editor() settings.
     69                 * Filters the wp_editor() settings.
    7070                 *
    7171                 * @since 4.0.0
    … …  
    242242
    243243                /**
    244                  * Filter the HTML markup output that displays the editor.
     244                 * Filters the HTML markup output that displays the editor.
    245245                 *
    246246                 * @since 2.1.0
    … …  
    259259
    260260                /**
    261                  * Filter the default editor content.
     261                 * Filters the default editor content.
    262262                 *
    263263                 * @since 2.1.0
    … …  
    334334
    335335                        /**
    336                          * Filter the Quicktags settings.
     336                         * Filters the Quicktags settings.
    337337                         *
    338338                         * @since 3.3.0
    … …  
    363363
    364364                                        /**
    365                                          * Filter the list of teenyMCE plugins.
     365                                         * Filters the list of teenyMCE plugins.
    366366                                         *
    367367                                         * @since 2.7.0
    … …  
    374374
    375375                                        /**
    376                                          * Filter the list of TinyMCE external plugins.
     376                                         * Filters the list of TinyMCE external plugins.
    377377                                         *
    378378                                         * The filter takes an associative array of external plugins for
    … …  
    419419
    420420                                        /**
    421                                          * Filter the list of default TinyMCE plugins.
     421                                         * Filters the list of default TinyMCE plugins.
    422422                                         *
    423423                                         * The filter specifies which of the default plugins included
    … …  
    439439
    440440                                                /**
    441                                                  * Filter the translations loaded for external TinyMCE 3.x plugins.
     441                                                 * Filters the translations loaded for external TinyMCE 3.x plugins.
    442442                                                 *
    443443                                                 * The filter takes an associative array ('plugin_name' => 'path')
    … …  
    577577
    578578                                /**
    579                                  * Filter the comma-delimited list of stylesheets to load in TinyMCE.
     579                                 * Filters the comma-delimited list of stylesheets to load in TinyMCE.
    580580                                 *
    581581                                 * @since 2.1.0
    … …  
    592592
    593593                                /**
    594                                  * Filter the list of teenyMCE buttons (Text tab).
     594                                 * Filters the list of teenyMCE buttons (Text tab).
    595595                                 *
    596596                                 * @since 2.7.0
    … …  
    615615
    616616                                /**
    617                                  * Filter the first-row list of TinyMCE buttons (Visual tab).
     617                                 * Filters the first-row list of TinyMCE buttons (Visual tab).
    618618                                 *
    619619                                 * @since 2.0.0
    … …  
    631631
    632632                                /**
    633                                  * Filter the second-row list of TinyMCE buttons (Visual tab).
     633                                 * Filters the second-row list of TinyMCE buttons (Visual tab).
    634634                                 *
    635635                                 * @since 2.0.0
    … …  
    641641
    642642                                /**
    643                                  * Filter the third-row list of TinyMCE buttons (Visual tab).
     643                                 * Filters the third-row list of TinyMCE buttons (Visual tab).
    644644                                 *
    645645                                 * @since 2.0.0
    … …  
    651651
    652652                                /**
    653                                  * Filter the fourth-row list of TinyMCE buttons (Visual tab).
     653                                 * Filters the fourth-row list of TinyMCE buttons (Visual tab).
    654654                                 *
    655655                                 * @since 2.5.0
    … …  
    712712
    713713                                /**
    714                                  * Filter the teenyMCE config before init.
     714                                 * Filters the teenyMCE config before init.
    715715                                 *
    716716                                 * @since 2.7.0
    … …  
    723723
    724724                                /**
    725                                  * Filter the TinyMCE config before init.
     725                                 * Filters the TinyMCE config before init.
    726726                                 *
    727727                                 * @since 2.5.0
    … …  
    10901090
    10911091                /**
    1092                  * Filter translated strings prepared for TinyMCE.
     1092                 * Filters translated strings prepared for TinyMCE.
    10931093                 *
    10941094                 * @since 3.9.0
    … …  
    11381138
    11391139                /**
    1140                  * Filter "tiny_mce_version" is deprecated
     1140                 * Filters "tiny_mce_version" is deprecated
    11411141                 *
    11421142                 * The tiny_mce_version filter is not needed since external plugins are loaded directly by TinyMCE.
    … …  
    13361336
    13371337                /**
    1338                  * Filter the link query arguments.
     1338                 * Filters the link query arguments.
    13391339                 *
    13401340                 * Allows modification of the link query arguments before querying.
    … …  
    13721372
    13731373                /**
    1374                  * Filter the link query results.
     1374                 * Filters the link query results.
    13751375                 *
    13761376                 * Allows modification of the returned link query results.
  • trunk/src/wp-includes/class-wp-embed.php

    r37487 r37492  
    166166                                        if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) )
    167167                                                /**
    168                                                  * Filter the returned embed handler.
     168                                                 * Filters the returned embed handler.
    169169                                                 *
    170170                                                 * @since 2.9.0
    … …  
    194194
    195195                        /**
    196                          * Filter the oEmbed TTL value (time to live).
     196                         * Filters the oEmbed TTL value (time to live).
    197197                         *
    198198                         * @since 4.0.0
    … …  
    221221                                if ( ! empty( $cache ) ) {
    222222                                        /**
    223                                          * Filter the cached oEmbed HTML.
     223                                         * Filters the cached oEmbed HTML.
    224224                                         *
    225225                                         * @since 2.9.0
    … …  
    237237
    238238                        /**
    239                          * Filter whether to inspect the given URL for discoverable link tags.
     239                         * Filters whether to inspect the given URL for discoverable link tags.
    240240                         *
    241241                         * @since 2.9.0
    … …  
    296296                $post_types = get_post_types( array( 'show_ui' => true ) );
    297297                /**
    298                  * Filter the array of post types to cache oEmbed results for.
     298                 * Filters the array of post types to cache oEmbed results for.
    299299                 *
    300300                 * @since 2.9.0
    … …  
    366366
    367367                /**
    368                  * Filter the returned, maybe-linked embed URL.
     368                 * Filters the returned, maybe-linked embed URL.
    369369                 *
    370370                 * @since 2.9.0
  • trunk/src/wp-includes/class-wp-http-cookie.php

    r34585 r37492  
    196196
    197197                /**
    198                  * Filter the header-encoded cookie value.
     198                 * Filters the header-encoded cookie value.
    199199                 *
    200200                 * @since 3.4.0
  • trunk/src/wp-includes/class-wp-http-curl.php

    r36970 r37492  
    374374
    375375                /**
    376                  * Filter whether cURL can be used as a transport for retrieving a URL.
     376                 * Filters whether cURL can be used as a transport for retrieving a URL.
    377377                 *
    378378                 * @since 2.7.0
  • trunk/src/wp-includes/class-wp-http-encoding.php

    r33875 r37492  
    162162
    163163                /**
    164                  * Filter the allowed encoding types.
     164                 * Filters the allowed encoding types.
    165165                 *
    166166                 * @since 3.6.0
  • trunk/src/wp-includes/class-wp-http-ixr-client.php

    r34203 r37492  
    7070
    7171                /**
    72                  * Filter the headers collection to be sent to the XML-RPC server.
     72                 * Filters the headers collection to be sent to the XML-RPC server.
    7373                 *
    7474                 * @since 4.4.0
  • trunk/src/wp-includes/class-wp-http-proxy.php

    r36416 r37492  
    177177
    178178                /**
    179                  * Filter whether to preempt sending the request through the proxy server.
     179                 * Filters whether to preempt sending the request through the proxy server.
    180180                 *
    181181                 * Returning false will bypass the proxy; returning true will send
  • trunk/src/wp-includes/class-wp-http-streams.php

    r37431 r37492  
    9090                if ( $is_local ) {
    9191                        /**
    92                          * Filter whether SSL should be verified for local requests.
     92                         * Filters whether SSL should be verified for local requests.
    9393                         *
    9494                         * @since 2.8.0
    … …  
    9999                } elseif ( ! $is_local ) {
    100100                        /**
    101                          * Filter whether SSL should be verified for non-local requests.
     101                         * Filters whether SSL should be verified for non-local requests.
    102102                         *
    103103                         * @since 2.8.0
    … …  
    402402
    403403                /**
    404                  * Filter whether streams can be used as a transport for retrieving a URL.
     404                 * Filters whether streams can be used as a transport for retrieving a URL.
    405405                 *
    406406                 * @since 2.7.0
  • trunk/src/wp-includes/class-wp-image-editor-gd.php

    r35479 r37492  
    9898
    9999                /**
    100                  * Filter the memory limit allocated for image manipulation.
     100                 * Filters the memory limit allocated for image manipulation.
    101101                 *
    102102                 * @since 3.5.0
    … …  
    430430
    431431                /**
    432                  * Filter the name of the saved image file.
     432                 * Filters the name of the saved image file.
    433433                 *
    434434                 * @since 2.6.0
  • trunk/src/wp-includes/class-wp-image-editor-imagick.php

    r37431 r37492  
    312312
    313313                /**
    314                  * Filter whether to strip metadata from images when they're resized.
     314                 * Filters whether to strip metadata from images when they're resized.
    315315                 *
    316316                 * This filter only applies when resizing using the Imagick editor since GD
  • trunk/src/wp-includes/class-wp-image-editor.php

    r37431 r37492  
    238238                if ( null === $quality ) {
    239239                        /**
    240                          * Filter the default image compression quality setting.
     240                         * Filters the default image compression quality setting.
    241241                         *
    242242                         * Applies only during initial editor instantiation, or when set_quality() is run
    … …  
    254254                        if ( 'image/jpeg' == $this->mime_type ) {
    255255                                /**
    256                                  * Filter the JPEG compression quality for backward-compatibility.
     256                                 * Filters the JPEG compression quality for backward-compatibility.
    257257                                 *
    258258                                 * Applies only during initial editor instantiation, or when set_quality() is run
    … …  
    334334                if ( ! $this->supports_mime_type( $mime_type ) ) {
    335335                        /**
    336                          * Filter default mime type prior to getting the file extension.
     336                         * Filters default mime type prior to getting the file extension.
    337337                         *
    338338                         * @see wp_get_mime_types()
  • trunk/src/wp-includes/class-wp-meta-query.php

    r37342 r37492  
    345345
    346346                /**
    347                  * Filter the meta query's generated SQL.
     347                 * Filters the meta query's generated SQL.
    348348                 *
    349349                 * @since 3.1.0
    … …  
    718718
    719719                /**
    720                  * Filter the table alias identified as compatible with the current clause.
     720                 * Filters the table alias identified as compatible with the current clause.
    721721                 *
    722722                 * @since 4.1.0
  • trunk/src/wp-includes/class-wp-network.php

    r36340 r37492  
    231231
    232232                        /**
    233                          * Filter the number of path segments to consider when searching for a site.
     233                         * Filters the number of path segments to consider when searching for a site.
    234234                         *
    235235                         * @since 3.9.0
  • trunk/src/wp-includes/class-wp-oembed-controller.php

    r35656 r37492  
    2424        public function register_routes() {
    2525                /**
    26                  * Filter the maxwidth oEmbed parameter.
     26                 * Filters the maxwidth oEmbed parameter.
    2727                 *
    2828                 * @since 4.4.0
    … …  
    6868
    6969                /**
    70                  * Filter the determined post ID.
     70                 * Filters the determined post ID.
    7171                 *
    7272                 * @since 4.4.0
  • trunk/src/wp-includes/class-wp-rewrite.php

    r37431 r37492  
    12981298
    12991299                /**
    1300                  * Filter rewrite rules used for "post" archives.
     1300                 * Filters rewrite rules used for "post" archives.
    13011301                 *
    13021302                 * @since 1.5.0
    … …  
    13101310
    13111311                /**
    1312                  * Filter rewrite rules used for date archives.
     1312                 * Filters rewrite rules used for date archives.
    13131313                 *
    13141314                 * Likely date archives would include /yyyy/, /yyyy/mm/, and /yyyy/mm/dd/.
    … …  
    13241324
    13251325                /**
    1326                  * Filter rewrite rules used for root-level archives.
     1326                 * Filters rewrite rules used for root-level archives.
    13271327                 *
    13281328                 * Likely root-level archives would include pagination rules for the homepage
    … …  
    13391339
    13401340                /**
    1341                  * Filter rewrite rules used for comment feed archives.
     1341                 * Filters rewrite rules used for comment feed archives.
    13421342                 *
    13431343                 * Likely comments feed archives include /comments/feed/, and /comments/feed/atom/.
    … …  
    13541354
    13551355                /**
    1356                  * Filter rewrite rules used for search archives.
     1356                 * Filters rewrite rules used for search archives.
    13571357                 *
    13581358                 * Likely search-related archives include /search/search+query/ as well as
    … …  
    13691369
    13701370                /**
    1371                  * Filter rewrite rules used for author archives.
     1371                 * Filters rewrite rules used for author archives.
    13721372                 *
    13731373                 * Likely author archives would include /author/author-name/, as well as
    … …  
    13841384
    13851385                /**
    1386                  * Filter rewrite rules used for "page" post type archives.
     1386                 * Filters rewrite rules used for "page" post type archives.
    13871387                 *
    13881388                 * @since 1.5.0
    … …  
    14041404
    14051405                        /**
    1406                          * Filter rewrite rules used for individual permastructs.
     1406                         * Filters rewrite rules used for individual permastructs.
    14071407                         *
    14081408                         * The dynamic portion of the hook name, `$permastructname`, refers
    … …  
    14181418
    14191419                                /**
    1420                                  * Filter rewrite rules used specifically for Tags.
     1420                                 * Filters rewrite rules used specifically for Tags.
    14211421                                 *
    14221422                                 * @since 2.3.0
    … …  
    14471447
    14481448                /**
    1449                  * Filter the full set of generated rewrite rules.
     1449                 * Filters the full set of generated rewrite rules.
    14501450                 *
    14511451                 * @since 1.5.0
    … …  
    15511551
    15521552                /**
    1553                  * Filter the list of rewrite rules formatted for output to an .htaccess file.
     1553                 * Filters the list of rewrite rules formatted for output to an .htaccess file.
    15541554                 *
    15551555                 * @since 1.5.0
    … …  
    15601560
    15611561                /**
    1562                  * Filter the list of rewrite rules formatted for output to an .htaccess file.
     1562                 * Filters the list of rewrite rules formatted for output to an .htaccess file.
    15631563                 *
    15641564                 * @since 1.5.0
    … …  
    16131613
    16141614                /**
    1615                  * Filter the list of rewrite rules formatted for output to a web.config.
     1615                 * Filters the list of rewrite rules formatted for output to a web.config.
    16161616                 *
    16171617                 * @since 2.8.0
    … …  
    18151815
    18161816                /**
    1817                  * Filter whether a "hard" rewrite rule flush should be performed when requested.
     1817                 * Filters whether a "hard" rewrite rule flush should be performed when requested.
    18181818                 *
    18191819                 * A "hard" flush updates .htaccess (Apache) or web.config (IIS).
  • trunk/src/wp-includes/class-wp-role.php

    r37487 r37492  
    9797        public function has_cap( $cap ) {
    9898                /**
    99                  * Filter which capabilities a role has.
     99                 * Filters which capabilities a role has.
    100100                 *
    101101                 * @since 2.0.0
  • trunk/src/wp-includes/class-wp-theme.php

    r37431 r37492  
    10321032
    10331033                /**
    1034                  * Filter list of page templates for a theme.
     1034                 * Filters list of page templates for a theme.
    10351035                 *
    10361036                 * @since 3.9.0
    … …  
    11931193        public static function get_allowed( $blog_id = null ) {
    11941194                /**
    1195                  * Filter the array of themes allowed on the network.
     1195                 * Filters the array of themes allowed on the network.
    11961196                 *
    11971197                 * Site is provided as context so that a list of network allowed themes can
    … …  
    12261226
    12271227                /**
    1228                  * Filter the array of themes allowed on the network.
     1228                 * Filters the array of themes allowed on the network.
    12291229                 *
    12301230                 * @since MU
    … …  
    12581258                if ( isset( $allowed_themes[ $blog_id ] ) ) {
    12591259                        /**
    1260                          * Filter the array of themes allowed on the site.
     1260                         * Filters the array of themes allowed on the site.
    12611261                         *
    12621262                         * @since 4.5.0
  • trunk/src/wp-includes/class-wp-user-query.php

    r37431 r37492  
    481481
    482482                        /**
    483                          * Filter the columns to search in a WP_User_Query search.
     483                         * Filters the columns to search in a WP_User_Query search.
    484484                         *
    485485                         * The default columns depend on the search term, and include 'user_email',
    … …  
    548548
    549549                /**
    550                  * Filter SELECT FOUND_ROWS() query for the current WP_User_Query instance.
     550                 * Filters SELECT FOUND_ROWS() query for the current WP_User_Query instance.
    551551                 *
    552552                 * @since 3.2.0
  • trunk/src/wp-includes/class-wp-widget.php

    r37425 r37492  
    354354
    355355                        /**
    356                          * Filter the settings for a particular widget instance.
     356                         * Filters the settings for a particular widget instance.
    357357                         *
    358358                         * Returning false will effectively short-circuit display of the widget.
    … …  
    443443
    444444                                /**
    445                                  * Filter a widget's settings before saving.
     445                                 * Filters a widget's settings before saving.
    446446                                 *
    447447                                 * Returning false will effectively short-circuit the widget's ability
    … …  
    499499
    500500                /**
    501                  * Filter the widget instance's settings before displaying the control form.
     501                 * Filters the widget instance's settings before displaying the control form.
    502502                 *
    503503                 * Returning false effectively short-circuits display of the control form.
  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r37487 r37492  
    160160
    161161                /**
    162                  * Filter the methods exposed by the XML-RPC server.
     162                 * Filters the methods exposed by the XML-RPC server.
    163163                 *
    164164                 * This filter can be used to add new methods, and remove built-in methods.
    … …  
    248248
    249249                /**
    250                  * Filter whether XML-RPC methods requiring authentication are enabled.
     250                 * Filters whether XML-RPC methods requiring authentication are enabled.
    251251                 *
    252252                 * Contrary to the way it's named, this filter does not control whether XML-RPC is *fully*
    … …  
    289289
    290290                        /**
    291                          * Filter the XML-RPC user login error message.
     291                         * Filters the XML-RPC user login error message.
    292292                         *
    293293                         * @since 3.5.0
    … …  
    563563
    564564                /**
    565                  * Filter the XML-RPC blog options property.
     565                 * Filters the XML-RPC blog options property.
    566566                 *
    567567                 * @since 2.6.0
    … …  
    705705
    706706                /**
    707                  * Filter XML-RPC-prepared data for the given taxonomy.
     707                 * Filters XML-RPC-prepared data for the given taxonomy.
    708708                 *
    709709                 * @since 3.4.0
    … …  
    739739
    740740                /**
    741                  * Filter XML-RPC-prepared data for the given term.
     741                 * Filters XML-RPC-prepared data for the given term.
    742742                 *
    743743                 * @since 3.4.0
    … …  
    868868
    869869                /**
    870                  * Filter XML-RPC-prepared date for the given post.
     870                 * Filters XML-RPC-prepared date for the given post.
    871871                 *
    872872                 * @since 3.4.0
    … …  
    919919
    920920                /**
    921                  * Filter XML-RPC-prepared date for the given post type.
     921                 * Filters XML-RPC-prepared date for the given post type.
    922922                 *
    923923                 * @since 3.4.0
    … …  
    958958
    959959                /**
    960                  * Filter XML-RPC-prepared data for the given media item.
     960                 * Filters XML-RPC-prepared data for the given media item.
    961961                 *
    962962                 * @since 3.4.0
    … …  
    10401040
    10411041                /**
    1042                  * Filter XML-RPC-prepared data for the given page.
     1042                 * Filters XML-RPC-prepared data for the given page.
    10431043                 *
    10441044                 * @since 3.4.0
    … …  
    10891089
    10901090                /**
    1091                  * Filter XML-RPC-prepared data for the given comment.
     1091                 * Filters XML-RPC-prepared data for the given comment.
    10921092                 *
    10931093                 * @since 3.4.0
    … …  
    11371137
    11381138                /**
    1139                  * Filter XML-RPC-prepared data for the given user.
     1139                 * Filters XML-RPC-prepared data for the given user.
    11401140                 *
    11411141                 * @since 3.5.0
    … …  
    15071507
    15081508                /**
    1509                  * Filter post data array to be inserted via XML-RPC.
     1509                 * Filters post data array to be inserted via XML-RPC.
    15101510                 *
    15111511                 * @since 3.4.0
    … …  
    17101710                } else {
    17111711                        /**
    1712                          * Filter the list of post query fields used by the given XML-RPC method.
     1712                         * Filters the list of post query fields used by the given XML-RPC method.
    17131713                         *
    17141714                         * @since 3.4.0
    … …  
    22612261                } else {
    22622262                        /**
    2263                          * Filter the taxonomy query fields used by the given XML-RPC method.
     2263                         * Filters the taxonomy query fields used by the given XML-RPC method.
    22642264                         *
    22652265                         * @since 3.4.0
    … …  
    23962396                } else {
    23972397                        /**
    2398                          * Filter the default user query fields used by the given XML-RPC method.
     2398                         * Filters the default user query fields used by the given XML-RPC method.
    23992399                         *
    24002400                         * @since 3.5.0
    … …  
    35093509
    35103510                /**
    3511                  * Filter whether to allow anonymous comments over XML-RPC.
     3511                 * Filters whether to allow anonymous comments over XML-RPC.
    35123512                 *
    35133513                 * @since 2.7.0
    … …  
    40794079                } else {
    40804080                        /**
    4081                          * Filter the default query fields used by the given XML-RPC method.
     4081                         * Filters the default query fields used by the given XML-RPC method.
    40824082                         *
    40834083                         * @since 3.4.0
    … …  
    41974197                } else {
    41984198                        /**
    4199                          * Filter the default revision query fields used by the given XML-RPC method.
     4199                         * Filters the default revision query fields used by the given XML-RPC method.
    42004200                         *
    42014201                         * @since 3.5.0
    … …  
    58015801
    58025802                /**
    5803                  * Filter whether to preempt the XML-RPC media upload.
     5803                 * Filters whether to preempt the XML-RPC media upload.
    58045804                 *
    58055805                 * Passing a truthy value will effectively short-circuit the media upload,
    … …  
    60866086
    60876087                /**
    6088                  * Filter the MoveableType text filters list for XML-RPC.
     6088                 * Filters the MoveableType text filters list for XML-RPC.
    60896089                 *
    60906090                 * @since 2.2.0
    … …  
    62146214
    62156215                /**
    6216                  * Filter the pingback source URI.
     6216                 * Filters the pingback source URI.
    62176217                 *
    62186218                 * @since 3.6.0
    … …  
    63116311
    63126312                /**
    6313                  * Filter the pingback remote source.
     6313                 * Filters the pingback remote source.
    63146314                 *
    63156315                 * @since 2.5.0
    … …  
    64576457        protected function pingback_error( $code, $message ) {
    64586458                /**
    6459                  * Filter the XML-RPC pingback error return.
     6459                 * Filters the XML-RPC pingback error return.
    64606460                 *
    64616461                 * @since 3.5.1
Note: See TracChangeset for help on using the changeset viewer.