From c3055cc190a4b09131e12a88c7f904f9f1079066 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 22 May 2016 18:01:30 +0000 Subject: [PATCH] Docs: Standardize hook docs in wp-admin/* to use third-person singular verbs per the inline documentation standards for PHP. See #36913. Built from https://develop.svn.wordpress.org/trunk@37488 git-svn-id: http://core.svn.wordpress.org/trunk@37456 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/admin-footer.php | 4 +- wp-admin/admin-header.php | 4 +- wp-admin/admin.php | 4 +- wp-admin/async-upload.php | 2 +- wp-admin/comment.php | 2 +- wp-admin/custom-header.php | 2 +- wp-admin/edit-form-advanced.php | 6 +-- wp-admin/edit-form-comment.php | 2 +- wp-admin/edit-tag-form.php | 2 +- wp-admin/edit-tags.php | 2 +- wp-admin/edit.php | 2 +- wp-admin/export.php | 2 +- wp-admin/includes/ajax-actions.php | 18 +++---- .../class-bulk-plugin-upgrader-skin.php | 2 +- .../class-bulk-theme-upgrader-skin.php | 2 +- wp-admin/includes/class-core-upgrader.php | 6 +-- .../class-language-pack-upgrader-skin.php | 2 +- .../includes/class-language-pack-upgrader.php | 2 +- .../includes/class-plugin-installer-skin.php | 2 +- .../includes/class-plugin-upgrader-skin.php | 2 +- .../includes/class-theme-installer-skin.php | 2 +- .../includes/class-theme-upgrader-skin.php | 2 +- .../includes/class-wp-automatic-upgrader.php | 16 +++---- .../includes/class-wp-comments-list-table.php | 6 +-- wp-admin/includes/class-wp-list-table.php | 14 +++--- .../includes/class-wp-media-list-table.php | 6 +-- .../includes/class-wp-ms-sites-list-table.php | 4 +- .../class-wp-ms-themes-list-table.php | 8 ++-- .../includes/class-wp-ms-users-list-table.php | 6 +-- .../class-wp-plugin-install-list-table.php | 8 ++-- .../includes/class-wp-plugins-list-table.php | 16 +++---- .../includes/class-wp-posts-list-table.php | 18 +++---- wp-admin/includes/class-wp-press-this.php | 12 ++--- wp-admin/includes/class-wp-screen.php | 18 +++---- wp-admin/includes/class-wp-site-icon.php | 4 +- .../includes/class-wp-terms-list-table.php | 14 +++--- .../class-wp-theme-install-list-table.php | 6 +-- wp-admin/includes/class-wp-upgrader.php | 12 ++--- .../includes/class-wp-users-list-table.php | 10 ++-- wp-admin/includes/comment.php | 2 +- wp-admin/includes/dashboard.php | 34 ++++++------- wp-admin/includes/edit-tag-messages.php | 2 +- wp-admin/includes/export.php | 12 ++--- wp-admin/includes/file.php | 14 +++--- wp-admin/includes/image-edit.php | 12 ++--- wp-admin/includes/image.php | 20 ++++---- wp-admin/includes/media.php | 48 +++++++++---------- wp-admin/includes/menu.php | 6 +-- wp-admin/includes/meta-boxes.php | 6 +-- wp-admin/includes/misc.php | 8 ++-- wp-admin/includes/ms.php | 16 +++---- wp-admin/includes/nav-menu.php | 8 ++-- wp-admin/includes/network.php | 2 +- wp-admin/includes/plugin-install.php | 6 +-- wp-admin/includes/post.php | 28 +++++------ wp-admin/includes/revision.php | 8 ++-- wp-admin/includes/schema.php | 2 +- wp-admin/includes/screen.php | 10 ++-- wp-admin/includes/taxonomy.php | 2 +- wp-admin/includes/template.php | 14 +++--- wp-admin/includes/theme.php | 12 ++--- wp-admin/includes/translation-install.php | 2 +- wp-admin/includes/update-core.php | 2 +- wp-admin/includes/update.php | 2 +- wp-admin/includes/upgrade.php | 10 ++-- wp-admin/includes/user.php | 6 +-- wp-admin/maint/repair.php | 2 +- wp-admin/media-upload.php | 4 +- wp-admin/menu-header.php | 4 +- wp-admin/ms-delete-site.php | 2 +- wp-admin/my-sites.php | 2 +- wp-admin/nav-menus.php | 2 +- wp-admin/network/admin.php | 2 +- wp-admin/network/settings.php | 2 +- wp-admin/network/site-users.php | 4 +- wp-admin/network/sites.php | 2 +- wp-admin/options-discussion.php | 6 +-- wp-admin/options-general.php | 4 +- wp-admin/options-writing.php | 2 +- wp-admin/options.php | 6 +-- wp-admin/plugin-editor.php | 2 +- wp-admin/theme-editor.php | 2 +- wp-admin/theme-install.php | 2 +- wp-admin/user-edit.php | 10 ++-- wp-admin/user-new.php | 4 +- wp-admin/user/admin.php | 2 +- wp-includes/version.php | 2 +- 87 files changed, 307 insertions(+), 307 deletions(-) diff --git a/wp-admin/admin-footer.php b/wp-admin/admin-footer.php index 922ce9e308..3f40130639 100644 --- a/wp-admin/admin-footer.php +++ b/wp-admin/admin-footer.php @@ -33,7 +33,7 @@ global $hook_suffix; WordPress.' ), __( 'https://wordpress.org/' ) ); /** - * Filter the "Thank you" text displayed in the admin footer. + * Filters the "Thank you" text displayed in the admin footer. * * @since 2.8.0 * @@ -45,7 +45,7 @@ global $hook_suffix;
' ) ) { /** - * Filter whether to enable major automatic core updates. + * Filters whether to enable major automatic core updates. * * @since 3.7.0 * diff --git a/wp-admin/includes/class-language-pack-upgrader-skin.php b/wp-admin/includes/class-language-pack-upgrader-skin.php index d368844ede..7c86bbeb83 100644 --- a/wp-admin/includes/class-language-pack-upgrader-skin.php +++ b/wp-admin/includes/class-language-pack-upgrader-skin.php @@ -71,7 +71,7 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin { $update_actions['updates_page'] = '' . __( 'Return to WordPress Updates page' ) . ''; /** - * Filter the list of action links available following a translations update. + * Filters the list of action links available following a translations update. * * @since 3.7.0 * diff --git a/wp-admin/includes/class-language-pack-upgrader.php b/wp-admin/includes/class-language-pack-upgrader.php index 04ba25a333..c554a34684 100644 --- a/wp-admin/includes/class-language-pack-upgrader.php +++ b/wp-admin/includes/class-language-pack-upgrader.php @@ -75,7 +75,7 @@ class Language_Pack_Upgrader extends WP_Upgrader { $update = ! empty( $language_update->autoupdate ); /** - * Filter whether to asynchronously update translation for core, a plugin, or a theme. + * Filters whether to asynchronously update translation for core, a plugin, or a theme. * * @since 4.0.0 * diff --git a/wp-admin/includes/class-plugin-installer-skin.php b/wp-admin/includes/class-plugin-installer-skin.php index a6df939a4b..544da97d34 100644 --- a/wp-admin/includes/class-plugin-installer-skin.php +++ b/wp-admin/includes/class-plugin-installer-skin.php @@ -76,7 +76,7 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin { } /** - * Filter the list of action links available following a single plugin installation. + * Filters the list of action links available following a single plugin installation. * * @since 2.7.0 * diff --git a/wp-admin/includes/class-plugin-upgrader-skin.php b/wp-admin/includes/class-plugin-upgrader-skin.php index cdb0b225db..df685ab6b5 100644 --- a/wp-admin/includes/class-plugin-upgrader-skin.php +++ b/wp-admin/includes/class-plugin-upgrader-skin.php @@ -54,7 +54,7 @@ class Plugin_Upgrader_Skin extends WP_Upgrader_Skin { unset( $update_actions['activate_plugin'] ); /** - * Filter the list of action links available following a single plugin update. + * Filters the list of action links available following a single plugin update. * * @since 2.7.0 * diff --git a/wp-admin/includes/class-theme-installer-skin.php b/wp-admin/includes/class-theme-installer-skin.php index c244fbb0ac..52281575cb 100644 --- a/wp-admin/includes/class-theme-installer-skin.php +++ b/wp-admin/includes/class-theme-installer-skin.php @@ -80,7 +80,7 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { unset( $install_actions['activate'], $install_actions['preview'] ); /** - * Filter the list of action links available following a single theme installation. + * Filters the list of action links available following a single theme installation. * * @since 2.8.0 * diff --git a/wp-admin/includes/class-theme-upgrader-skin.php b/wp-admin/includes/class-theme-upgrader-skin.php index 1c98b7cc38..e97c65b458 100644 --- a/wp-admin/includes/class-theme-upgrader-skin.php +++ b/wp-admin/includes/class-theme-upgrader-skin.php @@ -66,7 +66,7 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin { $update_actions['themes_page'] = '' . __( 'Return to Themes page' ) . ''; /** - * Filter the list of action links available following a single theme update. + * Filters the list of action links available following a single theme update. * * @since 2.8.0 * diff --git a/wp-admin/includes/class-wp-automatic-upgrader.php b/wp-admin/includes/class-wp-automatic-upgrader.php index 098f992132..1219939414 100644 --- a/wp-admin/includes/class-wp-automatic-upgrader.php +++ b/wp-admin/includes/class-wp-automatic-upgrader.php @@ -41,7 +41,7 @@ class WP_Automatic_Updater { $disabled = defined( 'AUTOMATIC_UPDATER_DISABLED' ) && AUTOMATIC_UPDATER_DISABLED; /** - * Filter whether to entirely disable background updates. + * Filters whether to entirely disable background updates. * * There are more fine-grained filters and controls for selective disabling. * This filter parallels the AUTOMATIC_UPDATER_DISABLED constant in name. @@ -104,7 +104,7 @@ class WP_Automatic_Updater { } /** - * Filter whether the automatic updater should consider a filesystem + * Filters whether the automatic updater should consider a filesystem * location to be potentially managed by a version control system. * * @since 3.7.0 @@ -158,7 +158,7 @@ class WP_Automatic_Updater { $update = ! empty( $item->autoupdate ); /** - * Filter whether to automatically update core, a plugin, a theme, or a language. + * Filters whether to automatically update core, a plugin, a theme, or a language. * * The dynamic portion of the hook name, `$type`, refers to the type of update * being checked. Can be 'core', 'theme', 'plugin', or 'translation'. @@ -220,7 +220,7 @@ class WP_Automatic_Updater { $notify = ! empty( $item->notify_email ); /** - * Filter whether to notify the site administrator of a new core update. + * Filters whether to notify the site administrator of a new core update. * * By default, administrators are notified when the update offer received * from WordPress.org sets a particular flag. This allows some discretion @@ -460,7 +460,7 @@ class WP_Automatic_Updater { $development_version = false !== strpos( $wp_version, '-' ); /** - * Filter whether to send a debugging email for each automatic background update. + * Filters whether to send a debugging email for each automatic background update. * * @since 3.7.0 * @@ -605,7 +605,7 @@ class WP_Automatic_Updater { $newer_version_available = ( 'upgrade' == $next_user_core_update->response && version_compare( $next_user_core_update->version, $core_update->version, '>' ) ); /** - * Filter whether to send an email following an automatic background core update. + * Filters whether to send an email following an automatic background core update. * * @since 3.7.0 * @@ -755,7 +755,7 @@ class WP_Automatic_Updater { $email = compact( 'to', 'subject', 'body', 'headers' ); /** - * Filter the email sent following an automatic background core update. + * Filters the email sent following an automatic background core update. * * @since 3.7.0 * @@ -908,7 +908,7 @@ Thanks! -- The WordPress Team" ) ); ); /** - * Filter the debug email that can be sent following an automatic + * Filters the debug email that can be sent following an automatic * background core update. * * @since 3.8.0 diff --git a/wp-admin/includes/class-wp-comments-list-table.php b/wp-admin/includes/class-wp-comments-list-table.php index a5f96939d5..b1f6f542ff 100644 --- a/wp-admin/includes/class-wp-comments-list-table.php +++ b/wp-admin/includes/class-wp-comments-list-table.php @@ -166,7 +166,7 @@ class WP_Comments_List_Table extends WP_List_Table { public function get_per_page( $comment_status = 'all' ) { $comments_per_page = $this->get_items_per_page( 'edit_comments_per_page' ); /** - * Filter the number of comments listed per page in the comments list table. + * Filters the number of comments listed per page in the comments list table. * * @since 2.6.0 * @@ -270,7 +270,7 @@ class WP_Comments_List_Table extends WP_List_Table { } /** - * Filter the comment status links. + * Filters the comment status links. * * @since 2.5.0 * @@ -330,7 +330,7 @@ class WP_Comments_List_Table extends WP_List_Table { get_views(); /** - * Filter the list of available list table views. + * Filters the list of available list table views. * * The dynamic portion of the hook name, `$this->screen->id`, refers * to the ID of the current screen, usually a string. @@ -438,7 +438,7 @@ class WP_List_Table { if ( is_null( $this->_actions ) ) { $no_new_actions = $this->_actions = $this->get_bulk_actions(); /** - * Filter the list table Bulk Actions drop-down. + * Filters the list table Bulk Actions drop-down. * * The dynamic portion of the hook name, `$this->screen->id`, refers * to the ID of the current screen, usually a string. @@ -541,7 +541,7 @@ class WP_List_Table { global $wpdb, $wp_locale; /** - * Filter whether to remove the 'Months' drop-down from the post list table. + * Filters whether to remove the 'Months' drop-down from the post list table. * * @since 4.2.0 * @@ -568,7 +568,7 @@ class WP_List_Table { ", $post_type ) ); /** - * Filter the 'Months' drop-down results. + * Filters the 'Months' drop-down results. * * @since 3.7.0 * @@ -721,7 +721,7 @@ class WP_List_Table { $per_page = $default; /** - * Filter the number of items to be displayed on each page of the list table. + * Filters the number of items to be displayed on each page of the list table. * * The dynamic hook name, $option, refers to the `per_page` option depending * on the type of list table in use. Possible values include: 'edit_comments_per_page', @@ -951,7 +951,7 @@ class WP_List_Table { } /** - * Filter the name of the primary column for the current list table. + * Filters the name of the primary column for the current list table. * * @since 4.3.0 * @@ -993,7 +993,7 @@ class WP_List_Table { $sortable_columns = $this->get_sortable_columns(); /** - * Filter the list table sortable columns for a specific screen. + * Filters the list table sortable columns for a specific screen. * * The dynamic portion of the hook name, `$this->screen->id`, refers * to the ID of the current screen, usually a string. diff --git a/wp-admin/includes/class-wp-media-list-table.php b/wp-admin/includes/class-wp-media-list-table.php index 98deaac8c9..3a61f159bc 100644 --- a/wp-admin/includes/class-wp-media-list-table.php +++ b/wp-admin/includes/class-wp-media-list-table.php @@ -282,7 +282,7 @@ class WP_Media_List_Table extends WP_List_Table { $taxonomies = wp_filter_object_list( $taxonomies, array( 'show_admin_column' => true ), 'and', 'name' ); /** - * Filter the taxonomy columns for attachments in the Media list table. + * Filters the taxonomy columns for attachments in the Media list table. * * @since 3.5.0 * @@ -312,7 +312,7 @@ class WP_Media_List_Table extends WP_List_Table { /* translators: column name */ $posts_columns['date'] = _x( 'Date', 'column name' ); /** - * Filter the Media list table columns. + * Filters the Media list table columns. * * @since 2.5.0 * @@ -745,7 +745,7 @@ class WP_Media_List_Table extends WP_List_Table { } /** - * Filter the action links for each attachment in the Media list table. + * Filters the action links for each attachment in the Media list table. * * @since 2.8.0 * diff --git a/wp-admin/includes/class-wp-ms-sites-list-table.php b/wp-admin/includes/class-wp-ms-sites-list-table.php index 9dd1d38f2d..148388afb0 100644 --- a/wp-admin/includes/class-wp-ms-sites-list-table.php +++ b/wp-admin/includes/class-wp-ms-sites-list-table.php @@ -224,7 +224,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table { } /** - * Filter the displayed site columns in Sites list table. + * Filters the displayed site columns in Sites list table. * * @since MU * @@ -531,7 +531,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table { $actions['visit'] = "" . __( 'Visit' ) . ''; /** - * Filter the action links displayed for each site in the Sites list table. + * Filters the action links displayed for each site in the Sites list table. * * The 'Edit', 'Dashboard', 'Delete', and 'Visit' links are displayed by * default for each site. The site's status determines whether to show the diff --git a/wp-admin/includes/class-wp-ms-themes-list-table.php b/wp-admin/includes/class-wp-ms-themes-list-table.php index 825c047672..e0c856d6b7 100644 --- a/wp-admin/includes/class-wp-ms-themes-list-table.php +++ b/wp-admin/includes/class-wp-ms-themes-list-table.php @@ -91,7 +91,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table { $themes = array( /** - * Filter the full array of WP_Theme objects to list in the Multisite + * Filters the full array of WP_Theme objects to list in the Multisite * themes list table. * * @since 3.1.0 @@ -477,7 +477,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table { ); } /** - * Filter the action links displayed for each theme in the Multisite + * Filters the action links displayed for each theme in the Multisite * themes list table. * * The action links displayed are determined by the theme's status, and @@ -501,7 +501,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table { $actions = apply_filters( 'theme_action_links', array_filter( $actions ), $theme, $context ); /** - * Filter the action links of a specific theme in the Multisite themes + * Filters the action links of a specific theme in the Multisite themes * list table. * * The dynamic portion of the hook name, `$stylesheet`, refers to the @@ -569,7 +569,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table { ); } /** - * Filter the array of row meta for each theme in the Multisite themes + * Filters the array of row meta for each theme in the Multisite themes * list table. * * @since 3.1.0 diff --git a/wp-admin/includes/class-wp-ms-users-list-table.php b/wp-admin/includes/class-wp-ms-users-list-table.php index 380e4a02d3..da00131bcd 100644 --- a/wp-admin/includes/class-wp-ms-users-list-table.php +++ b/wp-admin/includes/class-wp-ms-users-list-table.php @@ -172,7 +172,7 @@ class WP_MS_Users_List_Table extends WP_List_Table { 'blogs' => __( 'Sites' ) ); /** - * Filter the columns displayed in the Network Admin Users list table. + * Filters the columns displayed in the Network Admin Users list table. * * @since MU * @@ -351,7 +351,7 @@ class WP_MS_Users_List_Table extends WP_List_Table { $actions['view'] = '' . __( 'View' ) . ''; /** - * Filter the action links displayed next the sites a user belongs to + * Filters the action links displayed next the sites a user belongs to * in the Network Admin Users list table. * * @since 3.1.0 @@ -446,7 +446,7 @@ class WP_MS_Users_List_Table extends WP_List_Table { } /** - * Filter the action links displayed under each user in the Network Admin Users list table. + * Filters the action links displayed under each user in the Network Admin Users list table. * * @since 3.2.0 * diff --git a/wp-admin/includes/class-wp-plugin-install-list-table.php b/wp-admin/includes/class-wp-plugin-install-list-table.php index 26c8a0a21b..c16786242e 100644 --- a/wp-admin/includes/class-wp-plugin-install-list-table.php +++ b/wp-admin/includes/class-wp-plugin-install-list-table.php @@ -104,7 +104,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table { $nonmenu_tabs = array( 'plugin-information' ); // Valid actions to perform which do not have a Menu item. /** - * Filter the tabs shown on the Plugin Install screen. + * Filters the tabs shown on the Plugin Install screen. * * @since 2.7.0 * @@ -114,7 +114,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table { $tabs = apply_filters( 'install_plugins_tabs', $tabs ); /** - * Filter tabs not associated with a menu item on the Plugin Install screen. + * Filters tabs not associated with a menu item on the Plugin Install screen. * * @since 2.7.0 * @@ -191,7 +191,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table { } /** - * Filter API request arguments for each Plugin Install screen tab. + * Filters API request arguments for each Plugin Install screen tab. * * The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs. * Default tabs include 'featured', 'popular', 'recommended', 'favorites', and 'upload'. @@ -494,7 +494,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table { } /** - * Filter the install action links for a plugin. + * Filters the install action links for a plugin. * * @since 2.7.0 * diff --git a/wp-admin/includes/class-wp-plugins-list-table.php b/wp-admin/includes/class-wp-plugins-list-table.php index f49d1c8697..961775d093 100644 --- a/wp-admin/includes/class-wp-plugins-list-table.php +++ b/wp-admin/includes/class-wp-plugins-list-table.php @@ -78,7 +78,7 @@ class WP_Plugins_List_Table extends WP_List_Table { wp_reset_vars( array( 'orderby', 'order' ) ); /** - * Filters the full array of plugins to list in the Plugins list table. + * Filterss the full array of plugins to list in the Plugins list table. * * @since 3.0.0 * @@ -104,7 +104,7 @@ class WP_Plugins_List_Table extends WP_List_Table { if ( ! is_multisite() || ( $screen->in_admin( 'network' ) && current_user_can( 'manage_network_plugins' ) ) ) { /** - * Filter whether to display the advanced plugins list table. + * Filters whether to display the advanced plugins list table. * * There are two types of advanced plugins - must-use and drop-ins - * which can be used in a single site or Multisite network. @@ -140,7 +140,7 @@ class WP_Plugins_List_Table extends WP_List_Table { if ( ! $screen->in_admin( 'network' ) ) { $show = current_user_can( 'manage_network_plugins' ); /** - * Filter whether to display network-active plugins alongside plugins active for the current site. + * Filters whether to display network-active plugins alongside plugins active for the current site. * * This also controls the display of inactive network-only plugins (plugins with * "Network: true" in the plugin header). @@ -607,7 +607,7 @@ class WP_Plugins_List_Table extends WP_List_Table { if ( $screen->in_admin( 'network' ) ) { /** - * Filter the action links displayed for each plugin in the Network Admin Plugins list table. + * Filters the action links displayed for each plugin in the Network Admin Plugins list table. * * The default action links for the Network plugins list table include * 'Network Activate', 'Network Deactivate', 'Edit', and 'Delete'. @@ -625,7 +625,7 @@ class WP_Plugins_List_Table extends WP_List_Table { $actions = apply_filters( 'network_admin_plugin_action_links', $actions, $plugin_file, $plugin_data, $context ); /** - * Filter the list of action links displayed for a specific plugin in the Network Admin Plugins list table. + * Filters the list of action links displayed for a specific plugin in the Network Admin Plugins list table. * * The dynamic portion of the hook name, $plugin_file, refers to the path * to the plugin file, relative to the plugins directory. @@ -645,7 +645,7 @@ class WP_Plugins_List_Table extends WP_List_Table { } else { /** - * Filter the action links displayed for each plugin in the Plugins list table. + * Filters the action links displayed for each plugin in the Plugins list table. * * The default action links for the site plugins list table include * 'Activate', 'Deactivate', and 'Edit', for a network site, and @@ -664,7 +664,7 @@ class WP_Plugins_List_Table extends WP_List_Table { $actions = apply_filters( 'plugin_action_links', $actions, $plugin_file, $plugin_data, $context ); /** - * Filter the list of action links displayed for a specific plugin in the Plugins list table. + * Filters the list of action links displayed for a specific plugin in the Plugins list table. * * The dynamic portion of the hook name, $plugin_file, refers to the path * to the plugin file, relative to the plugins directory. @@ -757,7 +757,7 @@ class WP_Plugins_List_Table extends WP_List_Table { } /** - * Filter the array of row meta for each plugin in the Plugins list table. + * Filters the array of row meta for each plugin in the Plugins list table. * * @since 2.8.0 * diff --git a/wp-admin/includes/class-wp-posts-list-table.php b/wp-admin/includes/class-wp-posts-list-table.php index 15c4b05bb2..d6f4d9c0c3 100644 --- a/wp-admin/includes/class-wp-posts-list-table.php +++ b/wp-admin/includes/class-wp-posts-list-table.php @@ -515,7 +515,7 @@ class WP_Posts_List_Table extends WP_List_Table { $taxonomies = wp_filter_object_list( $taxonomies, array( 'show_admin_column' => true ), 'and', 'name' ); /** - * Filter the taxonomy columns in the Posts list table. + * Filters the taxonomy columns in the Posts list table. * * The dynamic portion of the hook name, `$post_type`, refers to the post * type slug. @@ -548,7 +548,7 @@ class WP_Posts_List_Table extends WP_List_Table { if ( 'page' === $post_type ) { /** - * Filter the columns displayed in the Pages list table. + * Filters the columns displayed in the Pages list table. * * @since 2.5.0 * @@ -558,7 +558,7 @@ class WP_Posts_List_Table extends WP_List_Table { } else { /** - * Filter the columns displayed in the Posts list table. + * Filters the columns displayed in the Posts list table. * * @since 1.5.0 * @@ -569,7 +569,7 @@ class WP_Posts_List_Table extends WP_List_Table { } /** - * Filter the columns displayed in the Posts list table for a specific post type. + * Filters the columns displayed in the Posts list table for a specific post type. * * The dynamic portion of the hook name, `$post_type`, refers to the post type slug. * @@ -964,7 +964,7 @@ class WP_Posts_List_Table extends WP_List_Table { echo '
'; if ( 'excerpt' === $mode ) { /** - * Filter the published time of the post. + * Filters the published time of the post. * * If `$mode` equals 'excerpt', the published time and date are both displayed. * If `$mode` equals 'list' (default), the publish date is displayed, with the @@ -1251,7 +1251,7 @@ class WP_Posts_List_Table extends WP_List_Table { if ( is_post_type_hierarchical( $post->post_type ) ) { /** - * Filter the array of row action links on the Pages list table. + * Filters the array of row action links on the Pages list table. * * The filter is evaluated only for hierarchical post types. * @@ -1266,7 +1266,7 @@ class WP_Posts_List_Table extends WP_List_Table { } else { /** - * Filter the array of row action links on the Posts list table. + * Filters the array of row action links on the Posts list table. * * The filter is evaluated only for non-hierarchical post types. * @@ -1308,7 +1308,7 @@ class WP_Posts_List_Table extends WP_List_Table { $show_in_quick_edit = $taxonomy->show_in_quick_edit; /** - * Filter whether the current taxonomy should be shown in the Quick Edit panel. + * Filters whether the current taxonomy should be shown in the Quick Edit panel. * * @since 4.2.0 * @@ -1473,7 +1473,7 @@ class WP_Posts_List_Table extends WP_List_Table { $dropdown_args['show_option_no_change'] = __( '— No Change —' ); /** - * Filter the arguments used to generate the Quick Edit page-parent drop-down. + * Filters the arguments used to generate the Quick Edit page-parent drop-down. * * @since 2.7.0 * diff --git a/wp-admin/includes/class-wp-press-this.php b/wp-admin/includes/class-wp-press-this.php index bb5ec1b97b..6a00cc8b6d 100644 --- a/wp-admin/includes/class-wp-press-this.php +++ b/wp-admin/includes/class-wp-press-this.php @@ -42,7 +42,7 @@ class WP_Press_This { public function site_settings() { return array( /** - * Filter whether or not Press This should redirect the user in the parent window upon save. + * Filters whether or not Press This should redirect the user in the parent window upon save. * * @since 4.2.0 * @@ -134,7 +134,7 @@ class WP_Press_This { $post_data['post_content'] = $this->side_load_images( $post_id, $post_data['post_content'] ); /** - * Filter the post data of a Press This post before saving/updating, after + * Filters the post data of a Press This post before saving/updating, after * side_load_images action had run. * * @since 4.5.0 @@ -168,7 +168,7 @@ class WP_Press_This { } /** - * Filter the URL to redirect to when Press This saves. + * Filters the URL to redirect to when Press This saves. * * @since 4.2.0 * @@ -690,7 +690,7 @@ class WP_Press_This { } /** - * Filter whether to enable in-source media discovery in Press This. + * Filters whether to enable in-source media discovery in Press This. * * @since 4.2.0 * @@ -765,7 +765,7 @@ class WP_Press_This { } /** - * Filter the Press This data array. + * Filters the Press This data array. * * @since 4.2.0 * @@ -1142,7 +1142,7 @@ class WP_Press_This { } /** - * Filter the default HTML tags used in the suggested content for the editor. + * Filters the default HTML tags used in the suggested content for the editor. * * The HTML strings use printf format. After filtering the content is added at the specified places with `sprintf()`. * diff --git a/wp-admin/includes/class-wp-screen.php b/wp-admin/includes/class-wp-screen.php index 77589fe400..a7d9a1a5c3 100644 --- a/wp-admin/includes/class-wp-screen.php +++ b/wp-admin/includes/class-wp-screen.php @@ -729,7 +729,7 @@ final class WP_Screen { public function render_screen_meta() { /** - * Filter the legacy contextual help list. + * Filters the legacy contextual help list. * * @since 2.7.0 * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or @@ -743,7 +743,7 @@ final class WP_Screen { $old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : ''; /** - * Filter the legacy contextual help text. + * Filters the legacy contextual help text. * * @since 2.7.0 * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or @@ -760,7 +760,7 @@ final class WP_Screen { if ( empty( $old_help ) && ! $this->get_help_tabs() ) { /** - * Filter the default legacy contextual help text. + * Filters the default legacy contextual help text. * * @since 2.8.0 * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or @@ -849,10 +849,10 @@ final class WP_Screen { // Setup layout columns /** - * Filter the array of screen layout columns. + * Filters the array of screen layout columns. * * This hook provides back-compat for plugins using the back-compat - * filter instead of add_screen_option(). + * Filters instead of add_screen_option(). * * @since 2.8.0 * @@ -929,7 +929,7 @@ final class WP_Screen { } /** - * Filter the screen settings text displayed in the Screen Options tab. + * Filters the screen settings text displayed in the Screen Options tab. * * This filter is currently only used on the Widgets screen to enable * accessibility mode. @@ -945,7 +945,7 @@ final class WP_Screen { $show_screen = true; /** - * Filter whether to show the Screen Options tab. + * Filters whether to show the Screen Options tab. * * @since 3.2.0 * @@ -995,7 +995,7 @@ final class WP_Screen { echo $this->_screen_settings; /** - * Filter whether to show the Screen Options submit button. + * Filters whether to show the Screen Options submit button. * * @since 4.4.0 * @@ -1204,7 +1204,7 @@ final class WP_Screen { $view_mode_post_types = get_post_types( array( 'hierarchical' => false, 'show_ui' => true ) ); /** - * Filter the post types that have different view mode options. + * Filters the post types that have different view mode options. * * @since 4.4.0 * diff --git a/wp-admin/includes/class-wp-site-icon.php b/wp-admin/includes/class-wp-site-icon.php index 8c06db6459..3afc83def7 100644 --- a/wp-admin/includes/class-wp-site-icon.php +++ b/wp-admin/includes/class-wp-site-icon.php @@ -121,7 +121,7 @@ class WP_Site_Icon { $metadata = wp_generate_attachment_metadata( $attachment_id, $file ); /** - * Filter the site icon attachment metadata. + * Filters the site icon attachment metadata. * * @since 4.3.0 * @@ -148,7 +148,7 @@ class WP_Site_Icon { $only_crop_sizes = array(); /** - * Filter the different dimensions that a site icon is saved in. + * Filters the different dimensions that a site icon is saved in. * * @since 4.3.0 * diff --git a/wp-admin/includes/class-wp-terms-list-table.php b/wp-admin/includes/class-wp-terms-list-table.php index 7da91a23e1..dcef0d71d8 100644 --- a/wp-admin/includes/class-wp-terms-list-table.php +++ b/wp-admin/includes/class-wp-terms-list-table.php @@ -79,7 +79,7 @@ class WP_Terms_List_Table extends WP_List_Table { if ( 'post_tag' === $this->screen->taxonomy ) { /** - * Filter the number of terms displayed per page for the Tags list table. + * Filters the number of terms displayed per page for the Tags list table. * * @since 2.8.0 * @@ -88,7 +88,7 @@ class WP_Terms_List_Table extends WP_List_Table { $tags_per_page = apply_filters( 'edit_tags_per_page', $tags_per_page ); /** - * Filter the number of terms displayed per page for the Tags list table. + * Filters the number of terms displayed per page for the Tags list table. * * @since 2.7.0 * @deprecated 2.8.0 Use edit_tags_per_page instead. @@ -98,7 +98,7 @@ class WP_Terms_List_Table extends WP_List_Table { $tags_per_page = apply_filters( 'tagsperpage', $tags_per_page ); } elseif ( 'category' === $this->screen->taxonomy ) { /** - * Filter the number of terms displayed per page for the Categories list table. + * Filters the number of terms displayed per page for the Categories list table. * * @since 2.8.0 * @@ -351,7 +351,7 @@ class WP_Terms_List_Table extends WP_List_Table { $pad = str_repeat( '— ', max( 0, $this->level ) ); /** - * Filter display of the term name in the terms list table. + * Filters display of the term name in the terms list table. * * The default output may include padding due to the term's * current level in the term hierarchy. @@ -469,7 +469,7 @@ class WP_Terms_List_Table extends WP_List_Table { } /** - * Filter the action links displayed for each term in the Tags list table. + * Filters the action links displayed for each term in the Tags list table. * * @since 2.8.0 * @deprecated 3.0.0 Use {$taxonomy}_row_actions instead. @@ -481,7 +481,7 @@ class WP_Terms_List_Table extends WP_List_Table { $actions = apply_filters( 'tag_row_actions', $actions, $tag ); /** - * Filter the action links displayed for each term in the terms list table. + * Filters the action links displayed for each term in the terms list table. * * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. * @@ -559,7 +559,7 @@ class WP_Terms_List_Table extends WP_List_Table { */ public function column_default( $tag, $column_name ) { /** - * Filter the displayed columns in the terms list table. + * Filters the displayed columns in the terms list table. * * The dynamic portion of the hook name, `$this->screen->taxonomy`, * refers to the slug of the current taxonomy. diff --git a/wp-admin/includes/class-wp-theme-install-list-table.php b/wp-admin/includes/class-wp-theme-install-list-table.php index 3780c89c95..b36dfc6b20 100644 --- a/wp-admin/includes/class-wp-theme-install-list-table.php +++ b/wp-admin/includes/class-wp-theme-install-list-table.php @@ -72,7 +72,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table { $tabs = apply_filters( 'install_themes_tabs', $tabs ); /** - * Filter tabs not associated with a menu item on the Install Themes screen. + * Filters tabs not associated with a menu item on the Install Themes screen. * * @since 2.8.0 * @@ -124,7 +124,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table { } /** - * Filter API request arguments for each Install Themes screen tab. + * Filters API request arguments for each Install Themes screen tab. * * The dynamic portion of the hook name, `$tab`, refers to the theme install * tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured', @@ -290,7 +290,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table { $actions[] = '' . __( 'Preview' ) . ''; /** - * Filter the install action links for a theme in the Install Themes list table. + * Filters the install action links for a theme in the Install Themes list table. * * @since 3.4.0 * diff --git a/wp-admin/includes/class-wp-upgrader.php b/wp-admin/includes/class-wp-upgrader.php index 42f93e7f53..407f0982dc 100644 --- a/wp-admin/includes/class-wp-upgrader.php +++ b/wp-admin/includes/class-wp-upgrader.php @@ -249,7 +249,7 @@ class WP_Upgrader { public function download_package( $package ) { /** - * Filter whether to return the package. + * Filters whether to return the package. * * @since 3.7.0 * @access public @@ -449,7 +449,7 @@ class WP_Upgrader { $this->skin->feedback( 'installing_package' ); /** - * Filter the install response before the installation has started. + * Filters the install response before the installation has started. * * Returning a truthy value, or one that could be evaluated as a WP_Error * will effectively short-circuit the installation, returning that value @@ -483,7 +483,7 @@ class WP_Upgrader { } /** - * Filter the source file location for the upgrade package. + * Filters the source file location for the upgrade package. * * @since 2.8.0 * @since 4.4.0 The $hook_extra parameter became available. @@ -529,7 +529,7 @@ class WP_Upgrader { $removed = $this->clear_destination( $remote_destination ); /** - * Filter whether the upgrader cleared the destination. + * Filters whether the upgrader cleared the destination. * * @since 2.8.0 * @@ -581,7 +581,7 @@ class WP_Upgrader { $this->result = compact( 'source', 'source_files', 'destination', 'destination_name', 'local_destination', 'remote_destination', 'clear_destination' ); /** - * Filter the install response after the installation has finished. + * Filters the install response after the installation has finished. * * @since 2.8.0 * @@ -649,7 +649,7 @@ class WP_Upgrader { $options = wp_parse_args( $options, $defaults ); /** - * Filter the package options before running an update. + * Filters the package options before running an update. * * @since 4.3.0 * diff --git a/wp-admin/includes/class-wp-users-list-table.php b/wp-admin/includes/class-wp-users-list-table.php index 903c7c7705..80720b6c0f 100644 --- a/wp-admin/includes/class-wp-users-list-table.php +++ b/wp-admin/includes/class-wp-users-list-table.php @@ -125,7 +125,7 @@ class WP_Users_List_Table extends WP_List_Table { $args['order'] = $_REQUEST['order']; /** - * Filter the query arguments used to retrieve users for the current users list table. + * Filters the query arguments used to retrieve users for the current users list table. * * @since 4.4.0 * @@ -160,7 +160,7 @@ class WP_Users_List_Table extends WP_List_Table { * with this table. * * Provides a list of roles and user count for that role for easy - * filtering of the user table. + * Filtersing of the user table. * * @since 3.1.0 * @access protected @@ -414,7 +414,7 @@ class WP_Users_List_Table extends WP_List_Table { $actions['remove'] = "" . __( 'Remove' ) . ""; /** - * Filter the action links displayed under each user in the Users list table. + * Filters the action links displayed under each user in the Users list table. * * @since 2.8.0 * @@ -490,7 +490,7 @@ class WP_Users_List_Table extends WP_List_Table { break; default: /** - * Filter the display output of custom columns in the Users list table. + * Filters the display output of custom columns in the Users list table. * * @since 2.8.0 * @@ -549,7 +549,7 @@ class WP_Users_List_Table extends WP_List_Table { } /** - * Filter the returned array of roles for a user. + * Filters the returned array of roles for a user. * * @since 4.4.0 * diff --git a/wp-admin/includes/comment.php b/wp-admin/includes/comment.php index 3037c4102e..12b2e04508 100644 --- a/wp-admin/includes/comment.php +++ b/wp-admin/includes/comment.php @@ -102,7 +102,7 @@ function get_comment_to_edit( $id ) { $comment->comment_content = format_to_edit( $comment->comment_content ); /** - * Filter the comment content before editing. + * Filters the comment content before editing. * * @since 2.0.0 * diff --git a/wp-admin/includes/dashboard.php b/wp-admin/includes/dashboard.php index 3efc5658e0..afe2de94e1 100644 --- a/wp-admin/includes/dashboard.php +++ b/wp-admin/includes/dashboard.php @@ -65,7 +65,7 @@ function wp_dashboard_setup() { do_action( 'wp_network_dashboard_setup' ); /** - * Filter the list of widgets to load for the Network Admin dashboard. + * Filters the list of widgets to load for the Network Admin dashboard. * * @since 3.1.0 * @@ -82,7 +82,7 @@ function wp_dashboard_setup() { do_action( 'wp_user_dashboard_setup' ); /** - * Filter the list of widgets to load for the User Admin dashboard. + * Filters the list of widgets to load for the User Admin dashboard. * * @since 3.1.0 * @@ -99,7 +99,7 @@ function wp_dashboard_setup() { do_action( 'wp_dashboard_setup' ); /** - * Filter the list of widgets to load for the admin dashboard. + * Filters the list of widgets to load for the admin dashboard. * * @since 2.5.0 * @@ -283,7 +283,7 @@ function wp_dashboard_right_now() { } /** - * Filter the array of extra elements to list in the 'At a Glance' + * Filters the array of extra elements to list in the 'At a Glance' * dashboard widget. * * Prior to 3.8.0, the widget was named 'Right Now'. Each element @@ -308,7 +308,7 @@ function wp_dashboard_right_now() { if ( ! is_network_admin() && ! is_user_admin() && current_user_can( 'manage_options' ) && '0' == get_option( 'blog_public' ) ) { /** - * Filter the link title attribute for the 'Search Engines Discouraged' + * Filters the link title attribute for the 'Search Engines Discouraged' * message displayed in the 'At a Glance' dashboard widget. * * Prior to 3.8.0, the widget was named 'Right Now'. @@ -321,7 +321,7 @@ function wp_dashboard_right_now() { $title = apply_filters( 'privacy_on_link_title', '' ); /** - * Filter the link label for the 'Search Engines Discouraged' message + * Filters the link label for the 'Search Engines Discouraged' message * displayed in the 'At a Glance' dashboard widget. * * Prior to 3.8.0, the widget was named 'Right Now'. @@ -538,7 +538,7 @@ function wp_dashboard_recent_drafts( $drafts = false ) { ); /** - * Filter the post query arguments for the 'Recent Drafts' dashboard widget. + * Filters the post query arguments for the 'Recent Drafts' dashboard widget. * * @since 4.4.0 * @@ -633,7 +633,7 @@ function _wp_dashboard_recent_comments_row( &$comment, $show_date = true ) { $actions['view'] = '' . __( 'View' ) . ''; /** - * Filter the action links displayed for each comment in the 'Recent Comments' + * Filters the action links displayed for each comment in the 'Recent Comments' * dashboard widget. * * @since 2.6.0 @@ -806,7 +806,7 @@ function wp_dashboard_recent_posts( $args ) { ); /** - * Filter the query arguments used for the Recent Posts widget. + * Filters the query arguments used for the Recent Posts widget. * * @since 4.2.0 * @@ -1068,7 +1068,7 @@ function wp_dashboard_primary() { 'news' => array( /** - * Filter the primary link URL for the 'WordPress News' dashboard widget. + * Filters the primary link URL for the 'WordPress News' dashboard widget. * * @since 2.5.0 * @@ -1077,7 +1077,7 @@ function wp_dashboard_primary() { 'link' => apply_filters( 'dashboard_primary_link', __( 'https://wordpress.org/news/' ) ), /** - * Filter the primary feed URL for the 'WordPress News' dashboard widget. + * Filters the primary feed URL for the 'WordPress News' dashboard widget. * * @since 2.3.0 * @@ -1086,7 +1086,7 @@ function wp_dashboard_primary() { 'url' => apply_filters( 'dashboard_primary_feed', __( 'http://wordpress.org/news/feed/' ) ), /** - * Filter the primary link title for the 'WordPress News' dashboard widget. + * Filters the primary link title for the 'WordPress News' dashboard widget. * * @since 2.3.0 * @@ -1101,7 +1101,7 @@ function wp_dashboard_primary() { 'planet' => array( /** - * Filter the secondary link URL for the 'WordPress News' dashboard widget. + * Filters the secondary link URL for the 'WordPress News' dashboard widget. * * @since 2.3.0 * @@ -1110,7 +1110,7 @@ function wp_dashboard_primary() { 'link' => apply_filters( 'dashboard_secondary_link', __( 'https://planet.wordpress.org/' ) ), /** - * Filter the secondary feed URL for the 'WordPress News' dashboard widget. + * Filters the secondary feed URL for the 'WordPress News' dashboard widget. * * @since 2.3.0 * @@ -1119,7 +1119,7 @@ function wp_dashboard_primary() { 'url' => apply_filters( 'dashboard_secondary_feed', __( 'https://planet.wordpress.org/feed/' ) ), /** - * Filter the secondary link title for the 'WordPress News' dashboard widget. + * Filters the secondary link title for the 'WordPress News' dashboard widget. * * @since 2.3.0 * @@ -1128,7 +1128,7 @@ function wp_dashboard_primary() { 'title' => apply_filters( 'dashboard_secondary_title', __( 'Other WordPress News' ) ), /** - * Filter the number of secondary link items for the 'WordPress News' dashboard widget. + * Filters the number of secondary link items for the 'WordPress News' dashboard widget. * * @since 4.4.0 * @@ -1355,7 +1355,7 @@ function wp_dashboard_browser_nag() { } /** - * Filter the notice output for the 'Browse Happy' nag meta box. + * Filters the notice output for the 'Browse Happy' nag meta box. * * @since 3.2.0 * diff --git a/wp-admin/includes/edit-tag-messages.php b/wp-admin/includes/edit-tag-messages.php index dcfd6034f5..8c34f0e3aa 100644 --- a/wp-admin/includes/edit-tag-messages.php +++ b/wp-admin/includes/edit-tag-messages.php @@ -40,7 +40,7 @@ $messages['post_tag'] = array( ); /** - * Filter the messages displayed when a tag is updated. + * Filters the messages displayed when a tag is updated. * * @since 3.7.0 * diff --git a/wp-admin/includes/export.php b/wp-admin/includes/export.php index 3aa172f93a..70a03b74b2 100644 --- a/wp-admin/includes/export.php +++ b/wp-admin/includes/export.php @@ -49,7 +49,7 @@ function export_wp( $args = array() ) { $date = date( 'Y-m-d' ); $wp_filename = $sitename . 'wordpress.' . $date . '.xml'; /** - * Filter the export filename. + * Filters the export filename. * * @since 4.4.0 * @@ -269,7 +269,7 @@ function export_wp( $args = array() ) { foreach ( $termmeta as $meta ) { /** - * Filter whether to selectively skip term meta used for WXR exports. + * Filters whether to selectively skip term meta used for WXR exports. * * Returning a truthy value to the filter will skip the current meta * object from being exported. @@ -484,7 +484,7 @@ function export_wp( $args = array() ) { get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d", $post->ID ) ); foreach ( $postmeta as $meta ) : /** - * Filter whether to selectively skip post meta used for WXR exports. + * Filters whether to selectively skip post meta used for WXR exports. * * Returning a truthy value to the filter will skip the current meta * object from being exported. @@ -560,7 +560,7 @@ function export_wp( $args = array() ) { get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id = %d", $c->comment_ID ) ); foreach ( $c_meta as $meta ) : /** - * Filter whether to selectively skip comment meta used for WXR exports. + * Filters whether to selectively skip comment meta used for WXR exports. * * Returning a truthy value to the filter will skip the current meta * object from being exported. diff --git a/wp-admin/includes/file.php b/wp-admin/includes/file.php index 9f47b013f3..b2b7ad59fb 100644 --- a/wp-admin/includes/file.php +++ b/wp-admin/includes/file.php @@ -251,7 +251,7 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) { } /** - * Filter the data for a file before it is uploaded to WordPress. + * Filters the data for a file before it is uploaded to WordPress. * * The dynamic portion of the hook name, `$action`, refers to the post action. * @@ -399,7 +399,7 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) { } /** - * Filter the data array for the uploaded file. + * Filters the data array for the uploaded file. * * @since 2.1.0 * @@ -589,7 +589,7 @@ function unzip_file($file, $to) { } /** - * Filter whether to use ZipArchive to unzip archives. + * Filters whether to use ZipArchive to unzip archives. * * @since 3.0.0 * @@ -890,7 +890,7 @@ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_own if ( ! class_exists( "WP_Filesystem_$method" ) ) { /** - * Filter the path for a specific filesystem method class file. + * Filters the path for a specific filesystem method class file. * * @since 2.6.0 * @@ -1006,7 +1006,7 @@ function get_filesystem_method( $args = array(), $context = false, $allow_relaxe if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread /** - * Filter the filesystem method to use. + * Filters the filesystem method to use. * * @since 2.6.0 * @@ -1051,7 +1051,7 @@ function request_filesystem_credentials( $form_post, $type = '', $error = false, global $pagenow; /** - * Filter the filesystem credentials form output. + * Filters the filesystem credentials form output. * * Returning anything other than an empty string will effectively short-circuit * output of the filesystem credentials form, returning that value instead. @@ -1152,7 +1152,7 @@ function request_filesystem_credentials( $form_post, $type = '', $error = false, $types[ 'ssh' ] = __('SSH2'); /** - * Filter the connection types to output to the filesystem credentials form. + * Filters the connection types to output to the filesystem credentials form. * * @since 2.9.0 * diff --git a/wp-admin/includes/image-edit.php b/wp-admin/includes/image-edit.php index 478a514df3..99e1c400ff 100644 --- a/wp-admin/includes/image-edit.php +++ b/wp-admin/includes/image-edit.php @@ -243,7 +243,7 @@ function wp_stream_image( $image, $mime_type, $post_id ) { if ( $image instanceof WP_Image_Editor ) { /** - * Filter the WP_Image_Editor instance for the image to be streamed to the browser. + * Filters the WP_Image_Editor instance for the image to be streamed to the browser. * * @since 3.5.0 * @@ -260,7 +260,7 @@ function wp_stream_image( $image, $mime_type, $post_id ) { _deprecated_argument( __FUNCTION__, '3.5', __( '$image needs to be an WP_Image_Editor object' ) ); /** - * Filter the GD image resource to be streamed to the browser. + * Filters the GD image resource to be streamed to the browser. * * @since 2.9.0 * @deprecated 3.5.0 Use image_editor_save_pre instead. @@ -302,7 +302,7 @@ function wp_save_image_file( $filename, $image, $mime_type, $post_id ) { $image = apply_filters( 'image_editor_save_pre', $image, $post_id ); /** - * Filter whether to skip saving the image file. + * Filters whether to skip saving the image file. * * Returning a non-null value will short-circuit the save method, * returning that value instead. @@ -328,7 +328,7 @@ function wp_save_image_file( $filename, $image, $mime_type, $post_id ) { $image = apply_filters( 'image_save_pre', $image, $post_id ); /** - * Filter whether to skip saving the image file. + * Filters whether to skip saving the image file. * * Returning a non-null value will short-circuit the save method, * returning that value instead. @@ -515,7 +515,7 @@ function image_edit_apply_changes( $image, $changes ) { if ( $image instanceof WP_Image_Editor ) { /** - * Filter the WP_Image_Editor instance before applying changes to the image. + * Filters the WP_Image_Editor instance before applying changes to the image. * * @since 3.5.0 * @@ -526,7 +526,7 @@ function image_edit_apply_changes( $image, $changes ) { } elseif ( is_resource( $image ) ) { /** - * Filter the GD image resource before applying changes to the image. + * Filters the GD image resource before applying changes to the image. * * @since 2.9.0 * @deprecated 3.5.0 Use wp_image_editor_before_change instead. diff --git a/wp-admin/includes/image.php b/wp-admin/includes/image.php index f0cb0e960e..4d9e076921 100644 --- a/wp-admin/includes/image.php +++ b/wp-admin/includes/image.php @@ -107,7 +107,7 @@ function wp_generate_attachment_metadata( $attachment_id, $file ) { } /** - * Filter the image sizes automatically generated when uploading an image. + * Filters the image sizes automatically generated when uploading an image. * * @since 2.9.0 * @since 4.4.0 Added the `$metadata` argument. @@ -174,7 +174,7 @@ function wp_generate_attachment_metadata( $attachment_id, $file ) { 'post_content' => '', ); /** - * Filter the parameters for the attachment thumbnail creation. + * Filters the parameters for the attachment thumbnail creation. * * @since 3.9.0 * @@ -199,7 +199,7 @@ function wp_generate_attachment_metadata( $attachment_id, $file ) { } /** - * Filter the generated attachment meta data. + * Filters the generated attachment meta data. * * @since 2.1.0 * @@ -337,7 +337,7 @@ function wp_read_image_metadata( $file ) { } /** - * Filter the image types to check for exif data. + * Filters the image types to check for exif data. * * @since 2.5.0 * @@ -417,7 +417,7 @@ function wp_read_image_metadata( $file ) { $meta = wp_kses_post_deep( $meta ); /** - * Filter the array of meta data read from an image's exif data. + * Filters the array of meta data read from an image's exif data. * * @since 2.5.0 * @since 4.4.0 The `$iptc` parameter was added. @@ -465,7 +465,7 @@ function file_is_displayable_image($path) { } /** - * Filter whether the current image is displayable in the browser. + * Filters whether the current image is displayable in the browser. * * @since 2.5.0 * @@ -506,7 +506,7 @@ function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) { } if ( is_resource($image) ) { /** - * Filter the current image being loaded for editing. + * Filters the current image being loaded for editing. * * @since 2.9.0 * @@ -542,7 +542,7 @@ function _load_image_to_edit_path( $attachment_id, $size = 'full' ) { if ( $filepath && file_exists( $filepath ) ) { if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) { /** - * Filter the path to the current image. + * Filters the path to the current image. * * The filter is evaluated for all image sizes except 'full'. * @@ -556,7 +556,7 @@ function _load_image_to_edit_path( $attachment_id, $size = 'full' ) { } } elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) { /** - * Filter the image URL if not in the local filesystem. + * Filters the image URL if not in the local filesystem. * * The filter is only evaluated if fopen is enabled on the server. * @@ -570,7 +570,7 @@ function _load_image_to_edit_path( $attachment_id, $size = 'full' ) { } /** - * Filter the returned path or URL of the current image. + * Filters the returned path or URL of the current image. * * @since 2.9.0 * diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index 5ee92e7ba9..0fd4f7bc43 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -22,7 +22,7 @@ function media_upload_tabs() { ); /** - * Filter the available tabs in the legacy (pre-3.5.0) media popup. + * Filters the available tabs in the legacy (pre-3.5.0) media popup. * * @since 2.5.0 * @@ -135,7 +135,7 @@ function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $re $html = '' . $html . ''; /** - * Filter the image HTML markup to send to the editor. + * Filters the image HTML markup to send to the editor. * * @since 2.5.0 * @@ -172,13 +172,13 @@ function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $re function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) { /** - * Filter the caption text. + * Filters the caption text. * * Note: If the caption text is empty, the caption shortcode will not be appended * to the image HTML when inserted into the editor. * * Passing an empty value also prevents the {@see 'image_add_caption_shortcode'} - * filter from being evaluated at the end of image_add_caption(). + * Filters from being evaluated at the end of image_add_caption(). * * @since 4.1.0 * @@ -188,7 +188,7 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $ $caption = apply_filters( 'image_add_caption_text', $caption, $id ); /** - * Filter whether to disable captions. + * Filters whether to disable captions. * * Prevents image captions from being appended to image HTML when inserted into the editor. * @@ -220,7 +220,7 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $ $shcode = '[caption id="' . $id . '" align="align' . $align . '" width="' . $width . '"]' . $html . ' ' . $caption . '[/caption]'; /** - * Filter the image HTML markup including the caption shortcode. + * Filters the image HTML markup including the caption shortcode. * * @since 2.6.0 * @@ -568,7 +568,7 @@ function media_buttons($editor_id = 'content') { $img . __( 'Add Media' ) ); /** - * Filter the legacy (pre-3.5.0) media buttons. + * Filters the legacy (pre-3.5.0) media buttons. * * @since 2.5.0 * @deprecated 3.5.0 Use 'media_buttons' action instead. @@ -608,7 +608,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) { $upload_iframe_src = add_query_arg('tab', $tab, $upload_iframe_src); /** - * Filter the upload iframe source URL for a specific media type. + * Filters the upload iframe source URL for a specific media type. * * The dynamic portion of the hook name, `$type`, refers to the type * of media uploaded. @@ -660,7 +660,7 @@ function media_upload_form_handler() { } /** - * Filter the attachment fields to be saved. + * Filters the attachment fields to be saved. * * @since 2.5.0 * @@ -716,7 +716,7 @@ function media_upload_form_handler() { } /** - * Filter the HTML markup for a media item sent to the editor. + * Filters the HTML markup for a media item sent to the editor. * * @since 2.5.0 * @@ -774,7 +774,7 @@ function wp_media_upload_handler() { $type = $ext_type; /** - * Filter the URL sent to the editor for a specific media type. + * Filters the URL sent to the editor for a specific media type. * * The dynamic portion of the hook name, `$type`, refers to the type * of media being sent. @@ -797,7 +797,7 @@ function wp_media_upload_handler() { $html = "$alt"; /** - * Filter the image URL sent to the editor. + * Filters the image URL sent to the editor. * * @since 2.8.0 * @@ -978,7 +978,7 @@ function image_align_input_fields( $post, $checked = '' ) { */ function image_size_input_fields( $post, $check = '' ) { /** - * Filter the names and labels of the default image sizes. + * Filters the names and labels of the default image sizes. * * @since 3.3.0 * @@ -1129,7 +1129,7 @@ function media_post_single_attachment_fields_to_edit( $form_fields, $post ) { } /** - * Filters input from media_upload_form_handler() and assigns a default + * Filterss input from media_upload_form_handler() and assigns a default * post_title from the file name if none supplied. * * Illustrates the use of the attachment_fields_to_save filter @@ -1285,7 +1285,7 @@ function get_attachment_fields_to_edit($post, $errors = null) { } /** - * Filter the attachment fields to edit. + * Filters the attachment fields to edit. * * @since 2.5.0 * @@ -1369,7 +1369,7 @@ function get_media_item( $attachment_id, $args = null ) { $args = wp_parse_args( $args, $default_args ); /** - * Filter the arguments used to retrieve an image for the edit image form. + * Filters the arguments used to retrieve an image for the edit image form. * * @since 3.1.0 * @@ -1427,7 +1427,7 @@ function get_media_item( $attachment_id, $args = null ) { $media_dims .= "{$meta['width']} × {$meta['height']} "; /** - * Filter the media metadata. + * Filters the media metadata. * * @since 2.5.0 * @@ -1845,7 +1845,7 @@ $post_params = array( ); /** - * Filter the media upload post parameters. + * Filters the media upload post parameters. * * @since 3.1.0 As 'swfupload_post_params' * @since 3.3.0 @@ -1878,7 +1878,7 @@ if ( wp_is_mobile() && strpos( $_SERVER['HTTP_USER_AGENT'], 'OS 7_' ) !== false } /** - * Filter the default Plupload settings. + * Filters the default Plupload settings. * * @since 3.3.0 * @@ -1985,7 +1985,7 @@ function media_upload_type_form($type = 'file', $errors = null, $id = null) { $form_action_url = admin_url("media-upload.php?type=$type&tab=type&post_id=$post_id"); /** - * Filter the media upload form action URL. + * Filters the media upload form action URL. * * @since 2.6.0 * @@ -2165,7 +2165,7 @@ jQuery(document).ready( function($) {
$label ) { $type_links[] = '
  • ' . sprintf( translate_nooped_plural( $label[2], $num_posts[$mime_type] ), '' . number_format_i18n( $num_posts[$mime_type] ) . '') . ''; } /** - * Filter the media upload mime type list items. + * Filters the media upload mime type list items. * * Returned values should begin with an `
  • ` tag. * @@ -2865,7 +2865,7 @@ function attachment_submitbox_metadata() { if ( preg_match( '#^(audio|video)/#', $post->post_mime_type ) ) { /** - * Filter the audio and video metadata fields to be shown in the publish meta box. + * Filters the audio and video metadata fields to be shown in the publish meta box. * * The key for each item in the array should correspond to an attachment * metadata key, and the value should be the desired label. @@ -2903,7 +2903,7 @@ function attachment_submitbox_metadata() { } /** - * Filter the audio attachment metadata fields to be shown in the publish meta box. + * Filters the audio attachment metadata fields to be shown in the publish meta box. * * The key for each item in the array should correspond to an attachment * metadata key, and the value should be the desired label. diff --git a/wp-admin/includes/menu.php b/wp-admin/includes/menu.php index 74804022b7..7e41e7165d 100644 --- a/wp-admin/includes/menu.php +++ b/wp-admin/includes/menu.php @@ -229,7 +229,7 @@ function add_menu_classes($menu) { } /** - * Filter administration menus array with classes added for top-level items. + * Filters administration menus array with classes added for top-level items. * * @since 2.7.0 * @@ -241,7 +241,7 @@ function add_menu_classes($menu) { uksort($menu, "strnatcasecmp"); // make it all pretty /** - * Filter whether to enable custom ordering of the administration menu. + * Filters whether to enable custom ordering of the administration menu. * * See the {@see 'menu_order'} filter for reordering menu items. * @@ -258,7 +258,7 @@ if ( apply_filters( 'custom_menu_order', false ) ) { $default_menu_order = $menu_order; /** - * Filter the order of administration menu items. + * Filters the order of administration menu items. * * A truthy value must first be passed to the {@see 'custom_menu_order'} filter * for this filter to work. Use the following to enable custom menu ordering: diff --git a/wp-admin/includes/meta-boxes.php b/wp-admin/includes/meta-boxes.php index bf877c3d86..e07cc5698a 100644 --- a/wp-admin/includes/meta-boxes.php +++ b/wp-admin/includes/meta-boxes.php @@ -522,7 +522,7 @@ function post_categories_meta_box( $post, $box ) { ); /** - * Filter the arguments for the taxonomy parent dropdown on the Post Edit page. + * Filters the arguments for the taxonomy parent dropdown on the Post Edit page. * * @since 4.4.0 * @@ -798,7 +798,7 @@ function page_attributes_meta_box($post) { ); /** - * Filter the arguments used to generate a Pages drop-down element. + * Filters the arguments used to generate a Pages drop-down element. * * @since 3.3.0 * @@ -835,7 +835,7 @@ function page_attributes_meta_box($post) {