WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/03/2020 03:50:29 AM (13 months ago)
Author:
SergeyBiryukov
Message:

Docs: Document the $linkdata parameter of wp_insert_link() using hash notation.

Props stevenlinx, peterwilsoncc.
Fixes #50853.

File:
1 edited

Legend:

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

    r47922 r49487  
    143143
    144144/**
    145  * Inserts/updates links into/in the database.
     145 * Inserts a link into the database, or updates an existing link.
     146 *
     147 * Runs all the necessary sanitizing, provides default values if arguments are missing,
     148 * and finally saves the link.
    146149 *
    147150 * @since 2.0.0
     
    149152 * @global wpdb $wpdb WordPress database abstraction object.
    150153 *
    151  * @param array $linkdata Elements that make up the link to insert.
     154 * @param array $linkdata {
     155 *     Elements that make up the link to insert.
     156 *
     157 *     @type int    $link_id          Optional. The ID of the existing link if updating.
     158 *     @type string $link_url         The URL the link points to.
     159 *     @type string $link_name        The title of the link.
     160 *     @type string $link_image       Optional. A URL of an image.
     161 *     @type string $link_target      Optional. The target element for the anchor tag.
     162 *     @type string $link_description Optional. A short description of the link.
     163 *     @type string $link_visible     Optional. 'Y' means visible, anything else means not.
     164 *     @type int    $link_owner       Optional. A user ID.
     165 *     @type int    $link_rating      Optional. A rating for the link.
     166 *     @type string $link_updated     Optional. When the link was last updated.
     167 *     @type string $link_rel         Optional. A relationship of the link to you.
     168 *     @type string $link_notes       Optional. An extended description of or notes on the link.
     169 *     @type string $link_rss         Optional. A URL of an associated RSS feed.
     170 *     @type int    $link_category    Optional. The term ID of the link category.
     171 *                                    If empty, uses default link category.
     172 * }
    152173 * @param bool  $wp_error Optional. Whether to return a WP_Error object on failure. Default false.
    153174 * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
     
    275296 * @since 2.0.0
    276297 *
    277  * @param array $linkdata Link data to update.
     298 * @param array $linkdata Link data to update. See wp_insert_link() for accepted arguments.
    278299 * @return int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
    279300 */
Note: See TracChangeset for help on using the changeset viewer.