WordPress.org

Make WordPress Core

Changeset 37488


Ignore:
Timestamp:
05/22/2016 06:00:23 PM (3 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.

Location:
trunk/src/wp-admin
Files:
86 edited

Legend:

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

    r37279 r37488  
    3434        $text = sprintf( __( 'Thank you for creating with <a href="%s">WordPress</a>.' ), __( 'https://wordpress.org/' ) );
    3535        /**
    36          * Filter the "Thank you" text displayed in the admin footer.
     36         * Filters the "Thank you" text displayed in the admin footer.
    3737         *
    3838         * @since 2.8.0
     
    4646        <?php
    4747        /**
    48          * Filter the version/update text displayed in the admin footer.
     48         * Filters the version/update text displayed in the admin footer.
    4949         *
    5050         * WordPress prints the current version and update information,
  • trunk/src/wp-admin/admin-header.php

    r32917 r37488  
    4747
    4848/**
    49  * Filter the title tag content for an admin page.
     49 * Filters the title tag content for an admin page.
    5050 *
    5151 * @since 3.1.0
     
    175175<?php
    176176/**
    177  * Filter the CSS classes for the body tag in the admin.
     177 * Filters the CSS classes for the body tag in the admin.
    178178 *
    179179 * This filter differs from the {@see 'post_class'} and {@see 'body_class'} filters
  • trunk/src/wp-admin/admin.php

    r37431 r37488  
    4949
    5050    /**
    51      * Filter whether to attempt to perform the multisite DB upgrade routine.
     51     * Filters whether to attempt to perform the multisite DB upgrade routine.
    5252     *
    5353     * In single site, the user would be redirected to wp-admin/upgrade.php.
     
    140140if ( current_user_can( 'manage_options' ) ) {
    141141    /**
    142      * Filter the maximum memory limit available for administration screens.
     142     * Filters the maximum memory limit available for administration screens.
    143143     *
    144144     * This only applies to administrators, who may require more memory for tasks like updates.
  • trunk/src/wp-admin/async-upload.php

    r34265 r37488  
    106106
    107107    /**
    108      * Filter the returned ID of an uploaded attachment.
     108     * Filters the returned ID of an uploaded attachment.
    109109     *
    110110     * The dynamic portion of the hook name, `$type`, refers to the attachment type,
  • trunk/src/wp-admin/comment.php

    r37161 r37488  
    314314
    315315    /**
    316      * Filter the URI the user is redirected to after editing a comment in the admin.
     316     * Filters the URI the user is redirected to after editing a comment in the admin.
    317317     *
    318318     * @since 2.1.0
  • trunk/src/wp-admin/custom-header.php

    r36658 r37488  
    11841184        $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
    11851185        /**
    1186          * Filter the header image attachment metadata.
     1186         * Filters the header image attachment metadata.
    11871187         *
    11881188         * @since 3.9.0
  • trunk/src/wp-admin/edit-form-advanced.php

    r37159 r37488  
    2222
    2323/**
    24  * Filter whether to enable the 'expand' functionality in the post editor.
     24 * Filters whether to enable the 'expand' functionality in the post editor.
    2525 *
    2626 * @since 4.0.0
     
    164164
    165165/**
    166  * Filter the post updated messages.
     166 * Filters the post updated messages.
    167167 *
    168168 * @since 3.0.0
     
    544544    <?php
    545545    /**
    546      * Filter the title field placeholder text.
     546     * Filters the title field placeholder text.
    547547     *
    548548     * @since 3.1.0
  • trunk/src/wp-admin/edit-form-comment.php

    r36958 r37488  
    144144<?php
    145145    /**
    146      * Filter miscellaneous actions for the edit comment form sidebar.
     146     * Filters miscellaneous actions for the edit comment form sidebar.
    147147     *
    148148     * @since 4.3.0
  • trunk/src/wp-admin/edit-tag-form.php

    r36969 r37488  
    128128            <?php
    129129            /**
    130              * Filter the editable slug.
     130             * Filters the editable slug.
    131131             *
    132132             * Note: This is a multi-use hook in that it is leveraged both for editable
  • trunk/src/wp-admin/edit-tags.php

    r37439 r37488  
    428428
    429429    /**
    430      * Filter the taxonomy parent drop-down on the Edit Term page.
     430     * Filters the taxonomy parent drop-down on the Edit Term page.
    431431     *
    432432     * @since 3.7.0
  • trunk/src/wp-admin/edit.php

    r36302 r37488  
    284284
    285285/**
    286  * Filter the bulk action updated messages.
     286 * Filters the bulk action updated messages.
    287287 *
    288288 * By default, custom post types use the messages for the 'post' post type.
  • trunk/src/wp-admin/export.php

    r36140 r37488  
    104104
    105105    /**
    106      * Filter the export args.
     106     * Filters the export args.
    107107     *
    108108     * @since 3.5.0
  • trunk/src/wp-admin/includes/ajax-actions.php

    r37431 r37488  
    3333
    3434        /**
    35          * Filter Heartbeat AJAX response in no-privilege environments.
     35         * Filters Heartbeat AJAX response in no-privilege environments.
    3636         *
    3737         * @since 3.6.0
     
    4545
    4646    /**
    47      * Filter Heartbeat AJAX response when no data is passed.
     47     * Filters Heartbeat AJAX response when no data is passed.
    4848     *
    4949     * @since 3.6.0
     
    133133
    134134    /**
    135      * Filter the minimum number of characters required to fire a tag search via AJAX.
     135     * Filters the minimum number of characters required to fire a tag search via AJAX.
    136136     *
    137137     * @since 4.0.0
     
    22772277
    22782278    /**
    2279      * Filter the post lock window duration.
     2279     * Filters the post lock window duration.
    22802280     *
    22812281     * @since 3.3.0
     
    23742374
    23752375    /**
    2376      * Filter the arguments passed to WP_Query during an AJAX
     2376     * Filters the arguments passed to WP_Query during an AJAX
    23772377     * call for querying attachments.
    23782378     *
     
    27122712    if ( ! empty( $data ) ) {
    27132713        /**
    2714          * Filter the Heartbeat response received.
     2714         * Filters the Heartbeat response received.
    27152715         *
    27162716         * @since 3.6.0
     
    27242724
    27252725    /**
    2726      * Filter the Heartbeat response sent.
     2726     * Filters the Heartbeat response sent.
    27272727     *
    27282728     * @since 3.6.0
     
    32743274
    32753275            /**
    3276              * Filter the cropped image attachment metadata.
     3276             * Filters the cropped image attachment metadata.
    32773277             *
    32783278             * @since 4.3.0
     
    32863286
    32873287            /**
    3288              * Filter the attachment ID for a cropped image.
     3288             * Filters the attachment ID for a cropped image.
    32893289             *
    32903290             * @since 4.3.0
  • trunk/src/wp-admin/includes/class-bulk-plugin-upgrader-skin.php

    r37432 r37488  
    5252
    5353        /**
    54          * Filter the list of action links available following bulk plugin updates.
     54         * Filters the list of action links available following bulk plugin updates.
    5555         *
    5656         * @since 3.0.0
  • trunk/src/wp-admin/includes/class-bulk-theme-upgrader-skin.php

    r37432 r37488  
    5252
    5353        /**
    54          * Filter the list of action links available following bulk theme updates.
     54         * Filters the list of action links available following bulk theme updates.
    5555         *
    5656         * @since 3.0.0
  • trunk/src/wp-admin/includes/class-core-upgrader.php

    r37432 r37488  
    292292
    293293            /**
    294              * Filter whether to enable automatic core updates for development versions.
     294             * Filters whether to enable automatic core updates for development versions.
    295295             *
    296296             * @since 3.7.0
     
    308308
    309309            /**
    310              * Filter whether to enable minor automatic core updates.
     310             * Filters whether to enable minor automatic core updates.
    311311             *
    312312             * @since 3.7.0
     
    321321
    322322            /**
    323              * Filter whether to enable major automatic core updates.
     323             * Filters whether to enable major automatic core updates.
    324324             *
    325325             * @since 3.7.0
  • trunk/src/wp-admin/includes/class-language-pack-upgrader-skin.php

    r37432 r37488  
    7272
    7373        /**
    74          * Filter the list of action links available following a translations update.
     74         * Filters the list of action links available following a translations update.
    7575         *
    7676         * @since 3.7.0
  • trunk/src/wp-admin/includes/class-language-pack-upgrader.php

    r37432 r37488  
    7676
    7777            /**
    78              * Filter whether to asynchronously update translation for core, a plugin, or a theme.
     78             * Filters whether to asynchronously update translation for core, a plugin, or a theme.
    7979             *
    8080             * @since 4.0.0
  • trunk/src/wp-admin/includes/class-plugin-installer-skin.php

    r37432 r37488  
    7777
    7878        /**
    79          * Filter the list of action links available following a single plugin installation.
     79         * Filters the list of action links available following a single plugin installation.
    8080         *
    8181         * @since 2.7.0
  • trunk/src/wp-admin/includes/class-plugin-upgrader-skin.php

    r37432 r37488  
    5555
    5656        /**
    57          * Filter the list of action links available following a single plugin update.
     57         * Filters the list of action links available following a single plugin update.
    5858         *
    5959         * @since 2.7.0
  • trunk/src/wp-admin/includes/class-theme-installer-skin.php

    r37432 r37488  
    8181
    8282        /**
    83          * Filter the list of action links available following a single theme installation.
     83         * Filters the list of action links available following a single theme installation.
    8484         *
    8585         * @since 2.8.0
  • trunk/src/wp-admin/includes/class-theme-upgrader-skin.php

    r37432 r37488  
    6767
    6868        /**
    69          * Filter the list of action links available following a single theme update.
     69         * Filters the list of action links available following a single theme update.
    7070         *
    7171         * @since 2.8.0
  • trunk/src/wp-admin/includes/class-wp-automatic-upgrader.php

    r37432 r37488  
    4242
    4343        /**
    44          * Filter whether to entirely disable background updates.
     44         * Filters whether to entirely disable background updates.
    4545         *
    4646         * There are more fine-grained filters and controls for selective disabling.
     
    105105
    106106        /**
    107          * Filter whether the automatic updater should consider a filesystem
     107         * Filters whether the automatic updater should consider a filesystem
    108108         * location to be potentially managed by a version control system.
    109109         *
     
    159159
    160160        /**
    161          * Filter whether to automatically update core, a plugin, a theme, or a language.
     161         * Filters whether to automatically update core, a plugin, a theme, or a language.
    162162         *
    163163         * The dynamic portion of the hook name, `$type`, refers to the type of update
     
    221221
    222222        /**
    223          * Filter whether to notify the site administrator of a new core update.
     223         * Filters whether to notify the site administrator of a new core update.
    224224         *
    225225         * By default, administrators are notified when the update offer received
     
    461461
    462462            /**
    463              * Filter whether to send a debugging email for each automatic background update.
     463             * Filters whether to send a debugging email for each automatic background update.
    464464             *
    465465             * @since 3.7.0
     
    606606
    607607        /**
    608          * Filter whether to send an email following an automatic background core update.
     608         * Filters whether to send an email following an automatic background core update.
    609609         *
    610610         * @since 3.7.0
     
    756756
    757757        /**
    758          * Filter the email sent following an automatic background core update.
     758         * Filters the email sent following an automatic background core update.
    759759         *
    760760         * @since 3.7.0
     
    909909
    910910        /**
    911          * Filter the debug email that can be sent following an automatic
     911         * Filters the debug email that can be sent following an automatic
    912912         * background core update.
    913913         *
  • trunk/src/wp-admin/includes/class-wp-comments-list-table.php

    r36521 r37488  
    167167        $comments_per_page = $this->get_items_per_page( 'edit_comments_per_page' );
    168168        /**
    169          * Filter the number of comments listed per page in the comments list table.
     169         * Filters the number of comments listed per page in the comments list table.
    170170         *
    171171         * @since 2.6.0
     
    271271
    272272        /**
    273          * Filter the comment status links.
     273         * Filters the comment status links.
    274274         *
    275275         * @since 2.5.0
     
    331331<?php
    332332                /**
    333                  * Filter the comment types dropdown menu.
     333                 * Filters the comment types dropdown menu.
    334334                 *
    335335                 * @since 2.7.0
  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r37431 r37488  
    389389        $views = $this->get_views();
    390390        /**
    391          * Filter the list of available list table views.
     391         * Filters the list of available list table views.
    392392         *
    393393         * The dynamic portion of the hook name, `$this->screen->id`, refers
     
    439439            $no_new_actions = $this->_actions = $this->get_bulk_actions();
    440440            /**
    441              * Filter the list table Bulk Actions drop-down.
     441             * Filters the list table Bulk Actions drop-down.
    442442             *
    443443             * The dynamic portion of the hook name, `$this->screen->id`, refers
     
    542542
    543543        /**
    544          * Filter whether to remove the 'Months' drop-down from the post list table.
     544         * Filters whether to remove the 'Months' drop-down from the post list table.
    545545         *
    546546         * @since 4.2.0
     
    569569
    570570        /**
    571          * Filter the 'Months' drop-down results.
     571         * Filters the 'Months' drop-down results.
    572572         *
    573573         * @since 3.7.0
     
    722722
    723723        /**
    724          * Filter the number of items to be displayed on each page of the list table.
     724         * Filters the number of items to be displayed on each page of the list table.
    725725         *
    726726         * The dynamic hook name, $option, refers to the `per_page` option depending
     
    952952
    953953        /**
    954          * Filter the name of the primary column for the current list table.
     954         * Filters the name of the primary column for the current list table.
    955955         *
    956956         * @since 4.3.0
     
    994994        $sortable_columns = $this->get_sortable_columns();
    995995        /**
    996          * Filter the list table sortable columns for a specific screen.
     996         * Filters the list table sortable columns for a specific screen.
    997997         *
    998998         * The dynamic portion of the hook name, `$this->screen->id`, refers
  • trunk/src/wp-admin/includes/class-wp-media-list-table.php

    r36887 r37488  
    283283
    284284        /**
    285          * Filter the taxonomy columns for attachments in the Media list table.
     285         * Filters the taxonomy columns for attachments in the Media list table.
    286286         *
    287287         * @since 3.5.0
     
    313313        $posts_columns['date'] = _x( 'Date', 'column name' );
    314314        /**
    315          * Filter the Media list table columns.
     315         * Filters the Media list table columns.
    316316         *
    317317         * @since 2.5.0
     
    746746
    747747        /**
    748          * Filter the action links for each attachment in the Media list table.
     748         * Filters the action links for each attachment in the Media list table.
    749749         *
    750750         * @since 2.8.0
  • trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php

    r36663 r37488  
    225225
    226226        /**
    227          * Filter the displayed site columns in Sites list table.
     227         * Filters the displayed site columns in Sites list table.
    228228         *
    229229         * @since MU
     
    532532
    533533        /**
    534          * Filter the action links displayed for each site in the Sites list table.
     534         * Filters the action links displayed for each site in the Sites list table.
    535535         *
    536536         * The 'Edit', 'Dashboard', 'Delete', and 'Visit' links are displayed by
  • trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php

    r36394 r37488  
    9292        $themes = array(
    9393            /**
    94              * Filter the full array of WP_Theme objects to list in the Multisite
     94             * Filters the full array of WP_Theme objects to list in the Multisite
    9595             * themes list table.
    9696             *
     
    478478        }
    479479        /**
    480          * Filter the action links displayed for each theme in the Multisite
     480         * Filters the action links displayed for each theme in the Multisite
    481481         * themes list table.
    482482         *
     
    502502
    503503        /**
    504          * Filter the action links of a specific theme in the Multisite themes
     504         * Filters the action links of a specific theme in the Multisite themes
    505505         * list table.
    506506         *
     
    570570        }
    571571        /**
    572          * Filter the array of row meta for each theme in the Multisite themes
     572         * Filters the array of row meta for each theme in the Multisite themes
    573573         * list table.
    574574         *
  • trunk/src/wp-admin/includes/class-wp-ms-users-list-table.php

    r36572 r37488  
    173173        );
    174174        /**
    175          * Filter the columns displayed in the Network Admin Users list table.
     175         * Filters the columns displayed in the Network Admin Users list table.
    176176         *
    177177         * @since MU
     
    352352
    353353            /**
    354              * Filter the action links displayed next the sites a user belongs to
     354             * Filters the action links displayed next the sites a user belongs to
    355355             * in the Network Admin Users list table.
    356356             *
     
    447447
    448448        /**
    449          * Filter the action links displayed under each user in the Network Admin Users list table.
     449         * Filters the action links displayed under each user in the Network Admin Users list table.
    450450         *
    451451         * @since 3.2.0
  • trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

    r37145 r37488  
    105105
    106106        /**
    107          * Filter the tabs shown on the Plugin Install screen.
     107         * Filters the tabs shown on the Plugin Install screen.
    108108         *
    109109         * @since 2.7.0
     
    115115
    116116        /**
    117          * Filter tabs not associated with a menu item on the Plugin Install screen.
     117         * Filters tabs not associated with a menu item on the Plugin Install screen.
    118118         *
    119119         * @since 2.7.0
     
    192192
    193193        /**
    194          * Filter API request arguments for each Plugin Install screen tab.
     194         * Filters API request arguments for each Plugin Install screen tab.
    195195         *
    196196         * The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.
     
    495495
    496496            /**
    497              * Filter the install action links for a plugin.
     497             * Filters the install action links for a plugin.
    498498             *
    499499             * @since 2.7.0
  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r36964 r37488  
    7979
    8080        /**
    81          * Filters the full array of plugins to list in the Plugins list table.
     81         * Filterss the full array of plugins to list in the Plugins list table.
    8282         *
    8383         * @since 3.0.0
     
    105105
    106106            /**
    107              * Filter whether to display the advanced plugins list table.
     107             * Filters whether to display the advanced plugins list table.
    108108             *
    109109             * There are two types of advanced plugins - must-use and drop-ins -
     
    141141            $show = current_user_can( 'manage_network_plugins' );
    142142            /**
    143              * Filter whether to display network-active plugins alongside plugins active for the current site.
     143             * Filters whether to display network-active plugins alongside plugins active for the current site.
    144144             *
    145145             * This also controls the display of inactive network-only plugins (plugins with
     
    608608
    609609            /**
    610              * Filter the action links displayed for each plugin in the Network Admin Plugins list table.
     610             * Filters the action links displayed for each plugin in the Network Admin Plugins list table.
    611611             *
    612612             * The default action links for the Network plugins list table include
     
    626626
    627627            /**
    628              * Filter the list of action links displayed for a specific plugin in the Network Admin Plugins list table.
     628             * Filters the list of action links displayed for a specific plugin in the Network Admin Plugins list table.
    629629             *
    630630             * The dynamic portion of the hook name, $plugin_file, refers to the path
     
    646646
    647647            /**
    648              * Filter the action links displayed for each plugin in the Plugins list table.
     648             * Filters the action links displayed for each plugin in the Plugins list table.
    649649             *
    650650             * The default action links for the site plugins list table include
     
    665665
    666666            /**
    667              * Filter the list of action links displayed for a specific plugin in the Plugins list table.
     667             * Filters the list of action links displayed for a specific plugin in the Plugins list table.
    668668             *
    669669             * The dynamic portion of the hook name, $plugin_file, refers to the path
     
    758758
    759759                    /**
    760                      * Filter the array of row meta for each plugin in the Plugins list table.
     760                     * Filters the array of row meta for each plugin in the Plugins list table.
    761761                     *
    762762                     * @since 2.8.0
  • trunk/src/wp-admin/includes/class-wp-posts-list-table.php

    r37422 r37488  
    516516
    517517        /**
    518          * Filter the taxonomy columns in the Posts list table.
     518         * Filters the taxonomy columns in the Posts list table.
    519519         *
    520520         * The dynamic portion of the hook name, `$post_type`, refers to the post
     
    549549
    550550            /**
    551              * Filter the columns displayed in the Pages list table.
     551             * Filters the columns displayed in the Pages list table.
    552552             *
    553553             * @since 2.5.0
     
    559559
    560560            /**
    561              * Filter the columns displayed in the Posts list table.
     561             * Filters the columns displayed in the Posts list table.
    562562             *
    563563             * @since 1.5.0
     
    570570
    571571        /**
    572          * Filter the columns displayed in the Posts list table for a specific post type.
     572         * Filters the columns displayed in the Posts list table for a specific post type.
    573573         *
    574574         * The dynamic portion of the hook name, `$post_type`, refers to the post type slug.
     
    965965        if ( 'excerpt' === $mode ) {
    966966            /**
    967              * Filter the published time of the post.
     967             * Filters the published time of the post.
    968968             *
    969969             * If `$mode` equals 'excerpt', the published time and date are both displayed.
     
    12521252
    12531253            /**
    1254              * Filter the array of row action links on the Pages list table.
     1254             * Filters the array of row action links on the Pages list table.
    12551255             *
    12561256             * The filter is evaluated only for hierarchical post types.
     
    12671267
    12681268            /**
    1269              * Filter the array of row action links on the Posts list table.
     1269             * Filters the array of row action links on the Posts list table.
    12701270             *
    12711271             * The filter is evaluated only for non-hierarchical post types.
     
    13091309
    13101310            /**
    1311              * Filter whether the current taxonomy should be shown in the Quick Edit panel.
     1311             * Filters whether the current taxonomy should be shown in the Quick Edit panel.
    13121312             *
    13131313             * @since 4.2.0
     
    14741474
    14751475        /**
    1476          * Filter the arguments used to generate the Quick Edit page-parent drop-down.
     1476         * Filters the arguments used to generate the Quick Edit page-parent drop-down.
    14771477         *
    14781478         * @since 2.7.0
  • trunk/src/wp-admin/includes/class-wp-press-this.php

    r37361 r37488  
    4343        return array(
    4444            /**
    45              * Filter whether or not Press This should redirect the user in the parent window upon save.
     45             * Filters whether or not Press This should redirect the user in the parent window upon save.
    4646             *
    4747             * @since 4.2.0
     
    135135
    136136        /**
    137          * Filter the post data of a Press This post before saving/updating, after
     137         * Filters the post data of a Press This post before saving/updating, after
    138138         * side_load_images action had run.
    139139         *
     
    169169
    170170            /**
    171              * Filter the URL to redirect to when Press This saves.
     171             * Filters the URL to redirect to when Press This saves.
    172172             *
    173173             * @since 4.2.0
     
    691691
    692692        /**
    693          * Filter whether to enable in-source media discovery in Press This.
     693         * Filters whether to enable in-source media discovery in Press This.
    694694         *
    695695         * @since 4.2.0
     
    766766
    767767        /**
    768          * Filter the Press This data array.
     768         * Filters the Press This data array.
    769769         *
    770770         * @since 4.2.0
     
    11431143
    11441144        /**
    1145          * Filter the default HTML tags used in the suggested content for the editor.
     1145         * Filters the default HTML tags used in the suggested content for the editor.
    11461146         *
    11471147         * The HTML strings use printf format. After filtering the content is added at the specified places with `sprintf()`.
  • trunk/src/wp-admin/includes/class-wp-screen.php

    r37431 r37488  
    730730
    731731        /**
    732          * Filter the legacy contextual help list.
     732         * Filters the legacy contextual help list.
    733733         *
    734734         * @since 2.7.0
     
    744744
    745745        /**
    746          * Filter the legacy contextual help text.
     746         * Filters the legacy contextual help text.
    747747         *
    748748         * @since 2.7.0
     
    761761
    762762            /**
    763              * Filter the default legacy contextual help text.
     763             * Filters the default legacy contextual help text.
    764764             *
    765765             * @since 2.8.0
     
    850850
    851851        /**
    852          * Filter the array of screen layout columns.
     852         * Filters the array of screen layout columns.
    853853         *
    854854         * This hook provides back-compat for plugins using the back-compat
    855          * filter instead of add_screen_option().
     855         * Filters instead of add_screen_option().
    856856         *
    857857         * @since 2.8.0
     
    930930
    931931        /**
    932          * Filter the screen settings text displayed in the Screen Options tab.
     932         * Filters the screen settings text displayed in the Screen Options tab.
    933933         *
    934934         * This filter is currently only used on the Widgets screen to enable
     
    946946
    947947        /**
    948          * Filter whether to show the Screen Options tab.
     948         * Filters whether to show the Screen Options tab.
    949949         *
    950950         * @since 3.2.0
     
    996996
    997997        /**
    998          * Filter whether to show the Screen Options submit button.
     998         * Filters whether to show the Screen Options submit button.
    999999         *
    10001000         * @since 4.4.0
     
    12051205
    12061206        /**
    1207          * Filter the post types that have different view mode options.
     1207         * Filters the post types that have different view mode options.
    12081208         *
    12091209         * @since 4.4.0
  • trunk/src/wp-admin/includes/class-wp-site-icon.php

    r35299 r37488  
    122122
    123123        /**
    124          * Filter the site icon attachment metadata.
     124         * Filters the site icon attachment metadata.
    125125         *
    126126         * @since 4.3.0
     
    149149
    150150        /**
    151          * Filter the different dimensions that a site icon is saved in.
     151         * Filters the different dimensions that a site icon is saved in.
    152152         *
    153153         * @since 4.3.0
  • trunk/src/wp-admin/includes/class-wp-terms-list-table.php

    r36265 r37488  
    8080        if ( 'post_tag' === $this->screen->taxonomy ) {
    8181            /**
    82              * Filter the number of terms displayed per page for the Tags list table.
     82             * Filters the number of terms displayed per page for the Tags list table.
    8383             *
    8484             * @since 2.8.0
     
    8989
    9090            /**
    91              * Filter the number of terms displayed per page for the Tags list table.
     91             * Filters the number of terms displayed per page for the Tags list table.
    9292             *
    9393             * @since 2.7.0
     
    9999        } elseif ( 'category' === $this->screen->taxonomy ) {
    100100            /**
    101              * Filter the number of terms displayed per page for the Categories list table.
     101             * Filters the number of terms displayed per page for the Categories list table.
    102102             *
    103103             * @since 2.8.0
     
    352352
    353353        /**
    354          * Filter display of the term name in the terms list table.
     354         * Filters display of the term name in the terms list table.
    355355         *
    356356         * The default output may include padding due to the term's
     
    470470
    471471        /**
    472          * Filter the action links displayed for each term in the Tags list table.
     472         * Filters the action links displayed for each term in the Tags list table.
    473473         *
    474474         * @since 2.8.0
     
    482482
    483483        /**
    484          * Filter the action links displayed for each term in the terms list table.
     484         * Filters the action links displayed for each term in the terms list table.
    485485         *
    486486         * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
     
    560560    public function column_default( $tag, $column_name ) {
    561561        /**
    562          * Filter the displayed columns in the terms list table.
     562         * Filters the displayed columns in the terms list table.
    563563         *
    564564         * The dynamic portion of the hook name, `$this->screen->taxonomy`,
  • trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php

    r36709 r37488  
    7373
    7474        /**
    75          * Filter tabs not associated with a menu item on the Install Themes screen.
     75         * Filters tabs not associated with a menu item on the Install Themes screen.
    7676         *
    7777         * @since 2.8.0
     
    125125
    126126        /**
    127          * Filter API request arguments for each Install Themes screen tab.
     127         * Filters API request arguments for each Install Themes screen tab.
    128128         *
    129129         * The dynamic portion of the hook name, `$tab`, refers to the theme install
     
    291291
    292292        /**
    293          * Filter the install action links for a theme in the Install Themes list table.
     293         * Filters the install action links for a theme in the Install Themes list table.
    294294         *
    295295         * @since 3.4.0
  • trunk/src/wp-admin/includes/class-wp-upgrader.php

    r37462 r37488  
    250250
    251251        /**
    252          * Filter whether to return the package.
     252         * Filters whether to return the package.
    253253         *
    254254         * @since 3.7.0
     
    450450
    451451        /**
    452          * Filter the install response before the installation has started.
     452         * Filters the install response before the installation has started.
    453453         *
    454454         * Returning a truthy value, or one that could be evaluated as a WP_Error
     
    484484
    485485        /**
    486          * Filter the source file location for the upgrade package.
     486         * Filters the source file location for the upgrade package.
    487487         *
    488488         * @since 2.8.0
     
    530530
    531531            /**
    532              * Filter whether the upgrader cleared the destination.
     532             * Filters whether the upgrader cleared the destination.
    533533             *
    534534             * @since 2.8.0
     
    582582
    583583        /**
    584          * Filter the install response after the installation has finished.
     584         * Filters the install response after the installation has finished.
    585585         *
    586586         * @since 2.8.0
     
    650650
    651651        /**
    652          * Filter the package options before running an update.
     652         * Filters the package options before running an update.
    653653         *
    654654         * @since 4.3.0
  • trunk/src/wp-admin/includes/class-wp-users-list-table.php

    r37422 r37488  
    126126
    127127        /**
    128          * Filter the query arguments used to retrieve users for the current users list table.
     128         * Filters the query arguments used to retrieve users for the current users list table.
    129129         *
    130130         * @since 4.4.0
     
    161161     *
    162162     * Provides a list of roles and user count for that role for easy
    163      * filtering of the user table.
     163     * Filtersing of the user table.
    164164     *
    165165     * @since  3.1.0
     
    415415
    416416            /**
    417              * Filter the action links displayed under each user in the Users list table.
     417             * Filters the action links displayed under each user in the Users list table.
    418418             *
    419419             * @since 2.8.0
     
    491491                    default:
    492492                        /**
    493                          * Filter the display output of custom columns in the Users list table.
     493                         * Filters the display output of custom columns in the Users list table.
    494494                         *
    495495                         * @since 2.8.0
     
    550550
    551551        /**
    552          * Filter the returned array of roles for a user.
     552         * Filters the returned array of roles for a user.
    553553         *
    554554         * @since 4.4.0
  • trunk/src/wp-admin/includes/comment.php

    r35262 r37488  
    103103    $comment->comment_content = format_to_edit( $comment->comment_content );
    104104    /**
    105      * Filter the comment content before editing.
     105     * Filters the comment content before editing.
    106106     *
    107107     * @since 2.0.0
  • trunk/src/wp-admin/includes/dashboard.php

    r37335 r37488  
    6666
    6767        /**
    68          * Filter the list of widgets to load for the Network Admin dashboard.
     68         * Filters the list of widgets to load for the Network Admin dashboard.
    6969         *
    7070         * @since 3.1.0
     
    8383
    8484        /**
    85          * Filter the list of widgets to load for the User Admin dashboard.
     85         * Filters the list of widgets to load for the User Admin dashboard.
    8686         *
    8787         * @since 3.1.0
     
    100100
    101101        /**
    102          * Filter the list of widgets to load for the admin dashboard.
     102         * Filters the list of widgets to load for the admin dashboard.
    103103         *
    104104         * @since 2.5.0
     
    284284
    285285    /**
    286      * Filter the array of extra elements to list in the 'At a Glance'
     286     * Filters the array of extra elements to list in the 'At a Glance'
    287287     * dashboard widget.
    288288     *
     
    309309
    310310        /**
    311          * Filter the link title attribute for the 'Search Engines Discouraged'
     311         * Filters the link title attribute for the 'Search Engines Discouraged'
    312312         * message displayed in the 'At a Glance' dashboard widget.
    313313         *
     
    322322
    323323        /**
    324          * Filter the link label for the 'Search Engines Discouraged' message
     324         * Filters the link label for the 'Search Engines Discouraged' message
    325325         * displayed in the 'At a Glance' dashboard widget.
    326326         *
     
    539539
    540540        /**
    541          * Filter the post query arguments for the 'Recent Drafts' dashboard widget.
     541         * Filters the post query arguments for the 'Recent Drafts' dashboard widget.
    542542         *
    543543         * @since 4.4.0
     
    634634
    635635        /**
    636          * Filter the action links displayed for each comment in the 'Recent Comments'
     636         * Filters the action links displayed for each comment in the 'Recent Comments'
    637637         * dashboard widget.
    638638         *
     
    807807
    808808    /**
    809      * Filter the query arguments used for the Recent Posts widget.
     809     * Filters the query arguments used for the Recent Posts widget.
    810810     *
    811811     * @since 4.2.0
     
    10691069
    10701070            /**
    1071              * Filter the primary link URL for the 'WordPress News' dashboard widget.
     1071             * Filters the primary link URL for the 'WordPress News' dashboard widget.
    10721072             *
    10731073             * @since 2.5.0
     
    10781078
    10791079            /**
    1080              * Filter the primary feed URL for the 'WordPress News' dashboard widget.
     1080             * Filters the primary feed URL for the 'WordPress News' dashboard widget.
    10811081             *
    10821082             * @since 2.3.0
     
    10871087
    10881088            /**
    1089              * Filter the primary link title for the 'WordPress News' dashboard widget.
     1089             * Filters the primary link title for the 'WordPress News' dashboard widget.
    10901090             *
    10911091             * @since 2.3.0
     
    11021102
    11031103            /**
    1104              * Filter the secondary link URL for the 'WordPress News' dashboard widget.
     1104             * Filters the secondary link URL for the 'WordPress News' dashboard widget.
    11051105             *
    11061106             * @since 2.3.0
     
    11111111
    11121112            /**
    1113              * Filter the secondary feed URL for the 'WordPress News' dashboard widget.
     1113             * Filters the secondary feed URL for the 'WordPress News' dashboard widget.
    11141114             *
    11151115             * @since 2.3.0
     
    11201120
    11211121            /**
    1122              * Filter the secondary link title for the 'WordPress News' dashboard widget.
     1122             * Filters the secondary link title for the 'WordPress News' dashboard widget.
    11231123             *
    11241124             * @since 2.3.0
     
    11291129
    11301130            /**
    1131              * Filter the number of secondary link items for the 'WordPress News' dashboard widget.
     1131             * Filters the number of secondary link items for the 'WordPress News' dashboard widget.
    11321132             *
    11331133             * @since 4.4.0
     
    13561356
    13571357    /**
    1358     * Filter the notice output for the 'Browse Happy' nag meta box.
     1358    * Filters the notice output for the 'Browse Happy' nag meta box.
    13591359    *
    13601360    * @since 3.2.0
  • trunk/src/wp-admin/includes/edit-tag-messages.php

    r34202 r37488  
    4141
    4242/**
    43  * Filter the messages displayed when a tag is updated.
     43 * Filters the messages displayed when a tag is updated.
    4444 *
    4545 * @since 3.7.0
  • trunk/src/wp-admin/includes/export.php

    r37240 r37488  
    5050    $wp_filename = $sitename . 'wordpress.' . $date . '.xml';
    5151    /**
    52      * Filter the export filename.
     52     * Filters the export filename.
    5353     *
    5454     * @since 4.4.0
     
    270270        foreach ( $termmeta as $meta ) {
    271271            /**
    272              * Filter whether to selectively skip term meta used for WXR exports.
     272             * Filters whether to selectively skip term meta used for WXR exports.
    273273             *
    274274             * Returning a truthy value to the filter will skip the current meta
     
    485485        <content:encoded><?php
    486486            /**
    487              * Filter the post content used for WXR exports.
     487             * Filters the post content used for WXR exports.
    488488             *
    489489             * @since 2.5.0
     
    495495        <excerpt:encoded><?php
    496496            /**
    497              * Filter the post excerpt used for WXR exports.
     497             * Filters the post excerpt used for WXR exports.
    498498             *
    499499             * @since 2.6.0
     
    522522        foreach ( $postmeta as $meta ) :
    523523            /**
    524              * Filter whether to selectively skip post meta used for WXR exports.
     524             * Filters whether to selectively skip post meta used for WXR exports.
    525525             *
    526526             * Returning a truthy value to the filter will skip the current meta
     
    561561            foreach ( $c_meta as $meta ) :
    562562                /**
    563                  * Filter whether to selectively skip comment meta used for WXR exports.
     563                 * Filters whether to selectively skip comment meta used for WXR exports.
    564564                 *
    565565                 * Returning a truthy value to the filter will skip the current meta
  • trunk/src/wp-admin/includes/file.php

    r37467 r37488  
    252252
    253253    /**
    254      * Filter the data for a file before it is uploaded to WordPress.
     254     * Filters the data for a file before it is uploaded to WordPress.
    255255     *
    256256     * The dynamic portion of the hook name, `$action`, refers to the post action.
     
    400400
    401401    /**
    402      * Filter the data array for the uploaded file.
     402     * Filters the data array for the uploaded file.
    403403     *
    404404     * @since 2.1.0
     
    590590
    591591    /**
    592      * Filter whether to use ZipArchive to unzip archives.
     592     * Filters whether to use ZipArchive to unzip archives.
    593593     *
    594594     * @since 3.0.0
     
    891891
    892892        /**
    893          * Filter the path for a specific filesystem method class file.
     893         * Filters the path for a specific filesystem method class file.
    894894         *
    895895         * @since 2.6.0
     
    10071007
    10081008    /**
    1009      * Filter the filesystem method to use.
     1009     * Filters the filesystem method to use.
    10101010     *
    10111011     * @since 2.6.0
     
    10521052
    10531053    /**
    1054      * Filter the filesystem credentials form output.
     1054     * Filters the filesystem credentials form output.
    10551055     *
    10561056     * Returning anything other than an empty string will effectively short-circuit
     
    11531153
    11541154    /**
    1155      * Filter the connection types to output to the filesystem credentials form.
     1155     * Filters the connection types to output to the filesystem credentials form.
    11561156     *
    11571157     * @since 2.9.0
  • trunk/src/wp-admin/includes/image-edit.php

    r37342 r37488  
    244244
    245245        /**
    246          * Filter the WP_Image_Editor instance for the image to be streamed to the browser.
     246         * Filters the WP_Image_Editor instance for the image to be streamed to the browser.
    247247         *
    248248         * @since 3.5.0
     
    261261
    262262        /**
    263          * Filter the GD image resource to be streamed to the browser.
     263         * Filters the GD image resource to be streamed to the browser.
    264264         *
    265265         * @since 2.9.0
     
    303303
    304304        /**
    305          * Filter whether to skip saving the image file.
     305         * Filters whether to skip saving the image file.
    306306         *
    307307         * Returning a non-null value will short-circuit the save method,
     
    329329
    330330        /**
    331          * Filter whether to skip saving the image file.
     331         * Filters whether to skip saving the image file.
    332332         *
    333333         * Returning a non-null value will short-circuit the save method,
     
    516516
    517517        /**
    518          * Filter the WP_Image_Editor instance before applying changes to the image.
     518         * Filters the WP_Image_Editor instance before applying changes to the image.
    519519         *
    520520         * @since 3.5.0
     
    527527
    528528        /**
    529          * Filter the GD image resource before applying changes to the image.
     529         * Filters the GD image resource before applying changes to the image.
    530530         *
    531531         * @since 2.9.0
  • trunk/src/wp-admin/includes/image.php

    r36970 r37488  
    108108
    109109        /**
    110          * Filter the image sizes automatically generated when uploading an image.
     110         * Filters the image sizes automatically generated when uploading an image.
    111111         *
    112112         * @since 2.9.0
     
    175175                );
    176176                /**
    177                  * Filter the parameters for the attachment thumbnail creation.
     177                 * Filters the parameters for the attachment thumbnail creation.
    178178                 *
    179179                 * @since 3.9.0
     
    200200
    201201    /**
    202      * Filter the generated attachment meta data.
     202     * Filters the generated attachment meta data.
    203203     *
    204204     * @since 2.1.0
     
    338338
    339339    /**
    340      * Filter the image types to check for exif data.
     340     * Filters the image types to check for exif data.
    341341     *
    342342     * @since 2.5.0
     
    418418
    419419    /**
    420      * Filter the array of meta data read from an image's exif data.
     420     * Filters the array of meta data read from an image's exif data.
    421421     *
    422422     * @since 2.5.0
     
    466466
    467467    /**
    468      * Filter whether the current image is displayable in the browser.
     468     * Filters whether the current image is displayable in the browser.
    469469     *
    470470     * @since 2.5.0
     
    507507    if ( is_resource($image) ) {
    508508        /**
    509          * Filter the current image being loaded for editing.
     509         * Filters the current image being loaded for editing.
    510510         *
    511511         * @since 2.9.0
     
    543543        if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
    544544            /**
    545              * Filter the path to the current image.
     545             * Filters the path to the current image.
    546546             *
    547547             * The filter is evaluated for all image sizes except 'full'.
     
    557557    } elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
    558558        /**
    559          * Filter the image URL if not in the local filesystem.
     559         * Filters the image URL if not in the local filesystem.
    560560         *
    561561         * The filter is only evaluated if fopen is enabled on the server.
     
    571571
    572572    /**
    573      * Filter the returned path or URL of the current image.
     573     * Filters the returned path or URL of the current image.
    574574     *
    575575     * @since 2.9.0
  • 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
  • trunk/src/wp-admin/includes/menu.php

    r35416 r37488  
    230230
    231231    /**
    232      * Filter administration menus array with classes added for top-level items.
     232     * Filters administration menus array with classes added for top-level items.
    233233     *
    234234     * @since 2.7.0
     
    242242
    243243/**
    244  * Filter whether to enable custom ordering of the administration menu.
     244 * Filters whether to enable custom ordering of the administration menu.
    245245 *
    246246 * See the {@see 'menu_order'} filter for reordering menu items.
     
    259259
    260260    /**
    261      * Filter the order of administration menu items.
     261     * Filters the order of administration menu items.
    262262     *
    263263     * A truthy value must first be passed to the {@see 'custom_menu_order'} filter
  • trunk/src/wp-admin/includes/meta-boxes.php

    r37016 r37488  
    523523
    524524                    /**
    525                      * Filter the arguments for the taxonomy parent dropdown on the Post Edit page.
     525                     * Filters the arguments for the taxonomy parent dropdown on the Post Edit page.
    526526                     *
    527527                     * @since 4.4.0
     
    799799
    800800        /**
    801          * Filter the arguments used to generate a Pages drop-down element.
     801         * Filters the arguments used to generate a Pages drop-down element.
    802802         *
    803803         * @since 3.3.0
     
    836836<?php
    837837/**
    838  * Filter the title of the default page template displayed in the drop-down.
     838 * Filters the title of the default page template displayed in the drop-down.
    839839 *
    840840 * @since 4.1.0
  • trunk/src/wp-admin/includes/misc.php

    r37273 r37488  
    1818
    1919    /**
    20      * Filter whether Apache and mod_rewrite are present.
     20     * Filters whether Apache and mod_rewrite are present.
    2121     *
    2222     * This filter was previously used to force URL rewriting for other servers,
     
    4747
    4848    /**
    49      * Filter whether URL rewriting is available.
     49     * Filters whether URL rewriting is available.
    5050     *
    5151     * @since 3.7.0
     
    370370
    371371    /**
    372      * Filter the list of functions and classes to be ignored from the documentation lookup.
     372     * Filters the list of functions and classes to be ignored from the documentation lookup.
    373373     *
    374374     * @since 2.8.0
     
    439439
    440440                /**
    441                  * Filter a screen option value before it is set.
     441                 * Filters a screen option value before it is set.
    442442                 *
    443443                 * The filter can also be used to modify non-standard [items]_per_page
  • trunk/src/wp-admin/includes/ms.php

    r37466 r37488  
    113113        $tables = $wpdb->tables( 'blog' );
    114114        /**
    115          * Filter the tables to drop when the site is deleted.
     115         * Filters the tables to drop when the site is deleted.
    116116         *
    117117         * @since MU
     
    129129
    130130        /**
    131          * Filter the upload base directory to delete when the site is deleted.
     131         * Filters the upload base directory to delete when the site is deleted.
    132132         *
    133133         * @since MU
     
    292292
    293293    /**
    294      * Filter the email text sent when the site admin email is changed.
     294     * Filters the email text sent when the site admin email is changed.
    295295     *
    296296     * The following strings have a special meaning and will get replaced dynamically:
     
    372372
    373373        /**
    374          * Filter the email text sent when a user changes emails.
     374         * Filters the email text sent when a user changes emails.
    375375         *
    376376         * The following strings have a special meaning and will get replaced dynamically:
     
    605605
    606606    /**
    607      * Filter the language codes.
     607     * Filters the language codes.
    608608     *
    609609     * @since MU
     
    731731
    732732    /**
    733      * Filter the languages available in the dropdown.
     733     * Filters the languages available in the dropdown.
    734734     *
    735735     * @since MU
     
    874874
    875875    /**
    876      * Filter whether this network can be edited from this page.
     876     * Filters whether this network can be edited from this page.
    877877     *
    878878     * @since 3.1.0
     
    10481048
    10491049    /**
    1050      * Filter the links that appear on site-editing network pages
     1050     * Filters the links that appear on site-editing network pages
    10511051     *
    10521052     * Default links: 'site-info', 'site-users', 'site-themes', and 'site-settings'
  • trunk/src/wp-admin/includes/nav-menu.php

    r37153 r37488  
    187187    foreach ( $post_types as $post_type ) {
    188188        /**
    189          * Filter whether a menu items meta box will be added for the current
     189         * Filters whether a menu items meta box will be added for the current
    190190         * object type.
    191191         *
     
    401401
    402402                /**
    403                  * Filter the posts displayed in the 'Most Recent' tab of the current
     403                 * Filters the posts displayed in the 'Most Recent' tab of the current
    404404                 * post type's menu items meta box.
    405405                 *
     
    509509
    510510                /**
    511                  * Filter the posts displayed in the 'View All' tab of the current
     511                 * Filters the posts displayed in the 'View All' tab of the current
    512512                 * post type's menu items meta box.
    513513                 *
     
    889889
    890890        /**
    891          * Filter the Walker class used when adding nav menu items.
     891         * Filters the Walker class used when adding nav menu items.
    892892         *
    893893         * @since 3.0.0
  • trunk/src/wp-admin/includes/network.php

    r36690 r37488  
    5353    global $wpdb;
    5454        /**
    55          * Filter whether to enable the subdirectory install feature in Multisite.
     55         * Filters whether to enable the subdirectory install feature in Multisite.
    5656         *
    5757         * @since 3.0.0
  • trunk/src/wp-admin/includes/plugin-install.php

    r37221 r37488  
    114114
    115115    /**
    116      * Filter the WordPress.org Plugin Install API arguments.
     116     * Filters the WordPress.org Plugin Install API arguments.
    117117     *
    118118     * Important: An object MUST be returned to this filter.
     
    126126
    127127    /**
    128      * Filter the response for the current WordPress.org Plugin Install API request.
     128     * Filters the response for the current WordPress.org Plugin Install API request.
    129129     *
    130130     * Passing a non-false value will effectively short-circuit the WordPress.org API request.
     
    172172
    173173    /**
    174      * Filter the Plugin Install API response results.
     174     * Filters the Plugin Install API response results.
    175175     *
    176176     * @since 2.7.0
  • trunk/src/wp-admin/includes/post.php

    r37196 r37488  
    623623
    624624    /**
    625      * Filter the default post content initially used in the "Write Post" form.
     625     * Filters the default post content initially used in the "Write Post" form.
    626626     *
    627627     * @since 1.5.0
     
    633633
    634634    /**
    635      * Filter the default post title initially used in the "Write Post" form.
     635     * Filters the default post title initially used in the "Write Post" form.
    636636     *
    637637     * @since 1.5.0
     
    643643
    644644    /**
    645      * Filter the default post excerpt initially used in the "Write Post" form.
     645     * Filters the default post excerpt initially used in the "Write Post" form.
    646646     *
    647647     * @since 1.5.0
     
    10231023
    10241024    /**
    1025      * Filter the number of items per page to show for a specific 'per_page' type.
     1025     * Filters the number of items per page to show for a specific 'per_page' type.
    10261026     *
    10271027     * The dynamic portion of the hook name, `$post_type`, refers to the post type.
     
    10381038
    10391039    /**
    1040      * Filter the number of posts displayed per page when specifically listing "posts".
     1040     * Filters the number of posts displayed per page when specifically listing "posts".
    10411041     *
    10421042     * @since 2.8.0
     
    11141114
    11151115    /**
    1116      * Filter the number of items to list per page when listing media items.
     1116     * Filters the number of items to list per page when listing media items.
    11171117     *
    11181118     * @since 2.9.0
     
    11821182
    11831183    /**
    1184      * Filter the postbox classes for a specific screen and screen ID combo.
     1184     * Filters the postbox classes for a specific screen and screen ID combo.
    11851185     *
    11861186     * The dynamic portions of the hook name, `$page` and `$id`, refer to
     
    12601260
    12611261    /**
    1262      * Filter the sample permalink.
     1262     * Filters the sample permalink.
    12631263     *
    12641264     * @since 4.4.0
     
    13481348
    13491349    /**
    1350      * Filter the sample permalink HTML markup.
     1350     * Filters the sample permalink HTML markup.
    13511351     *
    13521352     * @since 2.9.0
     
    13941394
    13951395        /**
    1396          * Filter the size used to display the post thumbnail image in the 'Featured Image' meta box.
     1396         * Filters the size used to display the post thumbnail image in the 'Featured Image' meta box.
    13971397         *
    13981398         * Note: When a theme adds 'post-thumbnail' support, a special 'post-thumbnail'
     
    14271427
    14281428    /**
    1429      * Filter the admin post thumbnail HTML markup to return.
     1429     * Filters the admin post thumbnail HTML markup to return.
    14301430     *
    14311431     * @since 2.9.0
     
    15061506
    15071507        /**
    1508          * Filter whether to show the post locked dialog.
     1508         * Filters whether to show the post locked dialog.
    15091509         *
    15101510         * Returning a falsey value to the filter will short-circuit displaying the dialog.
     
    15581558
    15591559        /**
    1560          * Filter whether to allow the post lock to be overridden.
     1560         * Filters whether to allow the post lock to be overridden.
    15611561         *
    15621562         * Returning a falsey value to the filter will disable the ability
     
    18361836
    18371837    /**
    1838      * Filter the post redirect destination URL.
     1838     * Filters the post redirect destination URL.
    18391839     *
    18401840     * @since 2.9.0
  • trunk/src/wp-admin/includes/revision.php

    r37342 r37488  
    8181
    8282        /**
    83          * Filter revisions text diff options.
    84          *
    85          * Filter the options passed to wp_text_diff() when viewing a post revision.
     83         * Filters revisions text diff options.
     84         *
     85         * Filters the options passed to wp_text_diff() when viewing a post revision.
    8686         *
    8787         * @since 4.1.0
     
    120120
    121121    /**
    122      * Filter the fields displayed in the post revision diff UI.
     122     * Filters the fields displayed in the post revision diff UI.
    123123     *
    124124     * @since 4.1.0
     
    214214
    215215        /**
    216          * Filter the array of revisions used on the revisions screen.
     216         * Filters the array of revisions used on the revisions screen.
    217217         *
    218218         * @since 4.4.0
  • trunk/src/wp-admin/includes/schema.php

    r36654 r37488  
    10291029
    10301030    /**
    1031      * Filter meta for a network on creation.
     1031     * Filters meta for a network on creation.
    10321032     *
    10331033     * @since 3.7.0
  • trunk/src/wp-admin/includes/screen.php

    r36156 r37488  
    2626
    2727        /**
    28          * Filter the column headers for a list table on a specific screen.
     28         * Filters the column headers for a list table on a specific screen.
    2929         *
    3030         * The dynamic portion of the hook name, `$screen->id`, refers to the
     
    6464
    6565        /**
    66          * Filter the default list of hidden columns.
     66         * Filters the default list of hidden columns.
    6767         *
    6868         * @since 4.4.0
     
    7575
    7676    /**
    77      * Filter the list of hidden columns.
     77     * Filters the list of hidden columns.
    7878     *
    7979     * @since 4.4.0
     
    154154
    155155        /**
    156          * Filter the default list of hidden meta boxes.
     156         * Filters the default list of hidden meta boxes.
    157157         *
    158158         * @since 3.1.0
     
    165165
    166166    /**
    167      * Filter the list of hidden meta boxes.
     167     * Filters the list of hidden meta boxes.
    168168     *
    169169     * @since 3.3.0
  • trunk/src/wp-admin/includes/taxonomy.php

    r35975 r37488  
    260260
    261261    /**
    262      * Filter the comma-separated list of terms available to edit.
     262     * Filters the comma-separated list of terms available to edit.
    263263     *
    264264     * @since 2.8.0
  • trunk/src/wp-admin/includes/template.php

    r37485 r37488  
    8787
    8888    /**
    89      * Filter the taxonomy terms checklist arguments.
     89     * Filters the taxonomy terms checklist arguments.
    9090     *
    9191     * @since 3.4.0
     
    355355    global $wp_list_table;
    356356    /**
    357      * Filter the in-line comment reply-to form output in the Comments
     357     * Filters the in-line comment reply-to form output in the Comments
    358358     * list table.
    359359     *
     
    583583
    584584    /**
    585      * Filter values for the meta key dropdown in the Custom Fields meta box.
     585     * Filters values for the meta key dropdown in the Custom Fields meta box.
    586586     *
    587587     * Returning a non-null value will effectively short-circuit and avoid a
     
    597597    if ( null === $keys ) {
    598598        /**
    599          * Filter the number of custom fields to retrieve for the drop-down
     599         * Filters the number of custom fields to retrieve for the drop-down
    600600         * in the Custom Fields meta box.
    601601         *
     
    844844
    845845    /**
    846      * Filter the maximum allowed upload size for import files.
     846     * Filters the maximum allowed upload size for import files.
    847847     *
    848848     * @since 2.3.0
     
    17131713
    17141714    /**
    1715      * Filter the default post display states used in the posts list table.
     1715     * Filters the default post display states used in the posts list table.
    17161716     *
    17171717     * @since 2.8.0
     
    17641764
    17651765    /**
    1766      * Filter the default media display states for items in the Media list table.
     1766     * Filters the default media display states for items in the Media list table.
    17671767     *
    17681768     * @since 3.2.0
  • trunk/src/wp-admin/includes/theme.php

    r37287 r37488  
    312312 *
    313313 * It is possible for a theme to override the Themes API result with three
    314  * filters. Assume this is for themes, which can extend on the Theme Info to
     314 * Filterss. Assume this is for themes, which can extend on the Theme Info to
    315315 * offer more choices. This is very powerful and must be used with care, when
    316316 * overriding the filters.
     
    404404
    405405    /**
    406      * Filter arguments used to query for installer pages from the WordPress.org Themes API.
     406     * Filters arguments used to query for installer pages from the WordPress.org Themes API.
    407407     *
    408408     * Important: An object MUST be returned to this filter.
     
    417417
    418418    /**
    419      * Filter whether to override the WordPress.org Themes API.
     419     * Filters whether to override the WordPress.org Themes API.
    420420     *
    421421     * Passing a non-false value will effectively short-circuit the WordPress.org API request.
     
    463463
    464464    /**
    465      * Filter the returned WordPress.org Themes API response.
     465     * Filters the returned WordPress.org Themes API response.
    466466     *
    467467     * @since 2.8.0
     
    489489
    490490    /**
    491      * Filter theme data before it is prepared for JavaScript.
     491     * Filters theme data before it is prepared for JavaScript.
    492492     *
    493493     * Passing a non-empty array will result in wp_prepare_themes_for_js() returning
     
    575575
    576576    /**
    577      * Filter the themes prepared for JavaScript, for themes.php.
     577     * Filters the themes prepared for JavaScript, for themes.php.
    578578     *
    579579     * Could be useful for changing the order, which is by name by default.
  • trunk/src/wp-admin/includes/translation-install.php

    r34828 r37488  
    7373
    7474    /**
    75      * Filter the Translation Install API response results.
     75     * Filters the Translation Install API response results.
    7676     *
    7777     * @since 4.0.0
  • trunk/src/wp-admin/includes/update-core.php

    r37485 r37488  
    804804
    805805    /**
    806      * Filter feedback messages displayed during the core update process.
     806     * Filters feedback messages displayed during the core update process.
    807807     *
    808808     * The filter is first evaluated after the zip file for the latest version
  • trunk/src/wp-admin/includes/update.php

    r36964 r37488  
    259259
    260260    /**
    261      * Filter the text displayed in the 'At a Glance' dashboard widget.
     261     * Filters the text displayed in the 'At a Glance' dashboard widget.
    262262     *
    263263     * Prior to 3.8.0, the widget was named 'Right Now'.
  • trunk/src/wp-admin/includes/upgrade.php

    r36985 r37488  
    20482048
    20492049/**
    2050  * Filters for content to remove unnecessary slashes.
     2050 * Filterss for content to remove unnecessary slashes.
    20512051 *
    20522052 * @since 1.5.0
     
    21052105
    21062106    /**
    2107      * Filter the dbDelta SQL queries.
     2107     * Filters the dbDelta SQL queries.
    21082108     *
    21092109     * @since 3.3.0
     
    21342134
    21352135    /**
    2136      * Filter the dbDelta SQL queries for creating tables and/or databases.
     2136     * Filters the dbDelta SQL queries for creating tables and/or databases.
    21372137     *
    21382138     * Queries filterable via this hook contain "CREATE TABLE" or "CREATE DATABASE".
     
    21452145
    21462146    /**
    2147      * Filter the dbDelta SQL queries for inserting or updating.
     2147     * Filters the dbDelta SQL queries for inserting or updating.
    21482148     *
    21492149     * Queries filterable via this hook contain "INSERT INTO" or "UPDATE".
     
    27832783
    27842784    /**
    2785      * Filter if upgrade routines should be run on global tables.
     2785     * Filters if upgrade routines should be run on global tables.
    27862786     *
    27872787     * @param bool $should_upgrade Whether to run the upgrade routines on global tables.
  • trunk/src/wp-admin/includes/user.php

    r37342 r37488  
    219219
    220220    /**
    221      * Filter the list of editable roles.
     221     * Filters the list of editable roles.
    222222     *
    223223     * @since 2.8.0
     
    262262
    263263    /**
    264      * Filter the user's drafts query string.
     264     * Filters the user's drafts query string.
    265265     *
    266266     * @since 2.0.0
     
    330330
    331331        /**
    332          * Filter the list of post types to delete with a user.
     332         * Filters the list of post types to delete with a user.
    333333         *
    334334         * @since 3.4.0
  • trunk/src/wp-admin/maint/repair.php

    r35837 r37488  
    8181
    8282    /**
    83      * Filter additional database tables to repair.
     83     * Filters additional database tables to repair.
    8484     *
    8585     * @since 3.0.0
  • trunk/src/wp-admin/media-upload.php

    r33853 r37488  
    5454} else {
    5555    /**
    56      * Filter the default media upload type in the legacy (pre-3.5.0) media popup.
     56     * Filters the default media upload type in the legacy (pre-3.5.0) media popup.
    5757     *
    5858     * @since 2.5.0
     
    6969} else {
    7070    /**
    71      * Filter the default tab in the legacy (pre-3.5.0) media popup.
     71     * Filters the default tab in the legacy (pre-3.5.0) media popup.
    7272     *
    7373     * @since 2.5.0
  • trunk/src/wp-admin/menu-header.php

    r36970 r37488  
    2828
    2929/**
    30  * Filter the parent file of an admin menu sub-menu item.
     30 * Filters the parent file of an admin menu sub-menu item.
    3131 *
    3232 * Allows plugins to move sub-menu items around.
     
    3939
    4040/**
    41  * Filter the file of an admin menu sub-menu item.
     41 * Filters the file of an admin menu sub-menu item.
    4242 *
    4343 * @since 4.4.0
  • trunk/src/wp-admin/ms-delete-site.php

    r33029 r37488  
    6161###SITE_NAME###" );
    6262    /**
    63      * Filter the email content sent when a site in a Multisite network is deleted.
     63     * Filters the email content sent when a site in a Multisite network is deleted.
    6464     *
    6565     * @since 3.0.0
  • trunk/src/wp-admin/my-sites.php

    r36709 r37488  
    110110        echo "<h3>{$user_blog->blogname}</h3>";
    111111        /**
    112          * Filter the row links displayed for each site on the My Sites screen.
     112         * Filters the row links displayed for each site on the My Sites screen.
    113113         *
    114114         * @since MU
  • trunk/src/wp-admin/nav-menus.php

    r36852 r37488  
    712712
    713713                            /**
    714                              * Filter the number of locations listed per menu in the drop-down select.
     714                             * Filters the number of locations listed per menu in the drop-down select.
    715715                             *
    716716                             * @since 3.6.0
  • trunk/src/wp-admin/network/admin.php

    r28083 r37488  
    1919
    2020/**
    21  * Filter whether to redirect the request to the Network Admin.
     21 * Filters whether to redirect the request to the Network Admin.
    2222 *
    2323 * @since 3.2.0
  • trunk/src/wp-admin/network/settings.php

    r37124 r37488  
    348348            $menu_perms = get_site_option( 'menu_items' );
    349349            /**
    350              * Filter available network-wide administration menu options.
     350             * Filters available network-wide administration menu options.
    351351             *
    352352             * Options returned to this filter are output as individual checkboxes that, when selected,
  • trunk/src/wp-admin/network/site-users.php

    r37466 r37488  
    186186
    187187/**
    188  * Filter whether to show the Add Existing User form on the Multisite Users screen.
     188 * Filters whether to show the Add Existing User form on the Multisite Users screen.
    189189 *
    190190 * @since 3.1.0
     
    293293<?php
    294294/**
    295  * Filter whether to show the Add New User form on the Multisite Users screen.
     295 * Filters whether to show the Add New User form on the Multisite Users screen.
    296296 *
    297297 * @since 3.1.0
  • trunk/src/wp-admin/network/sites.php

    r36709 r37488  
    260260        default:
    261261            /**
    262              * Filter a specific, non-default site-updated message in the Network admin.
     262             * Filters a specific, non-default site-updated message in the Network admin.
    263263             *
    264264             * The dynamic portion of the hook name, `$_GET['updated']`, refers to the
  • trunk/src/wp-admin/options-discussion.php

    r37227 r37488  
    7979<?php
    8080/**
    81  * Filter the maximum depth of threaded/nested comments.
     81 * Filters the maximum depth of threaded/nested comments.
    8282 *
    8383 * @since 2.7.0.
     
    230230);
    231231/**
    232  * Filter the default avatars.
     232 * Filters the default avatars.
    233233 *
    234234 * Avatars are stored in key/value pairs, where the key is option value,
     
    257257
    258258/**
    259  * Filter the HTML output of the default avatar list.
     259 * Filters the HTML output of the default avatar list.
    260260 *
    261261 * @since 2.6.0
  • trunk/src/wp-admin/options-general.php

    r36656 r37488  
    232232<?php
    233233    /**
    234     * Filter the default date formats.
     234    * Filters the default date formats.
    235235    *
    236236    * @since 2.7.0
     
    269269<?php
    270270    /**
    271     * Filter the default time formats.
     271    * Filters the default time formats.
    272272    *
    273273    * @since 2.7.0
  • trunk/src/wp-admin/options-writing.php

    r37198 r37488  
    157157<?php
    158158/**
    159  * Filter whether to enable the Update Services section in the Writing settings screen.
     159 * Filters whether to enable the Update Services section in the Writing settings screen.
    160160 *
    161161 * @since 3.0.0
  • trunk/src/wp-admin/options.php

    r37435 r37488  
    3333
    3434    /**
    35      * Filter the capability required when using the Settings API.
     35     * Filters the capability required when using the Settings API.
    3636     *
    3737     * By default, the options groups for all registered settings require the manage_options capability.
     
    125125
    126126    /**
    127      * Filter whether the post-by-email functionality is enabled.
     127     * Filters whether the post-by-email functionality is enabled.
    128128     *
    129129     * @since 3.0.0
     
    136136
    137137/**
    138  * Filter the options white list.
     138 * Filters the options white list.
    139139 *
    140140 * @since 2.7.0
  • trunk/src/wp-admin/plugin-editor.php

    r35107 r37488  
    107107
    108108    /**
    109      * Filter file type extensions editable in the plugin editor.
     109     * Filters file type extensions editable in the plugin editor.
    110110     *
    111111     * @since 2.8.0
  • trunk/src/wp-admin/theme-editor.php

    r35180 r37488  
    6767
    6868/**
    69  * Filter the list of file types allowed for editing in the Theme editor.
     69 * Filters the list of file types allowed for editing in the Theme editor.
    7070 *
    7171 * @since 4.4.0
  • trunk/src/wp-admin/theme-install.php

    r37431 r37488  
    117117
    118118    /**
    119      * Filter the tabs shown on the Add Themes screen.
     119     * Filters the tabs shown on the Add Themes screen.
    120120     *
    121121     * This filter is for backward compatibility only, for the suppression of the upload tab.
  • trunk/src/wp-admin/user-edit.php

    r37103 r37488  
    6161
    6262/**
    63  * Filter whether to allow administrators on Multisite to edit every user.
     63 * Filters whether to allow administrators on Multisite to edit every user.
    6464 *
    6565 * Enabling the user editing form via this filter also hinges on the user holding
     
    427427        <?php
    428428        /**
    429          * Filter a user contactmethod label.
     429         * Filters a user contactmethod label.
    430430         *
    431431         * The dynamic portion of the filter hook, `$name`, refers to
     
    471471
    472472            /**
    473              * Filter the user profile picture description displayed under the Gravatar.
     473             * Filters the user profile picture description displayed under the Gravatar.
    474474             *
    475475             * @since 4.4.0
     
    485485<?php
    486486/**
    487  * Filter the display of the password fields.
     487 * Filters the display of the password fields.
    488488 *
    489489 * @since 1.5.1
     
    602602<?php
    603603/**
    604  * Filter whether to display additional capabilities for the user.
     604 * Filters whether to display additional capabilities for the user.
    605605 *
    606606 * The 'Additional Capabilities' section will only be enabled if
  • trunk/src/wp-admin/user-new.php

    r36697 r37488  
    134134        } else {
    135135            /**
    136              * Filter the user_login, also known as the username, before it is added to the site.
     136             * Filters the user_login, also known as the username, before it is added to the site.
    137137             *
    138138             * @since 2.0.3
     
    211211
    212212/**
    213  * Filter whether to enable user auto-complete for non-super admins in Multisite.
     213 * Filters whether to enable user auto-complete for non-super admins in Multisite.
    214214 *
    215215 * @since 3.4.0
  • trunk/src/wp-admin/user/admin.php

    r28083 r37488  
    1919$redirect_user_admin_request = ( ( $current_blog->domain != $current_site->domain ) || ( $current_blog->path != $current_site->path ) );
    2020/**
    21  * Filter whether to redirect the request to the User Admin in Multisite.
     21 * Filters whether to redirect the request to the User Admin in Multisite.
    2222 *
    2323 * @since 3.2.0
Note: See TracChangeset for help on using the changeset viewer.