<!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>[51327] trunk/src: Docs: Add and correct examples of common names for various dynamic hooks.</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/51327">51327</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/51327","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-07-03 21:41:02 +0000 (Sat, 03 Jul 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Add and correct examples of common names for various dynamic hooks.
See <a href="https://core.trac.wordpress.org/ticket/53581">#53581</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminadminphp">trunk/src/wp-admin/admin.php</a></li>
<li><a href="#trunksrcwpadminincludesmediaphp">trunk/src/wp-admin/includes/media.php</a></li>
<li><a href="#trunksrcwpadminincludesmetaboxesphp">trunk/src/wp-admin/includes/meta-boxes.php</a></li>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
<li><a href="#trunksrcwpincludesclasswprewritephp">trunk/src/wp-includes/class-wp-rewrite.php</a></li>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunksrcwpincludesrevisionphp">trunk/src/wp-includes/revision.php</a></li>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminadminphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/admin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/admin.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-admin/admin.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -320,6 +320,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$importer`, refers to the importer slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `load-importer-blogger`
+ * - `load-importer-wpcat2tag`
+ * - `load-importer-livejournal`
+ * - `load-importer-mt`
+ * - `load-importer-rss`
+ * - `load-importer-tumblr`
+ * - `load-importer-wordpress`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( "load-importer-{$importer}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
</span></span></pre></div>
<a id="trunksrcwpadminincludesmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/media.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-admin/includes/media.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -578,9 +578,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (pre-3.5.0) media upload popup.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$content_func`, refers to the form
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * callback for the media upload type. Possible values include
- * 'media_upload_type_form', 'media_upload_type_url_form', and
- * 'media_upload_library_form'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * callback for the media upload type.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpadminincludesmetaboxesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/meta-boxes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/meta-boxes.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-admin/includes/meta-boxes.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1582,6 +1582,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$post_type`, refers to the post type of the post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `add_meta_boxes_post`
+ * - `add_meta_boxes_page`
+ * - `add_meta_boxes_attachment`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post Post object.
</span></span></pre></div>
<a id="trunksrcwpincludescategorytemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/category-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/category-template.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1346,6 +1346,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the filter name, `$taxonomy`, refers
</span><span class="cx" style="display: block; padding: 0 10px"> * to the taxonomy slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `term_links-category`
+ * - `term_links-post_tag`
+ * - `term_links-post_format`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $links An array of term links.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswprewritephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-rewrite.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/class-wp-rewrite.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1411,9 +1411,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters rewrite rules used for individual permastructs.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$permastructname`, refers
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * to the name of the registered permastruct, e.g. 'post_tag' (tags),
- * 'category' (categories), etc.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * to the name of the registered permastruct.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `category_rewrite_rules`
+ * - `post_format_rewrite_rules`
+ * - `post_tag_rewrite_rules`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $rules Array of rewrite rules generated for the current permastruct, keyed by their regex pattern.
</span></span></pre></div>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/comment-template.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2647,8 +2647,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters a comment form field for display.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the filter hook, `$name`, refers to the name
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * of the comment form field. Such as 'author', 'email', or 'url'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * of the comment form field.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `comment_form_field_comment`
+ * - `comment_form_field_author`
+ * - `comment_form_field_email`
+ * - `comment_form_field_url`
+ * - `comment_form_field_cookies`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $field The HTML-formatted output of the comment form field.
</span></span></pre></div>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/post.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4411,6 +4411,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$post->post_type`, refers to
</span><span class="cx" style="display: block; padding: 0 10px"> * the post type slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `edit_post_post`
+ * - `edit_post_page`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_ID Post ID.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4448,6 +4453,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$post->post_type`, refers to
</span><span class="cx" style="display: block; padding: 0 10px"> * the post type slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `save_post_post`
+ * - `save_post_page`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_ID Post ID.
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1024,6 +1024,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * They dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `rest_delete_post`
+ * - `rest_delete_page`
+ * - `rest_delete_attachment`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The deleted or trashed post.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2534,6 +2540,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the filter, `$this->post_type`, refers to the
</span><span class="cx" style="display: block; padding: 0 10px"> * post type slug for the controller.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `rest_post_item_schema`
+ * - `rest_page_item_schema`
+ * - `rest_attachment_item_schema`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $schema Item schema data.
</span></span></pre></div>
<a id="trunksrcwpincludesrevisionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/revision.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/revision.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/revision.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -574,6 +574,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$post->post_type`, refers to
</span><span class="cx" style="display: block; padding: 0 10px"> * the post type slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `wp_post_revisions_to_keep`
+ * - `wp_page_revisions_to_keep`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $num Number of revisions to store.
</span></span></pre></div>
<a id="trunksrcwpincludestaxonomyphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2021-07-03 21:31:13 UTC (rev 51326)
+++ trunk/src/wp-includes/taxonomy.php 2021-07-03 21:41:02 UTC (rev 51327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -948,6 +948,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the filter name, `$taxonomy`, refers
</span><span class="cx" style="display: block; padding: 0 10px"> * to the slug of the term's taxonomy.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible hook names include:
+ *
+ * - `get_category`
+ * - `get_post_tag`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 `$_term` is now a `WP_Term` object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>