vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-12 04:40:26 +00:00
Code Issues Actions 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.

Browse Source 
See #36913.


git-svn-id: https://develop.svn.wordpress.org/trunk@37488 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2016-05-22 18:00:23 +00:00
parent 520ed6b725
commit 1cd420af5e
86 changed files with 306 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-admin/includes/post.php
+14 -14
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
*