WordPress.org

Make WordPress Core


Ignore:
Timestamp:
09/07/2010 11:21:11 AM (10 years ago)
Author:
nacin
Message:

Phpdoc argument/@param cleanups. props duck_, see #14783.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/post.php

    r15589 r15590  
    626626 * @see get_post_statuses
    627627 *
    628  * @param string $post_type The name of a registered post status
     628 * @param string $post_status The name of a registered post status
    629629 * @return object A post status object
    630630 */
     
    670670 * @see get_post_type_object
    671671 *
    672  * @param string $post Post type name
     672 * @param string $post_type Post type name
    673673 * @return bool Whether post type is hierarchical.
    674674 */
     
    687687 * @uses get_post_type_object()
    688688 *
    689  * @param string Post type name
     689 * @param string $post_type Post type name
    690690 * @return bool Whether post type is registered.
    691691 */
     
    11451145 *
    11461146 * @param int $post_id Post ID.
    1147  * @param string $key Metadata name.
    1148  * @param mixed $value Metadata value.
     1147 * @param string $meta_key Metadata name.
     1148 * @param mixed $meta_value Metadata value.
    11491149 * @param bool $unique Optional, default is false. Whether the same key should not be added.
    11501150 * @return bool False for failure. True for success.
     
    12121212 *
    12131213 * @param int $post_id Post ID.
    1214  * @param string $key Metadata key.
    1215  * @param mixed $value Metadata value.
     1214 * @param string $meta_key Metadata key.
     1215 * @param mixed $meta_value Metadata value.
    12161216 * @param mixed $prev_value Optional. Previous value to check before removing.
    12171217 * @return bool False on failure, true if success.
     
    16511651 * @since 2.5.0
    16521652 *
    1653  * @param string|array $mime_types List of mime types or comma separated string of mime types.
     1653 * @param string|array $post_mime_types List of mime types or comma separated string of mime types.
    16541654 * @param string $table_alias Optional. Specify a table alias, if needed.
    16551655 * @return string The SQL AND clause for mime searching.
     
    18101810 * @uses wp_delete_post() if trash is disabled
    18111811 *
    1812  * @param int $postid Post ID.
     1812 * @param int $post_id Post ID.
    18131813 * @return mixed False on failure
    18141814 */
     
    18451845 * @uses do_action() on 'untrashed_post' after undeletion
    18461846 *
    1847  * @param int $postid Post ID.
     1847 * @param int $post_id Post ID.
    18481848 * @return mixed False on failure
    18491849 */
     
    29652965 * @since 2.0.0
    29662966 *
    2967  * @param array $posts Posts array.
    2968  * @param int $parent Parent page ID.
     2967 * @param array $pages Posts array.
     2968 * @param int $page_id Parent page ID.
    29692969 * @return array A list arranged by hierarchy. Children immediately follow their parents.
    29702970 */
    29712971function &get_page_hierarchy( &$pages, $page_id = 0 ) {
    2972 
    29732972    if ( empty( $pages ) ) {
    29742973        $result = array();
     
    29782977    $children = array();
    29792978    foreach ( (array) $pages as $p ) {
    2980 
    29812979        $parent_id = intval( $p->post_parent );
    29822980        $children[ $parent_id ][] = $p;
    2983      }
    2984 
    2985      $result = array();
    2986      _page_traverse_name( $page_id, $children, $result );
     2981    }
     2982
     2983    $result = array();
     2984    _page_traverse_name( $page_id, $children, $result );
    29872985
    29882986    return $result;
     
    29952993 */
    29962994function _page_traverse_name( $page_id, &$children, &$result ){
    2997 
    29982995    if ( isset( $children[ $page_id ] ) ){
    2999 
    30002996        foreach( (array)$children[ $page_id ] as $child ) {
    3001 
    30022997            $result[ $child->ID ] = $child->post_name;
    30032998            _page_traverse_name( $child->ID, $children, $result );
     
    32783273 * @param string|array $object Arguments to override defaults.
    32793274 * @param string $file Optional filename.
    3280  * @param int $post_parent Parent post ID.
     3275 * @param int $parent Parent post ID.
    32813276 * @return int Attachment ID.
    32823277 */
     
    34283423 * @uses do_action() Calls 'delete_attachment' hook on Attachment ID.
    34293424 *
    3430  * @param int $postid Attachment ID.
     3425 * @param int $post_id Attachment ID.
    34313426 * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
    34323427 * @return mixed False on failure. Post data on success.
     
    46464641 *
    46474642 * @param int|object $revision_id Revision ID or revision object.
    4648  * @param array $fields Optional. What fields to restore from.  Defaults to all.
    4649  * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
     4643 * @return mixed Null or WP_Error if error, deleted post if success.
    46504644 */
    46514645function wp_delete_post_revision( $revision_id ) {
Note: See TracChangeset for help on using the changeset viewer.