<!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>[51326] trunk/src/wp-includes/meta.php: Docs: Document common names for dynamic hooks relating to metadata.</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/51326">51326</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/51326","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:31:13 +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: Document common names for dynamic hooks relating to metadata.
See <a href="https://core.trac.wordpress.org/ticket/53581">#53581</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmetaphp"></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/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/meta.php 2021-07-03 15:14:23 UTC (rev 51325)
+++ trunk/src/wp-includes/meta.php 2021-07-03 21:31:13 UTC (rev 51326)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,6 +60,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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_post_metadata`
+ * - `add_comment_metadata`
+ * - `add_term_metadata`
+ * - `add_user_metadata`
+ *
</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 null|bool $check Whether to allow adding metadata for the given type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,6 +99,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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_post_meta`
+ * - `add_comment_meta`
+ * - `add_term_meta`
+ * - `add_user_meta`
+ *
</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 int $object_id ID of the object metadata is for.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -123,6 +137,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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:
+ *
+ * - `added_post_meta`
+ * - `added_comment_meta`
+ * - `added_term_meta`
+ * - `added_user_meta`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $mid The meta ID after successful update.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,6 +213,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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:
+ *
+ * - `update_post_metadata`
+ * - `update_comment_metadata`
+ * - `update_term_metadata`
+ * - `update_user_metadata`
+ *
</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 null|bool $check Whether to allow updating metadata for the given type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -243,6 +271,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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:
+ *
+ * - `update_post_meta`
+ * - `update_comment_meta`
+ * - `update_term_meta`
+ * - `update_user_meta`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $meta_id ID of the metadata entry to update.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,6 +317,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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:
+ *
+ * - `updated_post_meta`
+ * - `updated_comment_meta`
+ * - `updated_term_meta`
+ * - `updated_user_meta`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $meta_id ID of updated metadata entry.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -363,6 +405,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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:
+ *
+ * - `delete_post_metadata`
+ * - `delete_comment_metadata`
+ * - `delete_term_metadata`
+ * - `delete_user_metadata`
+ *
</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 null|bool $delete Whether to allow metadata deletion of the given type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,6 +459,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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:
+ *
+ * - `delete_post_meta`
+ * - `delete_comment_meta`
+ * - `delete_term_meta`
+ * - `delete_user_meta`
+ *
</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[] $meta_ids An array of metadata entry IDs to delete.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -453,6 +509,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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:
+ *
+ * - `deleted_post_meta`
+ * - `deleted_comment_meta`
+ * - `deleted_term_meta`
+ * - `deleted_user_meta`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $meta_ids An array of metadata entry IDs to delete.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -746,6 +809,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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_post_metadata_by_mid`
+ * - `get_comment_metadata_by_mid`
+ * - `get_term_metadata_by_mid`
+ * - `get_user_metadata_by_mid`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param stdClass|null $value The value to return.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -813,6 +883,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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:
+ *
+ * - `update_post_metadata_by_mid`
+ * - `update_comment_metadata_by_mid`
+ * - `update_term_metadata_by_mid`
+ * - `update_user_metadata_by_mid`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param null|bool $check Whether to allow updating metadata for the given type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -929,6 +1006,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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:
+ *
+ * - `delete_post_metadata_by_mid`
+ * - `delete_comment_metadata_by_mid`
+ * - `delete_term_metadata_by_mid`
+ * - `delete_user_metadata_by_mid`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param null|bool $delete Whether to allow metadata deletion of the given type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -955,6 +1039,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (post or comment).
</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:
+ *
+ * - `delete_postmeta`
+ * - `delete_commentmeta`
+ * - `delete_termmeta`
+ * - `delete_usermeta`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $meta_id ID of the metadata entry to delete.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -979,6 +1070,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$meta_type`, refers to the meta
</span><span class="cx" style="display: block; padding: 0 10px"> * object type (post or comment).
</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:
+ *
+ * - `deleted_postmeta`
+ * - `deleted_commentmeta`
+ * - `deleted_termmeta`
+ * - `deleted_usermeta`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $meta_ids Deleted metadata entry ID.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1034,6 +1132,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value will effectively short-circuit the function.
</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:
+ *
+ * - `update_post_metadata_cache`
+ * - `update_comment_metadata_cache`
+ * - `update_term_metadata_cache`
+ * - `update_user_metadata_cache`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $check Whether to allow updating the meta cache of the given type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1672,6 +1777,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook, `$object_type`, refers to the meta object type
</span><span class="cx" style="display: block; padding: 0 10px"> * (post, comment, term, user, or any other type with an associated meta table).
</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_object_subtype_post`
+ * - `get_object_subtype_comment`
+ * - `get_object_subtype_term`
+ * - `get_object_subtype_user`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.8
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $object_subtype Empty string to override.
</span></span></pre>
</div>
</div>
</body>
</html>