WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Drew Jaynes 2016-05-22 18:01:30 +00:00
parent f52a8cb1fa
commit c3055cc190
87 changed files with 307 additions and 307 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
wp-admin/admin-footer.php
View File

@ -33,7 +33,7 @@ global $hook_suffix;
<?php
$text = sprintf( __( 'Thank you for creating with <a href="%s">WordPress</a>.' ), __( '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;
<p id="footer-upgrade" class="alignright">
<?php
/**
* Filter the version/update text displayed in the admin footer.
* Filters the version/update text displayed in the admin footer.
*
* WordPress prints the current version and update information,
* using core_update_footer() at priority 10.

4
wp-admin/admin-header.php
View File

@ -46,7 +46,7 @@ else
$admin_title = sprintf( __( '%1$s &lsaquo; %2$s &#8212; WordPress' ), $title, $admin_title );
/**
* Filter the title tag content for an admin page.
* Filters the title tag content for an admin page.
*
* @since 3.1.0
*
@ -174,7 +174,7 @@ $admin_body_class .= ' no-customize-support no-svg';
</head>
<?php
/**
* Filter the CSS classes for the body tag in the admin.
* Filters the CSS classes for the body tag in the admin.
*
* This filter differs from the {@see 'post_class'} and {@see 'body_class'} filters
* in two important ways:

4
wp-admin/admin.php
View File

@ -48,7 +48,7 @@ if ( get_option('db_upgraded') ) {
exit;
/**
* Filter whether to attempt to perform the multisite DB upgrade routine.
* Filters whether to attempt to perform the multisite DB upgrade routine.
*
* In single site, the user would be redirected to wp-admin/upgrade.php.
* In multisite, the DB upgrade routine is automatically fired, but only
@ -139,7 +139,7 @@ else
if ( current_user_can( 'manage_options' ) ) {
/**
* Filter the maximum memory limit available for administration screens.
* Filters the maximum memory limit available for administration screens.
*
* This only applies to administrators, who may require more memory for tasks like updates.
* Memory limits when processing images (uploaded or edited by users of any role) are

2
wp-admin/async-upload.php
View File

@ -105,7 +105,7 @@ if ( $_REQUEST['short'] ) {
$type = $_REQUEST['type'];
/**
* Filter the returned ID of an uploaded attachment.
* Filters the returned ID of an uploaded attachment.
*
* The dynamic portion of the hook name, `$type`, refers to the attachment type,
* such as 'image', 'audio', 'video', 'file', etc.

2
wp-admin/comment.php
View File

@ -313,7 +313,7 @@ case 'editedcomment' :
$location = ( empty( $_POST['referredby'] ) ? "edit-comments.php?p=$comment_post_id" : $_POST['referredby'] ) . '#comment-' . $comment_id;
/**
* Filter the URI the user is redirected to after editing a comment in the admin.
* Filters the URI the user is redirected to after editing a comment in the admin.
*
* @since 2.1.0
*

2
wp-admin/custom-header.php
View File

@ -1183,7 +1183,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
$attachment_id = wp_insert_attachment( $object, $cropped );
$metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
/**
* Filter the header image attachment metadata.
* Filters the header image attachment metadata.
*
* @since 3.9.0
*

6
wp-admin/edit-form-advanced.php
View File

@ -21,7 +21,7 @@ wp_enqueue_script('post');
$_wp_editor_expand = $_content_editor_dfw = false;
/**
* Filter whether to enable the 'expand' functionality in the post editor.
* Filters whether to enable the 'expand' functionality in the post editor.
*
* @since 4.0.0
* @since 4.1.0 Added the `$post_type` parameter.
@ -163,7 +163,7 @@ $messages['page'] = array(
$messages['attachment'] = array_fill( 1, 10, __( 'Media file updated.' ) ); // Hack, for now.
/**
* Filter the post updated messages.
* Filters the post updated messages.
*
* @since 3.0.0
*
@ -543,7 +543,7 @@ do_action( 'edit_form_top', $post ); ?>
<div id="titlewrap">
<?php
/**
* Filter the title field placeholder text.
* Filters the title field placeholder text.
*
* @since 3.1.0
*

2
wp-admin/edit-form-comment.php
View File

@ -143,7 +143,7 @@ endif; ?>
<?php
/**
* Filter miscellaneous actions for the edit comment form sidebar.
* Filters miscellaneous actions for the edit comment form sidebar.
*
* @since 4.3.0
*

2
wp-admin/edit-tag-form.php
View File

@ -127,7 +127,7 @@ do_action( "{$taxonomy}_term_edit_form_top", $tag, $taxonomy );
<th scope="row"><label for="slug"><?php _e( 'Slug' ); ?></label></th>
<?php
/**
* Filter the editable slug.
* Filters the editable slug.
*
* Note: This is a multi-use hook in that it is leveraged both for editable
* post URIs and term slugs.

2
wp-admin/edit-tags.php
View File

@ -427,7 +427,7 @@ do_action( "{$taxonomy}_term_new_form_tag" );
);
/**
* Filter the taxonomy parent drop-down on the Edit Term page.
* Filters the taxonomy parent drop-down on the Edit Term page.
*
* @since 3.7.0
* @since 4.2.0 Added `$context` parameter.

2
wp-admin/edit.php
View File

@ -283,7 +283,7 @@ $bulk_messages['page'] = array(
);
/**
* Filter the bulk action updated messages.
* Filters the bulk action updated messages.
*
* By default, custom post types use the messages for the 'post' post type.
*

2
wp-admin/export.php
View File

@ -103,7 +103,7 @@ if ( isset( $_GET['download'] ) ) {
}
/**
* Filter the export args.
* Filters the export args.
*
* @since 3.5.0
*

18
wp-admin/includes/ajax-actions.php
View File

@ -32,7 +32,7 @@ function wp_ajax_nopriv_heartbeat() {
$data = wp_unslash( (array) $_POST['data'] );
/**
* Filter Heartbeat AJAX response in no-privilege environments.
* Filters Heartbeat AJAX response in no-privilege environments.
*
* @since 3.6.0
*
@ -44,7 +44,7 @@ function wp_ajax_nopriv_heartbeat() {
}
/**
* Filter Heartbeat AJAX response when no data is passed.
* Filters Heartbeat AJAX response when no data is passed.
*
* @since 3.6.0
*
@ -132,7 +132,7 @@ function wp_ajax_ajax_tag_search() {
$s = trim( $s );
/**
* Filter the minimum number of characters required to fire a tag search via AJAX.
* Filters the minimum number of characters required to fire a tag search via AJAX.
*
* @since 4.0.0
*
@ -2276,7 +2276,7 @@ function wp_ajax_wp_remove_post_lock() {
wp_die( 0 );
/**
* Filter the post lock window duration.
* Filters the post lock window duration.
*
* @since 3.3.0
*
@ -2373,7 +2373,7 @@ function wp_ajax_query_attachments() {
$query['post_status'] .= ',private';
/**
* Filter the arguments passed to WP_Query during an AJAX
* Filters the arguments passed to WP_Query during an AJAX
* call for querying attachments.
*
* @since 3.7.0
@ -2711,7 +2711,7 @@ function wp_ajax_heartbeat() {
if ( ! empty( $data ) ) {
/**
* Filter the Heartbeat response received.
* Filters the Heartbeat response received.
*
* @since 3.6.0
*
@ -2723,7 +2723,7 @@ function wp_ajax_heartbeat() {
}
/**
* Filter the Heartbeat response sent.
* Filters the Heartbeat response sent.
*
* @since 3.6.0
*
@ -3273,7 +3273,7 @@ function wp_ajax_crop_image() {
$metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
/**
* Filter the cropped image attachment metadata.
* Filters the cropped image attachment metadata.
*
* @since 4.3.0
*
@ -3285,7 +3285,7 @@ function wp_ajax_crop_image() {
wp_update_attachment_metadata( $attachment_id, $metadata );
/**
* Filter the attachment ID for a cropped image.
* Filters the attachment ID for a cropped image.
*
* @since 4.3.0
*

2
wp-admin/includes/class-bulk-plugin-upgrader-skin.php
View File

@ -51,7 +51,7 @@ class Bulk_Plugin_Upgrader_Skin extends Bulk_Upgrader_Skin {
unset( $update_actions['plugins_page'] );
/**
* Filter the list of action links available following bulk plugin updates.
* Filters the list of action links available following bulk plugin updates.
*
* @since 3.0.0
*

2
wp-admin/includes/class-bulk-theme-upgrader-skin.php
View File

@ -51,7 +51,7 @@ class Bulk_Theme_Upgrader_Skin extends Bulk_Upgrader_Skin {
unset( $update_actions['themes_page'] );
/**
* Filter the list of action links available following bulk theme updates.
* Filters the list of action links available following bulk theme updates.
*
* @since 3.0.0
*

6
wp-admin/includes/class-core-upgrader.php
View File

@ -291,7 +291,7 @@ class Core_Upgrader extends WP_Upgrader {
if ( $current_is_development_version ) {
/**
* Filter whether to enable automatic core updates for development versions.
* Filters whether to enable automatic core updates for development versions.
*
* @since 3.7.0
*
@ -307,7 +307,7 @@ class Core_Upgrader extends WP_Upgrader {
if ( $current_branch == $new_branch ) {
/**
* Filter whether to enable minor automatic core updates.
* Filters whether to enable minor automatic core updates.
*
* @since 3.7.0
*
@ -320,7 +320,7 @@ class Core_Upgrader extends WP_Upgrader {
if ( version_compare( $new_branch, $current_branch, '>' ) ) {
/**
* Filter whether to enable major automatic core updates.
* Filters whether to enable major automatic core updates.
*
* @since 3.7.0
*

2
wp-admin/includes/class-language-pack-upgrader-skin.php
View File

@ -71,7 +71,7 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin {
$update_actions['updates_page'] = '<a href="' . self_admin_url( 'update-core.php' ) . '" target="_parent">' . __( 'Return to WordPress Updates page' ) . '</a>';
/**
* 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
*

2
wp-admin/includes/class-language-pack-upgrader.php
View File

@ -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
*

2
wp-admin/includes/class-plugin-installer-skin.php
View File

@ -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
*

2
wp-admin/includes/class-plugin-upgrader-skin.php
View File

@ -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
*

2
wp-admin/includes/class-theme-installer-skin.php
View File

@ -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
*

2
wp-admin/includes/class-theme-upgrader-skin.php
View File

@ -66,7 +66,7 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin {
$update_actions['themes_page'] = '<a href="' . self_admin_url( 'themes.php' ) . '" target="_parent">' . __( 'Return to Themes page' ) . '</a>';
/**
* 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
*

16
wp-admin/includes/class-wp-automatic-upgrader.php
View File

@ -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

6
wp-admin/includes/class-wp-comments-list-table.php
View File

@ -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 {
<option value=""><?php _e( 'All comment types' ); ?></option>
<?php
/**
* Filter the comment types dropdown menu.
* Filters the comment types dropdown menu.
*
* @since 2.7.0
*

14
wp-admin/includes/class-wp-list-table.php
View File

@ -388,7 +388,7 @@ class WP_List_Table {
public function views() {
$views = $this->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.

6
wp-admin/includes/class-wp-media-list-table.php
View File

@ -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
*

4
wp-admin/includes/class-wp-ms-sites-list-table.php
View File

@ -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'] = "<a href='" . esc_url( get_home_url( $blog['blog_id'], '/' ) ) . "' rel='permalink'>" . __( 'Visit' ) . '</a>';
/**
* 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

8
wp-admin/includes/class-wp-ms-themes-list-table.php
View File

@ -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

6
wp-admin/includes/class-wp-ms-users-list-table.php
View File

@ -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'] = '<a class="' . $class . '" href="' . esc_url( get_home_url( $val->userblog_id ) ) . '">' . __( 'View' ) . '</a>';
/**
* 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
*

8
wp-admin/includes/class-wp-plugin-install-list-table.php
View File

@ -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
*

16
wp-admin/includes/class-wp-plugins-list-table.php
View File

@ -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
*

18
wp-admin/includes/class-wp-posts-list-table.php
View File

@ -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 '<br />';
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'] = __( '&mdash; No Change &mdash;' );
/**
* 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
*

12
wp-admin/includes/class-wp-press-this.php
View File

@ -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()`.
*

18
wp-admin/includes/class-wp-screen.php
View File

@ -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
*

4
wp-admin/includes/class-wp-site-icon.php
View File

@ -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
*

14
wp-admin/includes/class-wp-terms-list-table.php
View File

@ -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( '&#8212; ', 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.

6
wp-admin/includes/class-wp-theme-install-list-table.php
View File

@ -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[] = '<a class="install-theme-preview" href="' . esc_url( $preview_url ) . '" title="' . esc_attr( sprintf( __( 'Preview %s' ), $name ) ) . '">' . __( 'Preview' ) . '</a>';
/**
* 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
*

12
wp-admin/includes/class-wp-upgrader.php
View File

@ -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
*

10
wp-admin/includes/class-wp-users-list-table.php
View File

@ -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'] = "<a class='submitdelete' href='" . wp_nonce_url( $url."action=remove&amp;user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Remove' ) . "</a>";
/**
* 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
*

2
wp-admin/includes/comment.php
View File

@ -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
*

34
wp-admin/includes/dashboard.php
View File

@ -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'] = '<a class="comment-link" href="' . esc_url( get_comment_link( $comment ) ) . '" aria-label="' . esc_attr__( 'View this comment' ) . '">' . __( 'View' ) . '</a>';
/**
* 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
*

2
wp-admin/includes/edit-tag-messages.php
View File

@ -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
*

12
wp-admin/includes/export.php
View File

@ -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() ) {
<description></description>
<content:encoded><?php
/**
* Filter the post content used for WXR exports.
* Filters the post content used for WXR exports.
*
* @since 2.5.0
*
@ -494,7 +494,7 @@ function export_wp( $args = array() ) {
?></content:encoded>
<excerpt:encoded><?php
/**
* Filter the post excerpt used for WXR exports.
* Filters the post excerpt used for WXR exports.
*
* @since 2.6.0
*
@ -521,7 +521,7 @@ function export_wp( $args = array() ) {
<?php $postmeta = $wpdb->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() ) {
<?php $c_meta = $wpdb->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.

14
wp-admin/includes/file.php
View File

@ -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
*

12
wp-admin/includes/image-edit.php
View File

@ -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.

20
wp-admin/includes/image.php
View File

@ -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
*

48
wp-admin/includes/media.php
View File

@ -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 = '<a href="' . esc_attr( $url ) . '"' . $rel . '>' . $html . '</a>';
/**
* 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 = "<img src='" . esc_url($src) . "' alt='$alt'$class />";
/**
* 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 .= "<span id='media-dims-$post->ID'>{$meta['width']}&nbsp;&times;&nbsp;{$meta['height']}</span> ";
/**
* 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($) {
<div class="media-item media-blank">
<?php
/**
* Filter the insert media from URL form HTML.
* Filters the insert media from URL form HTML.
*
* @since 3.3.0
*
@ -2418,7 +2418,7 @@ foreach ( $post_mime_types as $mime_type => $label ) {
$type_links[] = '<li><a href="' . esc_url(add_query_arg(array('post_mime_type'=>$mime_type, 'paged'=>false))) . '"' . $class . '>' . sprintf( translate_nooped_plural( $label[2], $num_posts[$mime_type] ), '<span id="' . $mime_type . '-counter">' . number_format_i18n( $num_posts[$mime_type] ) . '</span>') . '</a>';
}
/**
* Filter the media upload mime type list items.
* Filters the media upload mime type list items.
*
* Returned values should begin with an `<li>` 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.

6
wp-admin/includes/menu.php
View File

@ -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:

6
wp-admin/includes/meta-boxes.php
View File

@ -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) {
<label class="screen-reader-text" for="page_template"><?php _e('Page Template') ?></label><select name="page_template" id="page_template">
<?php
/**
* Filter the title of the default page template displayed in the drop-down.
* Filters the title of the default page template displayed in the drop-down.
*
* @since 4.1.0
*

8
wp-admin/includes/misc.php
View File

@ -17,7 +17,7 @@ function got_mod_rewrite() {
$got_rewrite = apache_mod_loaded('mod_rewrite', true);
/**
* Filter whether Apache and mod_rewrite are present.
* Filters whether Apache and mod_rewrite are present.
*
* This filter was previously used to force URL rewriting for other servers,
* like nginx. Use the got_url_rewrite filter in got_url_rewrite() instead.
@ -46,7 +46,7 @@ function got_url_rewrite() {
$got_url_rewrite = ( got_mod_rewrite() || $GLOBALS['is_nginx'] || iis7_supports_permalinks() );
/**
* Filter whether URL rewriting is available.
* Filters whether URL rewriting is available.
*
* @since 3.7.0
*
@ -369,7 +369,7 @@ function wp_doc_link_parse( $content ) {
sort( $functions );
/**
* Filter the list of functions and classes to be ignored from the documentation lookup.
* Filters the list of functions and classes to be ignored from the documentation lookup.
*
* @since 2.8.0
*
@ -438,7 +438,7 @@ function set_screen_options() {
default:
/**
* Filter a screen option value before it is set.
* Filters a screen option value before it is set.
*
* The filter can also be used to modify non-standard [items]_per_page
* settings. See the parent function for a full list of standard options.

16
wp-admin/includes/ms.php
View File

@ -112,7 +112,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
$tables = $wpdb->tables( 'blog' );
/**
* Filter the tables to drop when the site is deleted.
* Filters the tables to drop when the site is deleted.
*
* @since MU
*
@ -128,7 +128,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
$wpdb->delete( $wpdb->blogs, array( 'blog_id' => $blog_id ) );
/**
* Filter the upload base directory to delete when the site is deleted.
* Filters the upload base directory to delete when the site is deleted.
*
* @since MU
*
@ -291,7 +291,7 @@ All at ###SITENAME###
###SITEURL###' );
/**
* Filter the email text sent when the site admin email is changed.
* Filters the email text sent when the site admin email is changed.
*
* The following strings have a special meaning and will get replaced dynamically:
* ###USERNAME### The current user's username.
@ -371,7 +371,7 @@ All at ###SITENAME###
###SITEURL###' );
/**
* Filter the email text sent when a user changes emails.
* Filters the email text sent when a user changes emails.
*
* The following strings have a special meaning and will get replaced dynamically:
* ###USERNAME### The current user's username.
@ -604,7 +604,7 @@ function format_code_lang( $code = '' ) {
've' => 'Venda', 'vi' => 'Vietnamese', 'vo' => 'Volapük', 'cy' => 'Welsh','wa' => 'Walloon','wo' => 'Wolof', 'xh' => 'Xhosa', 'yi' => 'Yiddish', 'yo' => 'Yoruba', 'za' => 'Zhuang; Chuang', 'zu' => 'Zulu' );
/**
* Filter the language codes.
* Filters the language codes.
*
* @since MU
*
@ -730,7 +730,7 @@ function mu_dropdown_languages( $lang_files = array(), $current = '' ) {
uksort( $output, 'strnatcasecmp' );
/**
* Filter the languages available in the dropdown.
* Filters the languages available in the dropdown.
*
* @since MU
*
@ -873,7 +873,7 @@ function can_edit_network( $site_id ) {
$result = false;
/**
* Filter whether this network can be edited from this page.
* Filters whether this network can be edited from this page.
*
* @since 3.1.0
*
@ -1047,7 +1047,7 @@ jQuery(document).ready( function($) {
function network_edit_site_nav( $args = array() ) {
/**
* Filter the links that appear on site-editing network pages
* Filters the links that appear on site-editing network pages
*
* Default links: 'site-info', 'site-users', 'site-themes', and 'site-settings'
*

8
wp-admin/includes/nav-menu.php
View File

@ -186,7 +186,7 @@ function wp_nav_menu_post_type_meta_boxes() {
foreach ( $post_types as $post_type ) {
/**
* Filter whether a menu items meta box will be added for the current
* Filters whether a menu items meta box will be added for the current
* object type.
*
* If a falsey value is returned instead of an object, the menu items
@ -400,7 +400,7 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
$args['walker'] = $walker;
/**
* Filter the posts displayed in the 'Most Recent' tab of the current
* Filters the posts displayed in the 'Most Recent' tab of the current
* post type's menu items meta box.
*
* The dynamic portion of the hook name, `$post_type_name`, refers to the post type name.
@ -508,7 +508,7 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
}
/**
* Filter the posts displayed in the 'View All' tab of the current
* Filters the posts displayed in the 'View All' tab of the current
* post type's menu items meta box.
*
* The dynamic portion of the hook name, `$post_type_name`, refers
@ -888,7 +888,7 @@ function wp_get_nav_menu_to_edit( $menu_id = 0 ) {
return $result . ' <ul class="menu" id="menu-to-edit"> </ul>';
/**
* Filter the Walker class used when adding nav menu items.
* Filters the Walker class used when adding nav menu items.
*
* @since 3.0.0
*

2
wp-admin/includes/network.php
View File

@ -52,7 +52,7 @@ function allow_subdomain_install() {
function allow_subdirectory_install() {
global $wpdb;
/**
* Filter whether to enable the subdirectory install feature in Multisite.
* Filters whether to enable the subdirectory install feature in Multisite.
*
* @since 3.0.0
*

6
wp-admin/includes/plugin-install.php
View File

@ -113,7 +113,7 @@ function plugins_api( $action, $args = array() ) {
}
/**
* Filter the WordPress.org Plugin Install API arguments.
* Filters the WordPress.org Plugin Install API arguments.
*
* Important: An object MUST be returned to this filter.
*
@ -125,7 +125,7 @@ function plugins_api( $action, $args = array() ) {
$args = apply_filters( 'plugins_api_args', $args, $action );
/**
* Filter the response for the current WordPress.org Plugin Install API request.
* Filters the response for the current WordPress.org Plugin Install API request.
*
* Passing a non-false value will effectively short-circuit the WordPress.org API request.
*
@ -171,7 +171,7 @@ function plugins_api( $action, $args = array() ) {
}
/**
* Filter the Plugin Install API response results.
* Filters the Plugin Install API response results.
*
* @since 2.7.0
*

28
wp-admin/includes/post.php
View File

@ -622,7 +622,7 @@ function get_default_post_to_edit( $post_type = 'post', $create_in_db = false )
}
/**
* Filter the default post content initially used in the "Write Post" form.
* Filters the default post content initially used in the "Write Post" form.
*
* @since 1.5.0
*
@ -632,7 +632,7 @@ function get_default_post_to_edit( $post_type = 'post', $create_in_db = false )
$post->post_content = apply_filters( 'default_content', $post_content, $post );
/**
* Filter the default post title initially used in the "Write Post" form.
* Filters the default post title initially used in the "Write Post" form.
*
* @since 1.5.0
*
@ -642,7 +642,7 @@ function get_default_post_to_edit( $post_type = 'post', $create_in_db = false )
$post->post_title = apply_filters( 'default_title', $post_title, $post );
/**
* Filter the default post excerpt initially used in the "Write Post" form.
* Filters the default post excerpt initially used in the "Write Post" form.
*
* @since 1.5.0
*
@ -1022,7 +1022,7 @@ function wp_edit_posts_query( $q = false ) {
$posts_per_page = 20;
/**
* Filter the number of items per page to show for a specific 'per_page' type.
* Filters the number of items per page to show for a specific 'per_page' type.
*
* The dynamic portion of the hook name, `$post_type`, refers to the post type.
*
@ -1037,7 +1037,7 @@ function wp_edit_posts_query( $q = false ) {
$posts_per_page = apply_filters( "edit_{$post_type}_per_page", $posts_per_page );
/**
* Filter the number of posts displayed per page when specifically listing "posts".
* Filters the number of posts displayed per page when specifically listing "posts".
*
* @since 2.8.0
*
@ -1113,7 +1113,7 @@ function wp_edit_attachments_query_vars( $q = false ) {
}
/**
* Filter the number of items to list per page when listing media items.
* Filters the number of items to list per page when listing media items.
*
* @since 2.9.0
*
@ -1181,7 +1181,7 @@ function postbox_classes( $id, $page ) {
}
/**
* Filter the postbox classes for a specific screen and screen ID combo.
* Filters the postbox classes for a specific screen and screen ID combo.
*
* The dynamic portions of the hook name, `$page` and `$id`, refer to
* the screen and screen ID, respectively.
@ -1259,7 +1259,7 @@ function get_sample_permalink($id, $title = null, $name = null) {
unset($post->filter);
/**
* Filter the sample permalink.
* Filters the sample permalink.
*
* @since 4.4.0
*
@ -1347,7 +1347,7 @@ function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) {
}
/**
* Filter the sample permalink HTML markup.
* Filters the sample permalink HTML markup.
*
* @since 2.9.0
* @since 4.4.0 Added `$post` parameter.
@ -1393,7 +1393,7 @@ function _wp_post_thumbnail_html( $thumbnail_id = null, $post = null ) {
$size = isset( $_wp_additional_image_sizes['post-thumbnail'] ) ? 'post-thumbnail' : array( 266, 266 );
/**
* Filter the size used to display the post thumbnail image in the 'Featured Image' meta box.
* Filters the size used to display the post thumbnail image in the 'Featured Image' meta box.
*
* Note: When a theme adds 'post-thumbnail' support, a special 'post-thumbnail'
* image size is registered, which differs from the 'thumbnail' image size
@ -1426,7 +1426,7 @@ function _wp_post_thumbnail_html( $thumbnail_id = null, $post = null ) {
}
/**
* Filter the admin post thumbnail HTML markup to return.
* Filters the admin post thumbnail HTML markup to return.
*
* @since 2.9.0
* @since 3.5.0 Added $post->ID
@ -1505,7 +1505,7 @@ function _admin_notice_post_locked() {
if ( $user ) {
/**
* Filter whether to show the post locked dialog.
* Filters whether to show the post locked dialog.
*
* Returning a falsey value to the filter will short-circuit displaying the dialog.
*
@ -1557,7 +1557,7 @@ function _admin_notice_post_locked() {
$preview_link = get_preview_post_link( $post->ID, $query_args );
/**
* Filter whether to allow the post lock to be overridden.
* Filters whether to allow the post lock to be overridden.
*
* Returning a falsey value to the filter will disable the ability
* to override the post lock.
@ -1835,7 +1835,7 @@ function redirect_post($post_id = '') {
}
/**
* Filter the post redirect destination URL.
* Filters the post redirect destination URL.
*
* @since 2.9.0
*

8
wp-admin/includes/revision.php
View File

@ -80,9 +80,9 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
);
/**
* Filter revisions text diff options.
* Filters revisions text diff options.
*
* Filter the options passed to wp_text_diff() when viewing a post revision.
* Filters the options passed to wp_text_diff() when viewing a post revision.
*
* @since 4.1.0
*
@ -119,7 +119,7 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
}
/**
* Filter the fields displayed in the post revision diff UI.
* Filters the fields displayed in the post revision diff UI.
*
* @since 4.1.0
*
@ -213,7 +213,7 @@ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null
);
/**
* Filter the array of revisions used on the revisions screen.
* Filters the array of revisions used on the revisions screen.
*
* @since 4.4.0
*

2
wp-admin/includes/schema.php
View File

@ -1028,7 +1028,7 @@ We hope you enjoy your new site. Thanks!
$sitemeta['illegal_names'][] = 'blog';
/**
* Filter meta for a network on creation.
* Filters meta for a network on creation.
*
* @since 3.7.0
*

10
wp-admin/includes/screen.php
View File

@ -25,7 +25,7 @@ function get_column_headers( $screen ) {
if ( ! isset( $column_headers[ $screen->id ] ) ) {
/**
* Filter the column headers for a list table on a specific screen.
* Filters the column headers for a list table on a specific screen.
*
* The dynamic portion of the hook name, `$screen->id`, refers to the
* ID of a specific screen. For example, the screen ID for the Posts
@ -63,7 +63,7 @@ function get_hidden_columns( $screen ) {
$hidden = array();
/**
* Filter the default list of hidden columns.
* Filters the default list of hidden columns.
*
* @since 4.4.0
*
@ -74,7 +74,7 @@ function get_hidden_columns( $screen ) {
}
/**
* Filter the list of hidden columns.
* Filters the list of hidden columns.
*
* @since 4.4.0
* @since 4.4.1 Added the `use_defaults` parameter.
@ -153,7 +153,7 @@ function get_hidden_meta_boxes( $screen ) {
}
/**
* Filter the default list of hidden meta boxes.
* Filters the default list of hidden meta boxes.
*
* @since 3.1.0
*
@ -164,7 +164,7 @@ function get_hidden_meta_boxes( $screen ) {
}
/**
* Filter the list of hidden meta boxes.
* Filters the list of hidden meta boxes.
*
* @since 3.3.0
*

2
wp-admin/includes/taxonomy.php
View File

@ -259,7 +259,7 @@ function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
$terms_to_edit = esc_attr( join( ',', $term_names ) );
/**
* Filter the comma-separated list of terms available to edit.
* Filters the comma-separated list of terms available to edit.
*
* @since 2.8.0
*

14
wp-admin/includes/template.php
View File

@ -86,7 +86,7 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) {
);
/**
* Filter the taxonomy terms checklist arguments.
* Filters the taxonomy terms checklist arguments.
*
* @since 3.4.0
*
@ -354,7 +354,7 @@ function get_inline_data($post) {
function wp_comment_reply( $position = 1, $checkbox = false, $mode = 'single', $table_row = true ) {
global $wp_list_table;
/**
* Filter the in-line comment reply-to form output in the Comments
* Filters the in-line comment reply-to form output in the Comments
* list table.
*
* Returning a non-empty value here will short-circuit display
@ -582,7 +582,7 @@ function meta_form( $post = null ) {
$post = get_post( $post );
/**
* Filter values for the meta key dropdown in the Custom Fields meta box.
* Filters values for the meta key dropdown in the Custom Fields meta box.
*
* Returning a non-null value will effectively short-circuit and avoid a
* potentially expensive query against postmeta.
@ -596,7 +596,7 @@ function meta_form( $post = null ) {
if ( null === $keys ) {
/**
* Filter the number of custom fields to retrieve for the drop-down
* Filters the number of custom fields to retrieve for the drop-down
* in the Custom Fields meta box.
*
* @since 2.1.0
@ -843,7 +843,7 @@ function wp_dropdown_roles( $selected = '' ) {
function wp_import_upload_form( $action ) {
/**
* Filter the maximum allowed upload size for import files.
* Filters the maximum allowed upload size for import files.
*
* @since 2.3.0
*
@ -1712,7 +1712,7 @@ function _post_states($post) {
}
/**
* Filter the default post display states used in the posts list table.
* Filters the default post display states used in the posts list table.
*
* @since 2.8.0
*
@ -1763,7 +1763,7 @@ function _media_states( $post ) {
}
/**
* Filter the default media display states for items in the Media list table.
* Filters the default media display states for items in the Media list table.
*
* @since 3.2.0
*

12
wp-admin/includes/theme.php
View File

@ -311,7 +311,7 @@ function get_theme_feature_list( $api = true ) {
* Retrieves theme installer pages from the WordPress.org Themes API.
*
* It is possible for a theme to override the Themes API result with three
* filters. Assume this is for themes, which can extend on the Theme Info to
* Filterss. Assume this is for themes, which can extend on the Theme Info to
* offer more choices. This is very powerful and must be used with care, when
* overriding the filters.
*
@ -403,7 +403,7 @@ function themes_api( $action, $args = array() ) {
}
/**
* Filter arguments used to query for installer pages from the WordPress.org Themes API.
* Filters arguments used to query for installer pages from the WordPress.org Themes API.
*
* Important: An object MUST be returned to this filter.
*
@ -416,7 +416,7 @@ function themes_api( $action, $args = array() ) {
$args = apply_filters( 'themes_api_args', $args, $action );
/**
* Filter whether to override the WordPress.org Themes API.
* Filters whether to override the WordPress.org Themes API.
*
* Passing a non-false value will effectively short-circuit the WordPress.org API request.
*
@ -462,7 +462,7 @@ function themes_api( $action, $args = array() ) {
}
/**
* Filter the returned WordPress.org Themes API response.
* Filters the returned WordPress.org Themes API response.
*
* @since 2.8.0
*
@ -488,7 +488,7 @@ function wp_prepare_themes_for_js( $themes = null ) {
$current_theme = get_stylesheet();
/**
* Filter theme data before it is prepared for JavaScript.
* Filters theme data before it is prepared for JavaScript.
*
* Passing a non-empty array will result in wp_prepare_themes_for_js() returning
* early with that value instead.
@ -574,7 +574,7 @@ function wp_prepare_themes_for_js( $themes = null ) {
}
/**
* Filter the themes prepared for JavaScript, for themes.php.
* Filters the themes prepared for JavaScript, for themes.php.
*
* Could be useful for changing the order, which is by name by default.
*

2
wp-admin/includes/translation-install.php
View File

@ -72,7 +72,7 @@ function translations_api( $type, $args = null ) {
}
/**
* Filter the Translation Install API response results.
* Filters the Translation Install API response results.
*
* @since 4.0.0
*

2
wp-admin/includes/update-core.php
View File

@ -803,7 +803,7 @@ function update_core($from, $to) {
@set_time_limit( 300 );
/**
* Filter feedback messages displayed during the core update process.
* Filters feedback messages displayed during the core update process.
*
* The filter is first evaluated after the zip file for the latest version
* has been downloaded and unzipped. It is evaluated five more times during

2
wp-admin/includes/update.php
View File

@ -258,7 +258,7 @@ function update_right_now_message() {
$content = __( 'WordPress %1$s running %2$s theme.' );
/**
* Filter the text displayed in the 'At a Glance' dashboard widget.
* Filters the text displayed in the 'At a Glance' dashboard widget.
*
* Prior to 3.8.0, the widget was named 'Right Now'.
*

10
wp-admin/includes/upgrade.php
View File

@ -2047,7 +2047,7 @@ function __get_option($setting) {
}
/**
* Filters for content to remove unnecessary slashes.
* Filterss for content to remove unnecessary slashes.
*
* @since 1.5.0
*
@ -2104,7 +2104,7 @@ function dbDelta( $queries = '', $execute = true ) {
}
/**
* Filter the dbDelta SQL queries.
* Filters the dbDelta SQL queries.
*
* @since 3.3.0
*
@ -2133,7 +2133,7 @@ function dbDelta( $queries = '', $execute = true ) {
}
/**
* Filter the dbDelta SQL queries for creating tables and/or databases.
* Filters the dbDelta SQL queries for creating tables and/or databases.
*
* Queries filterable via this hook contain "CREATE TABLE" or "CREATE DATABASE".
*
@ -2144,7 +2144,7 @@ function dbDelta( $queries = '', $execute = true ) {
$cqueries = apply_filters( 'dbdelta_create_queries', $cqueries );
/**
* Filter the dbDelta SQL queries for inserting or updating.
* Filters the dbDelta SQL queries for inserting or updating.
*
* Queries filterable via this hook contain "INSERT INTO" or "UPDATE".
*
@ -2782,7 +2782,7 @@ function wp_should_upgrade_global_tables() {
}
/**
* Filter if upgrade routines should be run on global tables.
* Filters if upgrade routines should be run on global tables.
*
* @param bool $should_upgrade Whether to run the upgrade routines on global tables.
*/

6
wp-admin/includes/user.php
View File

@ -218,7 +218,7 @@ function get_editable_roles() {
$all_roles = wp_roles()->roles;
/**
* Filter the list of editable roles.
* Filters the list of editable roles.
*
* @since 2.8.0
*
@ -261,7 +261,7 @@ function get_users_drafts( $user_id ) {
$query = $wpdb->prepare("SELECT ID, post_title FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'draft' AND post_author = %d ORDER BY post_modified DESC", $user_id);
/**
* Filter the user's drafts query string.
* Filters the user's drafts query string.
*
* @since 2.0.0
*
@ -329,7 +329,7 @@ function wp_delete_user( $id, $reassign = null ) {
}
/**
* Filter the list of post types to delete with a user.
* Filters the list of post types to delete with a user.
*
* @since 3.4.0
*

2
wp-admin/maint/repair.php
View File

@ -80,7 +80,7 @@ if ( ! defined( 'WP_ALLOW_REPAIR' ) ) {
}
/**
* Filter additional database tables to repair.
* Filters additional database tables to repair.
*
* @since 3.0.0
*

4
wp-admin/media-upload.php
View File

@ -53,7 +53,7 @@ if ( isset($_GET['type']) ) {
$type = strval($_GET['type']);
} else {
/**
* Filter the default media upload type in the legacy (pre-3.5.0) media popup.
* Filters the default media upload type in the legacy (pre-3.5.0) media popup.
*
* @since 2.5.0
*
@ -68,7 +68,7 @@ if ( isset($_GET['tab']) ) {
$tab = strval($_GET['tab']);
} else {
/**
* Filter the default tab in the legacy (pre-3.5.0) media popup.
* Filters the default tab in the legacy (pre-3.5.0) media popup.
*
* @since 2.5.0
*

4
wp-admin/menu-header.php
View File

@ -27,7 +27,7 @@ $self = preg_replace('|^.*/mu-plugins/|i', '', $self);
global $menu, $submenu, $parent_file, $submenu_file;
/**
* Filter the parent file of an admin menu sub-menu item.
* Filters the parent file of an admin menu sub-menu item.
*
* Allows plugins to move sub-menu items around.
*
@ -38,7 +38,7 @@ global $menu, $submenu, $parent_file, $submenu_file;
$parent_file = apply_filters( 'parent_file', $parent_file );
/**
* Filter the file of an admin menu sub-menu item.
* Filters the file of an admin menu sub-menu item.
*
* @since 4.4.0
*

2
wp-admin/ms-delete-site.php
View File

@ -60,7 +60,7 @@ Thanks for using the site,
Webmaster
###SITE_NAME###" );
/**
* Filter the email content sent when a site in a Multisite network is deleted.
* Filters the email content sent when a site in a Multisite network is deleted.
*
* @since 3.0.0
*

2
wp-admin/my-sites.php
View File

@ -109,7 +109,7 @@ else :
echo "<li>";
echo "<h3>{$user_blog->blogname}</h3>";
/**
* Filter the row links displayed for each site on the My Sites screen.
* Filters the row links displayed for each site on the My Sites screen.
*
* @since MU
*

2
wp-admin/nav-menus.php
View File

@ -711,7 +711,7 @@ require_once( ABSPATH . 'wp-admin/admin-header.php' );
}
/**
* Filter the number of locations listed per menu in the drop-down select.
* Filters the number of locations listed per menu in the drop-down select.
*
* @since 3.6.0
*

2
wp-admin/network/admin.php
View File

@ -18,7 +18,7 @@ if ( ! is_multisite() )
$redirect_network_admin_request = 0 !== strcasecmp( $current_blog->domain, $current_site->domain ) || 0 !== strcasecmp( $current_blog->path, $current_site->path );
/**
* Filter whether to redirect the request to the Network Admin.
* Filters whether to redirect the request to the Network Admin.
*
* @since 3.2.0
*

2
wp-admin/network/settings.php
View File

@ -347,7 +347,7 @@ if ( isset( $_GET['updated'] ) ) {
<?php
$menu_perms = get_site_option( 'menu_items' );
/**
* Filter available network-wide administration menu options.
* Filters available network-wide administration menu options.
*
* Options returned to this filter are output as individual checkboxes that, when selected,
* enable site administrator access to the specified administration menu in certain contexts.

4
wp-admin/network/site-users.php
View File

@ -185,7 +185,7 @@ $parent_file = 'sites.php';
$submenu_file = 'sites.php';
/**
* Filter whether to show the Add Existing User form on the Multisite Users screen.
* Filters whether to show the Add Existing User form on the Multisite Users screen.
*
* @since 3.1.0
*
@ -292,7 +292,7 @@ if ( current_user_can( 'promote_users' ) && apply_filters( 'show_network_site_us
<?php
/**
* Filter whether to show the Add New User form on the Multisite Users screen.
* Filters whether to show the Add New User form on the Multisite Users screen.
*
* @since 3.1.0
*

2
wp-admin/network/sites.php
View File

@ -259,7 +259,7 @@ if ( isset( $_GET['updated'] ) ) {
break;
default:
/**
* Filter a specific, non-default site-updated message in the Network admin.
* Filters a specific, non-default site-updated message in the Network admin.
*
* The dynamic portion of the hook name, `$_GET['updated']`, refers to the
* non-default site update action.

6
wp-admin/options-discussion.php
View File

@ -78,7 +78,7 @@ include( ABSPATH . 'wp-admin/admin-header.php' );
<input name="thread_comments" type="checkbox" id="thread_comments" value="1" <?php checked('1', get_option('thread_comments')); ?> />
<?php
/**
* Filter the maximum depth of threaded/nested comments.
* Filters the maximum depth of threaded/nested comments.
*
* @since 2.7.0.
*
@ -229,7 +229,7 @@ $avatar_defaults = array(
'retro' => __('Retro (Generated)')
);
/**
* Filter the default avatars.
* Filters the default avatars.
*
* Avatars are stored in key/value pairs, where the key is option value,
* and the name is the displayed avatar name.
@ -256,7 +256,7 @@ foreach ( $avatar_defaults as $default_key => $default_name ) {
remove_filter( 'pre_option_show_avatars', '__return_true', 100 );
/**
* Filter the HTML output of the default avatar list.
* Filters the HTML output of the default avatar list.
*
* @since 2.6.0
*

4
wp-admin/options-general.php
View File

@ -231,7 +231,7 @@ if ( empty($tzstring) ) { // Create a UTC+- zone if no timezone string exists
<fieldset><legend class="screen-reader-text"><span><?php _e('Date Format') ?></span></legend>
<?php
/**
* Filter the default date formats.
* Filters the default date formats.
*
* @since 2.7.0
* @since 4.0.0 Added ISO date standard YYYY-MM-DD format.
@ -268,7 +268,7 @@ if ( empty($tzstring) ) { // Create a UTC+- zone if no timezone string exists
<fieldset><legend class="screen-reader-text"><span><?php _e('Time Format') ?></span></legend>
<?php
/**
* Filter the default time formats.
* Filters the default time formats.
*
* @since 2.7.0
*

2
wp-admin/options-writing.php
View File

@ -156,7 +156,7 @@ wp_dropdown_categories(array('hide_empty' => 0, 'name' => 'default_email_categor
<?php
/**
* Filter whether to enable the Update Services section in the Writing settings screen.
* Filters whether to enable the Update Services section in the Writing settings screen.
*
* @since 3.0.0
*

6
wp-admin/options.php
View File

@ -32,7 +32,7 @@ if ( empty($option_page) ) {
} else {
/**
* Filter the capability required when using the Settings API.
* Filters the capability required when using the Settings API.
*
* By default, the options groups for all registered settings require the manage_options capability.
* This filter is required to change the capability required for a certain options page.
@ -124,7 +124,7 @@ if ( !is_multisite() ) {
$whitelist_options['general'][] = 'new_admin_email';
/**
* Filter whether the post-by-email functionality is enabled.
* Filters whether the post-by-email functionality is enabled.
*
* @since 3.0.0
*
@ -135,7 +135,7 @@ if ( !is_multisite() ) {
}
/**
* Filter the options white list.
* Filters the options white list.
*
* @since 2.7.0
*

2
wp-admin/plugin-editor.php
View File

@ -106,7 +106,7 @@ default:
$editable_extensions = array('php', 'txt', 'text', 'js', 'css', 'html', 'htm', 'xml', 'inc', 'include');
/**
* Filter file type extensions editable in the plugin editor.
* Filters file type extensions editable in the plugin editor.
*
* @since 2.8.0
*

2
wp-admin/theme-editor.php
View File

@ -66,7 +66,7 @@ $has_templates = false;
$default_types = array( 'php', 'css' );
/**
* Filter the list of file types allowed for editing in the Theme editor.
* Filters the list of file types allowed for editing in the Theme editor.
*
* @since 4.4.0
*

2
wp-admin/theme-install.php
View File

@ -116,7 +116,7 @@ include(ABSPATH . 'wp-admin/admin-header.php');
echo esc_html( $title );
/**
* Filter the tabs shown on the Add Themes screen.
* Filters the tabs shown on the Add Themes screen.
*
* This filter is for backward compatibility only, for the suppression of the upload tab.
*

10
wp-admin/user-edit.php
View File

@ -60,7 +60,7 @@ $wp_http_referer = remove_query_arg( array( 'update', 'delete_count', 'user_id'
$user_can_edit = current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' );
/**
* Filter whether to allow administrators on Multisite to edit every user.
* Filters whether to allow administrators on Multisite to edit every user.
*
* Enabling the user editing form via this filter also hinges on the user holding
* the 'manage_network_users' cap, and the logged-in user not matching the user
@ -426,7 +426,7 @@ if ( is_multisite() && is_network_admin() && ! IS_PROFILE_PAGE && current_user_c
<th><label for="<?php echo $name; ?>">
<?php
/**
* Filter a user contactmethod label.
* Filters a user contactmethod label.
*
* The dynamic portion of the filter hook, `$name`, refers to
* each of the keys in the contactmethods array.
@ -470,7 +470,7 @@ if ( is_multisite() && is_network_admin() && ! IS_PROFILE_PAGE && current_user_c
}
/**
* Filter the user profile picture description displayed under the Gravatar.
* Filters the user profile picture description displayed under the Gravatar.
*
* @since 4.4.0
*
@ -484,7 +484,7 @@ if ( is_multisite() && is_network_admin() && ! IS_PROFILE_PAGE && current_user_c
<?php
/**
* Filter the display of the password fields.
* Filters the display of the password fields.
*
* @since 1.5.1
* @since 2.8.0 Added the `$profileuser` parameter.
@ -601,7 +601,7 @@ if ( IS_PROFILE_PAGE && count( $sessions->get_all() ) === 1 ) : ?>
<?php
/**
* Filter whether to display additional capabilities for the user.
* Filters whether to display additional capabilities for the user.
*
* The 'Additional Capabilities' section will only be enabled if
* the number of the user's capabilities exceeds their number of

4
wp-admin/user-new.php
View File

@ -133,7 +133,7 @@ Please click the following link to confirm the invite:
$add_user_errors = $user_details[ 'errors' ];
} else {
/**
* Filter the user_login, also known as the username, before it is added to the site.
* Filters the user_login, also known as the username, before it is added to the site.
*
* @since 2.0.3
*
@ -210,7 +210,7 @@ wp_enqueue_script('wp-ajax-response');
wp_enqueue_script( 'user-profile' );
/**
* Filter whether to enable user auto-complete for non-super admins in Multisite.
* Filters whether to enable user auto-complete for non-super admins in Multisite.
*
* @since 3.4.0
*

2
wp-admin/user/admin.php
View File

@ -18,7 +18,7 @@ if ( ! is_multisite() ) {
$redirect_user_admin_request = ( ( $current_blog->domain != $current_site->domain ) || ( $current_blog->path != $current_site->path ) );
/**
* Filter whether to redirect the request to the User Admin in Multisite.
* Filters whether to redirect the request to the User Admin in Multisite.
*
* @since 3.2.0
*

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.6-alpha-37487';
$wp_version = '4.6-alpha-37488';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.