Wordpress by Examples

Our Todo List Plugin

A simple todo list plugin to share ideas/todos with blog members. All members work together to manage the todo list under “Manage” section in Wordpress administration interface.

A variant derived from AbstractDimension’s Todo List Plugin.

Screenshots

New!

Download

Download Our Todo List version 2.0

Howto Upgrade to version 2.0

Go to ‘Plugins’, deactivate Our Todo List.
In your server, replace the old ourtodolist.php file (or folder) with the new one.
Refresh ‘Plugins’, activate Our Todo List 2.0.
(For Wordpress 2 users) Go to ‘Options’ > ‘OurTodo’ to decide who can/cannot use the plugin.

Installing

Important: If you are using Abstract Dimension’s Todo List plugin, please read FAQs before installing.

Copy ourtodolist.php to your wp-content/plugins/
Activate the plugin
(Wordpress 1.5 users) Go to ‘Manage’ > ‘OurTodo’. Scroll to the bottom page to ‘Install’ and click the setup script.
(Wordpress 2 users) Go to ‘Options’ > ‘OurTodo’ to decide who can/cannot use the plugin.

Note: For Wordpress 2 users, step 3 should be done automatically. If not, try step 3.

Translating

The plugin comes with a POT file, otd.pot since version 1.5. Please let me know if you publish a translation. So that I can link to you:

German - translated by kretzschmar.
French (.mo file) - translated by Lise.
ä¸æ–‡ç®€ä½“ - translated by Anthony.

Install a Translation

Place the locale (.mo) file under the same directory with ourtodolist.php.

To be more organized, you can place both ourtodolist.php and the .mo file under a subdirectory, e.g. wp-content/plugins/ourtodolist/ .

Bug Reports/Feedbacks

Submit your feedback through comments.

Usage

As requested by BGH Quiz, APIs are added since version 1.2:

To display all tasks (added in version 1.7)
```
<?php ourtodolist_all(limit, show_priority, show_author); ?>
```
- limit - (integer) number of items. 0 means all items. Default is 0.
- show_priority - (boolean) show priority label. Default is false.
- show_author - (boolean) show author’s display name. Default is false.
To display todo tasks only
```
<?php ourtodolist(limit, show_priority, show_author); ?>
```
- limit - (integer) number of items. 0 means all items. Default is 0.
- show_priority - (boolean) show priority label. Default is false.
- show_author - (boolean) show author’s display name. Default is false.
To display completed tasks only
```
<?php ourtodolist_completed(limit, show_priority, show_author); ?>
```
- limit - (integer) number of items. 0 means all items. Default is 0.
- show_priority - (boolean) show priority label. Default is false.
- show_author - (boolean) show author’s display name. Default is false.
Exist any task?
```
<?php ourtodolist_exists(is_completed); ?>

/* since version 1.7 */
<?php ourtodolist_exists(status); ?>
```
- is_completed - (boolean) If true, check for completed tasks; if false, check for todo tasks. Default is false.
- status - (constant value):
  - OTD_ALL - does any tasks exist
  - OTD_TODO - does any todo tasks exist
  - OTD_COMPLETED - does any completed tasks exist
  Default is OTD_TODO.
- Returns true if exists, otherwise returns false.

Example Code

PHP source code:

<h4>Our Todo Tasks</h4>
<?php if ( ourtodolist_exists() ) : ?>
<ol>
     <?php ourtodolist(); ?>
</ol>
<?php endif; ?>

<?php if ( ourtodolist_exists(OTD_COMPLETED) ) : ?>
<h4>Completed Tasks</h4>
<ul>
    <?php ourtodolist_completed(5, false, true); ?>
</ul>
<?php endif; ?>

Genereated HTML:

Our Todo Tasks

Cook for lunch.
Late-night movie ticket.

Completed Tasks

Release Our Todo List plugin version 1.2. ~toydi

Example Code: Classnames & Styling

Since version 1.7, each list item will have a class name.
<li class="otd_completed">..</li> if it’s a completed task,
<li class="otd_todo">..</li> if it’s a todo task.

However, they are not styled by default. Feel free to style them in your current theme’s CSS file.