<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[27700] trunk/src/wp-includes/nav-menu.php: Inline documentation for hooks in wp-includes/nav-menu.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27700">27700</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-03-25 09:03:02 +0000 (Tue, 25 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/nav-menu.php.
Props dustyf, kpdesign.
Fixes <a href="http://core.trac.wordpress.org/ticket/27367">#27367</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesnavmenuphp">trunk/src/wp-includes/nav-menu.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesnavmenuphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/nav-menu.php (27699 => 27700)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/nav-menu.php 2014-03-25 08:59:55 UTC (rev 27699)
+++ trunk/src/wp-includes/nav-menu.php 2014-03-25 09:03:02 UTC (rev 27700)
</span><span class="lines">@@ -201,6 +201,14 @@
</span><span class="cx"> set_theme_mod( 'nav_menu_locations', $locations );
</span><span class="cx">
</span><span class="cx"> if ( $result && !is_wp_error($result) )
</span><ins>+
+ /**
+ * Fires after a navigation menu has been successfully deleted.
+ *
+ * @since 3.0.0
+ *
+ * @param int $term_id ID of the deleted menu.
+ */
</ins><span class="cx"> do_action( 'wp_delete_nav_menu', $menu->term_id );
</span><span class="cx">
</span><span class="cx"> return $result;
</span><span class="lines">@@ -213,7 +221,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int $menu_id The ID of the menu or "0" to create a new menu.
</span><span class="cx"> * @param array $menu_data The array of menu data.
</span><del>- * @return int|error object The menu's ID or WP_Error object.
</del><ins>+ * @return int|WP_Error object The menu's ID or WP_Error object.
</ins><span class="cx"> */
</span><span class="cx"> function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) {
</span><span class="cx"> $menu_id = (int) $menu_id;
</span><span class="lines">@@ -249,6 +257,14 @@
</span><span class="cx"> if ( is_wp_error( $_menu ) )
</span><span class="cx"> return $_menu;
</span><span class="cx">
</span><ins>+ /**
+ * Fires after a navigation menu is successfully created.
+ *
+ * @since 3.0.0
+ *
+ * @param int $term_id ID of the new menu.
+ * @param array $menu_data An array of menu data.
+ */
</ins><span class="cx"> do_action( 'wp_create_nav_menu', $_menu['term_id'], $menu_data );
</span><span class="cx">
</span><span class="cx"> return (int) $_menu['term_id'];
</span><span class="lines">@@ -264,6 +280,14 @@
</span><span class="cx"> if ( is_wp_error( $update_response ) )
</span><span class="cx"> return $update_response;
</span><span class="cx">
</span><ins>+ /**
+ * Fires after a navigation menu has been successfully updated.
+ *
+ * @since 3.0.0
+ *
+ * @param int $menu_id ID of the updated menu.
+ * @param array $menu_data An array of menu data.
+ */
</ins><span class="cx"> do_action( 'wp_update_nav_menu', $menu_id, $menu_data );
</span><span class="cx"> return $menu_id;
</span><span class="cx"> }
</span><span class="lines">@@ -411,7 +435,18 @@
</span><span class="cx"> wp_update_post( $post );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- do_action('wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args );
</del><ins>+ /**
+ * Fires after a navigation menu item has been updated.
+ *
+ * @since 3.0.0
+ *
+ * @see wp_update_nav_menu_items()
+ *
+ * @param int $menu_id ID of the updated menu.
+ * @param int $menu_item_db_id ID of the updated menu item.
+ * @param array $args An array of arguments used to update a menu item.
+ */
+ do_action( 'wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args );
</ins><span class="cx">
</span><span class="cx"> return $menu_item_db_id;
</span><span class="cx"> }
</span><span class="lines">@@ -427,6 +462,17 @@
</span><span class="cx"> function wp_get_nav_menus( $args = array() ) {
</span><span class="cx"> $defaults = array( 'hide_empty' => false, 'orderby' => 'none' );
</span><span class="cx"> $args = wp_parse_args( $args, $defaults );
</span><ins>+
+ /**
+ * Filter the navigation menu objects being returned.
+ *
+ * @since 3.0.0
+ *
+ * @see get_terms()
+ *
+ * @param array $menus An array of menu objects.
+ * @param array $args An array of arguments used to retrieve menu objects.
+ */
</ins><span class="cx"> return apply_filters( 'wp_get_nav_menus', get_terms( 'nav_menu', $args), $args );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -556,6 +602,15 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter the navigation menu items being returned.
+ *
+ * @since 3.0.0
+ *
+ * @param array $items An array of menu item post objects.
+ * @param object $menu The menu object.
+ * @param array $args An array of arguments used to retrieve menu item objects.
+ */
</ins><span class="cx"> return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -632,10 +687,25 @@
</span><span class="cx">
</span><span class="cx"> $menu_item->target = empty( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
</span><span class="cx">
</span><ins>+ /**
+ * Filter a navigation menu item's title attribute.
+ *
+ * @since 3.0.0
+ *
+ * @param string $item_title The menu item title attribute.
+ */
</ins><span class="cx"> $menu_item->attr_title = empty( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;
</span><span class="cx">
</span><del>- if ( empty( $menu_item->description ) )
- $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) );
</del><ins>+ if ( empty( $menu_item->description ) ) {
+ /**
+ * Filter a navigation menu item's description.
+ *
+ * @since 3.0.0
+ *
+ * @param string $description The menu item description.
+ */
+ $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) );
+ }
</ins><span class="cx">
</span><span class="cx"> $menu_item->classes = empty( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;
</span><span class="cx"> $menu_item->xfn = empty( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
</span><span class="lines">@@ -656,7 +726,10 @@
</span><span class="cx"> $menu_item->url = get_permalink( $menu_item->ID );
</span><span class="cx"> $menu_item->target = '';
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/nav-menu.php */
</ins><span class="cx"> $menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' );
</span><ins>+
+ /** This filter is documented in wp-includes/nav-menu.php */
</ins><span class="cx"> $menu_item->description = apply_filters( 'nav_menu_description', '' );
</span><span class="cx"> $menu_item->classes = array();
</span><span class="cx"> $menu_item->xfn = '';
</span><span class="lines">@@ -683,6 +756,13 @@
</span><span class="cx">
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter a navigation menu item object.
+ *
+ * @since 3.0.0
+ *
+ * @param object $menu_item The menu item object.
+ */
</ins><span class="cx"> return apply_filters( 'wp_setup_nav_menu_item', $menu_item );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>