Function CMS_Topic->_grab_at_and_above_and_remove

Definitions

sources/topics.php

  • Grab posts at or above a reference post and remove from queue.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$post_id AUTO_LINK No No required parameter N/A N/A Reference post in thread
&$queue array Yes No required parameter N/A N/A Posts to choose from (the queue)
&$posts array Yes No required parameter N/A N/A Posts picked out (passed by reference)

Preview

Code (PHP)

/**
 * Grab posts at or above a reference post and remove from queue.
 *
 * @param  AUTO_LINK $post_id Reference post in thread
 * @param  array $queue Posts to choose from (the queue)
 * @param  array $posts Posts picked out (passed by reference)
 */
protected function _grab_at_and_above_and_remove(int $post_id, array &$queue, array &$posts)