WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / includes / bookmark.php
index 09e5411e5901e30a57e9fc3391d164a7f24e85e8..bdf1d7fa4026897e381aee4558eaba575c6ede6f 100644 (file)
@@ -7,27 +7,27 @@
  */
 
 /**
- * {@internal Missing Short Description}}
+ * Add a link to using values provided in $_POST.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @return unknown
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
  */
 function add_link() {
        return edit_link();
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Update or insert a link using values provided in $_POST.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id Optional. ID of the link to edit.
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
  */
-function edit_link( $link_id = '' ) {
-       if (!current_user_can( 'manage_links' ))
-               wp_die( __( 'Cheatin’ uh?' ));
+function edit_link( $link_id = 0 ) {
+       if ( !current_user_can( 'manage_links' ) )
+               wp_die( __( 'Cheatin’ uh?' ), 403 );
 
        $_POST['link_url'] = esc_html( $_POST['link_url'] );
        $_POST['link_url'] = esc_url($_POST['link_url']);
@@ -39,27 +39,28 @@ function edit_link( $link_id = '' ) {
 
        if ( !empty( $link_id ) ) {
                $_POST['link_id'] = $link_id;
-               return wp_update_link( $_POST);
+               return wp_update_link( $_POST );
        } else {
-               return wp_insert_link( $_POST);
+               return wp_insert_link( $_POST );
        }
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieve the default link for editing.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @return unknown
+ * @return stdClass Default link
  */
 function get_default_link_to_edit() {
+       $link = new stdClass;
        if ( isset( $_GET['linkurl'] ) )
-               $link->link_url = esc_url( $_GET['linkurl']);
+               $link->link_url = esc_url( wp_unslash( $_GET['linkurl'] ) );
        else
                $link->link_url = '';
 
        if ( isset( $_GET['name'] ) )
-               $link->link_name = esc_attr( $_GET['name']);
+               $link->link_name = esc_attr( wp_unslash( $_GET['name'] ) );
        else
                $link->link_name = '';
 
@@ -69,22 +70,36 @@ function get_default_link_to_edit() {
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Delete link specified from database.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @param unknown_type $link_id
- * @return unknown
+ * @global wpdb $wpdb
+ *
+ * @param int $link_id ID of the link to delete
+ * @return true
  */
 function wp_delete_link( $link_id ) {
        global $wpdb;
-
+       /**
+        * Fires before a link is deleted.
+        *
+        * @since 2.0.0
+        *
+        * @param int $link_id ID of the link to delete.
+        */
        do_action( 'delete_link', $link_id );
 
        wp_delete_object_term_relationships( $link_id, 'link_category' );
 
-       $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->links WHERE link_id = %d", $link_id ) );
-
+       $wpdb->delete( $wpdb->links, array( 'link_id' => $link_id ) );
+       /**
+        * Fires after a link has been deleted.
+        *
+        * @since 2.2.0
+        *
+        * @param int $link_id ID of the deleted link.
+        */
        do_action( 'deleted_link', $link_id );
 
        clean_bookmark_cache( $link_id );
@@ -93,54 +108,57 @@ function wp_delete_link( $link_id ) {
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieves the link categories associated with the link specified.
  *
- * @since unknown
+ * @since 2.1.0
  *
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id Link ID to look up
+ * @return array The requested link's categories
  */
 function wp_get_link_cats( $link_id = 0 ) {
-
        $cats = wp_get_object_terms( $link_id, 'link_category', array('fields' => 'ids') );
-
        return array_unique( $cats );
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieve link data based on ID.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id ID of link to retrieve
+ * @return object Link for editing
  */
 function get_link_to_edit( $link_id ) {
        return get_bookmark( $link_id, OBJECT, 'edit' );
 }
 
 /**
- * {@internal Missing Short Description}}
+ * This function inserts/updates links into/in the database.
+ *
+ * @since 2.0.0
  *
- * @since unknown
+ * @global wpdb $wpdb
  *
- * @param unknown_type $linkdata
- * @return unknown
+ * @param array $linkdata Elements that make up the link to insert.
+ * @param bool  $wp_error Optional. If true return WP_Error object on failure.
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
  */
 function wp_insert_link( $linkdata, $wp_error = false ) {
        global $wpdb;
 
        $defaults = array( 'link_id' => 0, 'link_name' => '', 'link_url' => '', 'link_rating' => 0 );
 
-       $linkdata = wp_parse_args( $linkdata, $defaults );
-       $linkdata = sanitize_bookmark( $linkdata, 'db' );
+       $args = wp_parse_args( $linkdata, $defaults );
+       $r = wp_unslash( sanitize_bookmark( $args, 'db' ) );
 
-       extract( stripslashes_deep( $linkdata ), EXTR_SKIP );
+       $link_id   = $r['link_id'];
+       $link_name = $r['link_name'];
+       $link_url  = $r['link_url'];
 
        $update = false;
-
-       if ( !empty( $link_id ) )
+       if ( ! empty( $link_id ) ) {
                $update = true;
+       }
 
        if ( trim( $link_name ) == '' ) {
                if ( trim( $link_url ) != '' ) {
@@ -150,77 +168,78 @@ function wp_insert_link( $linkdata, $wp_error = false ) {
                }
        }
 
-       if ( trim( $link_url ) == '' )
+       if ( trim( $link_url ) == '' ) {
                return 0;
+       }
 
-       if ( empty( $link_rating ) )
-               $link_rating = 0;
-
-       if ( empty( $link_image ) )
-               $link_image = '';
-
-       if ( empty( $link_target ) )
-               $link_target = '';
-
-       if ( empty( $link_visible ) )
-               $link_visible = 'Y';
-
-       if ( empty( $link_owner ) )
-               $link_owner = get_current_user_id();
-
-       if ( empty( $link_notes ) )
-               $link_notes = '';
-
-       if ( empty( $link_description ) )
-               $link_description = '';
-
-       if ( empty( $link_rss ) )
-               $link_rss = '';
-
-       if ( empty( $link_rel ) )
-               $link_rel = '';
+       $link_rating      = ( ! empty( $r['link_rating'] ) ) ? $r['link_rating'] : 0;
+       $link_image       = ( ! empty( $r['link_image'] ) ) ? $r['link_image'] : '';
+       $link_target      = ( ! empty( $r['link_target'] ) ) ? $r['link_target'] : '';
+       $link_visible     = ( ! empty( $r['link_visible'] ) ) ? $r['link_visible'] : 'Y';
+       $link_owner       = ( ! empty( $r['link_owner'] ) ) ? $r['link_owner'] : get_current_user_id();
+       $link_notes       = ( ! empty( $r['link_notes'] ) ) ? $r['link_notes'] : '';
+       $link_description = ( ! empty( $r['link_description'] ) ) ? $r['link_description'] : '';
+       $link_rss         = ( ! empty( $r['link_rss'] ) ) ? $r['link_rss'] : '';
+       $link_rel         = ( ! empty( $r['link_rel'] ) ) ? $r['link_rel'] : '';
+       $link_category    = ( ! empty( $r['link_category'] ) ) ? $r['link_category'] : array();
 
        // Make sure we set a valid category
-       if ( ! isset( $link_category ) ||0 == count( $link_category ) || !is_array( $link_category ) ) {
+       if ( ! is_array( $link_category ) || 0 == count( $link_category ) ) {
                $link_category = array( get_option( 'default_link_category' ) );
        }
 
        if ( $update ) {
-               if ( false === $wpdb->update( $wpdb->links, compact('link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_rating', 'link_rel', 'link_notes', 'link_rss'), compact('link_id') ) ) {
-                       if ( $wp_error )
+               if ( false === $wpdb->update( $wpdb->links, compact( 'link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_rating', 'link_rel', 'link_notes', 'link_rss' ), compact( 'link_id' ) ) ) {
+                       if ( $wp_error ) {
                                return new WP_Error( 'db_update_error', __( 'Could not update link in the database' ), $wpdb->last_error );
-                       else
+                       } else {
                                return 0;
+                       }
                }
        } else {
-               if ( false === $wpdb->insert( $wpdb->links, compact('link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_rel', 'link_notes', 'link_rss') ) ) {
-                       if ( $wp_error )
+               if ( false === $wpdb->insert( $wpdb->links, compact( 'link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_rel', 'link_notes', 'link_rss' ) ) ) {
+                       if ( $wp_error ) {
                                return new WP_Error( 'db_insert_error', __( 'Could not insert link into the database' ), $wpdb->last_error );
-                       else
+                       } else {
                                return 0;
+                       }
                }
                $link_id = (int) $wpdb->insert_id;
        }
 
        wp_set_link_cats( $link_id, $link_category );
 
-       if ( $update )
+       if ( $update ) {
+               /**
+                * Fires after a link was updated in the database.
+                *
+                * @since 2.0.0
+                *
+                * @param int $link_id ID of the link that was updated.
+                */
                do_action( 'edit_link', $link_id );
-       else
+       } else {
+               /**
+                * Fires after a link was added to the database.
+                *
+                * @since 2.0.0
+                *
+                * @param int $link_id ID of the link that was added.
+                */
                do_action( 'add_link', $link_id );
-
+       }
        clean_bookmark_cache( $link_id );
 
        return $link_id;
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Update link with the specified link categories.
  *
- * @since unknown
+ * @since 2.1.0
  *
- * @param unknown_type $link_id
- * @param unknown_type $link_categories
+ * @param int $link_id ID of link to update
+ * @param array $link_categories Array of categories to
  */
 function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
        // If $link_categories isn't already an array, make it one:
@@ -233,15 +252,15 @@ function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
        wp_set_object_terms( $link_id, $link_categories, 'link_category' );
 
        clean_bookmark_cache( $link_id );
-}      // wp_set_link_cats()
+}
 
 /**
- * {@internal Missing Short Description}}
+ * Update a link in the database.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @param unknown_type $linkdata
- * @return unknown
+ * @param array $linkdata Link data to update.
+ * @return int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
  */
 function wp_update_link( $linkdata ) {
        $link_id = (int) $linkdata['link_id'];
@@ -249,7 +268,7 @@ function wp_update_link( $linkdata ) {
        $link = get_bookmark( $link_id, ARRAY_A );
 
        // Escape data pulled from DB.
-       $link = add_magic_quotes( $link );
+       $link = wp_slash( $link );
 
        // Passed link category list overwrites existing category list if not empty.
        if ( isset( $linkdata['link_category'] ) && is_array( $linkdata['link_category'] )
@@ -265,4 +284,25 @@ function wp_update_link( $linkdata ) {
        return wp_insert_link( $linkdata );
 }
 
-?>
+/**
+ * @since 3.5.0
+ * @access private
+ *
+ * @global string $pagenow
+ */
+function wp_link_manager_disabled_message() {
+       global $pagenow;
+       if ( 'link-manager.php' != $pagenow && 'link-add.php' != $pagenow && 'link.php' != $pagenow )
+               return;
+
+       add_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
+       $really_can_manage_links = current_user_can( 'manage_links' );
+       remove_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
+
+       if ( $really_can_manage_links && current_user_can( 'install_plugins' ) ) {
+               $link = network_admin_url( 'plugin-install.php?tab=search&s=Link+Manager' );
+               wp_die( sprintf( __( 'If you are looking to use the link manager, please install the <a href="%s">Link Manager</a> plugin.' ), $link ) );
+       }
+
+       wp_die( __( 'You do not have sufficient permissions to edit the links for this site.' ) );
+}