寻求Moodle动态加载课程章节的开发入门指导（仿Topics格式）

一、先搭好插件基础框架 #

• 直接复制Moodle自带的topics课程格式文件夹，重命名成你想要的名字（比如topics_dynamic），然后修改核心文件标识：
  • version.php里的component改成format_topics_dynamic，更新版本号
  • 语言文件夹lang/en/里的文件名改成format_topics_dynamic.php，把里面的字符串前缀统一换成format_topics_dynamic
• 先确保改完后插件能被Moodle识别、正常安装，这是后续开发的基础。

二、核心改造：把一次性渲染拆成动态加载 #

1. 前端页面拆分渲染 #

• 修改format.php：原代码是循环输出所有章节，现在改成只渲染前10个（数量可自定义），在章节列表末尾添加“加载更多”按钮。
• 抽离单个章节渲染模板：新建section_template.mustache，把单个章节的HTML结构单独存放，方便后端渲染后前端直接拼接。

2. 编写后端AJAX接口 #

• 在插件目录下新建ajax.php，处理前端的章节加载请求：
  • 接收三个参数：课程ID、起始章节序号、每次加载数量
  • 先做权限验证，确保请求用户能访问目标课程
  • 用Moodle的DB API拉取指定范围的章节及关联活动数据
  • 调用插件渲染器把章节转换成HTML，返回JSON格式内容
    代码示例：

  require_once('../../config.php');
  require_once($CFG->dirroot.'/course/format/topics_dynamic/renderer.php');
  
  $courseid = required_param('courseid', PARAM_INT);
  $start = required_param('start', PARAM_INT);
  $limit = optional_param('limit', 10, PARAM_INT);
  
  $course = get_course($courseid);
  require_login($course);
  
  // 提前关闭会话写入，规避锁问题
  \core\session\manager::write_close();
  
  $renderer = $PAGE->get_renderer('format_topics_dynamic');
  $sections = $DB->get_records_sql(
      'SELECT * FROM {course_sections} WHERE course = ? AND section >= ? ORDER BY section ASC LIMIT ?',
      [$courseid, $start, $limit]
  );
  
  $output = '';
  foreach ($sections as $section) {
      $output .= $renderer->render_section($section, $course);
  }
  
  echo json_encode(['html' => $output, 'hasmore' => count($sections) == $limit]);
  die();
  

3. 实现前端交互逻辑 #

• 在format.php中引入自定义JS文件（比如dynamic_load.js），完成加载逻辑：
  • 监听“加载更多”按钮点击事件，或页面滚动触底事件
  • 发送AJAX请求到ajax.php，传递课程ID、当前已加载章节序号
  • 将返回的HTML插入章节列表末尾，更新已加载计数
  • 如果返回章节数小于请求数量，说明无更多内容，隐藏加载按钮
    代码示例：

  let currentLoaded = 10; // 初始加载10个章节
  const courseId = <?php echo $course->id; ?>;
  const loadBtn = document.getElementById('load-more-btn');
  const sectionContainer = document.querySelector('.course-sections');
  
  loadBtn.addEventListener('click', async () => {
      loadBtn.disabled = true;
      const res = await fetch(`${M.cfg.wwwroot}/course/format/topics_dynamic/ajax.php`, {
          method: 'POST',
          headers: {'Content-Type': 'application/x-www-form-urlencoded'},
          body: `courseid=${courseId}&start=${currentLoaded}&limit=10`
      });
      const data = await res.json();
      sectionContainer.insertAdjacentHTML('beforeend', data.html);
      currentLoaded += 10;
      if (!data.hasmore) {
          loadBtn.style.display = 'none';
      }
      loadBtn.disabled = false;
  });
  
  // 可选：滚动触底自动加载
  window.addEventListener('scroll', () => {
      if (window.innerHeight + window.scrollY >= document.body.offsetHeight - 100 && !loadBtn.disabled) {
          loadBtn.click();
      }
  });
  

三、避坑要点 #

• 会话锁规避：AJAX接口开头必须加上\core\session\manager::write_close();，提前关闭会话写入，避免大量并发请求触发锁错误。
• 权限严格验证：后端接口必须确保只有授权用户能获取章节数据，不能跳过权限检查。
• 兼容性测试：要在目标Moodle版本、不同主题下测试，确保章节渲染正常、响应式布局适配。
• 性能优化：用Moodle的缓存API存储已渲染的章节内容，减少重复查询和渲染开销。

四、测试步骤 #

• 本地搭建测试环境，创建包含100+章节的测试课程，安装插件后切换为该动态格式。
• 检查页面加载速度，确认初始仅加载部分章节，数据库查询次数减少。
• 测试加载更多功能，验证章节内容显示正确、权限控制有效。
• 查看Moodle错误日志，排查会话锁、权限相关的报错。

内容的提问来源于stack exchange，提问作者Anup Ranekar