[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/includes/ -> bookmark.php (summary)

WordPress Bookmark Administration API

File Size: 380 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  add_link()
  edit_link()
  get_default_link_to_edit()
  wp_delete_link()
  wp_get_link_cats()
  get_link_to_edit()
  wp_insert_link()
  wp_set_link_cats()
  wp_update_link()
  wp_link_manager_disabled_message()

Functions
Functions that are not part of a class:

add_link()   X-Ref
Add a link to using values provided in $_POST.

return: int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
since: 2.0.0

edit_link( $link_id = 0 )   X-Ref
Updates or inserts a link using values provided in $_POST.

return: int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
param: int $link_id Optional. ID of the link to edit. Default 0.
since: 2.0.0

get_default_link_to_edit()   X-Ref
Retrieves the default link for editing.

return: stdClass Default link object.
since: 2.0.0

wp_delete_link( $link_id )   X-Ref
Deletes a specified link from the database.

return: true Always true.
param: int $link_id ID of the link to delete
since: 2.0.0

wp_get_link_cats( $link_id = 0 )   X-Ref
Retrieves the link category IDs associated with the link specified.

return: int[] The IDs of the requested link's categories.
param: int $link_id Link ID to look up.
since: 2.1.0

get_link_to_edit( $link )   X-Ref
Retrieves link data based on its ID.

return: object Link object for editing.
param: int|stdClass $link Link ID or object to retrieve.
since: 2.0.0

wp_insert_link( $linkdata, $wp_error = false )   X-Ref
Inserts a link into the database, or updates an existing link.

Runs all the necessary sanitizing, provides default values if arguments are missing,
and finally saves the link.

return: int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
param: array $linkdata {
param: bool  $wp_error Optional. Whether to return a WP_Error object on failure. Default false.
since: 2.0.0

wp_set_link_cats( $link_id = 0, $link_categories = array()   X-Ref
Update link with the specified link categories.

param: int   $link_id         ID of the link to update.
param: int[] $link_categories Array of link category IDs to add the link to.
since: 2.1.0

wp_update_link( $linkdata )   X-Ref
Updates a link in the database.

return: int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
param: array $linkdata Link data to update. See wp_insert_link() for accepted arguments.
since: 2.0.0

wp_link_manager_disabled_message()   X-Ref
Outputs the 'disabled' message for the WordPress Link Manager.

since: 3.5.0



Generated: Fri Dec 6 01:00:02 2024 Cross-referenced by PHPXref 0.7.1