WordPress.org

Make WordPress Core

Changeset 35169


Ignore:
Timestamp:
10/14/2015 11:24:46 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Fix third-person singular verbs for summaries in wp-admin/includes/bookmarks.php.

Also adds some missing parameter, return, and global descriptions, and one missing summary.

See #32246.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/bookmark.php

    r33887 r35169  
    1919
    2020/**
    21  * Update or insert a link using values provided in $_POST.
    22  *
    23  * @since 2.0.0
    24  *
    25  * @param int $link_id Optional. ID of the link to edit.
     21 * Updates or inserts a link using values provided in $_POST.
     22 *
     23 * @since 2.0.0
     24 *
     25 * @param int $link_id Optional. ID of the link to edit. Default 0.
    2626 * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
    2727 */
     
    5252
    5353/**
    54  * Retrieve the default link for editing.
    55  *
    56  * @since 2.0.0
    57  *
    58  * @return stdClass Default link
     54 * Retrieves the default link for editing.
     55 *
     56 * @since 2.0.0
     57 *
     58 * @return stdClass Default link object.
    5959 */
    6060function get_default_link_to_edit() {
     
    7676
    7777/**
    78  * Delete link specified from database.
    79  *
    80  * @since 2.0.0
    81  *
    82  * @global wpdb $wpdb
     78 * Deletes a specified link from the database.
     79 *
     80 * @since 2.0.0
     81 *
     82 * @global wpdb $wpdb WordPress database abstraction object.
    8383 *
    8484 * @param int $link_id ID of the link to delete
    85  * @return true
     85 * @return true Always true.
    8686 */
    8787function wp_delete_link( $link_id ) {
     
    9999
    100100    $wpdb->delete( $wpdb->links, array( 'link_id' => $link_id ) );
     101
    101102    /**
    102103     * Fires after a link has been deleted.
     
    127128
    128129/**
    129  * Retrieve link data based on ID.
    130  *
    131  * @since 2.0.0
    132  *
    133  * @param int $link_id ID of link to retrieve
    134  * @return object Link for editing
     130 * Retrieves link data based on its ID.
     131 *
     132 * @since 2.0.0
     133 *
     134 * @param int $link_id ID of link to retrieve.
     135 * @return object Link object for editing.
    135136 */
    136137function get_link_to_edit( $link_id ) {
     
    139140
    140141/**
    141  * This function inserts/updates links into/in the database.
    142  *
    143  * @since 2.0.0
    144  *
    145  * @global wpdb $wpdb
     142 * Inserts/updates links into/in the database.
     143 *
     144 * @since 2.0.0
     145 *
     146 * @global wpdb $wpdb WordPress database abstraction object.
    146147 *
    147148 * @param array $linkdata Elements that make up the link to insert.
    148  * @param bool  $wp_error Optional. If true return WP_Error object on failure.
     149 * @param bool  $wp_error Optional. Whether to return a WP_Error object on failure. Default false.
    149150 * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
    150151 */
     
    189190    $link_category    = ( ! empty( $r['link_category'] ) ) ? $r['link_category'] : array();
    190191
    191     // Make sure we set a valid category
     192    // Make sure we set a valid category.
    192193    if ( ! is_array( $link_category ) || 0 == count( $link_category ) ) {
    193194        $link_category = array( get_option( 'default_link_category' ) );
     
    244245 * @since 2.1.0
    245246 *
    246  * @param int $link_id ID of link to update
    247  * @param array $link_categories Array of categories to
     247 * @param int   $link_id         ID of the link to update.
     248 * @param array $link_categories Array of link categories to add the link to.
    248249 */
    249250function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
     
    261262
    262263/**
    263  * Update a link in the database.
     264 * Updates a link in the database.
    264265 *
    265266 * @since 2.0.0
     
    291292
    292293/**
     294 * Outputs the 'disabled' message for the WordPress Link Manager.
     295 *
    293296 * @since 3.5.0
    294297 * @access private
Note: See TracChangeset for help on using the changeset viewer.