<!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>[BuddyPress][13927] trunk/src: WPCS: param & global docs corrections.</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="http://buddypress.trac.wordpress.org/changeset/13927">13927</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13927","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-13 19:39:42 +0000 (Thu, 13 Jun 2024)</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'>WPCS: param & global docs corrections.

Some were missing, out-of-order, or potentially wrong based on conditional logic (I.E. when specific class names are juggled based on Site/Network admin area contexts). For those, I opted just to use "object" rather than the exact class names, because they're lengthy & ugly & make the docs more difficult to read. Feel free to override that decision later!

See: <a href="http://buddypress.trac.wordpress.org/ticket/9174">#9174</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcbpactivitybpactivityfunctionsphp">trunk/src/bp-activity/bp-activity-functions.php</a></li>

<li><a href="#trunksrcbpcoreadminbpcoreadminfunctionsphp">trunk/src/bp-core/admin/bp-core-admin-functions.php</a></li>

<li><a href="#trunksrcbpcoreadminbpcoreadminoptoutsphp">trunk/src/bp-core/admin/bp-core-admin-optouts.php</a></li>

<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.php</a></li>

<li><a href="#trunksrcbpmembersclassesclassbpmembersadminphp">trunk/src/bp-members/classes/class-bp-members-admin.php</a></li>

<li><a href="#trunksrcbptemplatesbplegacybuddypressgroupssingleadminmanagemembersphp">trunk/src/bp-templates/bp-legacy/buddypress/groups/single/admin/manage-members.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcbpactivitybpactivityfunctionsphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-functions.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-functions.php   2024-06-13 19:21:48 UTC (rev 13926)

+++ trunk/src/bp-activity/bp-activity-functions.php     2024-06-13 19:39:42 UTC (rev 13927)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -402,7 +402,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.2.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global $wp_post_types

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_post_types

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $post_type The name of the post type, as registered with WordPress. Eg 'post' or 'page'.

</span><span class="cx" style="display: block; padding: 0 10px">  * @param array  $args {

</span></span></pre></div>

<a id="trunksrcbpcoreadminbpcoreadminfunctionsphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/admin/bp-core-admin-functions.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/admin/bp-core-admin-functions.php       2024-06-13 19:21:48 UTC (rev 13926)

+++ trunk/src/bp-core/admin/bp-core-admin-functions.php 2024-06-13 19:39:42 UTC (rev 13927)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,7 +26,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * The old "bp-general-settings" page was renamed "bp-components".

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 1.6.0 

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 1.6.0

</ins><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @global array $_parent_pages

</span><span class="cx" style="display: block; padding: 0 10px">  * @global array $_registered_pages

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1130,7 +1130,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 1.9.0

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 7.0.0 Uses wp_nav_menu_item_post_type_meta_box()

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global $nav_menu_selected_id

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int|string $nav_menu_selected_id

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param WP_Post $post The current post object.

<span class="cx" style="display: block; padding: 0 10px">  * @param array   $box     The meta box arguments.

</span></span></pre></div>

<a id="trunksrcbpcoreadminbpcoreadminoptoutsphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/admin/bp-core-admin-optouts.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/admin/bp-core-admin-optouts.php 2024-06-13 19:21:48 UTC (rev 13926)

+++ trunk/src/bp-core/admin/bp-core-admin-optouts.php   2024-06-13 19:39:42 UTC (rev 13927)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,7 +19,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 8.0.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global $bp_optouts_list_table BP_Optouts_List_Table List table instance for nonmember opt-outs admin page.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global object $bp_optouts_list_table List table instance for nonmember opt-outs admin page.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_optouts_admin_load() {

</span><span class="cx" style="display: block; padding: 0 10px">        global $bp_optouts_list_table;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -290,8 +290,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 8.0.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global $plugin_page

- * @global $bp_optouts_list_table BP_Optouts_List_Table List table instance for nonmember opt-outs admin page.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global string $plugin_page

+ * @global object $bp_optouts_list_table List table instance for nonmember opt-outs admin page.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_optouts_admin_index() {

</span><span class="cx" style="display: block; padding: 0 10px">        global $plugin_page, $bp_optouts_list_table;

</span></span></pre></div>

<a id="trunksrcbpcorebpcoreavatarsphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-avatars.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-avatars.php     2024-06-13 19:21:48 UTC (rev 13926)

+++ trunk/src/bp-core/bp-core-avatars.php       2024-06-13 19:39:42 UTC (rev 13927)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2131,8 +2131,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.3.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global $is_safari

- * @global $is_IE

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global bool $is_safari

+ * @global bool $is_IE

</ins><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @return bool True to load the Webcam Avatar UI part. False otherwise.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span></span></pre></div>

<a id="trunksrcbpmembersclassesclassbpmembersadminphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-members-admin.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-members-admin.php   2024-06-13 19:21:48 UTC (rev 13926)

+++ trunk/src/bp-members/classes/class-bp-members-admin.php     2024-06-13 19:39:42 UTC (rev 13927)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1818,7 +1818,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.0.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @global $bp_members_signup_list_table

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @global object $bp_members_signup_list_table

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function signups_admin_load() {

</span><span class="cx" style="display: block; padding: 0 10px">                global $bp_members_signup_list_table;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2286,8 +2286,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.0.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @global $plugin_page

-        * @global $bp_members_signup_list_table

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @global string $plugin_page

+        * @global object $bp_members_signup_list_table

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function signups_admin_index() {

</span><span class="cx" style="display: block; padding: 0 10px">                global $plugin_page, $bp_members_signup_list_table;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2867,7 +2867,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 8.0.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @global $bp_members_invitations_list_table

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @global object $bp_members_invitations_list_table

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function members_invitations_admin_load() {

</span><span class="cx" style="display: block; padding: 0 10px">                global $bp_members_invitations_list_table;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3194,8 +3194,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 8.0.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @global $plugin_page

-        * @global $bp_members_invitations_list_table

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @global string $plugin_page

+        * @global object $bp_members_invitations_list_table

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function invitations_admin_index() {

</span><span class="cx" style="display: block; padding: 0 10px">                global $plugin_page, $bp_members_invitations_list_table;

</span></span></pre></div>

<a id="trunksrcbptemplatesbplegacybuddypressgroupssingleadminmanagemembersphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-templates/bp-legacy/buddypress/groups/single/admin/manage-members.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-templates/bp-legacy/buddypress/groups/single/admin/manage-members.php        2024-06-13 19:21:48 UTC (rev 13926)

+++ trunk/src/bp-templates/bp-legacy/buddypress/groups/single/admin/manage-members.php  2024-06-13 19:39:42 UTC (rev 13927)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,7 +65,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">                                                         * @since 1.1.0

</span><span class="cx" style="display: block; padding: 0 10px">                                                         * @since 2.7.0 Added $section parameter.

</span><span class="cx" style="display: block; padding: 0 10px">                                                         *