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

Updated phpDoc for wp-admin/includes/post.php . Fixes #11198 based on a patch from Simek. 

git-svn-id: http://svn.automattic.com/wordpress/trunk@12483 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi 2009-12-22 12:25:15 +00:00
parent bcaffad604
commit 1a097b6479
1 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -213,13 +213,14 @@ function edit_post( $post_data = null ) {
} }
/** /**
* {@internal Missing Short Description}} * Process the post data for the bulk editing of posts.
* *
* Updates all bulk edited posts/pages, adding (but not removing) tags and * Updates all bulk edited posts/pages, adding (but not removing) tags and
* categories. Skips pages when they would be their own parent or child. * categories. Skips pages when they would be their own parent or child.
* *
* @since unknown * @since 2.7.0
* *
* @param array $post_data Optional, the array of post data to process if not provided will use $_POST superglobal.
* @return array * @return array
*/ */
function bulk_edit_posts( $post_data = null ) { function bulk_edit_posts( $post_data = null ) {
@ -323,7 +324,7 @@ function bulk_edit_posts( $post_data = null ) {
* *
* @since unknown * @since unknown
* *
* @return unknown * @return object stdClass object containing all the default post data as attributes
*/ */
function get_default_post_to_edit() { function get_default_post_to_edit() {
@ -364,11 +365,11 @@ function get_default_post_to_edit() {
} }
/** /**
* {@internal Missing Short Description}} * Get the default page information to use.
* *
* @since unknown * @since 2.5.0
* *
* @return unknown * @return object stdClass object containing all the default post data as attributes
*/ */
function get_default_page_to_edit() { function get_default_page_to_edit() {
$page = get_default_post_to_edit(); $page = get_default_post_to_edit();
@ -789,12 +790,12 @@ function _relocate_children( $old_ID, $new_ID ) {
} }
/** /**
* {@internal Missing Short Description}} * Get all the possible statuses for a post_type
* *
* @since unknown * @since 2.5.0
* *
* @param unknown_type $type * @param string $type The post_type you want the statuses for
* @return unknown * @return array As array of all the statuses for the supplied post type
*/ */
function get_available_post_statuses($type = 'post') { function get_available_post_statuses($type = 'post') {
$stati = wp_count_posts($type); $stati = wp_count_posts($type);
@ -803,12 +804,12 @@ function get_available_post_statuses($type = 'post') {
} }
/** /**
* {@internal Missing Short Description}} * Run the wp query to fetch the posts for listing on the edit posts page
* *
* @since unknown * @since 2.5.0
* *
* @param unknown_type $q * @param array|bool $q Array of query variables to use to build the query or false to use $_GET superglobal.
* @return unknown * @return array
*/ */
function wp_edit_posts_query( $q = false ) { function wp_edit_posts_query( $q = false ) {
if ( false === $q ) if ( false === $q )
@ -922,6 +923,7 @@ function wp_edit_attachments_query( $q = false ) {
/** /**
* {@internal Missing Short Description}} * {@internal Missing Short Description}}
* *
* @uses get_user_option()
* @since unknown * @since unknown
* *
* @param unknown_type $id * @param unknown_type $id
@ -933,7 +935,9 @@ function postbox_classes( $id, $page ) {
return ''; return '';
$current_user = wp_get_current_user(); $current_user = wp_get_current_user();
if ( $closed = get_user_option('closedpostboxes_'.$page, 0, false ) ) { if ( $closed = get_user_option('closedpostboxes_'.$page, 0, false ) ) {
if ( !is_array( $closed ) ) return ''; if ( !is_array( $closed ) ) {
return '';
}
return in_array( $id, $closed )? 'closed' : ''; return in_array( $id, $closed )? 'closed' : '';
} else { } else {
return ''; return '';
@ -1172,6 +1176,8 @@ function _admin_notice_post_locked() {
* *
* @uses _wp_translate_postdata() * @uses _wp_translate_postdata()
* @uses _wp_post_revision_fields() * @uses _wp_post_revision_fields()
*
* @return unknown
*/ */
function wp_create_post_autosave( $post_id ) { function wp_create_post_autosave( $post_id ) {
$translated = _wp_translate_postdata( true ); $translated = _wp_translate_postdata( true );
@ -1198,7 +1204,7 @@ function wp_create_post_autosave( $post_id ) {
* Save draft or manually autosave for showing preview. * Save draft or manually autosave for showing preview.
* *
* @package WordPress * @package WordPress
* @since 2.7 * @since 2.7.0
* *
* @uses wp_write_post() * @uses wp_write_post()
* @uses edit_post() * @uses edit_post()
@ -1259,7 +1265,7 @@ function post_preview() {
* Adds the TinyMCE editor used on the Write and Edit screens. * Adds the TinyMCE editor used on the Write and Edit screens.
* *
* @package WordPress * @package WordPress
* @since 2.7 * @since 2.7.0
* *
* TinyMCE is loaded separately from other Javascript by using wp-tinymce.php. It outputs concatenated * TinyMCE is loaded separately from other Javascript by using wp-tinymce.php. It outputs concatenated
* and optionaly pre-compressed version of the core and all default plugins. Additional plugins are loaded * and optionaly pre-compressed version of the core and all default plugins. Additional plugins are loaded